Class SearchCatalogRequest.Scope (1.60.0)

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.v1beta1.SearchCatalogRequest.Scope

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchCatalogRequest.Scope

Implements

SearchCatalogRequest.ScopeOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

INCLUDE_GCP_PUBLIC_DATASETS_FIELD_NUMBER

public static final int INCLUDE_GCP_PUBLIC_DATASETS_FIELD_NUMBER

Field Value
Type	Description
`int`

INCLUDE_ORG_IDS_FIELD_NUMBER

public static final int INCLUDE_ORG_IDS_FIELD_NUMBER

Field Value
Type	Description
`int`

INCLUDE_PROJECT_IDS_FIELD_NUMBER

public static final int INCLUDE_PROJECT_IDS_FIELD_NUMBER

Field Value
Type	Description
`int`

RESTRICTED_LOCATIONS_FIELD_NUMBER

public static final int RESTRICTED_LOCATIONS_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static SearchCatalogRequest.Scope getDefaultInstance()

Returns
Type	Description
`SearchCatalogRequest.Scope`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static SearchCatalogRequest.Scope.Builder newBuilder()

Returns
Type	Description
`SearchCatalogRequest.Scope.Builder`

newBuilder(SearchCatalogRequest.Scope prototype)

public static SearchCatalogRequest.Scope.Builder newBuilder(SearchCatalogRequest.Scope prototype)

Parameter
Name	Description
`prototype`	`SearchCatalogRequest.Scope`

Returns
Type	Description
`SearchCatalogRequest.Scope.Builder`

parseDelimitedFrom(InputStream input)

public static SearchCatalogRequest.Scope parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`SearchCatalogRequest.Scope`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchCatalogRequest.Scope parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchCatalogRequest.Scope`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static SearchCatalogRequest.Scope parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`SearchCatalogRequest.Scope`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchCatalogRequest.Scope parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchCatalogRequest.Scope`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static SearchCatalogRequest.Scope parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`SearchCatalogRequest.Scope`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchCatalogRequest.Scope parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchCatalogRequest.Scope`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static SearchCatalogRequest.Scope parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`SearchCatalogRequest.Scope`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchCatalogRequest.Scope parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchCatalogRequest.Scope`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static SearchCatalogRequest.Scope parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`SearchCatalogRequest.Scope`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchCatalogRequest.Scope parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchCatalogRequest.Scope`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static SearchCatalogRequest.Scope parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`SearchCatalogRequest.Scope`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchCatalogRequest.Scope parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchCatalogRequest.Scope`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<SearchCatalogRequest.Scope> parser()

Returns
Type	Description
`Parser<Scope>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public SearchCatalogRequest.Scope getDefaultInstanceForType()

Returns
Type	Description
`SearchCatalogRequest.Scope`

getIncludeGcpPublicDatasets()

public boolean getIncludeGcpPublicDatasets()

If true, include Google Cloud public datasets in the search results. Info on Google Cloud public datasets is available at https://cloud.google.com/public-datasets/. By default, Google Cloud public datasets are excluded.

bool include_gcp_public_datasets = 7;

Returns
Type	Description
`boolean`	The includeGcpPublicDatasets.

getIncludeOrgIds(int index)

public String getIncludeOrgIds(int index)

The 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.

repeated string include_org_ids = 2;

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)

The 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.

repeated string include_org_ids = 2;

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

The 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.

repeated string include_org_ids = 2;

Returns
Type	Description
`int`	The count of includeOrgIds.

getIncludeOrgIdsList()

public ProtocolStringList getIncludeOrgIdsList()

The 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.

repeated string include_org_ids = 2;

Returns
Type	Description
`ProtocolStringList`	A list containing the includeOrgIds.

getIncludeProjectIds(int index)

public String getIncludeProjectIds(int index)

The 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.

repeated string include_project_ids = 3;

Parameter
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. To learn more about the distinction between project names/IDs/numbers, go to https://cloud.google.com/docs/overview/#projects.

repeated string include_project_ids = 3;

Parameter
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. To learn more about the distinction between project names/IDs/numbers, go to https://cloud.google.com/docs/overview/#projects.

repeated string include_project_ids = 3;

Returns
Type	Description
`int`	The count of includeProjectIds.

getIncludeProjectIdsList()

public ProtocolStringList getIncludeProjectIdsList()

The 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.

repeated string include_project_ids = 3;

Returns
Type	Description
`ProtocolStringList`	A list containing the includeProjectIds.

getParserForType()

public Parser<SearchCatalogRequest.Scope> getParserForType()

Returns
Type	Description
`Parser<Scope>`

Overrides

GeneratedMessageV3.getParserForType()

getRestrictedLocations(int index)

public String getRestrictedLocations(int index)

Optional. The list of locations to search within.

If empty, search will be performed in all locations;
If any of the locations are NOT in the valid locations list, error will be returned;
Otherwise, search only the given locations for matching results. Typical usage is to leave this field empty. When a location is unreachable as returned in the SearchCatalogResponse.unreachable field, users can repeat the search request with this parameter set to get additional information on the error.

Valid locations:
- asia-east1
- asia-east2
- asia-northeast1
- asia-northeast2
- asia-northeast3
- asia-south1
- asia-southeast1
- australia-southeast1
- eu
- europe-north1
- europe-west1
- europe-west2
- europe-west3
- europe-west4
- europe-west6
- global
- northamerica-northeast1
- southamerica-east1
- us
- us-central1
- us-east1
- us-east4
- us-west1
- us-west2

repeated string restricted_locations = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
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, search will be performed in all locations;
If any of the locations are NOT in the valid locations list, error will be returned;
Otherwise, search only the given locations for matching results. Typical usage is to leave this field empty. When a location is unreachable as returned in the SearchCatalogResponse.unreachable field, users can repeat the search request with this parameter set to get additional information on the error.

Valid locations:
- asia-east1
- asia-east2
- asia-northeast1
- asia-northeast2
- asia-northeast3
- asia-south1
- asia-southeast1
- australia-southeast1
- eu
- europe-north1
- europe-west1
- europe-west2
- europe-west3
- europe-west4
- europe-west6
- global
- northamerica-northeast1
- southamerica-east1
- us
- us-central1
- us-east1
- us-east4
- us-west1
- us-west2

repeated string restricted_locations = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
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, search will be performed in all locations;
If any of the locations are NOT in the valid locations list, error will be returned;
Otherwise, search only the given locations for matching results. Typical usage is to leave this field empty. When a location is unreachable as returned in the SearchCatalogResponse.unreachable field, users can repeat the search request with this parameter set to get additional information on the error.

Valid locations:
- asia-east1
- asia-east2
- asia-northeast1
- asia-northeast2
- asia-northeast3
- asia-south1
- asia-southeast1
- australia-southeast1
- eu
- europe-north1
- europe-west1
- europe-west2
- europe-west3
- europe-west4
- europe-west6
- global
- northamerica-northeast1
- southamerica-east1
- us
- us-central1
- us-east1
- us-east4
- us-west1
- us-west2

repeated string restricted_locations = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The count of restrictedLocations.

getRestrictedLocationsList()

public ProtocolStringList getRestrictedLocationsList()

Optional. The list of locations to search within.

If empty, search will be performed in all locations;
If any of the locations are NOT in the valid locations list, error will be returned;
Otherwise, search only the given locations for matching results. Typical usage is to leave this field empty. When a location is unreachable as returned in the SearchCatalogResponse.unreachable field, users can repeat the search request with this parameter set to get additional information on the error.

Valid locations:
- asia-east1
- asia-east2
- asia-northeast1
- asia-northeast2
- asia-northeast3
- asia-south1
- asia-southeast1
- australia-southeast1
- eu
- europe-north1
- europe-west1
- europe-west2
- europe-west3
- europe-west4
- europe-west6
- global
- northamerica-northeast1
- southamerica-east1
- us
- us-central1
- us-east1
- us-east4
- us-west1
- us-west2

repeated string restricted_locations = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ProtocolStringList`	A list containing the restrictedLocations.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public SearchCatalogRequest.Scope.Builder newBuilderForType()

Returns
Type	Description
`SearchCatalogRequest.Scope.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchCatalogRequest.Scope.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`SearchCatalogRequest.Scope.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public SearchCatalogRequest.Scope.Builder toBuilder()

Returns
Type	Description
`SearchCatalogRequest.Scope.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`