Class VectorSearch.Builder (0.1.0)

public static final class VectorSearch.Builder extends GeneratedMessageV3.Builder<VectorSearch.Builder> implements VectorSearchOrBuilder

Defines a search operation using a query vector.

Protobuf type google.cloud.vectorsearch.v1beta.VectorSearch

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > VectorSearch.Builder

Implements

VectorSearchOrBuilder

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 VectorSearch.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
VectorSearch.Builder

Overrides

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

build()

public VectorSearch build()

Returns
Type	Description
VectorSearch

buildPartial()

public VectorSearch buildPartial()

Returns
Type	Description
VectorSearch

clear()

public VectorSearch.Builder clear()

Returns
Type	Description
VectorSearch.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDistanceMetric()

public VectorSearch.Builder clearDistanceMetric()

Optional. The distance metric to use for the KNN search. If not specified, DOT_PRODUCT will be used as the default.

.google.cloud.vectorsearch.v1beta.DistanceMetric distance_metric = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
VectorSearch.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public VectorSearch.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
VectorSearch.Builder

Overrides

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

clearFilter()

public VectorSearch.Builder clearFilter()

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

.google.protobuf.Struct filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
VectorSearch.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public VectorSearch.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
VectorSearch.Builder

Overrides

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

clearOutputFields()

public VectorSearch.Builder clearOutputFields()

Optional. Mask specifying which fields to return.

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

Returns
Type	Description
VectorSearch.Builder

clearSearchField()

public VectorSearch.Builder clearSearchField()

Required. The vector field to search.

string search_field = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
VectorSearch.Builder	This builder for chaining.

clearSearchHint()

public VectorSearch.Builder clearSearchHint()

Optional. Sets the search hint. If no strategy is specified, the service will use an index if one is available, and fall back to the default KNN search otherwise.

.google.cloud.vectorsearch.v1beta.SearchHint search_hint = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
VectorSearch.Builder

clearSparseVector()

public VectorSearch.Builder clearSparseVector()

A sparse vector for the query.

.google.cloud.vectorsearch.v1beta.SparseVector sparse_vector = 2;

Returns
Type	Description
VectorSearch.Builder

clearTopK()

public VectorSearch.Builder clearTopK()

Optional. The number of nearest neighbors to return.

optional int32 top_k = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
VectorSearch.Builder	This builder for chaining.

clearVector()

public VectorSearch.Builder clearVector()

A dense vector for the query.

.google.cloud.vectorsearch.v1beta.DenseVector vector = 1;

Returns
Type	Description
VectorSearch.Builder

clearVectorType()

public VectorSearch.Builder clearVectorType()

Returns
Type	Description
VectorSearch.Builder

clone()

public VectorSearch.Builder clone()

Returns
Type	Description
VectorSearch.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public VectorSearch getDefaultInstanceForType()

Returns
Type	Description
VectorSearch

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDistanceMetric()

public DistanceMetric getDistanceMetric()

Optional. The distance metric to use for the KNN search. If not specified, DOT_PRODUCT will be used as the default.

.google.cloud.vectorsearch.v1beta.DistanceMetric distance_metric = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DistanceMetric	The distanceMetric.

getDistanceMetricValue()

public int getDistanceMetricValue()

Optional. The distance metric to use for the KNN search. If not specified, DOT_PRODUCT will be used as the default.

.google.cloud.vectorsearch.v1beta.DistanceMetric distance_metric = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for distanceMetric.

getFilter()

public Struct getFilter()

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

.google.protobuf.Struct filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Struct	The filter.

getFilterBuilder()

public Struct.Builder getFilterBuilder()

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

.google.protobuf.Struct filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Builder

getFilterOrBuilder()

public StructOrBuilder getFilterOrBuilder()

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

.google.protobuf.Struct filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
StructOrBuilder

getOutputFields()

public OutputFields getOutputFields()

Optional. Mask specifying which fields to return.

.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 7 [(.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 = 7 [(.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 = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
OutputFieldsOrBuilder

getSearchField()

public String getSearchField()

Required. The vector field to search.

string search_field = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The searchField.

getSearchFieldBytes()

public ByteString getSearchFieldBytes()

Required. The vector field to search.

string search_field = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for searchField.

getSearchHint()

public SearchHint getSearchHint()

Optional. Sets the search hint. If no strategy is specified, the service will use an index if one is available, and fall back to the default KNN search otherwise.

.google.cloud.vectorsearch.v1beta.SearchHint search_hint = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SearchHint	The searchHint.

getSearchHintBuilder()

public SearchHint.Builder getSearchHintBuilder()

Optional. Sets the search hint. If no strategy is specified, the service will use an index if one is available, and fall back to the default KNN search otherwise.

.google.cloud.vectorsearch.v1beta.SearchHint search_hint = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SearchHint.Builder

getSearchHintOrBuilder()

public SearchHintOrBuilder getSearchHintOrBuilder()

Optional. Sets the search hint. If no strategy is specified, the service will use an index if one is available, and fall back to the default KNN search otherwise.

.google.cloud.vectorsearch.v1beta.SearchHint search_hint = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SearchHintOrBuilder

getSparseVector()

public SparseVector getSparseVector()

A sparse vector for the query.

.google.cloud.vectorsearch.v1beta.SparseVector sparse_vector = 2;

Returns
Type	Description
SparseVector	The sparseVector.

getSparseVectorBuilder()

public SparseVector.Builder getSparseVectorBuilder()

A sparse vector for the query.

.google.cloud.vectorsearch.v1beta.SparseVector sparse_vector = 2;

Returns
Type	Description
SparseVector.Builder

getSparseVectorOrBuilder()

public SparseVectorOrBuilder getSparseVectorOrBuilder()

A sparse vector for the query.

.google.cloud.vectorsearch.v1beta.SparseVector sparse_vector = 2;

Returns
Type	Description
SparseVectorOrBuilder

getTopK()

public int getTopK()

Optional. The number of nearest neighbors to return.

optional int32 top_k = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The topK.

getVector()

public DenseVector getVector()

A dense vector for the query.

.google.cloud.vectorsearch.v1beta.DenseVector vector = 1;

Returns
Type	Description
DenseVector	The vector.

getVectorBuilder()

public DenseVector.Builder getVectorBuilder()

A dense vector for the query.

.google.cloud.vectorsearch.v1beta.DenseVector vector = 1;

Returns
Type	Description
DenseVector.Builder

getVectorOrBuilder()

public DenseVectorOrBuilder getVectorOrBuilder()

A dense vector for the query.

.google.cloud.vectorsearch.v1beta.DenseVector vector = 1;

Returns
Type	Description
DenseVectorOrBuilder

getVectorTypeCase()

public VectorSearch.VectorTypeCase getVectorTypeCase()

Returns
Type	Description
VectorSearch.VectorTypeCase

hasFilter()

public boolean hasFilter()

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

.google.protobuf.Struct filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the filter field is set.

hasOutputFields()

public boolean hasOutputFields()

Optional. Mask specifying which fields to return.

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

Returns
Type	Description
boolean	Whether the outputFields field is set.

hasSearchHint()

public boolean hasSearchHint()

Optional. Sets the search hint. If no strategy is specified, the service will use an index if one is available, and fall back to the default KNN search otherwise.

.google.cloud.vectorsearch.v1beta.SearchHint search_hint = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the searchHint field is set.

hasSparseVector()

public boolean hasSparseVector()

A sparse vector for the query.

.google.cloud.vectorsearch.v1beta.SparseVector sparse_vector = 2;

Returns
Type	Description
boolean	Whether the sparseVector field is set.

hasTopK()

public boolean hasTopK()

Optional. The number of nearest neighbors to return.

optional int32 top_k = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the topK field is set.

hasVector()

public boolean hasVector()

A dense vector for the query.

.google.cloud.vectorsearch.v1beta.DenseVector vector = 1;

Returns
Type	Description
boolean	Whether the vector 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()

mergeFilter(Struct value)

public VectorSearch.Builder mergeFilter(Struct value)

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

.google.protobuf.Struct filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	Struct

Returns
Type	Description
VectorSearch.Builder

mergeFrom(VectorSearch other)

public VectorSearch.Builder mergeFrom(VectorSearch other)

Parameter
Name	Description
other	VectorSearch

Returns
Type	Description
VectorSearch.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public VectorSearch.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
VectorSearch.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public VectorSearch.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
VectorSearch.Builder

Overrides

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

mergeOutputFields(OutputFields value)

public VectorSearch.Builder mergeOutputFields(OutputFields value)

Optional. Mask specifying which fields to return.

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

Parameter
Name	Description
value	OutputFields

Returns
Type	Description
VectorSearch.Builder

mergeSearchHint(SearchHint value)

public VectorSearch.Builder mergeSearchHint(SearchHint value)

Optional. Sets the search hint. If no strategy is specified, the service will use an index if one is available, and fall back to the default KNN search otherwise.

.google.cloud.vectorsearch.v1beta.SearchHint search_hint = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	SearchHint

Returns
Type	Description
VectorSearch.Builder

mergeSparseVector(SparseVector value)

public VectorSearch.Builder mergeSparseVector(SparseVector value)

A sparse vector for the query.

.google.cloud.vectorsearch.v1beta.SparseVector sparse_vector = 2;

Parameter
Name	Description
value	SparseVector

Returns
Type	Description
VectorSearch.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final VectorSearch.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
VectorSearch.Builder

Overrides

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

mergeVector(DenseVector value)

public VectorSearch.Builder mergeVector(DenseVector value)

A dense vector for the query.

.google.cloud.vectorsearch.v1beta.DenseVector vector = 1;

Parameter
Name	Description
value	DenseVector

Returns
Type	Description
VectorSearch.Builder

setDistanceMetric(DistanceMetric value)

public VectorSearch.Builder setDistanceMetric(DistanceMetric value)

Optional. The distance metric to use for the KNN search. If not specified, DOT_PRODUCT will be used as the default.

.google.cloud.vectorsearch.v1beta.DistanceMetric distance_metric = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	DistanceMetric The distanceMetric to set.

Returns
Type	Description
VectorSearch.Builder	This builder for chaining.

setDistanceMetricValue(int value)

public VectorSearch.Builder setDistanceMetricValue(int value)

Optional. The distance metric to use for the KNN search. If not specified, DOT_PRODUCT will be used as the default.

.google.cloud.vectorsearch.v1beta.DistanceMetric distance_metric = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	int The enum numeric value on the wire for distanceMetric to set.

Returns
Type	Description
VectorSearch.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
VectorSearch.Builder

Overrides

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

setFilter(Struct value)

public VectorSearch.Builder setFilter(Struct value)

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

.google.protobuf.Struct filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	Struct

Returns
Type	Description
VectorSearch.Builder

setFilter(Struct.Builder builderForValue)

public VectorSearch.Builder setFilter(Struct.Builder builderForValue)

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

.google.protobuf.Struct filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
VectorSearch.Builder

setOutputFields(OutputFields value)

public VectorSearch.Builder setOutputFields(OutputFields value)

Optional. Mask specifying which fields to return.

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

Parameter
Name	Description
value	OutputFields

Returns
Type	Description
VectorSearch.Builder

setOutputFields(OutputFields.Builder builderForValue)

public VectorSearch.Builder setOutputFields(OutputFields.Builder builderForValue)

Optional. Mask specifying which fields to return.

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

Parameter
Name	Description
builderForValue	OutputFields.Builder

Returns
Type	Description
VectorSearch.Builder

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
VectorSearch.Builder

Overrides

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

setSearchField(String value)

public VectorSearch.Builder setSearchField(String value)

Required. The vector field to search.

string search_field = 8 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	String The searchField to set.

Returns
Type	Description
VectorSearch.Builder	This builder for chaining.

setSearchFieldBytes(ByteString value)

public VectorSearch.Builder setSearchFieldBytes(ByteString value)

Required. The vector field to search.

string search_field = 8 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	ByteString The bytes for searchField to set.

Returns
Type	Description
VectorSearch.Builder	This builder for chaining.

setSearchHint(SearchHint value)

public VectorSearch.Builder setSearchHint(SearchHint value)

Optional. Sets the search hint. If no strategy is specified, the service will use an index if one is available, and fall back to the default KNN search otherwise.

.google.cloud.vectorsearch.v1beta.SearchHint search_hint = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	SearchHint

Returns
Type	Description
VectorSearch.Builder

setSearchHint(SearchHint.Builder builderForValue)

public VectorSearch.Builder setSearchHint(SearchHint.Builder builderForValue)

Optional. Sets the search hint. If no strategy is specified, the service will use an index if one is available, and fall back to the default KNN search otherwise.

.google.cloud.vectorsearch.v1beta.SearchHint search_hint = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	SearchHint.Builder

Returns
Type	Description
VectorSearch.Builder

setSparseVector(SparseVector value)

public VectorSearch.Builder setSparseVector(SparseVector value)

A sparse vector for the query.

.google.cloud.vectorsearch.v1beta.SparseVector sparse_vector = 2;

Parameter
Name	Description
value	SparseVector

Returns
Type	Description
VectorSearch.Builder

setSparseVector(SparseVector.Builder builderForValue)

public VectorSearch.Builder setSparseVector(SparseVector.Builder builderForValue)

A sparse vector for the query.

.google.cloud.vectorsearch.v1beta.SparseVector sparse_vector = 2;

Parameter
Name	Description
builderForValue	SparseVector.Builder

Returns
Type	Description
VectorSearch.Builder

setTopK(int value)

public VectorSearch.Builder setTopK(int value)

Optional. The number of nearest neighbors to return.

optional int32 top_k = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	int The topK to set.

Returns
Type	Description
VectorSearch.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final VectorSearch.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
VectorSearch.Builder

Overrides

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

setVector(DenseVector value)

public VectorSearch.Builder setVector(DenseVector value)

A dense vector for the query.

.google.cloud.vectorsearch.v1beta.DenseVector vector = 1;

Parameter
Name	Description
value	DenseVector

Returns
Type	Description
VectorSearch.Builder

setVector(DenseVector.Builder builderForValue)

public VectorSearch.Builder setVector(DenseVector.Builder builderForValue)

A dense vector for the query.

.google.cloud.vectorsearch.v1beta.DenseVector vector = 1;

Parameter
Name	Description
builderForValue	DenseVector.Builder

Returns
Type	Description
VectorSearch.Builder