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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > BatchSearchDataObjectsRequest.CombineResultsOptions

Implements

BatchSearchDataObjectsRequest.CombineResultsOptionsOrBuilder

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

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

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static BatchSearchDataObjectsRequest.CombineResultsOptions.Builder newBuilder()

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions.Builder

newBuilder(BatchSearchDataObjectsRequest.CombineResultsOptions prototype)

public static BatchSearchDataObjectsRequest.CombineResultsOptions.Builder newBuilder(BatchSearchDataObjectsRequest.CombineResultsOptions prototype)

Parameter
Name	Description
prototype	BatchSearchDataObjectsRequest.CombineResultsOptions

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions.Builder

parseDelimitedFrom(InputStream input)

public static BatchSearchDataObjectsRequest.CombineResultsOptions parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchSearchDataObjectsRequest.CombineResultsOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static BatchSearchDataObjectsRequest.CombineResultsOptions parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BatchSearchDataObjectsRequest.CombineResultsOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BatchSearchDataObjectsRequest.CombineResultsOptions parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BatchSearchDataObjectsRequest.CombineResultsOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BatchSearchDataObjectsRequest.CombineResultsOptions parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchSearchDataObjectsRequest.CombineResultsOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static BatchSearchDataObjectsRequest.CombineResultsOptions parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchSearchDataObjectsRequest.CombineResultsOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static BatchSearchDataObjectsRequest.CombineResultsOptions parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BatchSearchDataObjectsRequest.CombineResultsOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<BatchSearchDataObjectsRequest.CombineResultsOptions> parser()

Returns
Type	Description
Parser<CombineResultsOptions>

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 BatchSearchDataObjectsRequest.CombineResultsOptions getDefaultInstanceForType()

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions

getOutputFields()

public OutputFields getOutputFields()

Optional. Mask specifying which fields to return.

.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
OutputFields	The outputFields.

getOutputFieldsOrBuilder()

public OutputFieldsOrBuilder getOutputFieldsOrBuilder()

Optional. Mask specifying which fields to return.

.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
OutputFieldsOrBuilder

getParserForType()

public Parser<BatchSearchDataObjectsRequest.CombineResultsOptions> getParserForType()

Returns
Type	Description
Parser<CombineResultsOptions>

Overrides

GeneratedMessageV3.getParserForType()

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];

Returns
Type	Description
RankerOrBuilder

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getTopK()

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

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 BatchSearchDataObjectsRequest.CombineResultsOptions.Builder newBuilderForType()

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BatchSearchDataObjectsRequest.CombineResultsOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions.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 BatchSearchDataObjectsRequest.CombineResultsOptions.Builder toBuilder()

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException