/* * Copyright 2018-2023 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; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class RetireGrantRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved * eventual consistency. *

* Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual * consistency in the Key Management Service Developer Guide. *

*/ private String grantToken; /** *

* The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation. *

* For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab *

*/ private String keyId; /** *

* Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or * ListRetirableGrants. *

*
* Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123 *
*

*/ private String grantId; /** *

* Checks if your request will succeed. DryRun is an optional parameter. *

* To learn more about how to use this parameter, see Testing your KMS API * calls in the Key Management Service Developer Guide. *

*/ private Boolean dryRun; /** *

* Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved * eventual consistency. *

* Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual * consistency in the Key Management Service Developer Guide. *

* * @param grantToken * Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has * achieved eventual consistency.

* Only the CreateGrant operation returns a grant token. For details, see Grant token and * * Eventual consistency in the Key Management Service Developer Guide. */ public void setGrantToken(String grantToken) { this.grantToken = grantToken; } /** *

* Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved * eventual consistency. *

* Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual * consistency in the Key Management Service Developer Guide. *

* * @return Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has * achieved eventual consistency.

* Only the CreateGrant operation returns a grant token. For details, see Grant token and * * Eventual consistency in the Key Management Service Developer Guide. */ public String getGrantToken() { return this.grantToken; } /** *

* Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved * eventual consistency. *

* Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual * consistency in the Key Management Service Developer Guide. *

* * @param grantToken * Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has * achieved eventual consistency.

* Only the CreateGrant operation returns a grant token. For details, see Grant token and * * Eventual consistency in the Key Management Service Developer Guide. * @return Returns a reference to this object so that method calls can be chained together. */ public RetireGrantRequest withGrantToken(String grantToken) { setGrantToken(grantToken); return this; } /** *

* The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation. *

* For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab *

* * @param keyId * The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.

* For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab */ public void setKeyId(String keyId) { this.keyId = keyId; } /** *

* The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation. *

* For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab *

* * @return The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys * operation.

* For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab */ public String getKeyId() { return this.keyId; } /** *

* The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation. *

* For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab *

* * @param keyId * The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.

* For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab * @return Returns a reference to this object so that method calls can be chained together. */ public RetireGrantRequest withKeyId(String keyId) { setKeyId(keyId); return this; } /** *

* Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or * ListRetirableGrants. *

*
* Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123 *
*

* * @param grantId * Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or * ListRetirableGrants.

*
* Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123 *
*

* Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or * ListRetirableGrants. *

*
* Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123 *
*

CreateGrant

ListGrants

ListRetirableGrants

*
* Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123 *
*

* Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or * ListRetirableGrants. *

*
* Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123 *
*

CreateGrant

ListGrants

ListRetirableGrants

*
* Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123 *
*

* Checks if your request will succeed. DryRun is an optional parameter. *

* To learn more about how to use this parameter, see Testing your KMS API * calls in the Key Management Service Developer Guide. *

DryRun

* To learn more about how to use this parameter, see Testing your KMS API * calls in the Key Management Service Developer Guide. */ public void setDryRun(Boolean dryRun) { this.dryRun = dryRun; } /** *

* Checks if your request will succeed. DryRun is an optional parameter. *

* To learn more about how to use this parameter, see Testing your KMS API * calls in the Key Management Service Developer Guide. *

DryRun

* To learn more about how to use this parameter, see Testing your KMS API * calls in the Key Management Service Developer Guide. */ public Boolean getDryRun() { return this.dryRun; } /** *

* Checks if your request will succeed. DryRun is an optional parameter. *

* To learn more about how to use this parameter, see Testing your KMS API * calls in the Key Management Service Developer Guide. *

DryRun

* To learn more about how to use this parameter, see Testing your KMS API * calls in the Key Management Service Developer Guide. * @return Returns a reference to this object so that method calls can be chained together. */ public RetireGrantRequest withDryRun(Boolean dryRun) { setDryRun(dryRun); return this; } /** *

* Checks if your request will succeed. DryRun is an optional parameter. *

* To learn more about how to use this parameter, see Testing your KMS API * calls in the Key Management Service Developer Guide. *

DryRun

* To learn more about how to use this parameter, see Testing your KMS API * calls in the Key Management Service Developer Guide. */ public Boolean isDryRun() { return this.dryRun; } /** * 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 (getGrantToken() != null) sb.append("GrantToken: ").append(getGrantToken()).append(","); if (getKeyId() != null) sb.append("KeyId: ").append(getKeyId()).append(","); if (getGrantId() != null) sb.append("GrantId: ").append(getGrantId()).append(","); if (getDryRun() != null) sb.append("DryRun: ").append(getDryRun()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof RetireGrantRequest == false) return false; RetireGrantRequest other = (RetireGrantRequest) obj; if (other.getGrantToken() == null ^ this.getGrantToken() == null) return false; if (other.getGrantToken() != null && other.getGrantToken().equals(this.getGrantToken()) == false) return false; if (other.getKeyId() == null ^ this.getKeyId() == null) return false; if (other.getKeyId() != null && other.getKeyId().equals(this.getKeyId()) == false) return false; if (other.getGrantId() == null ^ this.getGrantId() == null) return false; if (other.getGrantId() != null && other.getGrantId().equals(this.getGrantId()) == false) return false; if (other.getDryRun() == null ^ this.getDryRun() == null) return false; if (other.getDryRun() != null && other.getDryRun().equals(this.getDryRun()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getGrantToken() == null) ? 0 : getGrantToken().hashCode()); hashCode = prime * hashCode + ((getKeyId() == null) ? 0 : getKeyId().hashCode()); hashCode = prime * hashCode + ((getGrantId() == null) ? 0 : getGrantId().hashCode()); hashCode = prime * hashCode + ((getDryRun() == null) ? 0 : getDryRun().hashCode()); return hashCode; } @Override public RetireGrantRequest clone() { return (RetireGrantRequest) super.clone(); } }