Class Index.IndexField (3.21.0)

public static final class Index.IndexField extends GeneratedMessageV3 implements Index.IndexFieldOrBuilder

A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.

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

Static Fields

ARRAY_CONFIG_FIELD_NUMBER

public static final int ARRAY_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

FIELD_PATH_FIELD_NUMBER

public static final int FIELD_PATH_FIELD_NUMBER
Field Value
Type Description
int

ORDER_FIELD_NUMBER

public static final int ORDER_FIELD_NUMBER
Field Value
Type Description
int

VECTOR_CONFIG_FIELD_NUMBER

public static final int VECTOR_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Index.IndexField getDefaultInstance()
Returns
Type Description
Index.IndexField

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Index.IndexField.Builder newBuilder()
Returns
Type Description
Index.IndexField.Builder

newBuilder(Index.IndexField prototype)

public static Index.IndexField.Builder newBuilder(Index.IndexField prototype)
Parameter
Name Description
prototype Index.IndexField
Returns
Type Description
Index.IndexField.Builder

parseDelimitedFrom(InputStream input)

public static Index.IndexField parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Index.IndexField
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Index.IndexField parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Index.IndexField
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Index.IndexField parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Index.IndexField
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Index.IndexField parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Index.IndexField
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Index.IndexField parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Index.IndexField
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Index.IndexField parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Index.IndexField
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Index.IndexField parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Index.IndexField
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Index.IndexField parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Index.IndexField
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Index.IndexField parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Index.IndexField
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Index.IndexField parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Index.IndexField
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Index.IndexField parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Index.IndexField
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Index.IndexField parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Index.IndexField
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Index.IndexField> parser()
Returns
Type Description
Parser<IndexField>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getArrayConfig()

public Index.IndexField.ArrayConfig getArrayConfig()

Indicates that this field supports operations on array_values.

.google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;

Returns
Type Description
Index.IndexField.ArrayConfig

The arrayConfig.

getArrayConfigValue()

public int getArrayConfigValue()

Indicates that this field supports operations on array_values.

.google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;

Returns
Type Description
int

The enum numeric value on the wire for arrayConfig.

getDefaultInstanceForType()

public Index.IndexField getDefaultInstanceForType()
Returns
Type Description
Index.IndexField

getFieldPath()

public String getFieldPath()

Can be name. For single field indexes, this must match the name of the field or may be omitted.

string field_path = 1;

Returns
Type Description
String

The fieldPath.

getFieldPathBytes()

public ByteString getFieldPathBytes()

Can be name. For single field indexes, this must match the name of the field or may be omitted.

string field_path = 1;

Returns
Type Description
ByteString

The bytes for fieldPath.

getOrder()

public Index.IndexField.Order getOrder()

Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.

.google.firestore.admin.v1.Index.IndexField.Order order = 2;

Returns
Type Description
Index.IndexField.Order

The order.

getOrderValue()

public int getOrderValue()

Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.

.google.firestore.admin.v1.Index.IndexField.Order order = 2;

Returns
Type Description
int

The enum numeric value on the wire for order.

getParserForType()

public Parser<Index.IndexField> getParserForType()
Returns
Type Description
Parser<IndexField>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getValueModeCase()

public Index.IndexField.ValueModeCase getValueModeCase()
Returns
Type Description
Index.IndexField.ValueModeCase

getVectorConfig()

public Index.IndexField.VectorConfig getVectorConfig()

Indicates that this field supports nearest neighbors and distance operations on vector.

.google.firestore.admin.v1.Index.IndexField.VectorConfig vector_config = 4;

Returns
Type Description
Index.IndexField.VectorConfig

The vectorConfig.

getVectorConfigOrBuilder()

public Index.IndexField.VectorConfigOrBuilder getVectorConfigOrBuilder()

Indicates that this field supports nearest neighbors and distance operations on vector.

.google.firestore.admin.v1.Index.IndexField.VectorConfig vector_config = 4;

Returns
Type Description
Index.IndexField.VectorConfigOrBuilder

hasArrayConfig()

public boolean hasArrayConfig()

Indicates that this field supports operations on array_values.

.google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;

Returns
Type Description
boolean

Whether the arrayConfig field is set.

hasOrder()

public boolean hasOrder()

Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.

.google.firestore.admin.v1.Index.IndexField.Order order = 2;

Returns
Type Description
boolean

Whether the order field is set.

hasVectorConfig()

public boolean hasVectorConfig()

Indicates that this field supports nearest neighbors and distance operations on vector.

.google.firestore.admin.v1.Index.IndexField.VectorConfig vector_config = 4;

Returns
Type Description
boolean

Whether the vectorConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Index.IndexField.Builder newBuilderForType()
Returns
Type Description
Index.IndexField.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Index.IndexField.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Index.IndexField.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Index.IndexField.Builder toBuilder()
Returns
Type Description
Index.IndexField.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException