Class BatchSearchDataObjectsResponse (0.1.0)

public final class BatchSearchDataObjectsResponse extends GeneratedMessageV3 implements BatchSearchDataObjectsResponseOrBuilder

A response from a batch search operation.

Protobuf type google.cloud.vectorsearch.v1beta.BatchSearchDataObjectsResponse

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > BatchSearchDataObjectsResponse

Static Fields

RESULTS_FIELD_NUMBER

public static final int RESULTS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BatchSearchDataObjectsResponse getDefaultInstance()
Returns
Type Description
BatchSearchDataObjectsResponse

getDescriptor()

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

newBuilder()

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

newBuilder(BatchSearchDataObjectsResponse prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public BatchSearchDataObjectsResponse getDefaultInstanceForType()
Returns
Type Description
BatchSearchDataObjectsResponse

getParserForType()

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

getResults(int index)

public SearchDataObjectsResponse getResults(int index)

Output only. A list of search responses, one for each request in the batch. If a ranker is used, a single ranked list of results is returned.

repeated .google.cloud.vectorsearch.v1beta.SearchDataObjectsResponse results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
SearchDataObjectsResponse

getResultsCount()

public int getResultsCount()

Output only. A list of search responses, one for each request in the batch. If a ranker is used, a single ranked list of results is returned.

repeated .google.cloud.vectorsearch.v1beta.SearchDataObjectsResponse results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getResultsList()

public List<SearchDataObjectsResponse> getResultsList()

Output only. A list of search responses, one for each request in the batch. If a ranker is used, a single ranked list of results is returned.

repeated .google.cloud.vectorsearch.v1beta.SearchDataObjectsResponse results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<SearchDataObjectsResponse>

getResultsOrBuilder(int index)

public SearchDataObjectsResponseOrBuilder getResultsOrBuilder(int index)

Output only. A list of search responses, one for each request in the batch. If a ranker is used, a single ranked list of results is returned.

repeated .google.cloud.vectorsearch.v1beta.SearchDataObjectsResponse results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
SearchDataObjectsResponseOrBuilder

getResultsOrBuilderList()

public List<? extends SearchDataObjectsResponseOrBuilder> getResultsOrBuilderList()

Output only. A list of search responses, one for each request in the batch. If a ranker is used, a single ranked list of results is returned.

repeated .google.cloud.vectorsearch.v1beta.SearchDataObjectsResponse results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 BatchSearchDataObjectsResponse.Builder newBuilderForType()
Returns
Type Description
BatchSearchDataObjectsResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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