Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2015 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;
 
 
Container for the parameters to the RetireGrant operation.

Retires a grant. You can retire a grant when you're done using it to clean up. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:

  • The account that created the grant
  • The RetiringPrincipal , if present
  • The GranteePrincipal , if RetireGrant is a grantee operation
The grant to retire must be identified by its grant token or by a combination of the key ARN and the grant ID. A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. Both are returned by the CreateGrant function.

 
 public class RetireGrantRequest extends AmazonWebServiceRequest implements SerializableCloneable {

    
Token that identifies the grant to be retired.

Constraints:
Length: 1 - 8192

 
     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

Constraints:
Length: 1 - 256

 
     private String keyId;

    
Unique identifier of the grant to be retired. The grant ID is returned by the CreateGrant function.
  • Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

Constraints:
Length: 1 - 128

 
     private String grantId;

    
Token that identifies the grant to be retired.

Constraints:
Length: 1 - 8192

Returns:
Token that identifies the grant to be retired.
 
     public String getGrantToken() {
         return ;
     }
    
    
Token that identifies the grant to be retired.

Constraints:
Length: 1 - 8192

Parameters:
grantToken Token that identifies the grant to be retired.
 
     public void setGrantToken(String grantToken) {
         this. = grantToken;
    }
    
    
Token that identifies the grant to be retired.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 8192

Parameters:
grantToken Token that identifies the grant to be retired.
Returns:
A reference to this updated object so that method calls can be chained together.
    public RetireGrantRequest withGrantToken(String grantToken) {
        this. = 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

Constraints:
Length: 1 - 256

Returns:
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 ;
    }
    
    
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

Constraints:
Length: 1 - 256

Parameters:
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;
    }
    
    
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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 256

Parameters:
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
Returns:
A reference to this updated object so that method calls can be chained together.
    public RetireGrantRequest withKeyId(String keyId) {
        this. = keyId;
        return this;
    }

    
Unique identifier of the grant to be retired. The grant ID is returned by the CreateGrant function.
  • Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

Constraints:
Length: 1 - 128

Returns:
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 ;
    }
    
    
Unique identifier of the grant to be retired. The grant ID is returned by the CreateGrant function.
  • Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

Constraints:
Length: 1 - 128

Parameters:
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;
    }
    
    
Unique identifier of the grant to be retired. The grant ID is returned by the CreateGrant function.
  • Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128

Parameters:
grantId Unique identifier of the grant to be retired. The grant ID is returned by the CreateGrant function.
  • Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123
Returns:
A reference to this updated object so that method calls can be chained together.
    public RetireGrantRequest withGrantId(String grantId) {
        this. = grantId;
        return this;
    }

    
Returns a string representation of this object; useful for testing and debugging.

Returns:
A string representation of this object.
See also:
java.lang.Object.toString()
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getGrantToken() != nullsb.append("GrantToken: " + getGrantToken() + ",");
        if (getKeyId() != nullsb.append("KeyId: " + getKeyId() + ",");
        if (getGrantId() != nullsb.append("GrantId: " + getGrantId() );
        sb.append("}");
        return sb.toString();
    }
    
    @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 boolean equals(Object obj) {
        if (this == objreturn true;
        if (obj == nullreturn false;
        if (obj instanceof RetireGrantRequest == falsereturn false;
        RetireGrantRequest other = (RetireGrantRequest)obj;
        
        if (other.getGrantToken() == null ^ this.getGrantToken() == nullreturn false;
        if (other.getGrantToken() != null && other.getGrantToken().equals(this.getGrantToken()) == falsereturn false
        if (other.getKeyId() == null ^ this.getKeyId() == nullreturn false;
        if (other.getKeyId() != null && other.getKeyId().equals(this.getKeyId()) == falsereturn false
        if (other.getGrantId() == null ^ this.getGrantId() == nullreturn false;
        if (other.getGrantId() != null && other.getGrantId().equals(this.getGrantId()) == falsereturn false
        return true;
    }
    
    @Override
    public RetireGrantRequest clone() {
        
            return (RetireGrantRequestsuper.clone();
    }
}
    
New to GrepCode? Check out our FAQ X