public static final class SearchCatalogRequest.Scope extends GeneratedMessageV3 implements SearchCatalogRequest.ScopeOrBuilder
The criteria that select the subspace used for query matching.
Protobuf type google.cloud.datacatalog.v1.SearchCatalogRequest.Scope
Static Fields
INCLUDE_GCP_PUBLIC_DATASETS_FIELD_NUMBER
public static final int INCLUDE_GCP_PUBLIC_DATASETS_FIELD_NUMBER
Field Value
INCLUDE_ORG_IDS_FIELD_NUMBER
public static final int INCLUDE_ORG_IDS_FIELD_NUMBER
Field Value
INCLUDE_PROJECT_IDS_FIELD_NUMBER
public static final int INCLUDE_PROJECT_IDS_FIELD_NUMBER
Field Value
INCLUDE_PUBLIC_TAG_TEMPLATES_FIELD_NUMBER
public static final int INCLUDE_PUBLIC_TAG_TEMPLATES_FIELD_NUMBER
Field Value
RESTRICTED_LOCATIONS_FIELD_NUMBER
public static final int RESTRICTED_LOCATIONS_FIELD_NUMBER
Field Value
STARRED_ONLY_FIELD_NUMBER
public static final int STARRED_ONLY_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static SearchCatalogRequest.Scope getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static SearchCatalogRequest.Scope.Builder newBuilder()
Returns
newBuilder(SearchCatalogRequest.Scope prototype)
public static SearchCatalogRequest.Scope.Builder newBuilder(SearchCatalogRequest.Scope prototype)
Parameter
Returns
public static SearchCatalogRequest.Scope parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static SearchCatalogRequest.Scope parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static SearchCatalogRequest.Scope parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchCatalogRequest.Scope parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static SearchCatalogRequest.Scope parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchCatalogRequest.Scope parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SearchCatalogRequest.Scope parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static SearchCatalogRequest.Scope parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SearchCatalogRequest.Scope parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static SearchCatalogRequest.Scope parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static SearchCatalogRequest.Scope parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchCatalogRequest.Scope parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<SearchCatalogRequest.Scope> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public SearchCatalogRequest.Scope getDefaultInstanceForType()
Returns
getIncludeGcpPublicDatasets()
public boolean getIncludeGcpPublicDatasets()
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.
bool include_gcp_public_datasets = 7;
| Type | Description |
| boolean | The includeGcpPublicDatasets.
|
getIncludeOrgIds(int index)
public String getIncludeOrgIds(int index)
Parameter
| Name | Description |
| index | int
The index of the element to return.
|
Returns
| Type | Description |
| String | The includeOrgIds at the given index.
|
getIncludeOrgIdsBytes(int index)
public ByteString getIncludeOrgIdsBytes(int index)
Parameter
| Name | Description |
| index | int
The index of the value to return.
|
Returns
| Type | Description |
| ByteString | The bytes of the includeOrgIds at the given index.
|
getIncludeOrgIdsCount()
public int getIncludeOrgIdsCount()
Returns
| Type | Description |
| int | The count of includeOrgIds.
|
getIncludeOrgIdsList()
public ProtocolStringList getIncludeOrgIdsList()
Returns
getIncludeProjectIds(int index)
public String getIncludeProjectIds(int index)
The list of project IDs to search within.
For more information on the distinction between project names, IDs, and
numbers, see Projects.
repeated string include_project_ids = 3;
| Name | Description |
| index | int
The index of the element to return.
|
Returns
| Type | Description |
| String | The includeProjectIds at the given index.
|
getIncludeProjectIdsBytes(int index)
public ByteString getIncludeProjectIdsBytes(int index)
The list of project IDs to search within.
For more information on the distinction between project names, IDs, and
numbers, see Projects.
repeated string include_project_ids = 3;
| Name | Description |
| index | int
The index of the value to return.
|
Returns
| Type | Description |
| ByteString | The bytes of the includeProjectIds at the given index.
|
getIncludeProjectIdsCount()
public int getIncludeProjectIdsCount()
The list of project IDs to search within.
For more information on the distinction between project names, IDs, and
numbers, see Projects.
repeated string include_project_ids = 3;
| Type | Description |
| int | The count of includeProjectIds.
|
getIncludeProjectIdsList()
public ProtocolStringList getIncludeProjectIdsList()
The list of project IDs to search within.
For more information on the distinction between project names, IDs, and
numbers, see Projects.
repeated string include_project_ids = 3;
getIncludePublicTagTemplates()
public boolean getIncludePublicTagTemplates()
Optional. This field is deprecated. The search mechanism for public and private tag
templates is the same.
bool include_public_tag_templates = 19 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | The includePublicTagTemplates.
|
getParserForType()
public Parser<SearchCatalogRequest.Scope> getParserForType()
Returns
Overrides
getRestrictedLocations(int index)
public String getRestrictedLocations(int index)
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.
repeated string restricted_locations = 16 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| index | int
The index of the element to return.
|
Returns
| Type | Description |
| String | The restrictedLocations at the given index.
|
getRestrictedLocationsBytes(int index)
public ByteString getRestrictedLocationsBytes(int index)
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.
repeated string restricted_locations = 16 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| index | int
The index of the value to return.
|
Returns
| Type | Description |
| ByteString | The bytes of the restrictedLocations at the given index.
|
getRestrictedLocationsCount()
public int getRestrictedLocationsCount()
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.
repeated string restricted_locations = 16 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| int | The count of restrictedLocations.
|
getRestrictedLocationsList()
public ProtocolStringList getRestrictedLocationsList()
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.
repeated string restricted_locations = 16 [(.google.api.field_behavior) = OPTIONAL];
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getStarredOnly()
public boolean getStarredOnly()
Optional. If true, search only among starred entries.
By default, all results are returned, starred or not.
bool starred_only = 18 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | The starredOnly.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public SearchCatalogRequest.Scope.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchCatalogRequest.Scope.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public SearchCatalogRequest.Scope.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
