com.google.firestore.admin.v1

Enum Index.ApiScope

java.lang.Object

java.lang.Enum<Index.ApiScope>

com.google.firestore.admin.v1.Index.ApiScope

All Implemented Interfaces:

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

Enclosing class:

Index

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

 API Scope defines the APIs (Firestore Native, or Firestore in
 Datastore Mode) that are supported for queries.
 

Protobuf enum google.firestore.admin.v1.Index.ApiScope

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANY_API The index can only be used by the Firestore Native query API.
DATASTORE_MODE_API The index can only be used by the Firestore in Datastore Mode query API.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	ANY_API_VALUE The index can only be used by the Firestore Native query API.
static int	DATASTORE_MODE_API_VALUE The index can only be used by the Firestore in Datastore Mode query API.

Method Summary

Modifier and Type	Method and Description
static Index.ApiScope	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.ApiScope>	internalGetValueMap()
static Index.ApiScope	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
static Index.ApiScope	valueOf(int value) Deprecated. Use forNumber(int) instead.
static Index.ApiScope	valueOf(String name) Returns the enum constant of this type with the specified name.
static Index.ApiScope[]	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

ANY_API

public static final Index.ApiScope ANY_API

 The index can only be used by the Firestore Native query API.
 This is the default.
 

ANY_API = 0;

DATASTORE_MODE_API

public static final Index.ApiScope DATASTORE_MODE_API

 The index can only be used by the Firestore in Datastore Mode query API.
 

DATASTORE_MODE_API = 1;

UNRECOGNIZED

public static final Index.ApiScope UNRECOGNIZED

Field Detail

ANY_API_VALUE

public static final int ANY_API_VALUE

 The index can only be used by the Firestore Native query API.
 This is the default.
 

ANY_API = 0;

See Also:

Constant Field Values

DATASTORE_MODE_API_VALUE

public static final int DATASTORE_MODE_API_VALUE

 The index can only be used by the Firestore in Datastore Mode query API.
 

DATASTORE_MODE_API = 1;

See Also:

Constant Field Values

Method Detail

values

public static Index.ApiScope[] 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.ApiScope c : Index.ApiScope.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.ApiScope 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.ApiScope 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.ApiScope 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.ApiScope> 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.ApiScope valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)