Class ChangeProgressDetails

java.lang.Object
software.amazon.awssdk.services.opensearch.model.ChangeProgressDetails
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ChangeProgressDetails.Builder,ChangeProgressDetails>
@Generated("software.amazon.awssdk:codegen") public final class ChangeProgressDetails extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ChangeProgressDetails.Builder,ChangeProgressDetails>

Container for information about a configuration change happening on a domain.

See Also:

  • Method Details

    • changeId

      public final String changeId()

      The ID of the configuration change.

      Returns:
      The ID of the configuration change.

    • message

      public final String message()

      A message corresponding to the status of the configuration change.

      Returns:
      A message corresponding to the status of the configuration change.

    • configChangeStatus

      public final ConfigChangeStatus configChangeStatus()

      The current status of the configuration change.

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

      Returns:
      The current status of the configuration change.
      See Also:

    • configChangeStatusAsString

      public final String configChangeStatusAsString()

      The current status of the configuration change.

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

      Returns:
      The current status of the configuration change.
      See Also:

    • initiatedBy

      public final InitiatedBy initiatedBy()

      The IAM principal who initiated the configuration change.

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

      Returns:
      The IAM principal who initiated the configuration change.
      See Also:

    • initiatedByAsString

      public final String initiatedByAsString()

      The IAM principal who initiated the configuration change.

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

      Returns:
      The IAM principal who initiated the configuration change.
      See Also:

    • startTime

      public final Instant startTime()

      The time that the configuration change was initiated, in Universal Coordinated Time (UTC).

      Returns:
      The time that the configuration change was initiated, in Universal Coordinated Time (UTC).

    • lastUpdatedTime

      public final Instant lastUpdatedTime()

      The last time that the configuration change was updated.

      Returns:
      The last time that the configuration change was updated.

    • toBuilder

      public ChangeProgressDetails.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<ChangeProgressDetails.Builder,ChangeProgressDetails>
      Returns:
      a builder for type T

    • builder

      public static ChangeProgressDetails.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ChangeProgressDetails.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.