Class Index.IndexField.VectorConfig.Builder (3.28.0)

Version latest

• 3.28.0 (latest)
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Index.IndexField.VectorConfig.Builder

Implements

Index.IndexField.VectorConfigOrBuilder

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

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

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

GeneratedMessageV3.Builder<BuilderType>.clear()

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

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

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

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

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

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public Index.IndexField.VectorConfig getDefaultInstanceForType()

Returns
Type	Description
Index.IndexField.VectorConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

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

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

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

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

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

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

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

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

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

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

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