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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleCloudDatacatalogV1beta1SearchCatalogRequestScope

Returns a new instance of GoogleCloudDatacatalogV1beta1SearchCatalogRequestScope.



1087
1088
1089
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1087

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

Instance Attribute Details

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


1065
1066
1067
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1065

def include_gcp_public_datasets
  @include_gcp_public_datasets
end

#include_org_idsArray<String>

Data Catalog tries to automatically choose the right corpus of data to search through. You can ensure an organization is included by adding it to include_org_ids. You can ensure a project's org is included with include_project_ids. You must specify at least one organization using include_org_ids or include_project_ids in all search requests. 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>)


1078
1079
1080
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1078

def include_org_ids
  @include_org_ids
end

#include_project_idsArray<String>

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


1085
1086
1087
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1085

def include_project_ids
  @include_project_ids
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1092
1093
1094
1095
1096
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1092

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