com.amazonaws.services.kms.model.ScheduleKeyDeletionResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kms Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.kms.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ScheduleKeyDeletionResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The Amazon Resource Name (key ARN) of the KMS
* key whose deletion is scheduled.
*
*/
private String keyId;
/**
*
* 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.
*
*/
private java.util.Date deletionDate;
/**
*
* 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.
*
*/
private String keyState;
/**
*
* 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.
*
*/
private Integer pendingWindowInDays;
/**
*
* The Amazon Resource Name (key ARN) of the KMS
* key whose deletion is scheduled.
*
*
* @param keyId
* The Amazon Resource Name (key ARN) of
* the KMS key whose deletion is scheduled.
*/
public void setKeyId(String keyId) {
this.keyId = keyId;
}
/**
*
* The Amazon Resource Name (key ARN) of the KMS
* key whose deletion is scheduled.
*
*
* @return The Amazon Resource Name (key ARN) of
* the KMS key whose deletion is scheduled.
*/
public String getKeyId() {
return this.keyId;
}
/**
*
* The Amazon Resource Name (key ARN) of the KMS
* key whose deletion is scheduled.
*
*
* @param keyId
* The Amazon Resource Name (key ARN) of
* the KMS key whose deletion is scheduled.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ScheduleKeyDeletionResult withKeyId(String keyId) {
setKeyId(keyId);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setDeletionDate(java.util.Date deletionDate) {
this.deletionDate = 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.
*
*
* @return 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.
*/
public java.util.Date getDeletionDate() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ScheduleKeyDeletionResult withDeletionDate(java.util.Date deletionDate) {
setDeletionDate(deletionDate);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @see KeyState
*/
public void setKeyState(String keyState) {
this.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.
*
*
* @return 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 KeyState
*/
public String getKeyState() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see KeyState
*/
public ScheduleKeyDeletionResult withKeyState(String keyState) {
setKeyState(keyState);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see KeyState
*/
public ScheduleKeyDeletionResult withKeyState(KeyState keyState) {
this.keyState = keyState.toString();
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setPendingWindowInDays(Integer pendingWindowInDays) {
this.pendingWindowInDays = 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.
*
*
* @return 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.
*/
public Integer getPendingWindowInDays() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ScheduleKeyDeletionResult withPendingWindowInDays(Integer pendingWindowInDays) {
setPendingWindowInDays(pendingWindowInDays);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getKeyId() != null)
sb.append("KeyId: ").append(getKeyId()).append(",");
if (getDeletionDate() != null)
sb.append("DeletionDate: ").append(getDeletionDate()).append(",");
if (getKeyState() != null)
sb.append("KeyState: ").append(getKeyState()).append(",");
if (getPendingWindowInDays() != null)
sb.append("PendingWindowInDays: ").append(getPendingWindowInDays());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ScheduleKeyDeletionResult == false)
return false;
ScheduleKeyDeletionResult other = (ScheduleKeyDeletionResult) obj;
if (other.getKeyId() == null ^ this.getKeyId() == null)
return false;
if (other.getKeyId() != null && other.getKeyId().equals(this.getKeyId()) == false)
return false;
if (other.getDeletionDate() == null ^ this.getDeletionDate() == null)
return false;
if (other.getDeletionDate() != null && other.getDeletionDate().equals(this.getDeletionDate()) == false)
return false;
if (other.getKeyState() == null ^ this.getKeyState() == null)
return false;
if (other.getKeyState() != null && other.getKeyState().equals(this.getKeyState()) == false)
return false;
if (other.getPendingWindowInDays() == null ^ this.getPendingWindowInDays() == null)
return false;
if (other.getPendingWindowInDays() != null && other.getPendingWindowInDays().equals(this.getPendingWindowInDays()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getKeyId() == null) ? 0 : getKeyId().hashCode());
hashCode = prime * hashCode + ((getDeletionDate() == null) ? 0 : getDeletionDate().hashCode());
hashCode = prime * hashCode + ((getKeyState() == null) ? 0 : getKeyState().hashCode());
hashCode = prime * hashCode + ((getPendingWindowInDays() == null) ? 0 : getPendingWindowInDays().hashCode());
return hashCode;
}
@Override
public ScheduleKeyDeletionResult clone() {
try {
return (ScheduleKeyDeletionResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}