Class Update

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

An object representing an asynchronous update.

See Also:

  • Method Details

    • id

      public final String id()

      A UUID that is used to track the update.

      Returns:
      A UUID that is used to track the update.

    • status

      public final UpdateStatus status()

      The current status of the update.

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

      Returns:
      The current status of the update.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the update.

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

      Returns:
      The current status of the update.
      See Also:

    • type

      public final UpdateType type()

      The type of the update.

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

      Returns:
      The type of the update.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the update.

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

      Returns:
      The type of the update.
      See Also:

    • hasParams

      public final boolean hasParams()
      For responses, this returns true if the service returned a value for the Params property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • params

      public final List<UpdateParam> params()

      A key-value map that contains the parameters associated with the update.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasParams() method.

      Returns:
      A key-value map that contains the parameters associated with the update.

    • createdAt

      public final Instant createdAt()

      The Unix epoch timestamp at object creation.

      Returns:
      The Unix epoch timestamp at object creation.

    • hasErrors

      public final boolean hasErrors()
      For responses, this returns true if the service returned a value for the Errors property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • errors

      public final List<ErrorDetail> errors()

      Any errors associated with a Failed update.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasErrors() method.

      Returns:
      Any errors associated with a Failed update.

    • toBuilder

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

    • builder

      public static Update.Builder builder()

    • serializableBuilderClass

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