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

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

The criteria that select the subspace used for query matching.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#include_gcp_public_datasets

def include_gcp_public_datasets() -> ::Boolean
Returns
  • (::Boolean) — If true, include Google Cloud public datasets in search results. By default, they are excluded.

    See Google Cloud Public Datasets for more information.

#include_gcp_public_datasets=

def include_gcp_public_datasets=(value) -> ::Boolean
Parameter
  • value (::Boolean) — If true, include Google Cloud public datasets in search results. By default, they are excluded.

    See Google Cloud Public Datasets for more information.

Returns
  • (::Boolean) — If true, include Google Cloud public datasets in search results. By default, they are excluded.

    See Google Cloud Public Datasets for more information.

#include_org_ids

def include_org_ids() -> ::Array<::String>
Returns

#include_org_ids=

def include_org_ids=(value) -> ::Array<::String>
Parameter
Returns

#include_project_ids

def include_project_ids() -> ::Array<::String>
Returns
  • (::Array<::String>) — The list of project IDs to search within.

    For more information on the distinction between project names, IDs, and numbers, see Projects.

#include_project_ids=

def include_project_ids=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — The list of project IDs to search within.

    For more information on the distinction between project names, IDs, and numbers, see Projects.

Returns
  • (::Array<::String>) — The list of project IDs to search within.

    For more information on the distinction between project names, IDs, and numbers, see Projects.

#include_public_tag_templates

def include_public_tag_templates() -> ::Boolean
Returns
  • (::Boolean) — Optional. This field is deprecated. The search mechanism for public and private tag templates is the same.

#include_public_tag_templates=

def include_public_tag_templates=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. This field is deprecated. The search mechanism for public and private tag templates is the same.
Returns
  • (::Boolean) — Optional. This field is deprecated. The search mechanism for public and private tag templates is the same.

#restricted_locations

def restricted_locations() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. The list of locations to search within. If empty, all locations are searched.

    Returns an error if any location in the list isn't one of the Supported regions.

    If a location is unreachable, its name is returned in the SearchCatalogResponse.unreachable field. To get additional information on the error, repeat the search request and set the location name as the value of this parameter.

#restricted_locations=

def restricted_locations=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Optional. The list of locations to search within. If empty, all locations are searched.

    Returns an error if any location in the list isn't one of the Supported regions.

    If a location is unreachable, its name is returned in the SearchCatalogResponse.unreachable field. To get additional information on the error, repeat the search request and set the location name as the value of this parameter.

Returns
  • (::Array<::String>) — Optional. The list of locations to search within. If empty, all locations are searched.

    Returns an error if any location in the list isn't one of the Supported regions.

    If a location is unreachable, its name is returned in the SearchCatalogResponse.unreachable field. To get additional information on the error, repeat the search request and set the location name as the value of this parameter.

#starred_only

def starred_only() -> ::Boolean
Returns
  • (::Boolean) — Optional. If true, search only among starred entries.

    By default, all results are returned, starred or not.

#starred_only=

def starred_only=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. If true, search only among starred entries.

    By default, all results are returned, starred or not.

Returns
  • (::Boolean) — Optional. If true, search only among starred entries.

    By default, all results are returned, starred or not.