Class: Google::Apis::DatacatalogV1::GoogleCloudDatacatalogV1SearchCatalogRequestScope

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/datacatalog_v1/classes.rb,
lib/google/apis/datacatalog_v1/representations.rb,
lib/google/apis/datacatalog_v1/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) ⇒ GoogleCloudDatacatalogV1SearchCatalogRequestScope

Returns a new instance of GoogleCloudDatacatalogV1SearchCatalogRequestScope.



1295
1296
1297
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 1295

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 search results. By default, they are excluded. See Google Cloud Public Datasets for more information. Corresponds to the JSON property includeGcpPublicDatasets

Returns:

  • (Boolean) 


1267
1268
1269
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 1267

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 the steps from Creating and managing organizations. Corresponds to the JSON property includeOrgIds

Returns:

  • (Array<String>) 


1275
1276
1277
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 1275

def include_org_ids
  @include_org_ids
end

#include_project_ids ⇒ Array<String>

The list of project IDs to search within. For more information on the distinction between project names, IDs, and numbers, see Projects. Corresponds to the JSON property includeProjectIds

Returns:

  • (Array<String>) 


1282
1283
1284
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 1282

def include_project_ids
  @include_project_ids
end

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

Returns:

  • (Array<String>) 


1293
1294
1295
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 1293

def restricted_locations
  @restricted_locations
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1300
1301
1302
1303
1304
1305
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 1300

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