Class: Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1SearchCatalogRequestScope

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/datacatalog_v1beta1/classes.rb,
generated/google/apis/datacatalog_v1beta1/representations.rb,
generated/google/apis/datacatalog_v1beta1/representations.rb

Overview

The criteria that select the subspace used for query matching.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDatacatalogV1beta1SearchCatalogRequestScope

Returns a new instance of GoogleCloudDatacatalogV1beta1SearchCatalogRequestScope.



1045
1046
1047
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1045

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#include_gcp_public_datasets ⇒ Boolean Also known as: include_gcp_public_datasets?

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. Corresponds to the JSON property includeGcpPublicDatasets

Returns:

  • (Boolean) 


1012
1013
1014
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1012

def include_gcp_public_datasets
  @include_gcp_public_datasets
end

#include_org_ids ⇒ 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. Corresponds to the JSON property includeOrgIds

Returns:

  • (Array<String>) 


1020
1021
1022
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1020

def include_org_ids
  @include_org_ids
end

#include_project_ids ⇒ 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. Corresponds to the JSON property includeProjectIds

Returns:

  • (Array<String>) 


1027
1028
1029
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1027

def include_project_ids
  @include_project_ids
end

#restricted_locations ⇒ 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 Corresponds to the JSON property restrictedLocations

Returns:

  • (Array<String>) 


1043
1044
1045
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1043

def restricted_locations
  @restricted_locations
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1050
1051
1052
1053
1054
1055
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1050

def update!(**args)
  @include_gcp_public_datasets = args[:include_gcp_public_datasets] if args.key?(:include_gcp_public_datasets)
  @include_org_ids = args[:include_org_ids] if args.key?(:include_org_ids)
  @include_project_ids = args[:include_project_ids] if args.key?(:include_project_ids)
  @restricted_locations = args[:restricted_locations] if args.key?(:restricted_locations)
end