Class Index.IndexField.VectorConfig.Builder (3.31.9)
Version 3.31.9keyboard_arrow_down
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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Index . IndexField . VectorConfig . Builder addRepeatedField ( Descriptors . FieldDescriptor field , Object value )
Overrides
build()
public Index . IndexField . VectorConfig build ()
buildPartial()
public Index . IndexField . VectorConfig buildPartial ()
clear()
public Index . IndexField . VectorConfig . Builder clear ()
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];
clearField(Descriptors.FieldDescriptor field)
public Index . IndexField . VectorConfig . Builder clearField ( Descriptors . FieldDescriptor field )
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;
clearOneof(Descriptors.OneofDescriptor oneof)
public Index . IndexField . VectorConfig . Builder clearOneof ( Descriptors . OneofDescriptor oneof )
Overrides
clearType()
public Index . IndexField . VectorConfig . Builder clearType ()
clone()
public Index . IndexField . VectorConfig . Builder clone ()
Overrides
getDefaultInstanceForType()
public Index . IndexField . VectorConfig getDefaultInstanceForType ()
getDescriptorForType()
public Descriptors . Descriptor getDescriptorForType ()
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;
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;
getTypeCase()
public Index . IndexField . VectorConfig . TypeCase getTypeCase ()
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 ()
Overrides
isInitialized()
public final boolean isInitialized ()
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;
mergeFrom(Index.IndexField.VectorConfig other)
public Index . IndexField . VectorConfig . Builder mergeFrom ( Index . IndexField . VectorConfig other )
public Index . IndexField . VectorConfig . Builder mergeFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Overrides
mergeFrom(Message other)
public Index . IndexField . VectorConfig . Builder mergeFrom ( Message other )
Parameter
Name Description
otherMessage
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Index . IndexField . VectorConfig . Builder mergeUnknownFields ( UnknownFieldSet unknownFields )
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
valueint The dimension to set.
setField(Descriptors.FieldDescriptor field, Object value)
public Index . IndexField . VectorConfig . Builder setField ( Descriptors . FieldDescriptor field , Object value )
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;
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;
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Index . IndexField . VectorConfig . Builder setRepeatedField ( Descriptors . FieldDescriptor field , int index , Object value )
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final Index . IndexField . VectorConfig . Builder setUnknownFields ( UnknownFieldSet unknownFields )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
