Class RetireGrantRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.RetireGrantRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class RetireGrantRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

• Serialized Form

Field Summary

Fields inherited from class AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor	Description
RetireGrantRequest()

Method Summary

Modifier and Type	Method	Description
RetireGrantRequest	clone()	Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getGrantId()	Unique identifier of the grant to be retired.
String	getGrantToken()	Token that identifies the grant to be retired.
String	getKeyId()	A unique identifier for the customer master key associated with the grant.
int	hashCode()
void	setGrantId(String grantId)	Unique identifier of the grant to be retired.
void	setGrantToken(String grantToken)	Token that identifies the grant to be retired.
void	setKeyId(String keyId)	A unique identifier for the customer master key associated with the grant.
String	toString()	Returns a string representation of this object; useful for testing and debugging.
RetireGrantRequest	withGrantId(String grantId)	Unique identifier of the grant to be retired.
RetireGrantRequest	withGrantToken(String grantToken)	Token that identifies the grant to be retired.
RetireGrantRequest	withKeyId(String keyId)	A unique identifier for the customer master key associated with the grant.

Methods inherited from class AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RetireGrantRequest

public RetireGrantRequest()

Method Details

setGrantToken

public void setGrantToken(String grantToken)

Token that identifies the grant to be retired.

Parameters:

grantToken - Token that identifies the grant to be retired.

getGrantToken

public String getGrantToken()

Token that identifies the grant to be retired.

Returns:

Token that identifies the grant to be retired.

withGrantToken

public RetireGrantRequest withGrantToken(String grantToken)

Token that identifies the grant to be retired.

Parameters:

grantToken - Token that identifies the grant to be retired.

Returns:

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

setKeyId

public void setKeyId(String 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

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

getKeyId

public String getKeyId()

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 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

withKeyId

public RetireGrantRequest withKeyId(String 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

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:

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

setGrantId

public void setGrantId(String grantId)

Unique identifier of the grant to be retired. The grant ID is returned by the CreateGrant function.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

Parameters:

grantId - Unique identifier of the grant to be retired. The grant ID is returned by the CreateGrant function.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

getGrantId

public String getGrantId()

Unique identifier of the grant to be retired. The grant ID is returned by the CreateGrant function.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

Returns:

Unique identifier of the grant to be retired. The grant ID is returned by the CreateGrant function.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

withGrantId

public RetireGrantRequest withGrantId(String grantId)

Unique identifier of the grant to be retired. The grant ID is returned by the CreateGrant function.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

Parameters:

grantId - Unique identifier of the grant to be retired. The grant ID is returned by the CreateGrant function.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

Returns:

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

toString

public String toString()

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

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

• Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public RetireGrantRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

• Object.clone()