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.



1414
1415
1416
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 1414

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) 


1376
1377
1378
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 1376

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>) 


1384
1385
1386
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 1384

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>) 


1391
1392
1393
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 1391

def include_project_ids
  @include_project_ids
end

#include_public_tag_templates ⇒ Boolean Also known as: include_public_tag_templates?

Optional. If true, include public tag templates 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. Corresponds to the JSON property includePublicTagTemplates

Returns:

  • (Boolean) 


1400
1401
1402
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 1400

def include_public_tag_templates
  @include_public_tag_templates
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>) 


1412
1413
1414
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 1412

def restricted_locations
  @restricted_locations
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1419
1420
1421
1422
1423
1424
1425
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 1419

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)
  @include_public_tag_templates = args[:include_public_tag_templates] if args.key?(:include_public_tag_templates)
  @restricted_locations = args[:restricted_locations] if args.key?(:restricted_locations)
end