software.amazon.awssdk.services.kms.model

Class ScheduleKeyDeletionResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.kms.model.KmsResponse

software.amazon.awssdk.services.kms.model.ScheduleKeyDeletionResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ScheduleKeyDeletionResponse.Builder,ScheduleKeyDeletionResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class ScheduleKeyDeletionResponse
extends KmsResponse
implements ToCopyableBuilder<ScheduleKeyDeletionResponse.Builder,ScheduleKeyDeletionResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ScheduleKeyDeletionResponse.Builder

Method Summary

Modifier and Type	Method and Description
static ScheduleKeyDeletionResponse.Builder	builder()
Instant	deletionDate() The date and time after which KMS deletes the KMS key.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	keyId() The Amazon Resource Name (key ARN) of the KMS key whose deletion is scheduled.
KeyState	keyState() The current status of the KMS key.
String	keyStateAsString() The current status of the KMS key.
Integer	pendingWindowInDays() The waiting period before the KMS key is deleted.
List<SdkField<?>>	sdkFields()
static Class<? extends ScheduleKeyDeletionResponse.Builder>	serializableBuilderClass()
ScheduleKeyDeletionResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.kms.model.KmsResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

keyId

public final String keyId()

The Amazon Resource Name (key ARN) of the KMS key whose deletion is scheduled.

Returns:

The Amazon Resource Name (key ARN) of the KMS key whose deletion is scheduled.

deletionDate

public final Instant deletionDate()

The date and time after which KMS deletes the KMS key.

If the KMS key is a multi-Region primary key with replica keys, this field does not appear. The deletion date for the primary key isn't known until its last replica key is deleted.

Returns:

The date and time after which KMS deletes the KMS key.

If the KMS key is a multi-Region primary key with replica keys, this field does not appear. The deletion date for the primary key isn't known until its last replica key is deleted.

keyState

public final KeyState keyState()

The current status of the KMS key.

For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.

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

Returns:

The current status of the KMS key.

For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.

See Also:

KeyState

keyStateAsString

public final String keyStateAsString()

The current status of the KMS key.

For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.

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

Returns:

The current status of the KMS key.

For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.

See Also:

KeyState

pendingWindowInDays

public final Integer pendingWindowInDays()

The waiting period before the KMS key is deleted.

If the KMS key is a multi-Region primary key with replicas, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.

Returns:

The waiting period before the KMS key is deleted.

If the KMS key is a multi-Region primary key with replicas, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.

toBuilder

public ScheduleKeyDeletionResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ScheduleKeyDeletionResponse.Builder,ScheduleKeyDeletionResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static ScheduleKeyDeletionResponse.Builder builder()

serializableBuilderClass

public static Class<? extends ScheduleKeyDeletionResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo