GenerateDataKeyWithoutPlaintextRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.kms.model.KmsRequest
    - - software.amazon.awssdk.services.kms.model.GenerateDataKeyWithoutPlaintextRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GenerateDataKeyWithoutPlaintextRequest.Builder,GenerateDataKeyWithoutPlaintextRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GenerateDataKeyWithoutPlaintextRequest
extends KmsRequest
implements ToCopyableBuilder<GenerateDataKeyWithoutPlaintextRequest.Builder,GenerateDataKeyWithoutPlaintextRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GenerateDataKeyWithoutPlaintextRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GenerateDataKeyWithoutPlaintextRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GenerateDataKeyWithoutPlaintextRequest.Builder`	`builder()`
`Map<String,String>`	`encryptionContext()` Specifies the encryption context that will be used when encrypting the data key.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`List<String>`	`grantTokens()` A list of grant tokens.
`boolean`	`hasEncryptionContext()` Returns true if the EncryptionContext property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasGrantTokens()` Returns true if the GrantTokens property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`String`	`keyId()` The identifier of the symmetric customer master key (CMK) that encrypts the data key.
`DataKeySpec`	`keySpec()` The length of the data key.
`String`	`keySpecAsString()` The length of the data key.
`Integer`	`numberOfBytes()` The length of the data key in bytes.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GenerateDataKeyWithoutPlaintextRequest.Builder>`	`serializableBuilderClass()`
`GenerateDataKeyWithoutPlaintextRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - keyId
```
public final String keyId()
```
    The identifier of the symmetric customer master key (CMK) that encrypts the data key.
    
    To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
    
    For example:
    - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    - Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    - Alias name: alias/ExampleAlias
    - Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
    Returns:
    The identifier of the symmetric customer master key (CMK) that encrypts the data key.
    
    To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
    
    For example:
    
    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    
    Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    
    Alias name: alias/ExampleAlias
    
    Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
    
    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
  - hasEncryptionContext
```
public final boolean hasEncryptionContext()
```
    Returns true if the EncryptionContext property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - encryptionContext
```
public final Map<String,String> encryptionContext()
```
    Specifies the encryption context that will be used when encrypting the data key.
    
    An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
    
    For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasEncryptionContext() to see if a value was sent in this field.
    
    Returns:
    
    Specifies the encryption context that will be used when encrypting the data key.
    
    An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
    
    For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
  - keySpec
```
public final DataKeySpec keySpec()
```
    The length of the data key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.
    
    If the service returns an enum value that is not available in the current SDK version, keySpec will return DataKeySpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keySpecAsString().
    
    Returns:
    
    The length of the data key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.
    
    See Also:
    
    DataKeySpec
  - keySpecAsString
```
public final String keySpecAsString()
```
    The length of the data key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.
    
    If the service returns an enum value that is not available in the current SDK version, keySpec will return DataKeySpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keySpecAsString().
    
    Returns:
    
    The length of the data key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.
    
    See Also:
    
    DataKeySpec
  - numberOfBytes
```
public final Integer numberOfBytes()
```
    The length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the KeySpec field instead of this one.
    
    Returns:
    
    The length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the KeySpec field instead of this one.
  - hasGrantTokens
```
public final boolean hasGrantTokens()
```
    Returns true if the GrantTokens property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - grantTokens
```
public final List<String> grantTokens()
```
    A list of grant tokens.
    
    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasGrantTokens() to see if a value was sent in this field.
    
    Returns:
    
    A list of grant tokens.
    
    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
  - toBuilder
```
public GenerateDataKeyWithoutPlaintextRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GenerateDataKeyWithoutPlaintextRequest.Builder,GenerateDataKeyWithoutPlaintextRequest>
    
    Specified by:
    
    toBuilder in class KmsRequest
  - builder
```
public static GenerateDataKeyWithoutPlaintextRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GenerateDataKeyWithoutPlaintextRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class GenerateDataKeyWithoutPlaintextRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

keyId

hasEncryptionContext

encryptionContext

keySpec

keySpecAsString

numberOfBytes

hasGrantTokens

grantTokens

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields