Class Google::Cloud::DataCatalog::V1::SearchCatalogRequest::Scope (v0.9.1)

Version 0.9.1

• 1.3.0 (latest)
• 1.2.0
• 1.1.0
• 1.0.1
• 0.23.0
• 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

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 Platform (GCP) 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 Platform (GCP) 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 Platform (GCP) 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

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

  To find your organization ID, follow the steps from Creating and managing organizations.

#include_org_ids=

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

Parameter

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

  To find your organization ID, follow the steps from Creating and managing organizations.

Returns

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

  To find your organization ID, follow the steps from Creating and managing organizations.

#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. If true, include [public tag templates][google.cloud.datacatalog.v1.TagTemplate.is_publicly_readable] in the search results. By default, they are included only if you have explicit permissions on them to view them. For example, if you are the owner.

  Other scope fields, for example, include_org_ids, still restrict the returned public tag templates and at least one of them is required.

#include_public_tag_templates=

def include_public_tag_templates=(value) -> ::Boolean

Parameter

• value (::Boolean) — Optional. If true, include [public tag templates][google.cloud.datacatalog.v1.TagTemplate.is_publicly_readable] in the search results. By default, they are included only if you have explicit permissions on them to view them. For example, if you are the owner.

  Other scope fields, for example, include_org_ids, still restrict the returned public tag templates and at least one of them is required.

Returns

• (::Boolean) — Optional. If true, include [public tag templates][google.cloud.datacatalog.v1.TagTemplate.is_publicly_readable] in the search results. By default, they are included only if you have explicit permissions on them to view them. For example, if you are the owner.

  Other scope fields, for example, include_org_ids, still restrict the returned public tag templates and at least one of them is required.

#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.