Package com.google.firestore.v1
Enum TargetChange.TargetChangeType
- All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite,com.google.protobuf.ProtocolMessageEnum,Serializable,Comparable<TargetChange.TargetChangeType>
- Enclosing class:
- TargetChange
public static enum TargetChange.TargetChangeType
extends Enum<TargetChange.TargetChangeType>
implements com.google.protobuf.ProtocolMessageEnum
The type of change.Protobuf enum
google.firestore.v1.TargetChange.TargetChangeType-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe targets have been added.The targets reflect all changes committed before the targets were added to the stream.No change has occurred.The targets have been removed.The targets have been reset, and a new initial state for the targets will be returned in subsequent changes. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe targets have been added.static final intThe targets reflect all changes committed before the targets were added to the stream.static final intNo change has occurred.static final intThe targets have been removed.static final intThe targets have been reset, and a new initial state for the targets will be returned in subsequent changes. -
Method Summary
Modifier and TypeMethodDescriptionforNumber(int value) static final com.google.protobuf.Descriptors.EnumDescriptorfinal com.google.protobuf.Descriptors.EnumDescriptorfinal intfinal com.google.protobuf.Descriptors.EnumValueDescriptorstatic com.google.protobuf.Internal.EnumLiteMap<TargetChange.TargetChangeType>valueOf(int value) Deprecated.valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc) Returns the enum constant of this type with the specified name.Returns the enum constant of this type with the specified name.static TargetChange.TargetChangeType[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
NO_CHANGE
No change has occurred. Used only to send an updated `resume_token`.
NO_CHANGE = 0; -
ADD
The targets have been added.
ADD = 1; -
REMOVE
The targets have been removed.
REMOVE = 2; -
CURRENT
The targets reflect all changes committed before the targets were added to the stream. This will be sent after or with a `read_time` that is greater than or equal to the time at which the targets were added. Listeners can wait for this change if read-after-write semantics are desired.
CURRENT = 3; -
RESET
The targets have been reset, and a new initial state for the targets will be returned in subsequent changes. After the initial state is complete, `CURRENT` will be returned even if the target was previously indicated to be `CURRENT`.
RESET = 4; -
UNRECOGNIZED
-
-
Field Details
-
NO_CHANGE_VALUE
public static final int NO_CHANGE_VALUENo change has occurred. Used only to send an updated `resume_token`.
NO_CHANGE = 0;- See Also:
-
ADD_VALUE
public static final int ADD_VALUEThe targets have been added.
ADD = 1;- See Also:
-
REMOVE_VALUE
public static final int REMOVE_VALUEThe targets have been removed.
REMOVE = 2;- See Also:
-
CURRENT_VALUE
public static final int CURRENT_VALUEThe targets reflect all changes committed before the targets were added to the stream. This will be sent after or with a `read_time` that is greater than or equal to the time at which the targets were added. Listeners can wait for this change if read-after-write semantics are desired.
CURRENT = 3;- See Also:
-
RESET_VALUE
public static final int RESET_VALUEThe targets have been reset, and a new initial state for the targets will be returned in subsequent changes. After the initial state is complete, `CURRENT` will be returned even if the target was previously indicated to be `CURRENT`.
RESET = 4;- 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<TargetChange.TargetChangeType> 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 final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor() -
valueOf
public static TargetChange.TargetChangeType 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
-