Package com.google.firestore.admin.v1

Class Index.IndexField.VectorConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

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

All Implemented Interfaces:

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

Enclosing class:

Index.IndexField

public static final class Index.IndexField.VectorConfig
extends com.google.protobuf.GeneratedMessage
implements Index.IndexField.VectorConfigOrBuilder

 The index configuration to support vector search operations
 

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

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Index.IndexField.VectorConfig.Builder	The index configuration to support vector search operations
static final class	Index.IndexField.VectorConfig.FlatIndex	An index that stores vectors in a flat data structure, and supports exhaustive search.
static interface	Index.IndexField.VectorConfig.FlatIndexOrBuilder
static enum	Index.IndexField.VectorConfig.TypeCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DIMENSION_FIELD_NUMBER
static final int	FLAT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static Index.IndexField.VectorConfig	getDefaultInstance()
Index.IndexField.VectorConfig	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
int	getDimension()	Required.
Index.IndexField.VectorConfig.FlatIndex	getFlat()	Indicates the vector index is a flat index.
Index.IndexField.VectorConfig.FlatIndexOrBuilder	getFlatOrBuilder()	Indicates the vector index is a flat index.
com.google.protobuf.Parser<Index.IndexField.VectorConfig>	getParserForType()
int	getSerializedSize()
Index.IndexField.VectorConfig.TypeCase	getTypeCase()
boolean	hasFlat()	Indicates the vector index is a flat index.
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static Index.IndexField.VectorConfig.Builder	newBuilder()
static Index.IndexField.VectorConfig.Builder	newBuilder(Index.IndexField.VectorConfig prototype)
Index.IndexField.VectorConfig.Builder	newBuilderForType()
protected Index.IndexField.VectorConfig.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static Index.IndexField.VectorConfig	parseDelimitedFrom(InputStream input)
static Index.IndexField.VectorConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Index.IndexField.VectorConfig	parseFrom(byte[] data)
static Index.IndexField.VectorConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Index.IndexField.VectorConfig	parseFrom(com.google.protobuf.ByteString data)
static Index.IndexField.VectorConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Index.IndexField.VectorConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static Index.IndexField.VectorConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Index.IndexField.VectorConfig	parseFrom(InputStream input)
static Index.IndexField.VectorConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Index.IndexField.VectorConfig	parseFrom(ByteBuffer data)
static Index.IndexField.VectorConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Index.IndexField.VectorConfig>	parser()
Index.IndexField.VectorConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Details

DIMENSION_FIELD_NUMBER

public static final int DIMENSION_FIELD_NUMBER

See Also:

• Constant Field Values

FLAT_FIELD_NUMBER

public static final int FLAT_FIELD_NUMBER

See Also:

• Constant Field Values

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

getTypeCase

public Index.IndexField.VectorConfig.TypeCase getTypeCase()

Specified by:

getTypeCase in interface Index.IndexField.VectorConfigOrBuilder

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.

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.

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Index.IndexField.VectorConfig parseFrom(ByteBuffer data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Index.IndexField.VectorConfig parseFrom(ByteBuffer data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Index.IndexField.VectorConfig parseFrom(com.google.protobuf.ByteString data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Index.IndexField.VectorConfig parseFrom(com.google.protobuf.ByteString data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Index.IndexField.VectorConfig parseFrom(byte[] data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Index.IndexField.VectorConfig parseFrom(byte[] data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Index.IndexField.VectorConfig parseFrom(InputStream input)
                                               throws IOException

Throws:

IOException

parseFrom

public static Index.IndexField.VectorConfig parseFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static Index.IndexField.VectorConfig parseDelimitedFrom(InputStream input)
                                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static Index.IndexField.VectorConfig parseDelimitedFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws IOException

Throws:

IOException

parseFrom

public static Index.IndexField.VectorConfig parseFrom(com.google.protobuf.CodedInputStream input)
                                               throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Index.IndexField.VectorConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Index.IndexField.VectorConfig.Builder newBuilder()

newBuilder

public static Index.IndexField.VectorConfig.Builder newBuilder(Index.IndexField.VectorConfig prototype)

toBuilder

public Index.IndexField.VectorConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Index.IndexField.VectorConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static Index.IndexField.VectorConfig getDefaultInstance()

parser

public static com.google.protobuf.Parser<Index.IndexField.VectorConfig> parser()

getParserForType

public com.google.protobuf.Parser<Index.IndexField.VectorConfig> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public Index.IndexField.VectorConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder