Enum OptionState
- All Implemented Interfaces:
Serializable
,Comparable<OptionState>
The state of processing a change to an option. One of:
- RequiresIndexDocuments: The option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
- Processing: The option's latest value is in the process of being activated.
- Active: The option's latest value is fully deployed.
- FailedToValidate: The option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
-
Enum Constant Summary
Enum ConstantDescription -
Method Summary
Modifier and TypeMethodDescriptionstatic OptionState
Use this in place of valueOf to convert the raw string returned by the service into the enum value.static Set
<OptionState> toString()
static OptionState
Returns the enum constant of this type with the specified name.static OptionState[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
REQUIRES_INDEX_DOCUMENTS
-
PROCESSING
-
ACTIVE
-
FAILED_TO_VALIDATE
-
UNKNOWN_TO_SDK_VERSION
-
-
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
-
toString
- Overrides:
toString
in classEnum<OptionState>
-
fromValue
Use this in place of valueOf to convert the raw string returned by the service into the enum value.- Parameters:
value
- real value- Returns:
- OptionState corresponding to the value
-
knownValues
Use this in place ofvalues()
to return aSet
of all values known to the SDK. This will return all known enum values exceptUNKNOWN_TO_SDK_VERSION
.- Returns:
- a
Set
of knownOptionState
s
-