public sealed class SearchCatalogRequest.Types.Scope : IMessage<SearchCatalogRequest.Types.Scope>, IEquatable<SearchCatalogRequest.Types.Scope>, IDeepCloneable<SearchCatalogRequest.Types.Scope>, IBufferMessage, IMessage
Reference documentation and code samples for the Data Catalog v1 API class SearchCatalogRequest.Types.Scope.
The criteria that select the subspace used for query matching.
Implements
IMessageSearchCatalogRequestTypesScope, IEquatableSearchCatalogRequestTypesScope, IDeepCloneableSearchCatalogRequestTypesScope, IBufferMessage, IMessageNamespace
GoogleCloudGoogle.Cloud.DataCatalogV1Assembly
Google.Cloud.DataCatalog.V1.dll
Constructors
Scope()
public Scope()
Scope(Scope)
public Scope(SearchCatalogRequest.Types.Scope other)
Parameter | |
---|---|
Name | Description |
other | SearchCatalogRequestTypesScope |
Properties
IncludeGcpPublicDatasets
public bool IncludeGcpPublicDatasets { get; set; }
If true
, include Google Cloud public datasets in
search results. By default, they are excluded.
See Google Cloud Public Datasets for more information.
Property Value | |
---|---|
Type | Description |
bool |
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 | |
---|---|
Type | Description |
RepeatedFieldstring |
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 | |
---|---|
Type | Description |
RepeatedFieldstring |
IncludePublicTagTemplates
[Obsolete]
public bool IncludePublicTagTemplates { get; set; }
Optional. This field is deprecated. The search mechanism for public and private tag templates is the same.
Property Value | |
---|---|
Type | Description |
bool |
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 | |
---|---|
Type | Description |
RepeatedFieldstring |
StarredOnly
public bool StarredOnly { get; set; }
Optional. If true
, search only among starred entries.
By default, all results are returned, starred or not.
Property Value | |
---|---|
Type | Description |
bool |