Class RenewalSummary

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

Contains information about the status of ACM's managed renewal for the certificate. This structure exists only when the certificate type is AMAZON_ISSUED.

See Also:

  • Method Details

    • renewalStatus

      public final RenewalStatus renewalStatus()

      The status of ACM's managed renewal of the certificate.

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

      Returns:
      The status of ACM's managed renewal of the certificate.
      See Also:

    • renewalStatusAsString

      public final String renewalStatusAsString()

      The status of ACM's managed renewal of the certificate.

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

      Returns:
      The status of ACM's managed renewal of the certificate.
      See Also:

    • hasDomainValidationOptions

      public final boolean hasDomainValidationOptions()
      For responses, this returns true if the service returned a value for the DomainValidationOptions 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.

    • domainValidationOptions

      public final List<DomainValidation> domainValidationOptions()

      Contains information about the validation of each domain name in the certificate, as it pertains to ACM's managed renewal. This is different from the initial validation that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED.

      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 hasDomainValidationOptions() method.

      Returns:
      Contains information about the validation of each domain name in the certificate, as it pertains to ACM's managed renewal. This is different from the initial validation that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED.

    • renewalStatusReason

      public final FailureReason renewalStatusReason()

      The reason that a renewal request was unsuccessful.

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

      Returns:
      The reason that a renewal request was unsuccessful.
      See Also:

    • renewalStatusReasonAsString

      public final String renewalStatusReasonAsString()

      The reason that a renewal request was unsuccessful.

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

      Returns:
      The reason that a renewal request was unsuccessful.
      See Also:

    • updatedAt

      public final Instant updatedAt()

      The time at which the renewal summary was last updated.

      Returns:
      The time at which the renewal summary was last updated.

    • toBuilder

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

    • builder

      public static RenewalSummary.Builder builder()

    • serializableBuilderClass

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