google_api_data_catalog v0.8.0 GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1SearchCatalogRequest View Source

Request message for SearchCatalog.

Attributes

  • orderBy (type: String.t, default: nil) - 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.

  • pageSize (type: integer(), default: nil) - 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.

  • pageToken (type: String.t, default: nil) - 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.

  • query (type: String.t, default: nil) - 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 for more information.

  • scope (type: GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1SearchCatalogRequestScope.t, default: nil) - Required. The scope of this search request.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t()

View Source
t() ::
  %GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1SearchCatalogRequest{
    orderBy: String.t(),
    pageSize: integer(),
    pageToken: String.t(),
    query: String.t(),
    scope:
      GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1SearchCatalogRequestScope.t()
  }

Link to this section Functions

Link to this function

decode(value, options)

View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.