Class SearchCatalogRequest (3.9.1)

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

Request message for SearchCatalog.

Attributes

NameDescription
scope google.cloud.datacatalog_v1beta1.types.SearchCatalogRequest.Scope
Required. The scope of this search request. A ``scope`` that has empty ``include_org_ids``, ``include_project_ids`` AND false ``include_gcp_public_datasets`` is considered invalid. Data Catalog will return an error in such a case.
query str
Required. The query string in search query syntax. The query must be non-empty. Query strings can be simple as "x" or more qualified as: - name:x - column:x - description:y Note: Query tokens need to have a minimum of 3 characters for substring matching to work correctly. See `Data Catalog Search Syntax
page_size int
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 str
Optional. Pagination token returned in an earlier SearchCatalogResponse.next_page_token, which indicates that this is a continuation of a prior SearchCatalogRequest call, and that the system should return the next page of data. If empty, the first page is returned.
order_by str
Specifies the ordering of results, currently supported case-sensitive choices are: - ``relevance``, only supports descending - ``last_modified_timestamp [asc|desc]``, defaults to descending if not specified If not specified, defaults to ``relevance`` descending.

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.