com.google.firestore.admin.v1

Enum Index.IndexField.Order

java.lang.Object

java.lang.Enum<Index.IndexField.Order>

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

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<Index.IndexField.Order>

Enclosing class:

Index.IndexField

public static enum Index.IndexField.Order
extends Enum<Index.IndexField.Order>
implements com.google.protobuf.ProtocolMessageEnum

 The supported orderings.
 

Protobuf enum google.firestore.admin.v1.Index.IndexField.Order

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASCENDING The field is ordered by ascending field value.
DESCENDING The field is ordered by descending field value.
ORDER_UNSPECIFIED The ordering is unspecified.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	ASCENDING_VALUE The field is ordered by ascending field value.
static int	DESCENDING_VALUE The field is ordered by descending field value.
static int	ORDER_UNSPECIFIED_VALUE The ordering is unspecified.

Method Summary

Modifier and Type	Method and Description
static Index.IndexField.Order	forNumber(int value)
static com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor()
com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor()
static com.google.protobuf.Internal.EnumLiteMap<Index.IndexField.Order>	internalGetValueMap()
static Index.IndexField.Order	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
static Index.IndexField.Order	valueOf(int value) Deprecated. Use forNumber(int) instead.
static Index.IndexField.Order	valueOf(String name) Returns the enum constant of this type with the specified name.
static Index.IndexField.Order[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ORDER_UNSPECIFIED

public static final Index.IndexField.Order ORDER_UNSPECIFIED

 The ordering is unspecified. Not a valid option.
 

ORDER_UNSPECIFIED = 0;

ASCENDING

public static final Index.IndexField.Order ASCENDING

 The field is ordered by ascending field value.
 

ASCENDING = 1;

DESCENDING

public static final Index.IndexField.Order DESCENDING

 The field is ordered by descending field value.
 

DESCENDING = 2;

UNRECOGNIZED

public static final Index.IndexField.Order UNRECOGNIZED

Field Detail

ORDER_UNSPECIFIED_VALUE

public static final int ORDER_UNSPECIFIED_VALUE

 The ordering is unspecified. Not a valid option.
 

ORDER_UNSPECIFIED = 0;

See Also:

Constant Field Values

ASCENDING_VALUE

public static final int ASCENDING_VALUE

 The field is ordered by ascending field value.
 

ASCENDING = 1;

See Also:

Constant Field Values

DESCENDING_VALUE

public static final int DESCENDING_VALUE

 The field is ordered by descending field value.
 

DESCENDING = 2;

See Also:

Constant Field Values

Method Detail

values

public static Index.IndexField.Order[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Index.IndexField.Order c : Index.IndexField.Order.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Index.IndexField.Order valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getNumber

public final int getNumber()

Specified by:

getNumber in interface com.google.protobuf.Internal.EnumLite

Specified by:

getNumber in interface com.google.protobuf.ProtocolMessageEnum

valueOf

@Deprecated
public static Index.IndexField.Order valueOf(int value)

Deprecated. Use forNumber(int) instead.

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

forNumber

public static Index.IndexField.Order forNumber(int value)

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

internalGetValueMap

public static com.google.protobuf.Internal.EnumLiteMap<Index.IndexField.Order> internalGetValueMap()

getValueDescriptor

public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

getDescriptorForType

public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

getDescriptor

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

valueOf

public static Index.IndexField.Order valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)