Class SearchCatalogRequest (3.9.0)

SearchCatalogRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Request message for SearchCatalog.

Attributes

NameDescription
scope google.cloud.datacatalog_v1.types.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 str
Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see `Data Catalog search syntax
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 str
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 str
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``.

Inheritance

builtins.object > proto.message.Message > SearchCatalogRequest

Classes

Scope

Scope(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The criteria that select the subspace used for query matching.