Google Cloud Data Catalog V1BETA1 API - Class Google::Cloud::DataCatalog::V1beta1::SearchCatalogRequest (v0.9.1)

Reference documentation and code samples for the Google Cloud Data Catalog V1BETA1 API class Google::Cloud::DataCatalog::V1beta1::SearchCatalogRequest.

Request message for SearchCatalog.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#order_by

def order_by() -> ::String
Returns
  • (::String) — 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
    • default that can only be descending

    If not specified, defaults to relevance descending.

#order_by=

def order_by=(value) -> ::String
Parameter
  • value (::String) — 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
    • default that can only be descending

    If not specified, defaults to relevance descending.

Returns
  • (::String) — 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
    • default that can only be descending

    If not specified, defaults to relevance descending.

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — 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_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.
Returns
  • (::Integer) — 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

def page_token() -> ::String
Returns

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns

#query

def query() -> ::String
Returns
  • (::String) — Optional. The query string in search query syntax. An empty query string will result in all data assets (in the specified scope) that the user has access to. 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.

#query=

def query=(value) -> ::String
Parameter
  • value (::String) — Optional. The query string in search query syntax. An empty query string will result in all data assets (in the specified scope) that the user has access to. 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.

Returns
  • (::String) — Optional. The query string in search query syntax. An empty query string will result in all data assets (in the specified scope) that the user has access to. 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

def scope() -> ::Google::Cloud::DataCatalog::V1beta1::SearchCatalogRequest::Scope
Returns

#scope=

def scope=(value) -> ::Google::Cloud::DataCatalog::V1beta1::SearchCatalogRequest::Scope
Parameter
Returns