GoogleApi.DataCatalog.V1.Model.GoogleCloudDatacatalogV1SearchCatalogRequest (google_api_data_catalog v0.25.0) View Source

Request message for SearchCatalog.

Attributes

orderBy (type: String.t, default: nil) - 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.
pageSize (type: integer(), default: nil) - 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.
pageToken (type: String.t, default: nil) - 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.
query (type: String.t, default: nil) - 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
scope (type: GoogleApi.DataCatalog.V1.Model.GoogleCloudDatacatalogV1SearchCatalogRequestScope.t, default: nil) - 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.

Link to this section Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

t()

Specs

t() ::
  %GoogleApi.DataCatalog.V1.Model.GoogleCloudDatacatalogV1SearchCatalogRequest{
    orderBy: String.t() | nil,
    pageSize: integer() | nil,
    pageToken: String.t() | nil,
    query: String.t() | nil,
    scope:
      GoogleApi.DataCatalog.V1.Model.GoogleCloudDatacatalogV1SearchCatalogRequestScope.t()
      | nil
  }

Link to this section Functions

decode(value, options)

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.