Package com.google.firestore.admin.v1

Class Index.IndexField.VectorConfig.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<Index.IndexField.VectorConfig.Builder>

com.google.firestore.admin.v1.Index.IndexField.VectorConfig.Builder

All Implemented Interfaces:

Index.IndexField.VectorConfigOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

Index.IndexField.VectorConfig

public static final class Index.IndexField.VectorConfig.Builder
extends com.google.protobuf.GeneratedMessage.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

Method Summary

Modifier and Type	Method	Description
Index.IndexField.VectorConfig	build()
Index.IndexField.VectorConfig	buildPartial()
Index.IndexField.VectorConfig.Builder	clear()
Index.IndexField.VectorConfig.Builder	clearDimension()	Required.
Index.IndexField.VectorConfig.Builder	clearFlat()	Indicates the vector index is a flat index.
Index.IndexField.VectorConfig.Builder	clearType()
Index.IndexField.VectorConfig	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
int	getDimension()	Required.
Index.IndexField.VectorConfig.FlatIndex	getFlat()	Indicates the vector index is a flat index.
Index.IndexField.VectorConfig.FlatIndex.Builder	getFlatBuilder()	Indicates the vector index is a flat index.
Index.IndexField.VectorConfig.FlatIndexOrBuilder	getFlatOrBuilder()	Indicates the vector index is a flat index.
Index.IndexField.VectorConfig.TypeCase	getTypeCase()
boolean	hasFlat()	Indicates the vector index is a flat index.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
Index.IndexField.VectorConfig.Builder	mergeFlat(Index.IndexField.VectorConfig.FlatIndex value)	Indicates the vector index is a flat index.
Index.IndexField.VectorConfig.Builder	mergeFrom(Index.IndexField.VectorConfig other)
Index.IndexField.VectorConfig.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Index.IndexField.VectorConfig.Builder	mergeFrom(com.google.protobuf.Message other)
Index.IndexField.VectorConfig.Builder	setDimension(int value)	Required.
Index.IndexField.VectorConfig.Builder	setFlat(Index.IndexField.VectorConfig.FlatIndex value)	Indicates the vector index is a flat index.
Index.IndexField.VectorConfig.Builder	setFlat(Index.IndexField.VectorConfig.FlatIndex.Builder builderForValue)	Indicates the vector index is a flat index.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Details

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Index.IndexField.VectorConfig.Builder>

clear

public Index.IndexField.VectorConfig.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<Index.IndexField.VectorConfig.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Index.IndexField.VectorConfig.Builder>

getDefaultInstanceForType

public Index.IndexField.VectorConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Index.IndexField.VectorConfig build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Index.IndexField.VectorConfig buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public Index.IndexField.VectorConfig.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Index.IndexField.VectorConfig.Builder>

mergeFrom

public Index.IndexField.VectorConfig.Builder mergeFrom(Index.IndexField.VectorConfig other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Index.IndexField.VectorConfig.Builder>

mergeFrom

public Index.IndexField.VectorConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Index.IndexField.VectorConfig.Builder>

Throws:

IOException

getTypeCase

public Index.IndexField.VectorConfig.TypeCase getTypeCase()

Specified by:

getTypeCase in interface Index.IndexField.VectorConfigOrBuilder

clearType

public Index.IndexField.VectorConfig.Builder clearType()

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

Specified by:

getDimension in interface Index.IndexField.VectorConfigOrBuilder

Returns:

The dimension.

setDimension

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

Parameters:

value - The dimension to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

hasFlat

public boolean hasFlat()

 Indicates the vector index is a flat index.
 

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

Specified by:

hasFlat in interface Index.IndexField.VectorConfigOrBuilder

Returns:

Whether the flat field is set.

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;

Specified by:

getFlat in interface Index.IndexField.VectorConfigOrBuilder

Returns:

The flat.

setFlat

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;

setFlat

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;

mergeFlat

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;

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;

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;

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;

Specified by:

getFlatOrBuilder in interface Index.IndexField.VectorConfigOrBuilder