Package software.amazon.awssdk.services.cloudsearch.model

Enum OptionState

java.lang.Object

java.lang.Enum<OptionState>

software.amazon.awssdk.services.cloudsearch.model.OptionState

All Implemented Interfaces:

Serializable, Comparable<OptionState>

@Generated("software.amazon.awssdk:codegen")
public enum OptionState
extends Enum<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 Constants

Enum Constant	Description
ACTIVE
FAILED_TO_VALIDATE
PROCESSING
REQUIRES_INDEX_DOCUMENTS
UNKNOWN_TO_SDK_VERSION

Method Summary

Modifier and Type	Method	Description
static OptionState	fromValue(String value)	Use this in place of valueOf to convert the raw string returned by the service into the enum value.
static Set<OptionState>	knownValues()	Use this in place of values() to return a Set of all values known to the SDK.
String	toString()
static OptionState	valueOf(String name)	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.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

REQUIRES_INDEX_DOCUMENTS

public static final OptionState REQUIRES_INDEX_DOCUMENTS

PROCESSING

public static final OptionState PROCESSING

ACTIVE

public static final OptionState ACTIVE

FAILED_TO_VALIDATE

public static final OptionState FAILED_TO_VALIDATE

UNKNOWN_TO_SDK_VERSION

public static final OptionState UNKNOWN_TO_SDK_VERSION

Method Detail

values

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

Returns:

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

valueOf

public static OptionState 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

toString

public String toString()

Overrides:

toString in class Enum<OptionState>

fromValue

public static OptionState fromValue(String value)

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

public static Set<OptionState> knownValues()

Use this in place of values() to return a Set of all values known to the SDK. This will return all known enum values except UNKNOWN_TO_SDK_VERSION.

Returns:

a Set of known OptionStates