Package com.google.firestore.admin.v1
Enum 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 ConstantsEnum ConstantDescriptionNot used.Use optimistic concurrency control by default.Use optimistic concurrency control with entity groups by default.Use pessimistic concurrency control by default. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intNot used.static final intUse optimistic concurrency control by default.static final intUse optimistic concurrency control with entity groups by default.static final intUse pessimistic concurrency control by default. -
Method Summary
Modifier and TypeMethodDescriptionstatic Database.ConcurrencyModeforNumber(int value) static com.google.protobuf.Descriptors.EnumDescriptorfinal com.google.protobuf.Descriptors.EnumDescriptorfinal intfinal com.google.protobuf.Descriptors.EnumValueDescriptorstatic com.google.protobuf.Internal.EnumLiteMap<Database.ConcurrencyMode>static Database.ConcurrencyModevalueOf(int value) Deprecated.static Database.ConcurrencyModevalueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc) Returns the enum constant of this type with the specified name.static Database.ConcurrencyModeReturns 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.
-
Enum Constant Details
-
CONCURRENCY_MODE_UNSPECIFIED
Not used.
CONCURRENCY_MODE_UNSPECIFIED = 0; -
OPTIMISTIC
Use optimistic concurrency control by default. This mode is available for Cloud Firestore databases. This is the default setting for Cloud Firestore Enterprise Edition databases.
OPTIMISTIC = 1; -
PESSIMISTIC
Use pessimistic concurrency control by default. This mode is available for Cloud Firestore databases. This is the default setting for Cloud Firestore Standard Edition databases.
PESSIMISTIC = 2; -
OPTIMISTIC_WITH_ENTITY_GROUPS
Use optimistic concurrency control with entity groups by default. This mode is enabled for some databases that were automatically upgraded from Cloud Datastore to Cloud Firestore with Datastore Mode. It is not recommended for any new databases, and not supported for Firestore Native databases.
OPTIMISTIC_WITH_ENTITY_GROUPS = 3; -
UNRECOGNIZED
-
-
Field Details
-
CONCURRENCY_MODE_UNSPECIFIED_VALUE
public static final int CONCURRENCY_MODE_UNSPECIFIED_VALUENot used.
CONCURRENCY_MODE_UNSPECIFIED = 0;- See Also:
-
OPTIMISTIC_VALUE
public static final int OPTIMISTIC_VALUEUse optimistic concurrency control by default. This mode is available for Cloud Firestore databases. This is the default setting for Cloud Firestore Enterprise Edition databases.
OPTIMISTIC = 1;- See Also:
-
PESSIMISTIC_VALUE
public static final int PESSIMISTIC_VALUEUse pessimistic concurrency control by default. This mode is available for Cloud Firestore databases. This is the default setting for Cloud Firestore Standard Edition databases.
PESSIMISTIC = 2;- See Also:
-
OPTIMISTIC_WITH_ENTITY_GROUPS_VALUE
public static final int OPTIMISTIC_WITH_ENTITY_GROUPS_VALUEUse optimistic concurrency control with entity groups by default. This mode is enabled for some databases that were automatically upgraded from Cloud Datastore to Cloud Firestore with Datastore Mode. It is not recommended for any new databases, and not supported for Firestore Native databases.
OPTIMISTIC_WITH_ENTITY_GROUPS = 3;- See Also:
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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 nameNullPointerException- if the argument is null
-
getNumber
public final int getNumber()- Specified by:
getNumberin interfacecom.google.protobuf.Internal.EnumLite- Specified by:
getNumberin interfacecom.google.protobuf.ProtocolMessageEnum
-
valueOf
Deprecated.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:
value- 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 nameNullPointerException- if the argument is null
-
forNumber
- 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:
getValueDescriptorin interfacecom.google.protobuf.ProtocolMessageEnum
-
getDescriptorForType
public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.ProtocolMessageEnum
-
getDescriptor
public static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor() -
valueOf
public static Database.ConcurrencyMode valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc) 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:
desc- 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 nameNullPointerException- if the argument is null
-