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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static BatchSearchDataObjectsRequest.Builder newBuilder()
newBuilder(BatchSearchDataObjectsRequest prototype)
public static BatchSearchDataObjectsRequest.Builder newBuilder(BatchSearchDataObjectsRequest prototype)
public static BatchSearchDataObjectsRequest parseDelimitedFrom(InputStream input)
public static BatchSearchDataObjectsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static BatchSearchDataObjectsRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BatchSearchDataObjectsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static BatchSearchDataObjectsRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BatchSearchDataObjectsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BatchSearchDataObjectsRequest parseFrom(CodedInputStream input)
public static BatchSearchDataObjectsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static BatchSearchDataObjectsRequest parseFrom(InputStream input)
public static BatchSearchDataObjectsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static BatchSearchDataObjectsRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BatchSearchDataObjectsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<BatchSearchDataObjectsRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
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];
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];
getDefaultInstanceForType()
public BatchSearchDataObjectsRequest getDefaultInstanceForType()
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()
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];
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
|
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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public BatchSearchDataObjectsRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected BatchSearchDataObjectsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public BatchSearchDataObjectsRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-11-19 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-11-19 UTC."],[],[]]
