Reference documentation and code samples for the Google Cloud Data Catalog V1BETA1 API class Google::Cloud::DataCatalog::V1beta1::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 the search results. Info on Google Cloud public datasets is available at https://cloud.google.com/public-datasets/. By default, Google Cloud public datasets are excluded.
#include_gcp_public_datasets=
def include_gcp_public_datasets=(value) -> ::Boolean
Parameter
-
value (::Boolean) — If
true, include Google Cloud public datasets in the search results. Info on Google Cloud public datasets is available at https://cloud.google.com/public-datasets/. By default, Google Cloud public datasets are excluded.
Returns
-
(::Boolean) — If
true, include Google Cloud public datasets in the search results. Info on Google Cloud public datasets is available at https://cloud.google.com/public-datasets/. By default, Google Cloud public datasets are excluded.
#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 instructions in https://cloud.google.com/resource-manager/docs/creating-managing-organization.
#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 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.
#include_project_ids
def include_project_ids() -> ::Array<::String>
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.
#include_project_ids=
def include_project_ids=(value) -> ::Array<::String>
Parameter
- value (::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.
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.
#restricted_locations
def restricted_locations() -> ::Array<::String>
Returns
-
(::Array<::String>) —
Optional. The list of locations to search within.
- If empty, search will be performed in all locations;
- If any of the locations are NOT in the valid locations list, error will be returned;
- 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.unreachablefield, 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
#restricted_locations=
def restricted_locations=(value) -> ::Array<::String>
Parameter
-
value (::Array<::String>) —
Optional. The list of locations to search within.
- If empty, search will be performed in all locations;
- If any of the locations are NOT in the valid locations list, error will be returned;
- 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.unreachablefield, 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.
- If empty, search will be performed in all locations;
- If any of the locations are NOT in the valid locations list, error will be returned;
- 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.unreachablefield, 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