com.google.firestore.admin.v1

Class Index.IndexField

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

All Implemented Interfaces:

Index.IndexFieldOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

Index

public static final class Index.IndexField
extends com.google.protobuf.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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Index.IndexField.ArrayConfig The supported array value configurations.
static class	Index.IndexField.Builder A field in an index.
static class	Index.IndexField.Order The supported orderings.
static class	Index.IndexField.ValueModeCase

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ARRAY_CONFIG_FIELD_NUMBER
static int	FIELD_PATH_FIELD_NUMBER
static int	ORDER_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, 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 and Description
boolean	equals(Object obj)
Index.IndexField.ArrayConfig	getArrayConfig() Indicates that this field supports operations on `array_value`s.
int	getArrayConfigValue() Indicates that this field supports operations on `array_value`s.
static Index.IndexField	getDefaultInstance()
Index.IndexField	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getFieldPath() Can be __name__.
com.google.protobuf.ByteString	getFieldPathBytes() Can be __name__.
Index.IndexField.Order	getOrder() Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
int	getOrderValue() Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
com.google.protobuf.Parser<Index.IndexField>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
Index.IndexField.ValueModeCase	getValueModeCase()
boolean	hasArrayConfig() Indicates that this field supports operations on `array_value`s.
int	hashCode()
boolean	hasOrder() Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Index.IndexField.Builder	newBuilder()
static Index.IndexField.Builder	newBuilder(Index.IndexField prototype)
Index.IndexField.Builder	newBuilderForType()
protected Index.IndexField.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Index.IndexField	parseDelimitedFrom(InputStream input)
static Index.IndexField	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Index.IndexField	parseFrom(byte[] data)
static Index.IndexField	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Index.IndexField	parseFrom(ByteBuffer data)
static Index.IndexField	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Index.IndexField	parseFrom(com.google.protobuf.ByteString data)
static Index.IndexField	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Index.IndexField	parseFrom(com.google.protobuf.CodedInputStream input)
static Index.IndexField	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Index.IndexField	parseFrom(InputStream input)
static Index.IndexField	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Index.IndexField>	parser()
Index.IndexField.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

FIELD_PATH_FIELD_NUMBER

public static final int FIELD_PATH_FIELD_NUMBER

See Also:

Constant Field Values

ORDER_FIELD_NUMBER

public static final int ORDER_FIELD_NUMBER

See Also:

Constant Field Values

ARRAY_CONFIG_FIELD_NUMBER

public static final int ARRAY_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getValueModeCase

public Index.IndexField.ValueModeCase getValueModeCase()

Specified by:

getValueModeCase in interface Index.IndexFieldOrBuilder

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;

Specified by:

getFieldPath in interface Index.IndexFieldOrBuilder

Returns:

The fieldPath.

getFieldPathBytes

public com.google.protobuf.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;

Specified by:

getFieldPathBytes in interface Index.IndexFieldOrBuilder

Returns:

The bytes for fieldPath.

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;

Specified by:

hasOrder in interface Index.IndexFieldOrBuilder

Returns:

Whether the order field is set.

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;

Specified by:

getOrderValue in interface Index.IndexFieldOrBuilder

Returns:

The enum numeric value on the wire for order.

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;

Specified by:

getOrder in interface Index.IndexFieldOrBuilder

Returns:

The order.

hasArrayConfig

public boolean hasArrayConfig()

 Indicates that this field supports operations on `array_value`s.
 

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

Specified by:

hasArrayConfig in interface Index.IndexFieldOrBuilder

Returns:

Whether the arrayConfig field is set.

getArrayConfigValue

public int getArrayConfigValue()

 Indicates that this field supports operations on `array_value`s.
 

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

Specified by:

getArrayConfigValue in interface Index.IndexFieldOrBuilder

Returns:

The enum numeric value on the wire for arrayConfig.

getArrayConfig

public Index.IndexField.ArrayConfig getArrayConfig()

 Indicates that this field supports operations on `array_value`s.
 

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

Specified by:

getArrayConfig in interface Index.IndexFieldOrBuilder

Returns:

The arrayConfig.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

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 parseFrom(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Index.IndexField 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 parseFrom(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Index.IndexField.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.Builder newBuilder()

newBuilder

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

toBuilder

public Index.IndexField.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Index.IndexField getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<Index.IndexField> 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.GeneratedMessageV3

getDefaultInstanceForType

public Index.IndexField getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder