Class: Google::Cloud::DataCatalog::V1::SearchCatalogRequest::Scope

Inherits:

Object

• Object
• Google::Cloud::DataCatalog::V1::SearchCatalogRequest::Scope

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/datacatalog/v1/datacatalog.rb

Overview

The criteria that select the subspace used for query matching.

Instance Attribute Summary

• #include_gcp_public_datasets ⇒ ::Boolean

  If true, include Google Cloud Platform (GCP) public datasets in the search results.

• #include_org_ids ⇒ ::Array<::String>

  The list of organization IDs to search within.

• #include_project_ids ⇒ ::Array<::String>

  The list of project IDs to search within.

• #restricted_locations ⇒ ::Array<::String>

  Optional.

Instance Attribute Details

#include_gcp_public_datasets ⇒ ::Boolean

Returns If true, include Google Cloud Platform (GCP) public datasets in the search results. Info on GCP public datasets is available at https://cloud.google.com/public-datasets/. By default, GCP public datasets are excluded.

Returns:

• (::Boolean) —

  If true, include Google Cloud Platform (GCP) public datasets in the search results. Info on GCP public datasets is available at https://cloud.google.com/public-datasets/. By default, GCP public datasets are excluded.

# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 127

class Scope
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#include_org_ids ⇒ ::Array<::String>

Returns The list of organization IDs to search within. To find your organization ID, follow instructions in https://cloud.google.com/resource-manager/docs/creating-managing-organization.

Returns:

• (::Array<::String>) —

  The list of organization IDs to search within. To find your organization ID, follow instructions in https://cloud.google.com/resource-manager/docs/creating-managing-organization.

# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 127

class Scope
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#include_project_ids ⇒ ::Array<::String>

Returns The list of project IDs to search within. To learn more about the distinction between project names/IDs/numbers, go to https://cloud.google.com/docs/overview/#projects.

Returns:

• (::Array<::String>) —

  The list of project IDs to search within. To learn more about the distinction between project names/IDs/numbers, go to https://cloud.google.com/docs/overview/#projects.

# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 127

class Scope
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#restricted_locations ⇒ ::Array<::String>

Returns Optional. The list of locations to search within.

1. If empty, search will be performed in all locations;
2. If any of the locations are NOT in the valid locations list, error will be returned;
3. Otherwise, search only the given locations for matching results. Typical usage is to leave this field empty. When a location is unreachable as returned in the SearchCatalogResponse.unreachable field, users can repeat the search request with this parameter set to get additional information on the error.

Valid locations:

• asia-east1
• asia-east2
• asia-northeast1
• asia-northeast2
• asia-northeast3
• asia-south1
• asia-southeast1
• australia-southeast1
• eu
• europe-north1
• europe-west1
• europe-west2
• europe-west3
• europe-west4
• europe-west6
• global
• northamerica-northeast1
• southamerica-east1
• us
• us-central1
• us-east1
• us-east4
• us-west1
• us-west2.

Returns:

• (::Array<::String>) —

  Optional. The list of locations to search within.

  1. If empty, search will be performed in all locations;
  2. If any of the locations are NOT in the valid locations list, error will be returned;
  3. Otherwise, search only the given locations for matching results. Typical usage is to leave this field empty. When a location is unreachable as returned in the SearchCatalogResponse.unreachable field, users can repeat the search request with this parameter set to get additional information on the error.

  Valid locations:

  • asia-east1
  • asia-east2
  • asia-northeast1
  • asia-northeast2
  • asia-northeast3
  • asia-south1
  • asia-southeast1
  • australia-southeast1
  • eu
  • europe-north1
  • europe-west1
  • europe-west2
  • europe-west3
  • europe-west4
  • europe-west6
  • global
  • northamerica-northeast1
  • southamerica-east1
  • us
  • us-central1
  • us-east1
  • us-east4
  • us-west1
  • us-west2

# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 127

class Scope
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end