Class Index.IndexField (3.6.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
TypeDescription
int

FIELD_PATH_FIELD_NUMBER

public static final int FIELD_PATH_FIELD_NUMBER
Field Value
TypeDescription
int

ORDER_FIELD_NUMBER

public static final int ORDER_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Index.IndexField getDefaultInstance()
Returns
TypeDescription
Index.IndexField

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Index.IndexField.Builder newBuilder()
Returns
TypeDescription
Index.IndexField.Builder

newBuilder(Index.IndexField prototype)

public static Index.IndexField.Builder newBuilder(Index.IndexField prototype)
Parameter
NameDescription
prototypeIndex.IndexField
Returns
TypeDescription
Index.IndexField.Builder

parseDelimitedFrom(InputStream input)

public static Index.IndexField parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Index.IndexField
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Index.IndexField parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Index.IndexField
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Index.IndexField parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Index.IndexField
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Index.IndexField parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Index.IndexField
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Index.IndexField parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Index.IndexField
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Index.IndexField parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Index.IndexField
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Index.IndexField parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Index.IndexField
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Index.IndexField parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Index.IndexField
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Index.IndexField parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Index.IndexField
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Index.IndexField parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Index.IndexField
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Index.IndexField parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Index.IndexField
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Index.IndexField parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Index.IndexField
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for arrayConfig.

getDefaultInstanceForType()

public Index.IndexField getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for order.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getValueModeCase()

public Index.IndexField.ValueModeCase getValueModeCase()
Returns
TypeDescription
Index.IndexField.ValueModeCase

hasArrayConfig()

public boolean hasArrayConfig()

Indicates that this field supports operations on array_values.

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

Returns
TypeDescription
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
TypeDescription
boolean

Whether the order field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Index.IndexField.Builder newBuilderForType()
Returns
TypeDescription
Index.IndexField.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Index.IndexField.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Index.IndexField.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Index.IndexField.Builder toBuilder()
Returns
TypeDescription
Index.IndexField.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException