software.amazon.awssdk.services.acm.model

Class RenewalSummary

java.lang.Object

software.amazon.awssdk.services.acm.model.RenewalSummary

All Implemented Interfaces:

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

@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RenewalSummary.Builder

Method Summary

Modifier and Type	Method and Description
static RenewalSummary.Builder	builder()
List<DomainValidation>	domainValidationOptions() Contains information about the validation of each domain name in the certificate, as it pertains to ACM's managed renewal.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDomainValidationOptions() For responses, this returns true if the service returned a value for the DomainValidationOptions property.
int	hashCode()
RenewalStatus	renewalStatus() The status of ACM's managed renewal of the certificate.
String	renewalStatusAsString() The status of ACM's managed renewal of the certificate.
FailureReason	renewalStatusReason() The reason that a renewal request was unsuccessful.
String	renewalStatusReasonAsString() The reason that a renewal request was unsuccessful.
List<SdkField<?>>	sdkFields()
static Class<? extends RenewalSummary.Builder>	serializableBuilderClass()
RenewalSummary.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Instant	updatedAt() The time at which the renewal summary 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

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:

RenewalStatus

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:

RenewalStatus

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:

FailureReason

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:

FailureReason

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()

Specified by:

toBuilder in interface ToCopyableBuilder<RenewalSummary.Builder,RenewalSummary>

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)

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