software.amazon.awssdk.services.kms.model.GenerateDataKeyResponse Maven / Gradle / Ivy
Show all versions of kms Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.kms.model;
import java.nio.ByteBuffer;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkBytes;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class GenerateDataKeyResponse extends KmsResponse implements
ToCopyableBuilder {
private static final SdkField CIPHERTEXT_BLOB_FIELD = SdkField. builder(MarshallingType.SDK_BYTES)
.memberName("CiphertextBlob").getter(getter(GenerateDataKeyResponse::ciphertextBlob))
.setter(setter(Builder::ciphertextBlob))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CiphertextBlob").build()).build();
private static final SdkField PLAINTEXT_FIELD = SdkField. builder(MarshallingType.SDK_BYTES)
.memberName("Plaintext").getter(getter(GenerateDataKeyResponse::plaintext)).setter(setter(Builder::plaintext))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Plaintext").build()).build();
private static final SdkField KEY_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("KeyId")
.getter(getter(GenerateDataKeyResponse::keyId)).setter(setter(Builder::keyId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KeyId").build()).build();
private static final SdkField CIPHERTEXT_FOR_RECIPIENT_FIELD = SdkField
. builder(MarshallingType.SDK_BYTES).memberName("CiphertextForRecipient")
.getter(getter(GenerateDataKeyResponse::ciphertextForRecipient)).setter(setter(Builder::ciphertextForRecipient))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CiphertextForRecipient").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CIPHERTEXT_BLOB_FIELD,
PLAINTEXT_FIELD, KEY_ID_FIELD, CIPHERTEXT_FOR_RECIPIENT_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private final SdkBytes ciphertextBlob;
private final SdkBytes plaintext;
private final String keyId;
private final SdkBytes ciphertextForRecipient;
private GenerateDataKeyResponse(BuilderImpl builder) {
super(builder);
this.ciphertextBlob = builder.ciphertextBlob;
this.plaintext = builder.plaintext;
this.keyId = builder.keyId;
this.ciphertextForRecipient = builder.ciphertextForRecipient;
}
/**
*
* The encrypted copy of the data key. When you use the HTTP API or the Amazon Web Services CLI, the value is
* Base64-encoded. Otherwise, it is not Base64-encoded.
*
*
* @return The encrypted copy of the data key. When you use the HTTP API or the Amazon Web Services CLI, the value
* is Base64-encoded. Otherwise, it is not Base64-encoded.
*/
public final SdkBytes ciphertextBlob() {
return ciphertextBlob;
}
/**
*
* The plaintext data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded.
* Otherwise, it is not Base64-encoded. Use this data key to encrypt your data outside of KMS. Then, remove it from
* memory as soon as possible.
*
*
* If the response includes the CiphertextForRecipient field, the Plaintext field is null
* or empty.
*
*
* @return The plaintext data key. When you use the HTTP API or the Amazon Web Services CLI, the value is
* Base64-encoded. Otherwise, it is not Base64-encoded. Use this data key to encrypt your data outside of
* KMS. Then, remove it from memory as soon as possible.
*
* If the response includes the CiphertextForRecipient field, the Plaintext field
* is null or empty.
*/
public final SdkBytes plaintext() {
return plaintext;
}
/**
*
* The Amazon Resource Name (key ARN) of the KMS
* key that encrypted the data key.
*
*
* @return The Amazon Resource Name (key ARN) of
* the KMS key that encrypted the data key.
*/
public final String keyId() {
return keyId;
}
/**
*
* The plaintext data key encrypted with the public key from the Nitro enclave. This ciphertext can be decrypted
* only by using a private key in the Nitro enclave.
*
*
* This field is included in the response only when the Recipient parameter in the request includes a
* valid attestation document from an Amazon Web Services Nitro enclave. For information about the interaction
* between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services
* Nitro Enclaves uses KMS in the Key Management Service Developer Guide.
*
*
* @return The plaintext data key encrypted with the public key from the Nitro enclave. This ciphertext can be
* decrypted only by using a private key in the Nitro enclave.
*
* This field is included in the response only when the Recipient parameter in the request
* includes a valid attestation document from an Amazon Web Services Nitro enclave. For information about
* the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web
* Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.
*/
public final SdkBytes ciphertextForRecipient() {
return ciphertextForRecipient;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(ciphertextBlob());
hashCode = 31 * hashCode + Objects.hashCode(plaintext());
hashCode = 31 * hashCode + Objects.hashCode(keyId());
hashCode = 31 * hashCode + Objects.hashCode(ciphertextForRecipient());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof GenerateDataKeyResponse)) {
return false;
}
GenerateDataKeyResponse other = (GenerateDataKeyResponse) obj;
return Objects.equals(ciphertextBlob(), other.ciphertextBlob()) && Objects.equals(plaintext(), other.plaintext())
&& Objects.equals(keyId(), other.keyId())
&& Objects.equals(ciphertextForRecipient(), other.ciphertextForRecipient());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("GenerateDataKeyResponse").add("CiphertextBlob", ciphertextBlob())
.add("Plaintext", plaintext() == null ? null : "*** Sensitive Data Redacted ***").add("KeyId", keyId())
.add("CiphertextForRecipient", ciphertextForRecipient()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "CiphertextBlob":
return Optional.ofNullable(clazz.cast(ciphertextBlob()));
case "Plaintext":
return Optional.ofNullable(clazz.cast(plaintext()));
case "KeyId":
return Optional.ofNullable(clazz.cast(keyId()));
case "CiphertextForRecipient":
return Optional.ofNullable(clazz.cast(ciphertextForRecipient()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("CiphertextBlob", CIPHERTEXT_BLOB_FIELD);
map.put("Plaintext", PLAINTEXT_FIELD);
map.put("KeyId", KEY_ID_FIELD);
map.put("CiphertextForRecipient", CIPHERTEXT_FOR_RECIPIENT_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((GenerateDataKeyResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends KmsResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* The encrypted copy of the data key. When you use the HTTP API or the Amazon Web Services CLI, the value is
* Base64-encoded. Otherwise, it is not Base64-encoded.
*
*
* @param ciphertextBlob
* The encrypted copy of the data key. When you use the HTTP API or the Amazon Web Services CLI, the
* value is Base64-encoded. Otherwise, it is not Base64-encoded.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ciphertextBlob(SdkBytes ciphertextBlob);
/**
*
* The plaintext data key. When you use the HTTP API or the Amazon Web Services CLI, the value is
* Base64-encoded. Otherwise, it is not Base64-encoded. Use this data key to encrypt your data outside of KMS.
* Then, remove it from memory as soon as possible.
*
*
* If the response includes the CiphertextForRecipient field, the Plaintext field is
* null or empty.
*
*
* @param plaintext
* The plaintext data key. When you use the HTTP API or the Amazon Web Services CLI, the value is
* Base64-encoded. Otherwise, it is not Base64-encoded. Use this data key to encrypt your data outside of
* KMS. Then, remove it from memory as soon as possible.
*
* If the response includes the CiphertextForRecipient field, the Plaintext
* field is null or empty.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder plaintext(SdkBytes plaintext);
/**
*
* The Amazon Resource Name (key ARN) of the
* KMS key that encrypted the data key.
*
*
* @param keyId
* The Amazon Resource Name (key ARN)
* of the KMS key that encrypted the data key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder keyId(String keyId);
/**
*
* The plaintext data key encrypted with the public key from the Nitro enclave. This ciphertext can be decrypted
* only by using a private key in the Nitro enclave.
*
*
* This field is included in the response only when the Recipient parameter in the request includes
* a valid attestation document from an Amazon Web Services Nitro enclave. For information about the interaction
* between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web
* Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.
*
*
* @param ciphertextForRecipient
* The plaintext data key encrypted with the public key from the Nitro enclave. This ciphertext can be
* decrypted only by using a private key in the Nitro enclave.
*
* This field is included in the response only when the Recipient parameter in the request
* includes a valid attestation document from an Amazon Web Services Nitro enclave. For information about
* the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon
* Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ciphertextForRecipient(SdkBytes ciphertextForRecipient);
}
static final class BuilderImpl extends KmsResponse.BuilderImpl implements Builder {
private SdkBytes ciphertextBlob;
private SdkBytes plaintext;
private String keyId;
private SdkBytes ciphertextForRecipient;
private BuilderImpl() {
}
private BuilderImpl(GenerateDataKeyResponse model) {
super(model);
ciphertextBlob(model.ciphertextBlob);
plaintext(model.plaintext);
keyId(model.keyId);
ciphertextForRecipient(model.ciphertextForRecipient);
}
public final ByteBuffer getCiphertextBlob() {
return ciphertextBlob == null ? null : ciphertextBlob.asByteBuffer();
}
public final void setCiphertextBlob(ByteBuffer ciphertextBlob) {
ciphertextBlob(ciphertextBlob == null ? null : SdkBytes.fromByteBuffer(ciphertextBlob));
}
@Override
public final Builder ciphertextBlob(SdkBytes ciphertextBlob) {
this.ciphertextBlob = ciphertextBlob;
return this;
}
public final ByteBuffer getPlaintext() {
return plaintext == null ? null : plaintext.asByteBuffer();
}
public final void setPlaintext(ByteBuffer plaintext) {
plaintext(plaintext == null ? null : SdkBytes.fromByteBuffer(plaintext));
}
@Override
public final Builder plaintext(SdkBytes plaintext) {
this.plaintext = plaintext;
return this;
}
public final String getKeyId() {
return keyId;
}
public final void setKeyId(String keyId) {
this.keyId = keyId;
}
@Override
public final Builder keyId(String keyId) {
this.keyId = keyId;
return this;
}
public final ByteBuffer getCiphertextForRecipient() {
return ciphertextForRecipient == null ? null : ciphertextForRecipient.asByteBuffer();
}
public final void setCiphertextForRecipient(ByteBuffer ciphertextForRecipient) {
ciphertextForRecipient(ciphertextForRecipient == null ? null : SdkBytes.fromByteBuffer(ciphertextForRecipient));
}
@Override
public final Builder ciphertextForRecipient(SdkBytes ciphertextForRecipient) {
this.ciphertextForRecipient = ciphertextForRecipient;
return this;
}
@Override
public GenerateDataKeyResponse build() {
return new GenerateDataKeyResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}