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.
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: projects/{project}/locations/{location}
.
↳ 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 SearchEntries
call. Provide this to retrieve the subsequent page.
↳ order_by
string
Optional. Specifies the ordering of results. Supported values are: * * relevance
(default) * * last_modified_timestamp
* * last_modified_timestamp asc
↳ scope
string
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.
↳ semantic_search
bool
Optional. Specifies whether the search should understand the meaning and intent behind the query, rather than just matching keywords.
getName
Required. The project to which the request should be attributed in the
following form: projects/{project}/locations/{location}
.
string
setName
Required. The project to which the request should be attributed in the
following form: projects/{project}/locations/{location}
.
var
string
$this
getQuery
Required. The query against which entries in scope should be matched.
The query syntax is defined in Search syntax for Dataplex Catalog .
string
setQuery
Required. The query against which entries in scope should be matched.
The query syntax is defined in Search syntax for Dataplex Catalog .
var
string
$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.
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.
var
int
$this
getPageToken
Optional. Page token received from a previous SearchEntries
call. Provide
this to retrieve the subsequent page.
string
setPageToken
Optional. Page token received from a previous SearchEntries
call. Provide
this to retrieve the subsequent page.
var
string
$this
getOrderBy
Optional. Specifies the ordering of results.
Supported values are:
-
relevance(default) -
last_modified_timestamp -
last_modified_timestamp asc
string
setOrderBy
Optional. Specifies the ordering of results.
Supported values are:
-
relevance(default) -
last_modified_timestamp -
last_modified_timestamp asc
var
string
$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.
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.
var
string
$this
getSemanticSearch
Optional. Specifies whether the search should understand the meaning and intent behind the query, rather than just matching keywords.
bool
setSemanticSearch
Optional. Specifies whether the search should understand the meaning and intent behind the query, rather than just matching keywords.
var
bool
$this
static::build
name
string
Required. The project to which the request should be attributed in the
following form: projects/{project}/locations/{location}
. Please see CatalogServiceClient::locationName()
for help formatting this field.
query
string
Required. The query against which entries in scope should be matched. The query syntax is defined in Search syntax for Dataplex Catalog .
