Enum Class IncentiveStateEnum.IncentiveState
java.lang.Object
java.lang.Enum<IncentiveStateEnum.IncentiveState>
com.google.ads.googleads.v23.enums.IncentiveStateEnum.IncentiveState
- All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite,com.google.protobuf.ProtocolMessageEnum,Serializable,Comparable<IncentiveStateEnum.IncentiveState>,Constable
- Enclosing class:
- IncentiveStateEnum
public static enum IncentiveStateEnum.IncentiveState
extends Enum<IncentiveStateEnum.IncentiveState>
implements com.google.protobuf.ProtocolMessageEnum
The possible states of a redeemed incentive.Protobuf enum
google.ads.googleads.v23.enums.IncentiveStateEnum.IncentiveState-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe incentive expired before the requirements were met.The incentive's requirements have been met but the reward has not yet been granted.The incentive was marked as invalid after redemption.The incentive has been redeemed but the requirements are not yet met.The granted reward has been fully used.The granted reward has expired.The reward for the incentive has been granted.Used for return value only.Not specified. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe incentive expired before the requirements were met.static final intThe incentive's requirements have been met but the reward has not yet been granted.static final intThe incentive was marked as invalid after redemption.static final intThe incentive has been redeemed but the requirements are not yet met.static final intThe granted reward has been fully used.static final intThe granted reward has expired.static final intThe reward for the incentive has been granted.static final intUsed for return value only.static final intNot specified. -
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<IncentiveStateEnum.IncentiveState>valueOf(int value) Deprecated.valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc) Returns the enum constant of this class with the specified name.Returns the enum constant of this class with the specified name.static IncentiveStateEnum.IncentiveState[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
UNSPECIFIED
Not specified.
UNSPECIFIED = 0; -
UNKNOWN
Used for return value only. Represents value unknown in this version.
UNKNOWN = 1; -
REDEEMED
The incentive has been redeemed but the requirements are not yet met.
REDEEMED = 2; -
FULFILLED
The incentive's requirements have been met but the reward has not yet been granted.
FULFILLED = 3; -
REWARD_GRANTED
The reward for the incentive has been granted.
REWARD_GRANTED = 4; -
EXPIRED
The incentive expired before the requirements were met.
EXPIRED = 5; -
REWARD_EXPIRED
The granted reward has expired.
REWARD_EXPIRED = 6; -
INVALIDATED
The incentive was marked as invalid after redemption.
INVALIDATED = 7; -
REWARD_EXHAUSTED
The granted reward has been fully used.
REWARD_EXHAUSTED = 8; -
UNRECOGNIZED
-
-
Field Details
-
UNSPECIFIED_VALUE
public static final int UNSPECIFIED_VALUENot specified.
UNSPECIFIED = 0;- See Also:
-
UNKNOWN_VALUE
public static final int UNKNOWN_VALUEUsed for return value only. Represents value unknown in this version.
UNKNOWN = 1;- See Also:
-
REDEEMED_VALUE
public static final int REDEEMED_VALUEThe incentive has been redeemed but the requirements are not yet met.
REDEEMED = 2;- See Also:
-
FULFILLED_VALUE
public static final int FULFILLED_VALUEThe incentive's requirements have been met but the reward has not yet been granted.
FULFILLED = 3;- See Also:
-
REWARD_GRANTED_VALUE
public static final int REWARD_GRANTED_VALUEThe reward for the incentive has been granted.
REWARD_GRANTED = 4;- See Also:
-
EXPIRED_VALUE
public static final int EXPIRED_VALUEThe incentive expired before the requirements were met.
EXPIRED = 5;- See Also:
-
REWARD_EXPIRED_VALUE
public static final int REWARD_EXPIRED_VALUEThe granted reward has expired.
REWARD_EXPIRED = 6;- See Also:
-
INVALIDATED_VALUE
public static final int INVALIDATED_VALUEThe incentive was marked as invalid after redemption.
INVALIDATED = 7;- See Also:
-
REWARD_EXHAUSTED_VALUE
public static final int REWARD_EXHAUSTED_VALUEThe granted reward has been fully used.
REWARD_EXHAUSTED = 8;- See Also:
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class 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 class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class 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<IncentiveStateEnum.IncentiveState> 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 IncentiveStateEnum.IncentiveState valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc) Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException- if the argument is null
-