ReEncryptRequest (AWS SDK for Java

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

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ReEncryptRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ReEncryptRequest.Builder`	`builder()`
`SdkBytes`	`ciphertextBlob()` Ciphertext of the data to reencrypt.
`EncryptionAlgorithmSpec`	`destinationEncryptionAlgorithm()` Specifies the encryption algorithm that KMS will use to reecrypt the data after it has decrypted it.
`String`	`destinationEncryptionAlgorithmAsString()` Specifies the encryption algorithm that KMS will use to reecrypt the data after it has decrypted it.
`Map<String,String>`	`destinationEncryptionContext()` Specifies that encryption context to use when the reencrypting the data.
`String`	`destinationKeyId()` A unique identifier for the KMS key that is used to reencrypt the data.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`List<String>`	`grantTokens()` A list of grant tokens.
`boolean`	`hasDestinationEncryptionContext()` For responses, this returns true if the service returned a value for the DestinationEncryptionContext property.
`boolean`	`hasGrantTokens()` For responses, this returns true if the service returned a value for the GrantTokens property.
`int`	`hashCode()`
`boolean`	`hasSourceEncryptionContext()` For responses, this returns true if the service returned a value for the SourceEncryptionContext property.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ReEncryptRequest.Builder>`	`serializableBuilderClass()`
`EncryptionAlgorithmSpec`	`sourceEncryptionAlgorithm()` Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it is reencrypted.
`String`	`sourceEncryptionAlgorithmAsString()` Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it is reencrypted.
`Map<String,String>`	`sourceEncryptionContext()` Specifies the encryption context to use to decrypt the ciphertext.
`String`	`sourceKeyId()` Specifies the KMS key that KMS will use to decrypt the ciphertext before it is re-encrypted.
`ReEncryptRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`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
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - ciphertextBlob
```
public final SdkBytes ciphertextBlob()
```
    Ciphertext of the data to reencrypt.
    
    Returns:
    
    Ciphertext of the data to reencrypt.
  - hasSourceEncryptionContext
```
public final boolean hasSourceEncryptionContext()
```
    For responses, this returns true if the service returned a value for the SourceEncryptionContext property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - sourceEncryptionContext
```
public final Map<String,String> sourceEncryptionContext()
```
    Specifies the encryption context to use to decrypt the ciphertext. Enter the same encryption context that was used to encrypt the ciphertext.
    
    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 KMS key, but it is highly recommended.
    
    For more information, see Encryption Context in the Key Management Service Developer Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSourceEncryptionContext() method.
    
    Returns:
    
    Specifies the encryption context to use to decrypt the ciphertext. Enter the same encryption context that was used to encrypt the ciphertext.
    
    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 KMS key, but it is highly recommended.
    
    For more information, see Encryption Context in the Key Management Service Developer Guide.
  - sourceKeyId
```
public final String sourceKeyId()
```
    Specifies the KMS key that KMS will use to decrypt the ciphertext before it is re-encrypted. Enter a key ID of the KMS key that was used to encrypt the ciphertext.
    
    This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. If you used a symmetric KMS key, KMS can get the KMS key from metadata that it adds to the symmetric ciphertext blob. However, it is always recommended as a best practice. This practice ensures that you use the KMS key that you intend.
    
    To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
    Returns:
    Specifies the KMS key that KMS will use to decrypt the ciphertext before it is re-encrypted. Enter a key ID of the KMS key that was used to encrypt the ciphertext.
    
    This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. If you used a symmetric KMS key, KMS can get the KMS key from metadata that it adds to the symmetric ciphertext blob. However, it is always recommended as a best practice. This practice ensures that you use the KMS key that you intend.
    
    To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
  - destinationKeyId
```
public final String destinationKeyId()
```
    A unique identifier for the KMS key that is used to reencrypt the data. Specify a symmetric or asymmetric KMS key with a KeyUsage value of ENCRYPT_DECRYPT. To find the KeyUsage value of a KMS key, use the DescribeKey operation.
    
    To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
    Returns:
    A unique identifier for the KMS key that is used to reencrypt the data. Specify a symmetric or asymmetric KMS key with a KeyUsage value of ENCRYPT_DECRYPT. To find the KeyUsage value of a KMS key, use the DescribeKey operation.
    
    To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
  - hasDestinationEncryptionContext
```
public final boolean hasDestinationEncryptionContext()
```
    For responses, this returns true if the service returned a value for the DestinationEncryptionContext property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - destinationEncryptionContext
```
public final Map<String,String> destinationEncryptionContext()
```
    Specifies that encryption context to use when the reencrypting the data.
    
    A destination encryption context is valid only when the destination KMS key is a symmetric KMS key. The standard ciphertext format for asymmetric KMS keys does not include fields for metadata.
    
    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 KMS key, but it is highly recommended.
    
    For more information, see Encryption Context in the Key Management Service Developer Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDestinationEncryptionContext() method.
    
    Returns:
    
    Specifies that encryption context to use when the reencrypting the data.
    
    A destination encryption context is valid only when the destination KMS key is a symmetric KMS key. The standard ciphertext format for asymmetric KMS keys does not include fields for metadata.
    
    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 KMS key, but it is highly recommended.
    
    For more information, see Encryption Context in the Key Management Service Developer Guide.
  - sourceEncryptionAlgorithm
```
public final EncryptionAlgorithmSpec sourceEncryptionAlgorithm()
```
    Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it is reencrypted. The default value, SYMMETRIC_DEFAULT, represents the algorithm used for symmetric KMS keys.
    
    Specify the same algorithm that was used to encrypt the ciphertext. If you specify a different algorithm, the decrypt attempt fails.
    
    This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key.
    
    If the service returns an enum value that is not available in the current SDK version, sourceEncryptionAlgorithm will return EncryptionAlgorithmSpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceEncryptionAlgorithmAsString().
    
    Returns:
    
    Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it is reencrypted. The default value, SYMMETRIC_DEFAULT, represents the algorithm used for symmetric KMS keys.
    
    Specify the same algorithm that was used to encrypt the ciphertext. If you specify a different algorithm, the decrypt attempt fails.
    
    This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key.
    
    See Also:
    
    EncryptionAlgorithmSpec
  - sourceEncryptionAlgorithmAsString
```
public final String sourceEncryptionAlgorithmAsString()
```
    Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it is reencrypted. The default value, SYMMETRIC_DEFAULT, represents the algorithm used for symmetric KMS keys.
    
    Specify the same algorithm that was used to encrypt the ciphertext. If you specify a different algorithm, the decrypt attempt fails.
    
    This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key.
    
    If the service returns an enum value that is not available in the current SDK version, sourceEncryptionAlgorithm will return EncryptionAlgorithmSpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceEncryptionAlgorithmAsString().
    
    Returns:
    
    Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it is reencrypted. The default value, SYMMETRIC_DEFAULT, represents the algorithm used for symmetric KMS keys.
    
    Specify the same algorithm that was used to encrypt the ciphertext. If you specify a different algorithm, the decrypt attempt fails.
    
    This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key.
    
    See Also:
    
    EncryptionAlgorithmSpec
  - destinationEncryptionAlgorithm
```
public final EncryptionAlgorithmSpec destinationEncryptionAlgorithm()
```
    Specifies the encryption algorithm that KMS will use to reecrypt the data after it has decrypted it. The default value, SYMMETRIC_DEFAULT, represents the encryption algorithm used for symmetric KMS keys.
    
    This parameter is required only when the destination KMS key is an asymmetric KMS key.
    
    If the service returns an enum value that is not available in the current SDK version, destinationEncryptionAlgorithm will return EncryptionAlgorithmSpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from destinationEncryptionAlgorithmAsString().
    
    Returns:
    
    Specifies the encryption algorithm that KMS will use to reecrypt the data after it has decrypted it. The default value, SYMMETRIC_DEFAULT, represents the encryption algorithm used for symmetric KMS keys.
    
    This parameter is required only when the destination KMS key is an asymmetric KMS key.
    
    See Also:
    
    EncryptionAlgorithmSpec
  - destinationEncryptionAlgorithmAsString
```
public final String destinationEncryptionAlgorithmAsString()
```
    Specifies the encryption algorithm that KMS will use to reecrypt the data after it has decrypted it. The default value, SYMMETRIC_DEFAULT, represents the encryption algorithm used for symmetric KMS keys.
    
    This parameter is required only when the destination KMS key is an asymmetric KMS key.
    
    If the service returns an enum value that is not available in the current SDK version, destinationEncryptionAlgorithm will return EncryptionAlgorithmSpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from destinationEncryptionAlgorithmAsString().
    
    Returns:
    
    Specifies the encryption algorithm that KMS will use to reecrypt the data after it has decrypted it. The default value, SYMMETRIC_DEFAULT, represents the encryption algorithm used for symmetric KMS keys.
    
    This parameter is required only when the destination KMS key is an asymmetric KMS key.
    
    See Also:
    
    EncryptionAlgorithmSpec
  - hasGrantTokens
```
public final boolean hasGrantTokens()
```
    For responses, this returns true if the service returned a value for the GrantTokens property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - grantTokens
```
public final List<String> grantTokens()
```
    A list of grant tokens.
    
    Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGrantTokens() method.
    
    Returns:
    
    A list of grant tokens.
    
    Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
  - toBuilder
```
public ReEncryptRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ReEncryptRequest.Builder,ReEncryptRequest>
    
    Specified by:
    
    toBuilder in class KmsRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static ReEncryptRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ReEncryptRequest.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)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - 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)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.17.41

Class ReEncryptRequest

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

ciphertextBlob

hasSourceEncryptionContext

sourceEncryptionContext

sourceKeyId

destinationKeyId

hasDestinationEncryptionContext

destinationEncryptionContext

sourceEncryptionAlgorithm

sourceEncryptionAlgorithmAsString

destinationEncryptionAlgorithm

destinationEncryptionAlgorithmAsString

hasGrantTokens

grantTokens

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields