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:

  • Method Details

    • 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:

    • 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:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<OptionStatus.Builder,OptionStatus>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.