Class BatchSearchDataObjectsRequest.CombineResultsOptions.Builder (0.1.0)

public static final class BatchSearchDataObjectsRequest.CombineResultsOptions.Builder extends GeneratedMessageV3.Builder<BatchSearchDataObjectsRequest.CombineResultsOptions.Builder> implements BatchSearchDataObjectsRequest.CombineResultsOptionsOrBuilder

Options for combining the results of the batch search operations.

Protobuf type google.cloud.vectorsearch.v1beta.BatchSearchDataObjectsRequest.CombineResultsOptions

Inheritance

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

Implements

BatchSearchDataObjectsRequest.CombineResultsOptionsOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BatchSearchDataObjectsRequest.CombineResultsOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public BatchSearchDataObjectsRequest.CombineResultsOptions build()

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions

buildPartial()

public BatchSearchDataObjectsRequest.CombineResultsOptions buildPartial()

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions

clear()

public BatchSearchDataObjectsRequest.CombineResultsOptions.Builder clear()

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public BatchSearchDataObjectsRequest.CombineResultsOptions.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public BatchSearchDataObjectsRequest.CombineResultsOptions.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearOutputFields()

public BatchSearchDataObjectsRequest.CombineResultsOptions.Builder clearOutputFields()

Optional. Mask specifying which fields to return.

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

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions.Builder

clearRanker()

public BatchSearchDataObjectsRequest.CombineResultsOptions.Builder clearRanker()

Required. The ranker to use for combining the results.

.google.cloud.vectorsearch.v1beta.Ranker ranker = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions.Builder

clearTopK()

public BatchSearchDataObjectsRequest.CombineResultsOptions.Builder clearTopK()

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
BatchSearchDataObjectsRequest.CombineResultsOptions.Builder	This builder for chaining.

clone()

public BatchSearchDataObjectsRequest.CombineResultsOptions.Builder clone()

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public BatchSearchDataObjectsRequest.CombineResultsOptions getDefaultInstanceForType()

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

getOutputFieldsBuilder()

public OutputFields.Builder getOutputFieldsBuilder()

Optional. Mask specifying which fields to return.

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

Returns
Type	Description
OutputFields.Builder

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

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.

getRankerBuilder()

public Ranker.Builder getRankerBuilder()

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.Builder

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

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(BatchSearchDataObjectsRequest.CombineResultsOptions other)

public BatchSearchDataObjectsRequest.CombineResultsOptions.Builder mergeFrom(BatchSearchDataObjectsRequest.CombineResultsOptions other)

Parameter
Name	Description
other	BatchSearchDataObjectsRequest.CombineResultsOptions

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BatchSearchDataObjectsRequest.CombineResultsOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public BatchSearchDataObjectsRequest.CombineResultsOptions.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeOutputFields(OutputFields value)

public BatchSearchDataObjectsRequest.CombineResultsOptions.Builder mergeOutputFields(OutputFields value)

Optional. Mask specifying which fields to return.

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

Parameter
Name	Description
value	OutputFields

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions.Builder

mergeRanker(Ranker value)

public BatchSearchDataObjectsRequest.CombineResultsOptions.Builder mergeRanker(Ranker value)

Required. The ranker to use for combining the results.

.google.cloud.vectorsearch.v1beta.Ranker ranker = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	Ranker

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BatchSearchDataObjectsRequest.CombineResultsOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public BatchSearchDataObjectsRequest.CombineResultsOptions.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setOutputFields(OutputFields value)

public BatchSearchDataObjectsRequest.CombineResultsOptions.Builder setOutputFields(OutputFields value)

Optional. Mask specifying which fields to return.

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

Parameter
Name	Description
value	OutputFields

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions.Builder

setOutputFields(OutputFields.Builder builderForValue)

public BatchSearchDataObjectsRequest.CombineResultsOptions.Builder setOutputFields(OutputFields.Builder builderForValue)

Optional. Mask specifying which fields to return.

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

Parameter
Name	Description
builderForValue	OutputFields.Builder

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions.Builder

setRanker(Ranker value)

public BatchSearchDataObjectsRequest.CombineResultsOptions.Builder setRanker(Ranker value)

Required. The ranker to use for combining the results.

.google.cloud.vectorsearch.v1beta.Ranker ranker = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	Ranker

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions.Builder

setRanker(Ranker.Builder builderForValue)

public BatchSearchDataObjectsRequest.CombineResultsOptions.Builder setRanker(Ranker.Builder builderForValue)

Required. The ranker to use for combining the results.

.google.cloud.vectorsearch.v1beta.Ranker ranker = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
builderForValue	Ranker.Builder

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public BatchSearchDataObjectsRequest.CombineResultsOptions.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setTopK(int value)

public BatchSearchDataObjectsRequest.CombineResultsOptions.Builder setTopK(int value)

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

Parameter
Name	Description
value	int The topK to set.

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final BatchSearchDataObjectsRequest.CombineResultsOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)