Class BatchSearchDataObjectsRequest.CombineResultsOptions (0.1.0)
public static final class BatchSearchDataObjectsRequest.CombineResultsOptions extends GeneratedMessageV3 implements BatchSearchDataObjectsRequest.CombineResultsOptionsOrBuilder
Options for combining the results of the batch search operations.
Protobuf type
google.cloud.vectorsearch.v1beta.BatchSearchDataObjectsRequest.CombineResultsOptions
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
OUTPUT_FIELDS_FIELD_NUMBER
public static final int OUTPUT_FIELDS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RANKER_FIELD_NUMBER
public static final int RANKER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TOP_K_FIELD_NUMBER
public static final int TOP_K_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static BatchSearchDataObjectsRequest.CombineResultsOptions getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static BatchSearchDataObjectsRequest.CombineResultsOptions.Builder newBuilder()
newBuilder(BatchSearchDataObjectsRequest.CombineResultsOptions prototype)
public static BatchSearchDataObjectsRequest.CombineResultsOptions.Builder newBuilder(BatchSearchDataObjectsRequest.CombineResultsOptions prototype)
public static BatchSearchDataObjectsRequest.CombineResultsOptions parseDelimitedFrom(InputStream input)
public static BatchSearchDataObjectsRequest.CombineResultsOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static BatchSearchDataObjectsRequest.CombineResultsOptions parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BatchSearchDataObjectsRequest.CombineResultsOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static BatchSearchDataObjectsRequest.CombineResultsOptions parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BatchSearchDataObjectsRequest.CombineResultsOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BatchSearchDataObjectsRequest.CombineResultsOptions parseFrom(CodedInputStream input)
public static BatchSearchDataObjectsRequest.CombineResultsOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static BatchSearchDataObjectsRequest.CombineResultsOptions parseFrom(InputStream input)
public static BatchSearchDataObjectsRequest.CombineResultsOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static BatchSearchDataObjectsRequest.CombineResultsOptions parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BatchSearchDataObjectsRequest.CombineResultsOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<BatchSearchDataObjectsRequest.CombineResultsOptions> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public BatchSearchDataObjectsRequest.CombineResultsOptions getDefaultInstanceForType()
getOutputFields()
public OutputFields getOutputFields()
Optional. Mask specifying which fields to return.
.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 2 [(.google.api.field_behavior) = OPTIONAL];
getOutputFieldsOrBuilder()
public OutputFieldsOrBuilder getOutputFieldsOrBuilder()
Optional. Mask specifying which fields to return.
.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 2 [(.google.api.field_behavior) = OPTIONAL];
getParserForType()
public Parser<BatchSearchDataObjectsRequest.CombineResultsOptions> getParserForType()
Overrides
getRanker()
public Ranker getRanker()
Required. The ranker to use for combining the results.
.google.cloud.vectorsearch.v1beta.Ranker ranker = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
Ranker |
The ranker.
|
getRankerOrBuilder()
public RankerOrBuilder getRankerOrBuilder()
Required. The ranker to use for combining the results.
.google.cloud.vectorsearch.v1beta.Ranker ranker = 1 [(.google.api.field_behavior) = REQUIRED];
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getTopK()
Optional. The number of results to return. If not set, a default value
will be used.
int32 top_k = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The topK.
|
hasOutputFields()
public boolean hasOutputFields()
Optional. Mask specifying which fields to return.
.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the outputFields field is set.
|
hasRanker()
public boolean hasRanker()
Required. The ranker to use for combining the results.
.google.cloud.vectorsearch.v1beta.Ranker ranker = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
boolean |
Whether the ranker field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public BatchSearchDataObjectsRequest.CombineResultsOptions.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected BatchSearchDataObjectsRequest.CombineResultsOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public BatchSearchDataObjectsRequest.CombineResultsOptions.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."],[],[]]
