Google Cloud Dataplex V1 Client - Class SearchEntriesRequest (1.6.1)
Stay organized with collections
Save and categorize content based on your preferences.
Reference documentation and code samples for the Google Cloud Dataplex V1 Client class SearchEntriesRequest.
Generated from protobuf message google.cloud.dataplex.v1.SearchEntriesRequest
Namespace
Google \ Cloud \ Dataplex \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The project to which the request should be attributed in the following form: |
↳ query |
string
Required. The query against which entries in scope should be matched. The query syntax is defined in Search syntax for Dataplex Catalog. |
↳ page_size |
int
Optional. Number of results in the search page. If <=0, then defaults to 10. Max limit for page_size is 1000. Throws an invalid argument for page_size > 1000. |
↳ page_token |
string
Optional. Page token received from a previous |
↳ order_by |
string
Optional. Specifies the ordering of results. Supported values are: * * |
↳ scope |
string
Optional. The scope under which the search should be operating. It must either be |
getName
Required. The project to which the request should be attributed in the
following form: projects/{project}/locations/{location}.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. The project to which the request should be attributed in the
following form: projects/{project}/locations/{location}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getQuery
Required. The query against which entries in scope should be matched.
The query syntax is defined in Search syntax for Dataplex Catalog.
| Returns | |
|---|---|
| Type | Description |
string |
|
setQuery
Required. The query against which entries in scope should be matched.
The query syntax is defined in Search syntax for Dataplex Catalog.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
Optional. Number of results in the search page. If <=0, then defaults to 10. Max limit for page_size is 1000. Throws an invalid argument for page_size > 1000.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
Optional. Number of results in the search page. If <=0, then defaults to 10. Max limit for page_size is 1000. Throws an invalid argument for page_size > 1000.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
Optional. Page token received from a previous SearchEntries call. Provide
this to retrieve the subsequent page.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
Optional. Page token received from a previous SearchEntries call. Provide
this to retrieve the subsequent page.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOrderBy
Optional. Specifies the ordering of results.
Supported values are:
relevance(default)last_modified_timestamplast_modified_timestamp asc
| Returns | |
|---|---|
| Type | Description |
string |
|
setOrderBy
Optional. Specifies the ordering of results.
Supported values are:
relevance(default)last_modified_timestamplast_modified_timestamp asc
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getScope
Optional. The scope under which the search should be operating. It must
either be organizations/<org_id> or projects/<project_ref>. If it is
unspecified, it defaults to the organization where the project provided in
name is located.
| Returns | |
|---|---|
| Type | Description |
string |
|
setScope
Optional. The scope under which the search should be operating. It must
either be organizations/<org_id> or projects/<project_ref>. If it is
unspecified, it defaults to the organization where the project provided in
name is located.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. The project to which the request should be attributed in the
following form: |
query |
string
Required. The query against which entries in scope should be matched. The query syntax is defined in Search syntax for Dataplex Catalog. |
| Returns | |
|---|---|
| Type | Description |
SearchEntriesRequest |
|