class Google::Apis::DatacatalogV1::GoogleCloudDatacatalogV1SearchCatalogRequestScope

The criteria that select the subspace used for query matching.

Attributes

include_gcp_public_datasets[RW]

If `true`, include Google Cloud Platform (GCP) public datasets in search results. By default, they are excluded. See [Google Cloud Public Datasets](/ public-datasets) for more information. Corresponds to the JSON property `includeGcpPublicDatasets` @return [Boolean]

include_gcp_public_datasets?[RW]

If `true`, include Google Cloud Platform (GCP) public datasets in search results. By default, they are excluded. See [Google Cloud Public Datasets](/ public-datasets) for more information. Corresponds to the JSON property `includeGcpPublicDatasets` @return [Boolean]

include_org_ids[RW]

The list of organization IDs to search within. To find your organization ID, follow the steps from [Creating and managing organizations] (/resource-manager/ docs/creating-managing-organization). Corresponds to the JSON property `includeOrgIds` @return [Array<String>]

include_project_ids[RW]

The list of project IDs to search within. For more information on the distinction between project names, IDs, and numbers, see [Projects](/docs/ overview/#projects). Corresponds to the JSON property `includeProjectIds` @return [Array<String>]

include_public_tag_templates[RW]

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` @return [Boolean]

include_public_tag_templates?[RW]

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` @return [Boolean]

restricted_locations[RW]

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](cloud.google.com/data-catalog/docs/concepts/regions# 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` @return [Array<String>]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/datacatalog_v1/classes.rb, line 1404
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/datacatalog_v1/classes.rb, line 1409
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