com.amazonaws.services.kms.model

Class EncryptRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.EncryptRequest

All Implemented Interfaces:

Serializable, Cloneable

public class EncryptRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the Encrypt operation.

Encrypts plaintext into ciphertext by using a customer master key.

See Also:

AWSKMS.encrypt(EncryptRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
EncryptRequest()

Method Summary

Methods

Modifier and Type	Method and Description
EncryptRequest	addEncryptionContextEntry(String key, String value) Name:value pair that specifies the encryption context to be used for authenticated encryption.
EncryptRequest	clearEncryptionContextEntries() Removes all the entries added into EncryptionContext.
EncryptRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
Map<String,String>	getEncryptionContext() Name:value pair that specifies the encryption context to be used for authenticated encryption.
List<String>	getGrantTokens() A list of grant tokens that represent grants which can be used to provide long term permissions to perform encryption.
String	getKeyId() Unique identifier of the customer master.
ByteBuffer	getPlaintext() Data to be encrypted.
int	hashCode()
void	setEncryptionContext(Map<String,String> encryptionContext) Name:value pair that specifies the encryption context to be used for authenticated encryption.
void	setGrantTokens(Collection<String> grantTokens) A list of grant tokens that represent grants which can be used to provide long term permissions to perform encryption.
void	setKeyId(String keyId) Unique identifier of the customer master.
void	setPlaintext(ByteBuffer plaintext) Data to be encrypted.
String	toString() Returns a string representation of this object; useful for testing and debugging.
EncryptRequest	withEncryptionContext(Map<String,String> encryptionContext) Name:value pair that specifies the encryption context to be used for authenticated encryption.
EncryptRequest	withGrantTokens(Collection<String> grantTokens) A list of grant tokens that represent grants which can be used to provide long term permissions to perform encryption.
EncryptRequest	withGrantTokens(String... grantTokens) A list of grant tokens that represent grants which can be used to provide long term permissions to perform encryption.
EncryptRequest	withKeyId(String keyId) Unique identifier of the customer master.
EncryptRequest	withPlaintext(ByteBuffer plaintext) Data to be encrypted.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

EncryptRequest

public EncryptRequest()

Method Detail

getKeyId

public String getKeyId()

Unique identifier of the customer master. This can be an ARN, an alias, or the Key ID.

Constraints:
Length: 1 - 256

Returns:

Unique identifier of the customer master. This can be an ARN, an alias, or the Key ID.

setKeyId

public void setKeyId(String keyId)

Unique identifier of the customer master. This can be an ARN, an alias, or the Key ID.

Constraints:
Length: 1 - 256

Parameters:

keyId - Unique identifier of the customer master. This can be an ARN, an alias, or the Key ID.

withKeyId

public EncryptRequest withKeyId(String keyId)

Unique identifier of the customer master. This can be an ARN, an alias, or the Key ID.

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

Constraints:
Length: 1 - 256

Parameters:

keyId - Unique identifier of the customer master. This can be an ARN, an alias, or the Key ID.

Returns:

A reference to this updated object so that method calls can be chained together.

getPlaintext

public ByteBuffer getPlaintext()

Data to be encrypted.

Constraints:
Length: 1 - 4096

Returns:

Data to be encrypted.

setPlaintext

public void setPlaintext(ByteBuffer plaintext)

Data to be encrypted.

Constraints:
Length: 1 - 4096

Parameters:

plaintext - Data to be encrypted.

withPlaintext

public EncryptRequest withPlaintext(ByteBuffer plaintext)

Data to be encrypted.

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

Constraints:
Length: 1 - 4096

Parameters:

plaintext - Data to be encrypted.

Returns:

A reference to this updated object so that method calls can be chained together.

getEncryptionContext

public Map<String,String> getEncryptionContext()

Name:value pair that specifies the encryption context to be used for authenticated encryption. For more information, see Authenticated Encryption.

Returns:

Name:value pair that specifies the encryption context to be used for authenticated encryption. For more information, see Authenticated Encryption.

setEncryptionContext

public void setEncryptionContext(Map<String,String> encryptionContext)

Name:value pair that specifies the encryption context to be used for authenticated encryption. For more information, see Authenticated Encryption.

Parameters:

encryptionContext - Name:value pair that specifies the encryption context to be used for authenticated encryption. For more information, see Authenticated Encryption.

withEncryptionContext

public EncryptRequest withEncryptionContext(Map<String,String> encryptionContext)

Name:value pair that specifies the encryption context to be used for authenticated encryption. For more information, see Authenticated Encryption.

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

Parameters:

encryptionContext - Name:value pair that specifies the encryption context to be used for authenticated encryption. For more information, see Authenticated Encryption.

Returns:

A reference to this updated object so that method calls can be chained together.

addEncryptionContextEntry

public EncryptRequest addEncryptionContextEntry(String key,
                                       String value)

Name:value pair that specifies the encryption context to be used for authenticated encryption. For more information, see Authenticated Encryption.

The method adds a new key-value pair into EncryptionContext parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into EncryptionContext.

value - The corresponding value of the entry to be added into EncryptionContext.

clearEncryptionContextEntries

public EncryptRequest clearEncryptionContextEntries()

Removes all the entries added into EncryptionContext.

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

getGrantTokens

public List<String> getGrantTokens()

A list of grant tokens that represent grants which can be used to provide long term permissions to perform encryption.

Constraints:
Length: 0 - 10

Returns:

A list of grant tokens that represent grants which can be used to provide long term permissions to perform encryption.

setGrantTokens

public void setGrantTokens(Collection<String> grantTokens)

A list of grant tokens that represent grants which can be used to provide long term permissions to perform encryption.

Constraints:
Length: 0 - 10

Parameters:

grantTokens - A list of grant tokens that represent grants which can be used to provide long term permissions to perform encryption.

withGrantTokens

public EncryptRequest withGrantTokens(String... grantTokens)

A list of grant tokens that represent grants which can be used to provide long term permissions to perform encryption.

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

Constraints:
Length: 0 - 10

Parameters:

grantTokens - A list of grant tokens that represent grants which can be used to provide long term permissions to perform encryption.

Returns:

A reference to this updated object so that method calls can be chained together.

withGrantTokens

public EncryptRequest withGrantTokens(Collection<String> grantTokens)

A list of grant tokens that represent grants which can be used to provide long term permissions to perform encryption.

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

Constraints:
Length: 0 - 10

Parameters:

grantTokens - A list of grant tokens that represent grants which can be used to provide long term permissions to perform encryption.

Returns:

A reference to this updated 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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public EncryptRequest 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()