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

Class OptionStatus

java.lang.Object

software.amazon.awssdk.services.cloudsearch.model.OptionStatus

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<OptionStatus.Builder,OptionStatus>

@Generated("software.amazon.awssdk:codegen")
public final class OptionStatus
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<OptionStatus.Builder,OptionStatus>

The status of domain configuration option.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OptionStatus.Builder

Method Summary

Modifier and Type	Method	Description
static OptionStatus.Builder	builder()
Instant	creationDate()	A timestamp for when this option was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	pendingDeletion()	Indicates that the option will be deleted once processing is complete.
List<SdkField<?>>	sdkFields()
static Class<? extends OptionStatus.Builder>	serializableBuilderClass()
OptionState	state()	The state of processing a change to an option.
String	stateAsString()	The state of processing a change to an option.
OptionStatus.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Instant	updateDate()	A timestamp for when this option was last updated.
Integer	updateVersion()	A unique integer that indicates when this option was last updated.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

creationDate

public final Instant creationDate()

A timestamp for when this option was created.

Returns:

A timestamp for when this option was created.

updateDate

public final Instant updateDate()

A timestamp for when this option was last updated.

Returns:

A timestamp for when this option was last updated.

updateVersion

public final Integer updateVersion()

A unique integer that indicates when this option was last updated.

Returns:

A unique integer that indicates when this option was last updated.

state

public final OptionState state()

The state of processing a change to an option. Possible values:

• 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 completely 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.

If the service returns an enum value that is not available in the current SDK version, state will return OptionState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state of processing a change to an option. Possible values:

• 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 completely 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.

See Also:

OptionState

stateAsString

public final String stateAsString()

The state of processing a change to an option. Possible values:

• 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 completely 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.

If the service returns an enum value that is not available in the current SDK version, state will return OptionState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state of processing a change to an option. Possible values:

• 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 completely 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.

See Also:

OptionState

pendingDeletion

public final Boolean pendingDeletion()

Indicates that the option will be deleted once processing is complete.

Returns:

Indicates that the option will be deleted once processing is complete.

toBuilder

public OptionStatus.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<OptionStatus.Builder,OptionStatus>

builder

public static OptionStatus.Builder builder()

serializableBuilderClass

public static Class<? extends OptionStatus.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo