com.google.firestore.admin.v1

Enum Database.ConcurrencyMode

java.lang.Object

java.lang.Enum<Database.ConcurrencyMode>

com.google.firestore.admin.v1.Database.ConcurrencyMode

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<Database.ConcurrencyMode>

Enclosing class:

Database

public static enum Database.ConcurrencyMode
extends Enum<Database.ConcurrencyMode>
implements com.google.protobuf.ProtocolMessageEnum

 The type of concurrency control mode for transactions.
 

Protobuf enum google.firestore.admin.v1.Database.ConcurrencyMode

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONCURRENCY_MODE_UNSPECIFIED Not used.
OPTIMISTIC Use optimistic concurrency control by default.
OPTIMISTIC_WITH_ENTITY_GROUPS Use optimistic concurrency control with entity groups by default.
PESSIMISTIC Use pessimistic concurrency control by default.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONCURRENCY_MODE_UNSPECIFIED_VALUE Not used.
static int	OPTIMISTIC_VALUE Use optimistic concurrency control by default.
static int	OPTIMISTIC_WITH_ENTITY_GROUPS_VALUE Use optimistic concurrency control with entity groups by default.
static int	PESSIMISTIC_VALUE Use pessimistic concurrency control by default.

Method Summary

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

CONCURRENCY_MODE_UNSPECIFIED

public static final Database.ConcurrencyMode CONCURRENCY_MODE_UNSPECIFIED

 Not used.
 

CONCURRENCY_MODE_UNSPECIFIED = 0;

OPTIMISTIC

public static final Database.ConcurrencyMode OPTIMISTIC

 Use optimistic concurrency control by default. This mode is available
 for Cloud Firestore databases.
 

OPTIMISTIC = 1;

PESSIMISTIC

public static final Database.ConcurrencyMode PESSIMISTIC

 Use pessimistic concurrency control by default. This mode is available
 for Cloud Firestore databases.
 This is the default setting for Cloud Firestore.
 

PESSIMISTIC = 2;

OPTIMISTIC_WITH_ENTITY_GROUPS

public static final Database.ConcurrencyMode OPTIMISTIC_WITH_ENTITY_GROUPS

 Use optimistic concurrency control with entity groups by default.
 This is the only available mode for Cloud Datastore.
 This mode is also available for Cloud Firestore with Datastore Mode but
 is not recommended.
 

OPTIMISTIC_WITH_ENTITY_GROUPS = 3;

UNRECOGNIZED

public static final Database.ConcurrencyMode UNRECOGNIZED

Field Detail

CONCURRENCY_MODE_UNSPECIFIED_VALUE

public static final int CONCURRENCY_MODE_UNSPECIFIED_VALUE

 Not used.
 

CONCURRENCY_MODE_UNSPECIFIED = 0;

See Also:

Constant Field Values

OPTIMISTIC_VALUE

public static final int OPTIMISTIC_VALUE

 Use optimistic concurrency control by default. This mode is available
 for Cloud Firestore databases.
 

OPTIMISTIC = 1;

See Also:

Constant Field Values

PESSIMISTIC_VALUE

public static final int PESSIMISTIC_VALUE

 Use pessimistic concurrency control by default. This mode is available
 for Cloud Firestore databases.
 This is the default setting for Cloud Firestore.
 

PESSIMISTIC = 2;

See Also:

Constant Field Values

OPTIMISTIC_WITH_ENTITY_GROUPS_VALUE

public static final int OPTIMISTIC_WITH_ENTITY_GROUPS_VALUE

 Use optimistic concurrency control with entity groups by default.
 This is the only available mode for Cloud Datastore.
 This mode is also available for Cloud Firestore with Datastore Mode but
 is not recommended.
 

OPTIMISTIC_WITH_ENTITY_GROUPS = 3;

See Also:

Constant Field Values

Method Detail

values

public static Database.ConcurrencyMode[] 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 (Database.ConcurrencyMode c : Database.ConcurrencyMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static Database.ConcurrencyMode 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 Database.ConcurrencyMode 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 Database.ConcurrencyMode 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<Database.ConcurrencyMode> 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 Database.ConcurrencyMode valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)