Data Catalog V1 API - Class Google::Cloud::DataCatalog::V1::SearchCatalogRequest (v1.0.0)

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

#admin_search

def admin_search() -> ::Boolean
Returns
  • (::Boolean) — Optional. If set, use searchAll permission granted on organizations from include_org_ids and projects from include_project_ids instead of the fine grained per resource permissions when filtering the search results. The only allowed order_by criteria for admin_search mode is default. Using this flags guarantees a full recall of the search results.

#admin_search=

def admin_search=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. If set, use searchAll permission granted on organizations from include_org_ids and projects from include_project_ids instead of the fine grained per resource permissions when filtering the search results. The only allowed order_by criteria for admin_search mode is default. Using this flags guarantees a full recall of the search results.
Returns
  • (::Boolean) — Optional. If set, use searchAll permission granted on organizations from include_org_ids and projects from include_project_ids instead of the fine grained per resource permissions when filtering the search results. The only allowed order_by criteria for admin_search mode is default. Using this flags guarantees a full recall of the search results.

#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

    Search queries don't guarantee full recall. Results that match your query might not be returned, even in subsequent result pages. Additionally, returned (and not returned) results can vary if you repeat search queries. If you are experiencing recall issues and you don't have to fetch the results in any specific order, consider setting this parameter to default.

    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

    Search queries don't guarantee full recall. Results that match your query might not be returned, even in subsequent result pages. Additionally, returned (and not returned) results can vary if you repeat search queries. If you are experiencing recall issues and you don't have to fetch the results in any specific order, consider setting this parameter to default.

    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

    Search queries don't guarantee full recall. Results that match your query might not be returned, even in subsequent result pages. Additionally, returned (and not returned) results can vary if you repeat search queries. If you are experiencing recall issues and you don't have to fetch the results in any specific order, consider setting this parameter to default.

    If this parameter is omitted, it defaults to the descending relevance.

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — Upper bound on the number of results you can get in a single response.

    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) — Upper bound on the number of results you can get in a single response.

    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) — Upper bound on the number of results you can get in a single response.

    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

#page_token=

def page_token=(value) -> ::String
Parameter
Returns

#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

#scope=

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