Class SearchCatalogRequest.Types.Scope (1.5.0)

public sealed class Scope : IMessage<SearchCatalogRequest.Types.Scope>, IEquatable<SearchCatalogRequest.Types.Scope>, IDeepCloneable<SearchCatalogRequest.Types.Scope>, IBufferMessage, IMessage

The criteria that select the subspace used for query matching.

Inheritance

Object > SearchCatalogRequest.Types.Scope

Namespace

Google.Cloud.DataCatalog.V1

Assembly

Google.Cloud.DataCatalog.V1.dll

Constructors

Scope()

public Scope()

Scope(SearchCatalogRequest.Types.Scope)

public Scope(SearchCatalogRequest.Types.Scope other)
Parameter
NameDescription
otherSearchCatalogRequest.Types.Scope

Properties

IncludeGcpPublicDatasets

public bool IncludeGcpPublicDatasets { get; set; }

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.

Property Value
TypeDescription
Boolean

IncludeOrgIds

public RepeatedField<string> IncludeOrgIds { get; }

The list of organization IDs to search within.

To find your organization ID, follow the steps from Creating and managing organizations.

Property Value
TypeDescription
RepeatedField<String>

IncludeProjectIds

public RepeatedField<string> IncludeProjectIds { get; }

The list of project IDs to search within.

For more information on the distinction between project names, IDs, and numbers, see Projects.

Property Value
TypeDescription
RepeatedField<String>

IncludePublicTagTemplates

public bool IncludePublicTagTemplates { get; set; }

Optional. If true, include [public tag templates][google.cloud.datacatalog.v1.TagTemplate.is_publicly_readable] 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.

Property Value
TypeDescription
Boolean

RestrictedLocations

public RepeatedField<string> RestrictedLocations { get; }

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.

Property Value
TypeDescription
RepeatedField<String>