Google Cloud Data Catalog V1 Client - Class SearchCatalogRequest (1.4.2)

Reference documentation and code samples for the Google Cloud Data Catalog V1 Client class SearchCatalogRequest.

Request message for SearchCatalog.

Generated from protobuf message google.cloud.datacatalog.v1.SearchCatalogRequest

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ scope`	`Google\Cloud\DataCatalog\V1\SearchCatalogRequest\Scope` Required. The scope of this search request. The `scope` is invalid if `include_org_ids`, `include_project_ids` are empty AND `include_gcp_public_datasets` is set to `false`. In this case, the request returns an error.
`↳ query`	`string` Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see Data Catalog search syntax. An empty query string returns all data assets (in the specified scope) that you have access to. A query string can be a simple `xyz` or qualified by predicates: * `name:x` * `column:y` * `description:z`
`↳ page_size`	`int` Number of results to return in a single search page. Can't be negative or 0, defaults to 10 in this case. The maximum number is 1000. If exceeded, throws an "invalid argument" exception.
`↳ page_token`	`string` Optional. Pagination token that, if specified, returns the next page of search results. If empty, returns the first page. This token is returned in the SearchCatalogResponse.next_page_token field of the response to a previous SearchCatalogRequest call.
`↳ order_by`	`string` Specifies the order of results. Currently supported case-sensitive values are: * `relevance` that can only be descending * `last_modified_timestamp [asc\|desc]` with descending (`desc`) as default * `default` that can only be descending If this parameter is omitted, it defaults to the descending `relevance`.

getScope

Required. The scope of this search request.

The scope is invalid if include_org_ids, include_project_ids are empty AND include_gcp_public_datasets is set to false. In this case, the request returns an error.

Returns
Type	Description
`Google\Cloud\DataCatalog\V1\SearchCatalogRequest\Scope\|null`

hasScope

clearScope

setScope

Required. The scope of this search request.

The scope is invalid if include_org_ids, include_project_ids are empty AND include_gcp_public_datasets is set to false. In this case, the request returns an error.

Parameter
Name	Description
`var`	`Google\Cloud\DataCatalog\V1\SearchCatalogRequest\Scope`

Returns
Type	Description
`$this`

getQuery

Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see Data Catalog search syntax.

An empty query string returns all data assets (in the specified scope) that you have access to. A query string can be a simple xyz or qualified by predicates:

name:x
column:y
description:z

Returns
Type	Description
`string`

setQuery

Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see Data Catalog search syntax.

An empty query string returns all data assets (in the specified scope) that you have access to. A query string can be a simple xyz or qualified by predicates:

name:x
column:y
description:z

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageSize

Number of results to return in a single search page.

Can't be negative or 0, defaults to 10 in this case. The maximum number is 1000. If exceeded, throws an "invalid argument" exception.

Returns
Type	Description
`int`

setPageSize