com.google.firestore.admin.v1

Enum Index.State

java.lang.Object

java.lang.Enum<Index.State>

com.google.firestore.admin.v1.Index.State

All Implemented Interfaces:

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

Enclosing class:

Index

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

 The state of an index. During index creation, an index will be in the
 `CREATING` state. If the index is created successfully, it will transition
 to the `READY` state. If the index creation encounters a problem, the index
 will transition to the `NEEDS_REPAIR` state.
 

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
CREATING The index is being created.
NEEDS_REPAIR The index was being created, but something went wrong.
READY The index is ready to be used.
STATE_UNSPECIFIED The state is unspecified.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	CREATING_VALUE The index is being created.
static int	NEEDS_REPAIR_VALUE The index was being created, but something went wrong.
static int	READY_VALUE The index is ready to be used.
static int	STATE_UNSPECIFIED_VALUE The state is unspecified.

Method Summary

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

STATE_UNSPECIFIED

public static final Index.State STATE_UNSPECIFIED

 The state is unspecified.
 

STATE_UNSPECIFIED = 0;

CREATING

public static final Index.State CREATING

 The index is being created.
 There is an active long-running operation for the index.
 The index is updated when writing a document.
 Some index data may exist.
 

CREATING = 1;

READY

public static final Index.State READY

 The index is ready to be used.
 The index is updated when writing a document.
 The index is fully populated from all stored documents it applies to.
 

READY = 2;

NEEDS_REPAIR

public static final Index.State NEEDS_REPAIR

 The index was being created, but something went wrong.
 There is no active long-running operation for the index,
 and the most recently finished long-running operation failed.
 The index is not updated when writing a document.
 Some index data may exist.
 Use the google.longrunning.Operations API to determine why the operation
 that last attempted to create this index failed, then re-create the
 index.
 

NEEDS_REPAIR = 3;

UNRECOGNIZED

public static final Index.State UNRECOGNIZED

Field Detail

STATE_UNSPECIFIED_VALUE

public static final int STATE_UNSPECIFIED_VALUE

 The state is unspecified.
 

STATE_UNSPECIFIED = 0;

See Also:

Constant Field Values

CREATING_VALUE

public static final int CREATING_VALUE

 The index is being created.
 There is an active long-running operation for the index.
 The index is updated when writing a document.
 Some index data may exist.
 

CREATING = 1;

See Also:

Constant Field Values

READY_VALUE

public static final int READY_VALUE

 The index is ready to be used.
 The index is updated when writing a document.
 The index is fully populated from all stored documents it applies to.
 

READY = 2;

See Also:

Constant Field Values

NEEDS_REPAIR_VALUE

public static final int NEEDS_REPAIR_VALUE

 The index was being created, but something went wrong.
 There is no active long-running operation for the index,
 and the most recently finished long-running operation failed.
 The index is not updated when writing a document.
 Some index data may exist.
 Use the google.longrunning.Operations API to determine why the operation
 that last attempted to create this index failed, then re-create the
 index.
 

NEEDS_REPAIR = 3;

See Also:

Constant Field Values

Method Detail

values

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