Class Index.IndexField.VectorConfig.Builder (3.22.0)

public static final class Index.IndexField.VectorConfig.Builder extends GeneratedMessageV3.Builder<Index.IndexField.VectorConfig.Builder> implements Index.IndexField.VectorConfigOrBuilder

The index configuration to support vector search operations

Protobuf type google.firestore.admin.v1.Index.IndexField.VectorConfig

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Index.IndexField.VectorConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Index.IndexField.VectorConfig.Builder
Overrides

build()

public Index.IndexField.VectorConfig build()
Returns
Type Description
Index.IndexField.VectorConfig

buildPartial()

public Index.IndexField.VectorConfig buildPartial()
Returns
Type Description
Index.IndexField.VectorConfig

clear()

public Index.IndexField.VectorConfig.Builder clear()
Returns
Type Description
Index.IndexField.VectorConfig.Builder
Overrides

clearDimension()

public Index.IndexField.VectorConfig.Builder clearDimension()

Required. The vector dimension this configuration applies to.

The resulting index will only include vectors of this dimension, and can be used for vector search with the same dimension.

int32 dimension = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Index.IndexField.VectorConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Index.IndexField.VectorConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Index.IndexField.VectorConfig.Builder
Overrides

clearFlat()

public Index.IndexField.VectorConfig.Builder clearFlat()

Indicates the vector index is a flat index.

.google.firestore.admin.v1.Index.IndexField.VectorConfig.FlatIndex flat = 2;

Returns
Type Description
Index.IndexField.VectorConfig.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Index.IndexField.VectorConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Index.IndexField.VectorConfig.Builder
Overrides

clearType()

public Index.IndexField.VectorConfig.Builder clearType()
Returns
Type Description
Index.IndexField.VectorConfig.Builder

clone()

public Index.IndexField.VectorConfig.Builder clone()
Returns
Type Description
Index.IndexField.VectorConfig.Builder
Overrides

getDefaultInstanceForType()

public Index.IndexField.VectorConfig getDefaultInstanceForType()
Returns
Type Description
Index.IndexField.VectorConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDimension()

public int getDimension()

Required. The vector dimension this configuration applies to.

The resulting index will only include vectors of this dimension, and can be used for vector search with the same dimension.

int32 dimension = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The dimension.

getFlat()

public Index.IndexField.VectorConfig.FlatIndex getFlat()

Indicates the vector index is a flat index.

.google.firestore.admin.v1.Index.IndexField.VectorConfig.FlatIndex flat = 2;

Returns
Type Description
Index.IndexField.VectorConfig.FlatIndex

The flat.

getFlatBuilder()

public Index.IndexField.VectorConfig.FlatIndex.Builder getFlatBuilder()

Indicates the vector index is a flat index.

.google.firestore.admin.v1.Index.IndexField.VectorConfig.FlatIndex flat = 2;

Returns
Type Description
Index.IndexField.VectorConfig.FlatIndex.Builder

getFlatOrBuilder()

public Index.IndexField.VectorConfig.FlatIndexOrBuilder getFlatOrBuilder()

Indicates the vector index is a flat index.

.google.firestore.admin.v1.Index.IndexField.VectorConfig.FlatIndex flat = 2;

Returns
Type Description
Index.IndexField.VectorConfig.FlatIndexOrBuilder

getTypeCase()

public Index.IndexField.VectorConfig.TypeCase getTypeCase()
Returns
Type Description
Index.IndexField.VectorConfig.TypeCase

hasFlat()

public boolean hasFlat()

Indicates the vector index is a flat index.

.google.firestore.admin.v1.Index.IndexField.VectorConfig.FlatIndex flat = 2;

Returns
Type Description
boolean

Whether the flat field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFlat(Index.IndexField.VectorConfig.FlatIndex value)

public Index.IndexField.VectorConfig.Builder mergeFlat(Index.IndexField.VectorConfig.FlatIndex value)

Indicates the vector index is a flat index.

.google.firestore.admin.v1.Index.IndexField.VectorConfig.FlatIndex flat = 2;

Parameter
Name Description
value Index.IndexField.VectorConfig.FlatIndex
Returns
Type Description
Index.IndexField.VectorConfig.Builder

mergeFrom(Index.IndexField.VectorConfig other)

public Index.IndexField.VectorConfig.Builder mergeFrom(Index.IndexField.VectorConfig other)
Parameter
Name Description
other Index.IndexField.VectorConfig
Returns
Type Description
Index.IndexField.VectorConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Index.IndexField.VectorConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Index.IndexField.VectorConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Index.IndexField.VectorConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Index.IndexField.VectorConfig.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Index.IndexField.VectorConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Index.IndexField.VectorConfig.Builder
Overrides

setDimension(int value)

public Index.IndexField.VectorConfig.Builder setDimension(int value)

Required. The vector dimension this configuration applies to.

The resulting index will only include vectors of this dimension, and can be used for vector search with the same dimension.

int32 dimension = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

The dimension to set.

Returns
Type Description
Index.IndexField.VectorConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Index.IndexField.VectorConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Index.IndexField.VectorConfig.Builder
Overrides

setFlat(Index.IndexField.VectorConfig.FlatIndex value)

public Index.IndexField.VectorConfig.Builder setFlat(Index.IndexField.VectorConfig.FlatIndex value)

Indicates the vector index is a flat index.

.google.firestore.admin.v1.Index.IndexField.VectorConfig.FlatIndex flat = 2;

Parameter
Name Description
value Index.IndexField.VectorConfig.FlatIndex
Returns
Type Description
Index.IndexField.VectorConfig.Builder

setFlat(Index.IndexField.VectorConfig.FlatIndex.Builder builderForValue)

public Index.IndexField.VectorConfig.Builder setFlat(Index.IndexField.VectorConfig.FlatIndex.Builder builderForValue)

Indicates the vector index is a flat index.

.google.firestore.admin.v1.Index.IndexField.VectorConfig.FlatIndex flat = 2;

Parameter
Name Description
builderForValue Index.IndexField.VectorConfig.FlatIndex.Builder
Returns
Type Description
Index.IndexField.VectorConfig.Builder

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

public Index.IndexField.VectorConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Index.IndexField.VectorConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Index.IndexField.VectorConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Index.IndexField.VectorConfig.Builder
Overrides