GenerateDataKeyWithoutPlaintextRequest (AWS Java SDK for AWS KMS 1.9.22 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.kms.model.GenerateDataKeyWithoutPlaintextRequest

All Implemented Interfaces:

Serializable
```
public class GenerateDataKeyWithoutPlaintextRequest
extends AmazonWebServiceRequest
implements Serializable
```
Container for the parameters to the GenerateDataKeyWithoutPlaintext operation.
Returns a key wrapped by a customer master key without the plaintext copy of that key. To retrieve the plaintext, see GenerateDataKey.

See Also:
AWSKMS.generateDataKeyWithoutPlaintext(GenerateDataKeyWithoutPlaintextRequest), Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

GenerateDataKeyWithoutPlaintextRequest()

Constructors
Constructor and Description
`GenerateDataKeyWithoutPlaintextRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`GenerateDataKeyWithoutPlaintextRequest`	`addEncryptionContextEntry(String key, String value)` Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.
`GenerateDataKeyWithoutPlaintextRequest`	`clearEncryptionContextEntries()` Removes all the entries added into EncryptionContext.
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getEncryptionContext()` Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.
`List<String>`	`getGrantTokens()` A list of grant tokens that represent grants which can be used to provide long term permissions to generate a key.
`String`	`getKeyId()` Unique identifier of the key.
`String`	`getKeySpec()` Value that identifies the encryption algorithm and key size.
`Integer`	`getNumberOfBytes()` Integer that contains the number of bytes to generate.
`int`	`hashCode()`
`void`	`setEncryptionContext(Map<String,String> encryptionContext)` Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.
`void`	`setGrantTokens(Collection<String> grantTokens)` A list of grant tokens that represent grants which can be used to provide long term permissions to generate a key.
`void`	`setKeyId(String keyId)` Unique identifier of the key.
`void`	`setKeySpec(DataKeySpec keySpec)` Value that identifies the encryption algorithm and key size.
`void`	`setKeySpec(String keySpec)` Value that identifies the encryption algorithm and key size.
`void`	`setNumberOfBytes(Integer numberOfBytes)` Integer that contains the number of bytes to generate.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`GenerateDataKeyWithoutPlaintextRequest`	`withEncryptionContext(Map<String,String> encryptionContext)` Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.
`GenerateDataKeyWithoutPlaintextRequest`	`withGrantTokens(Collection<String> grantTokens)` A list of grant tokens that represent grants which can be used to provide long term permissions to generate a key.
`GenerateDataKeyWithoutPlaintextRequest`	`withGrantTokens(String... grantTokens)` A list of grant tokens that represent grants which can be used to provide long term permissions to generate a key.
`GenerateDataKeyWithoutPlaintextRequest`	`withKeyId(String keyId)` Unique identifier of the key.
`GenerateDataKeyWithoutPlaintextRequest`	`withKeySpec(DataKeySpec keySpec)` Value that identifies the encryption algorithm and key size.
`GenerateDataKeyWithoutPlaintextRequest`	`withKeySpec(String keySpec)` Value that identifies the encryption algorithm and key size.
`GenerateDataKeyWithoutPlaintextRequest`	`withNumberOfBytes(Integer numberOfBytes)` Integer that contains the number of bytes to generate.

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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GenerateDataKeyWithoutPlaintextRequest
```
public GenerateDataKeyWithoutPlaintextRequest()
```
- Method Detail
  - getKeyId
```
public String getKeyId()
```
    Unique identifier of the key. This can be an ARN, an alias, or a globally unique identifier.
    Constraints:
    Length: 1 - 256
    
    Returns:
    Unique identifier of the key. This can be an ARN, an alias, or a globally unique identifier.
  - setKeyId
```
public void setKeyId(String keyId)
```
    Unique identifier of the key. This can be an ARN, an alias, or a globally unique identifier.
    Constraints:
    Length: 1 - 256
    
    Parameters:
    keyId - Unique identifier of the key. This can be an ARN, an alias, or a globally unique identifier.
  - withKeyId
```
public GenerateDataKeyWithoutPlaintextRequest withKeyId(String keyId)
```
    Unique identifier of the key. This can be an ARN, an alias, or a globally unique identifier.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 256
    
    Parameters:
    keyId - Unique identifier of the key. This can be an ARN, an alias, or a globally unique identifier.
    
    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 contains additional data to be authenticated during the encryption and decryption processes.
    
    Returns:
    Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.
  - setEncryptionContext
```
public void setEncryptionContext(Map<String,String> encryptionContext)
```
    Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.
    
    Parameters:
    encryptionContext - Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.
  - withEncryptionContext
```
public GenerateDataKeyWithoutPlaintextRequest withEncryptionContext(Map<String,String> encryptionContext)
```
    Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    encryptionContext - Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - addEncryptionContextEntry
```
public GenerateDataKeyWithoutPlaintextRequest addEncryptionContextEntry(String key,
                                                               String value)
```
    Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.
    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 GenerateDataKeyWithoutPlaintextRequest clearEncryptionContextEntries()
```
    Removes all the entries added into EncryptionContext.
    Returns a reference to this object so that method calls can be chained together.
  - getKeySpec
```
public String getKeySpec()
```
    Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.
    Constraints:
    Allowed Values: AES_256, AES_128
    
    Returns:
    Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.
    See Also:
    DataKeySpec
  - setKeySpec
```
public void setKeySpec(String keySpec)
```
    Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.
    Constraints:
    Allowed Values: AES_256, AES_128
    
    Parameters:
    keySpec - Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.
    See Also:
    DataKeySpec
  - withKeySpec
```
public GenerateDataKeyWithoutPlaintextRequest withKeySpec(String keySpec)
```
    Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: AES_256, AES_128
    
    Parameters:
    keySpec - Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    DataKeySpec
  - setKeySpec
```
public void setKeySpec(DataKeySpec keySpec)
```
    Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.
    Constraints:
    Allowed Values: AES_256, AES_128
    
    Parameters:
    keySpec - Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.
    See Also:
    DataKeySpec
  - withKeySpec
```
public GenerateDataKeyWithoutPlaintextRequest withKeySpec(DataKeySpec keySpec)
```
    Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: AES_256, AES_128
    
    Parameters:
    keySpec - Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    DataKeySpec
  - getNumberOfBytes
```
public Integer getNumberOfBytes()
```
    Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on.
    Constraints:
    Range: 1 - 1024
    
    Returns:
    Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on.
  - setNumberOfBytes
```
public void setNumberOfBytes(Integer numberOfBytes)
```
    Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on.
    Constraints:
    Range: 1 - 1024
    
    Parameters:
    numberOfBytes - Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on.
  - withNumberOfBytes
```
public GenerateDataKeyWithoutPlaintextRequest withNumberOfBytes(Integer numberOfBytes)
```
    Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 1 - 1024
    
    Parameters:
    numberOfBytes - Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on.
    
    Returns:
    A reference to this updated 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 generate a key.
    Constraints:
    Length: 0 - 10
    
    Returns:
    A list of grant tokens that represent grants which can be used to provide long term permissions to generate a key.
  - 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 generate a key.
    Constraints:
    Length: 0 - 10
    
    Parameters:
    grantTokens - A list of grant tokens that represent grants which can be used to provide long term permissions to generate a key.
  - withGrantTokens
```
public GenerateDataKeyWithoutPlaintextRequest withGrantTokens(String... grantTokens)
```
    A list of grant tokens that represent grants which can be used to provide long term permissions to generate a key.
    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 generate a key.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withGrantTokens
```
public GenerateDataKeyWithoutPlaintextRequest withGrantTokens(Collection<String> grantTokens)
```
    A list of grant tokens that represent grants which can be used to provide long term permissions to generate a key.
    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 generate a key.
    
    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

Class GenerateDataKeyWithoutPlaintextRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

GenerateDataKeyWithoutPlaintextRequest

Method Detail

getKeyId

setKeyId

withKeyId

getEncryptionContext

setEncryptionContext

withEncryptionContext

addEncryptionContextEntry

clearEncryptionContextEntries

getKeySpec

setKeySpec

withKeySpec

setKeySpec

withKeySpec

getNumberOfBytes

setNumberOfBytes

withNumberOfBytes

getGrantTokens

setGrantTokens

withGrantTokens

withGrantTokens

toString

hashCode

equals