Class EncapsulateResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.kms.model.KmsResponse
software.amazon.awssdk.services.kms.model.EncapsulateResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<EncapsulateResponse.Builder,EncapsulateResponse>
@Generated("software.amazon.awssdk:codegen") public final class EncapsulateResponse extends KmsResponse implements ToCopyableBuilder<EncapsulateResponse.Builder,EncapsulateResponse>

  • Method Details

    • keyId

      public final String keyId()

      The identifier of the ML-KEM KMS key used to encapsulate the shared secret.

      Returns:
      The identifier of the ML-KEM KMS key used to encapsulate the shared secret.

    • sharedSecret

      public final SdkBytes sharedSecret()

      The plaintext shared secret. It is a 32-byte cryptographically random value that both parties can use directly as key material or pass through a key derivation function to generate multiple keys and nonces. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

      Returns:
      The plaintext shared secret. It is a 32-byte cryptographically random value that both parties can use directly as key material or pass through a key derivation function to generate multiple keys and nonces. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

    • sharedSecretCiphertextBlob

      public final SdkBytes sharedSecretCiphertextBlob()

      The encapsulated form of the shared secret. Pass this value to the Decapsulate operation to recover the shared secret. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. The length of SharedSecretCiphertextBlob depends on the ML-KEM key spec. Before Base64 encoding, the encapsulated shared secret is 768 bytes for ML_KEM_512, 1088 bytes for ML_KEM_768, and 1568 bytes for ML_KEM_1024.

      Returns:
      The encapsulated form of the shared secret. Pass this value to the Decapsulate operation to recover the shared secret. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. The length of SharedSecretCiphertextBlob depends on the ML-KEM key spec. Before Base64 encoding, the encapsulated shared secret is 768 bytes for ML_KEM_512, 1088 bytes for ML_KEM_768, and 1568 bytes for ML_KEM_1024.

    • encapsulationAlgorithm

      public final EncapsulationAlgorithmSpec encapsulationAlgorithm()

      The key encapsulation algorithm used to generate the shared secret.

      If the service returns an enum value that is not available in the current SDK version, encapsulationAlgorithm will return EncapsulationAlgorithmSpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encapsulationAlgorithmAsString().

      Returns:
      The key encapsulation algorithm used to generate the shared secret.
      See Also:

    • encapsulationAlgorithmAsString

      public final String encapsulationAlgorithmAsString()

      The key encapsulation algorithm used to generate the shared secret.

      If the service returns an enum value that is not available in the current SDK version, encapsulationAlgorithm will return EncapsulationAlgorithmSpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encapsulationAlgorithmAsString().

      Returns:
      The key encapsulation algorithm used to generate the shared secret.
      See Also:

    • toBuilder

      public EncapsulateResponse.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<EncapsulateResponse.Builder,EncapsulateResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static EncapsulateResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends EncapsulateResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.