Class BatchSearchDataObjectsRequest (0.1.0)

public final class BatchSearchDataObjectsRequest extends GeneratedMessageV3 implements BatchSearchDataObjectsRequestOrBuilder

A request to perform a batch of search operations.

Protobuf type google.cloud.vectorsearch.v1beta.BatchSearchDataObjectsRequest

Static Fields

COMBINE_FIELD_NUMBER

public static final int COMBINE_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

SEARCHES_FIELD_NUMBER

public static final int SEARCHES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BatchSearchDataObjectsRequest getDefaultInstance()
Returns
Type Description
BatchSearchDataObjectsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static BatchSearchDataObjectsRequest.Builder newBuilder()
Returns
Type Description
BatchSearchDataObjectsRequest.Builder

newBuilder(BatchSearchDataObjectsRequest prototype)

public static BatchSearchDataObjectsRequest.Builder newBuilder(BatchSearchDataObjectsRequest prototype)
Parameter
Name Description
prototype BatchSearchDataObjectsRequest
Returns
Type Description
BatchSearchDataObjectsRequest.Builder

parseDelimitedFrom(InputStream input)

public static BatchSearchDataObjectsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BatchSearchDataObjectsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchSearchDataObjectsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchSearchDataObjectsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static BatchSearchDataObjectsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
BatchSearchDataObjectsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BatchSearchDataObjectsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchSearchDataObjectsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BatchSearchDataObjectsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
BatchSearchDataObjectsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BatchSearchDataObjectsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchSearchDataObjectsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BatchSearchDataObjectsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BatchSearchDataObjectsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchSearchDataObjectsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchSearchDataObjectsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static BatchSearchDataObjectsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BatchSearchDataObjectsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchSearchDataObjectsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchSearchDataObjectsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static BatchSearchDataObjectsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BatchSearchDataObjectsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BatchSearchDataObjectsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchSearchDataObjectsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<BatchSearchDataObjectsRequest> parser()
Returns
Type Description
Parser<BatchSearchDataObjectsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCombine()

public BatchSearchDataObjectsRequest.CombineResultsOptions getCombine()

Optional. Options for combining the results of the batch search operations.

.google.cloud.vectorsearch.v1beta.BatchSearchDataObjectsRequest.CombineResultsOptions combine = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BatchSearchDataObjectsRequest.CombineResultsOptions

The combine.

getCombineOrBuilder()

public BatchSearchDataObjectsRequest.CombineResultsOptionsOrBuilder getCombineOrBuilder()

Optional. Options for combining the results of the batch search operations.

.google.cloud.vectorsearch.v1beta.BatchSearchDataObjectsRequest.CombineResultsOptions combine = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BatchSearchDataObjectsRequest.CombineResultsOptionsOrBuilder

getDefaultInstanceForType()

public BatchSearchDataObjectsRequest getDefaultInstanceForType()
Returns
Type Description
BatchSearchDataObjectsRequest

getParent()

public String getParent()

Required. The resource name of the Collection for which to search. Format: projects/{project}/locations/{location}/collections/{collection}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The resource name of the Collection for which to search. Format: projects/{project}/locations/{location}/collections/{collection}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<BatchSearchDataObjectsRequest> getParserForType()
Returns
Type Description
Parser<BatchSearchDataObjectsRequest>
Overrides

getSearches(int index)

public Search getSearches(int index)

Required. A list of search requests to execute in parallel.

repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Search

getSearchesCount()

public int getSearchesCount()

Required. A list of search requests to execute in parallel.

repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getSearchesList()

public List<Search> getSearchesList()

Required. A list of search requests to execute in parallel.

repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Search>

getSearchesOrBuilder(int index)

public SearchOrBuilder getSearchesOrBuilder(int index)

Required. A list of search requests to execute in parallel.

repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
SearchOrBuilder

getSearchesOrBuilderList()

public List<? extends SearchOrBuilder> getSearchesOrBuilderList()

Required. A list of search requests to execute in parallel.

repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.cloud.vectorsearch.v1beta.SearchOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasCombine()

public boolean hasCombine()

Optional. Options for combining the results of the batch search operations.

.google.cloud.vectorsearch.v1beta.BatchSearchDataObjectsRequest.CombineResultsOptions combine = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the combine field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public BatchSearchDataObjectsRequest.Builder newBuilderForType()
Returns
Type Description
BatchSearchDataObjectsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BatchSearchDataObjectsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BatchSearchDataObjectsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public BatchSearchDataObjectsRequest.Builder toBuilder()
Returns
Type Description
BatchSearchDataObjectsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException