Data Catalog V1 API - Class Google::Cloud::DataCatalog::V1::SearchCatalogRequest (v0.16.1)

Version 0.16.1

• 0.23.0 (latest)
• 0.22.0
• 0.21.2
• 0.20.1
• 0.19.0
• 0.18.1
• 0.17.0
• 0.16.1
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.1
• 0.11.0
• 0.10.0
• 0.9.1

Reference documentation and code samples for the Data Catalog V1 API class Google::Cloud::DataCatalog::V1::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 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.

#order_by=

def order_by=(value) -> ::String

Parameter

• value (::String) — 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.

Returns

• (::String) — 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.

#page_size

def page_size() -> ::Integer

Returns

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

def page_size=(value) -> ::Integer

Parameter

• value (::Integer) — 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.

Returns

• (::Integer) — 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

def page_token() -> ::String

Returns

• (::String) — 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.

#page_token=

def page_token=(value) -> ::String

Parameter

• value (::String) — 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.

Returns

• (::String) — 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

def query() -> ::String

Returns

• (::String) —

  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

#query=

def query=(value) -> ::String

Parameter

• value (::String) —

  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

Returns

• (::String) —

  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

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

Returns

• (::Google::Cloud::DataCatalog::V1::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.

#scope=

def scope=(value) -> ::Google::Cloud::DataCatalog::V1::SearchCatalogRequest::Scope

Parameter

• value (::Google::Cloud::DataCatalog::V1::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.

Returns

• (::Google::Cloud::DataCatalog::V1::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.