com.amazonaws.services.kms.model.RetireGrantRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kms Show documentation
/*
* Copyright 2011-2016 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 com.amazonaws.AmazonWebServiceRequest;
/**
*
*/
public class RetireGrantRequest extends AmazonWebServiceRequest implements
Serializable, Cloneable {
/**
*
* Token that identifies the grant to be retired.
*
*/
private String grantToken;
/**
*
* A unique identifier for the customer master key associated with the
* grant. This value can be a globally unique identifier or a fully
* specified ARN of the key.
*
*
* -
*
* Key ARN Example -
* arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234
* -1234-123456789012
*
*
* -
*
* Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
*
*
*
*/
private String keyId;
/**
*
* Unique identifier of the grant to be retired. The grant ID is returned by
* the CreateGrant function.
*
*
* -
*
* Grant ID Example -
* 0123456789012345678901234567890123456789012345678901234567890123
*
*
*
*/
private String grantId;
/**
*
* Token that identifies the grant to be retired.
*
*
* @param grantToken
* Token that identifies the grant to be retired.
*/
public void setGrantToken(String grantToken) {
this.grantToken = grantToken;
}
/**
*
* Token that identifies the grant to be retired.
*
*
* @return Token that identifies the grant to be retired.
*/
public String getGrantToken() {
return this.grantToken;
}
/**
*
* Token that identifies the grant to be retired.
*
*
* @param grantToken
* Token that identifies the grant to be retired.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public RetireGrantRequest withGrantToken(String grantToken) {
setGrantToken(grantToken);
return this;
}
/**
*
* A unique identifier for the customer master key associated with the
* grant. This value can be a globally unique identifier or a fully
* specified ARN of the key.
*
*
* -
*
* Key ARN Example -
* arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234
* -1234-123456789012
*
*
* -
*
* Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
*
*
*
*
* @param keyId
* A unique identifier for the customer master key associated with
* the grant. This value can be a globally unique identifier or a
* fully specified ARN of the key.
*
* -
*
* Key ARN Example -
* arn:aws:kms:us-east-1:123456789012:key/12345678-1234
* -1234-1234-123456789012
*
*
* -
*
* Globally Unique Key ID Example -
* 12345678-1234-1234-1234-123456789012
*
*
*/
public void setKeyId(String keyId) {
this.keyId = keyId;
}
/**
*
* A unique identifier for the customer master key associated with the
* grant. This value can be a globally unique identifier or a fully
* specified ARN of the key.
*
*
* -
*
* Key ARN Example -
* arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234
* -1234-123456789012
*
*
* -
*
* Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
*
*
*
*
* @return A unique identifier for the customer master key associated with
* the grant. This value can be a globally unique identifier or a
* fully specified ARN of the key.
*
* -
*
* Key ARN Example -
* arn:aws:kms:us-east-1:123456789012:key/12345678-
* 1234-1234-1234-123456789012
*
*
* -
*
* Globally Unique Key ID Example -
* 12345678-1234-1234-1234-123456789012
*
*
*/
public String getKeyId() {
return this.keyId;
}
/**
*
* A unique identifier for the customer master key associated with the
* grant. This value can be a globally unique identifier or a fully
* specified ARN of the key.
*
*
* -
*
* Key ARN Example -
* arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234
* -1234-123456789012
*
*
* -
*
* Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
*
*
*
*
* @param keyId
* A unique identifier for the customer master key associated with
* the grant. This value can be a globally unique identifier or a
* fully specified ARN of the key.
*
* -
*
* Key ARN Example -
* arn:aws:kms:us-east-1:123456789012:key/12345678-1234
* -1234-1234-123456789012
*
*
* -
*
* Globally Unique Key ID Example -
* 12345678-1234-1234-1234-123456789012
*
*
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public RetireGrantRequest withKeyId(String keyId) {
setKeyId(keyId);
return this;
}
/**
*
* Unique identifier of the grant to be retired. The grant ID is returned by
* the CreateGrant function.
*
*
* -
*
* Grant ID Example -
* 0123456789012345678901234567890123456789012345678901234567890123
*
*
*
*
* @param grantId
* Unique identifier of the grant to be retired. The grant ID is
* returned by the CreateGrant function.
*
* -
*
* Grant ID Example -
* 0123456789012345678901234567890123456789012345678901234567890123
*
*
*/
public void setGrantId(String grantId) {
this.grantId = grantId;
}
/**
*
* Unique identifier of the grant to be retired. The grant ID is returned by
* the CreateGrant function.
*
*
* -
*
* Grant ID Example -
* 0123456789012345678901234567890123456789012345678901234567890123
*
*
*
*
* @return Unique identifier of the grant to be retired. The grant ID is
* returned by the CreateGrant function.
*
* -
*
* Grant ID Example -
* 0123456789012345678901234567890123456789012345678901234567890123
*
*
*/
public String getGrantId() {
return this.grantId;
}
/**
*
* Unique identifier of the grant to be retired. The grant ID is returned by
* the CreateGrant function.
*
*
* -
*
* Grant ID Example -
* 0123456789012345678901234567890123456789012345678901234567890123
*
*
*
*
* @param grantId
* Unique identifier of the grant to be retired. The grant ID is
* returned by the CreateGrant function.
*
* -
*
* Grant ID Example -
* 0123456789012345678901234567890123456789012345678901234567890123
*
*
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public RetireGrantRequest withGrantId(String grantId) {
setGrantId(grantId);
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @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: " + getGrantToken() + ",");
if (getKeyId() != null)
sb.append("KeyId: " + getKeyId() + ",");
if (getGrantId() != null)
sb.append("GrantId: " + getGrantId());
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;
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());
return hashCode;
}
@Override
public RetireGrantRequest clone() {
return (RetireGrantRequest) super.clone();
}
}