public static final class Index.IndexField.VectorConfig extends GeneratedMessageV3 implements Index.IndexField.VectorConfigOrBuilder
The index configuration to support vector search operations
Protobuf type google.firestore.admin.v1.Index.IndexField.VectorConfig
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Index.IndexField.VectorConfigImplements
Index.IndexField.VectorConfigOrBuilderStatic Fields
DIMENSION_FIELD_NUMBER
public static final int DIMENSION_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
FLAT_FIELD_NUMBER
public static final int FLAT_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static Index.IndexField.VectorConfig getDefaultInstance()
Returns | |
---|---|
Type | Description |
Index.IndexField.VectorConfig |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static Index.IndexField.VectorConfig.Builder newBuilder()
Returns | |
---|---|
Type | Description |
Index.IndexField.VectorConfig.Builder |
newBuilder(Index.IndexField.VectorConfig prototype)
public static Index.IndexField.VectorConfig.Builder newBuilder(Index.IndexField.VectorConfig prototype)
Parameter | |
---|---|
Name | Description |
prototype |
Index.IndexField.VectorConfig |
Returns | |
---|---|
Type | Description |
Index.IndexField.VectorConfig.Builder |
parseDelimitedFrom(InputStream input)
public static Index.IndexField.VectorConfig parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
Index.IndexField.VectorConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Index.IndexField.VectorConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Index.IndexField.VectorConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static Index.IndexField.VectorConfig parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data |
byte[] |
Returns | |
---|---|
Type | Description |
Index.IndexField.VectorConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Index.IndexField.VectorConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Index.IndexField.VectorConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static Index.IndexField.VectorConfig parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data |
ByteString |
Returns | |
---|---|
Type | Description |
Index.IndexField.VectorConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Index.IndexField.VectorConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Index.IndexField.VectorConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static Index.IndexField.VectorConfig parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
Returns | |
---|---|
Type | Description |
Index.IndexField.VectorConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Index.IndexField.VectorConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Index.IndexField.VectorConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static Index.IndexField.VectorConfig parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
Index.IndexField.VectorConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Index.IndexField.VectorConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Index.IndexField.VectorConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static Index.IndexField.VectorConfig parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data |
ByteBuffer |
Returns | |
---|---|
Type | Description |
Index.IndexField.VectorConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Index.IndexField.VectorConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Index.IndexField.VectorConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<Index.IndexField.VectorConfig> parser()
Returns | |
---|---|
Type | Description |
Parser<VectorConfig> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj |
Object |
Returns | |
---|---|
Type | Description |
boolean |
getDefaultInstanceForType()
public Index.IndexField.VectorConfig getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
Index.IndexField.VectorConfig |
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. |
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 |
getParserForType()
public Parser<Index.IndexField.VectorConfig> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<VectorConfig> |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
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. |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public Index.IndexField.VectorConfig.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
Index.IndexField.VectorConfig.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Index.IndexField.VectorConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent |
BuilderParent |
Returns | |
---|---|
Type | Description |
Index.IndexField.VectorConfig.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public Index.IndexField.VectorConfig.Builder toBuilder()
Returns | |
---|---|
Type | Description |
Index.IndexField.VectorConfig.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output |
CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |