software.amazon.awssdk.services.kms.model.GenerateDataKeyPairResponse 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.List;
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 GenerateDataKeyPairResponse extends KmsResponse implements
ToCopyableBuilder {
private static final SdkField PRIVATE_KEY_CIPHERTEXT_BLOB_FIELD = SdkField
. builder(MarshallingType.SDK_BYTES).memberName("PrivateKeyCiphertextBlob")
.getter(getter(GenerateDataKeyPairResponse::privateKeyCiphertextBlob))
.setter(setter(Builder::privateKeyCiphertextBlob))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PrivateKeyCiphertextBlob").build())
.build();
private static final SdkField PRIVATE_KEY_PLAINTEXT_FIELD = SdkField. builder(MarshallingType.SDK_BYTES)
.memberName("PrivateKeyPlaintext").getter(getter(GenerateDataKeyPairResponse::privateKeyPlaintext))
.setter(setter(Builder::privateKeyPlaintext))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PrivateKeyPlaintext").build())
.build();
private static final SdkField PUBLIC_KEY_FIELD = SdkField. builder(MarshallingType.SDK_BYTES)
.memberName("PublicKey").getter(getter(GenerateDataKeyPairResponse::publicKey)).setter(setter(Builder::publicKey))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PublicKey").build()).build();
private static final SdkField KEY_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("KeyId")
.getter(getter(GenerateDataKeyPairResponse::keyId)).setter(setter(Builder::keyId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KeyId").build()).build();
private static final SdkField KEY_PAIR_SPEC_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("KeyPairSpec").getter(getter(GenerateDataKeyPairResponse::keyPairSpecAsString))
.setter(setter(Builder::keyPairSpec))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KeyPairSpec").build()).build();
private static final SdkField CIPHERTEXT_FOR_RECIPIENT_FIELD = SdkField
. builder(MarshallingType.SDK_BYTES).memberName("CiphertextForRecipient")
.getter(getter(GenerateDataKeyPairResponse::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(
PRIVATE_KEY_CIPHERTEXT_BLOB_FIELD, PRIVATE_KEY_PLAINTEXT_FIELD, PUBLIC_KEY_FIELD, KEY_ID_FIELD, KEY_PAIR_SPEC_FIELD,
CIPHERTEXT_FOR_RECIPIENT_FIELD));
private final SdkBytes privateKeyCiphertextBlob;
private final SdkBytes privateKeyPlaintext;
private final SdkBytes publicKey;
private final String keyId;
private final String keyPairSpec;
private final SdkBytes ciphertextForRecipient;
private GenerateDataKeyPairResponse(BuilderImpl builder) {
super(builder);
this.privateKeyCiphertextBlob = builder.privateKeyCiphertextBlob;
this.privateKeyPlaintext = builder.privateKeyPlaintext;
this.publicKey = builder.publicKey;
this.keyId = builder.keyId;
this.keyPairSpec = builder.keyPairSpec;
this.ciphertextForRecipient = builder.ciphertextForRecipient;
}
/**
*
* The encrypted copy of the private 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 private 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 privateKeyCiphertextBlob() {
return privateKeyCiphertextBlob;
}
/**
*
* The plaintext copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is
* Base64-encoded. Otherwise, it is not Base64-encoded.
*
*
* If the response includes the CiphertextForRecipient field, the PrivateKeyPlaintext
* field is null or empty.
*
*
* @return The plaintext copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the
* value is Base64-encoded. Otherwise, it is not Base64-encoded.
*
* If the response includes the CiphertextForRecipient field, the
* PrivateKeyPlaintext field is null or empty.
*/
public final SdkBytes privateKeyPlaintext() {
return privateKeyPlaintext;
}
/**
*
* The public key (in plaintext). 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 public key (in plaintext). 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 publicKey() {
return publicKey;
}
/**
*
* The Amazon Resource Name (key ARN) of the KMS
* key that encrypted the private key.
*
*
* @return The Amazon Resource Name (key ARN) of
* the KMS key that encrypted the private key.
*/
public final String keyId() {
return keyId;
}
/**
*
* The type of data key pair that was generated.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #keyPairSpec} will
* return {@link DataKeyPairSpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #keyPairSpecAsString}.
*
*
* @return The type of data key pair that was generated.
* @see DataKeyPairSpec
*/
public final DataKeyPairSpec keyPairSpec() {
return DataKeyPairSpec.fromValue(keyPairSpec);
}
/**
*
* The type of data key pair that was generated.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #keyPairSpec} will
* return {@link DataKeyPairSpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #keyPairSpecAsString}.
*
*
* @return The type of data key pair that was generated.
* @see DataKeyPairSpec
*/
public final String keyPairSpecAsString() {
return keyPairSpec;
}
/**
*
* The plaintext private 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 private 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(privateKeyCiphertextBlob());
hashCode = 31 * hashCode + Objects.hashCode(privateKeyPlaintext());
hashCode = 31 * hashCode + Objects.hashCode(publicKey());
hashCode = 31 * hashCode + Objects.hashCode(keyId());
hashCode = 31 * hashCode + Objects.hashCode(keyPairSpecAsString());
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 GenerateDataKeyPairResponse)) {
return false;
}
GenerateDataKeyPairResponse other = (GenerateDataKeyPairResponse) obj;
return Objects.equals(privateKeyCiphertextBlob(), other.privateKeyCiphertextBlob())
&& Objects.equals(privateKeyPlaintext(), other.privateKeyPlaintext())
&& Objects.equals(publicKey(), other.publicKey()) && Objects.equals(keyId(), other.keyId())
&& Objects.equals(keyPairSpecAsString(), other.keyPairSpecAsString())
&& 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("GenerateDataKeyPairResponse").add("PrivateKeyCiphertextBlob", privateKeyCiphertextBlob())
.add("PrivateKeyPlaintext", privateKeyPlaintext() == null ? null : "*** Sensitive Data Redacted ***")
.add("PublicKey", publicKey()).add("KeyId", keyId()).add("KeyPairSpec", keyPairSpecAsString())
.add("CiphertextForRecipient", ciphertextForRecipient()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "PrivateKeyCiphertextBlob":
return Optional.ofNullable(clazz.cast(privateKeyCiphertextBlob()));
case "PrivateKeyPlaintext":
return Optional.ofNullable(clazz.cast(privateKeyPlaintext()));
case "PublicKey":
return Optional.ofNullable(clazz.cast(publicKey()));
case "KeyId":
return Optional.ofNullable(clazz.cast(keyId()));
case "KeyPairSpec":
return Optional.ofNullable(clazz.cast(keyPairSpecAsString()));
case "CiphertextForRecipient":
return Optional.ofNullable(clazz.cast(ciphertextForRecipient()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GenerateDataKeyPairResponse) 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 private 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 privateKeyCiphertextBlob
* The encrypted copy of the private 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 privateKeyCiphertextBlob(SdkBytes privateKeyCiphertextBlob);
/**
*
* The plaintext copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is
* Base64-encoded. Otherwise, it is not Base64-encoded.
*
*
* If the response includes the CiphertextForRecipient field, the PrivateKeyPlaintext
* field is null or empty.
*
*
* @param privateKeyPlaintext
* The plaintext copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the
* value is Base64-encoded. Otherwise, it is not Base64-encoded.
*
* If the response includes the CiphertextForRecipient field, the
* PrivateKeyPlaintext field is null or empty.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder privateKeyPlaintext(SdkBytes privateKeyPlaintext);
/**
*
* The public key (in plaintext). When you use the HTTP API or the Amazon Web Services CLI, the value is
* Base64-encoded. Otherwise, it is not Base64-encoded.
*
*
* @param publicKey
* The public key (in plaintext). 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 publicKey(SdkBytes publicKey);
/**
*
* The Amazon Resource Name (key ARN) of the
* KMS key that encrypted the private key.
*
*
* @param keyId
* The Amazon Resource Name (key ARN)
* of the KMS key that encrypted the private key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder keyId(String keyId);
/**
*
* The type of data key pair that was generated.
*
*
* @param keyPairSpec
* The type of data key pair that was generated.
* @see DataKeyPairSpec
* @return Returns a reference to this object so that method calls can be chained together.
* @see DataKeyPairSpec
*/
Builder keyPairSpec(String keyPairSpec);
/**
*
* The type of data key pair that was generated.
*
*
* @param keyPairSpec
* The type of data key pair that was generated.
* @see DataKeyPairSpec
* @return Returns a reference to this object so that method calls can be chained together.
* @see DataKeyPairSpec
*/
Builder keyPairSpec(DataKeyPairSpec keyPairSpec);
/**
*
* The plaintext private 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 private 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 privateKeyCiphertextBlob;
private SdkBytes privateKeyPlaintext;
private SdkBytes publicKey;
private String keyId;
private String keyPairSpec;
private SdkBytes ciphertextForRecipient;
private BuilderImpl() {
}
private BuilderImpl(GenerateDataKeyPairResponse model) {
super(model);
privateKeyCiphertextBlob(model.privateKeyCiphertextBlob);
privateKeyPlaintext(model.privateKeyPlaintext);
publicKey(model.publicKey);
keyId(model.keyId);
keyPairSpec(model.keyPairSpec);
ciphertextForRecipient(model.ciphertextForRecipient);
}
public final ByteBuffer getPrivateKeyCiphertextBlob() {
return privateKeyCiphertextBlob == null ? null : privateKeyCiphertextBlob.asByteBuffer();
}
public final void setPrivateKeyCiphertextBlob(ByteBuffer privateKeyCiphertextBlob) {
privateKeyCiphertextBlob(privateKeyCiphertextBlob == null ? null : SdkBytes.fromByteBuffer(privateKeyCiphertextBlob));
}
@Override
public final Builder privateKeyCiphertextBlob(SdkBytes privateKeyCiphertextBlob) {
this.privateKeyCiphertextBlob = privateKeyCiphertextBlob;
return this;
}
public final ByteBuffer getPrivateKeyPlaintext() {
return privateKeyPlaintext == null ? null : privateKeyPlaintext.asByteBuffer();
}
public final void setPrivateKeyPlaintext(ByteBuffer privateKeyPlaintext) {
privateKeyPlaintext(privateKeyPlaintext == null ? null : SdkBytes.fromByteBuffer(privateKeyPlaintext));
}
@Override
public final Builder privateKeyPlaintext(SdkBytes privateKeyPlaintext) {
this.privateKeyPlaintext = privateKeyPlaintext;
return this;
}
public final ByteBuffer getPublicKey() {
return publicKey == null ? null : publicKey.asByteBuffer();
}
public final void setPublicKey(ByteBuffer publicKey) {
publicKey(publicKey == null ? null : SdkBytes.fromByteBuffer(publicKey));
}
@Override
public final Builder publicKey(SdkBytes publicKey) {
this.publicKey = publicKey;
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 String getKeyPairSpec() {
return keyPairSpec;
}
public final void setKeyPairSpec(String keyPairSpec) {
this.keyPairSpec = keyPairSpec;
}
@Override
public final Builder keyPairSpec(String keyPairSpec) {
this.keyPairSpec = keyPairSpec;
return this;
}
@Override
public final Builder keyPairSpec(DataKeyPairSpec keyPairSpec) {
this.keyPairSpec(keyPairSpec == null ? null : keyPairSpec.toString());
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 GenerateDataKeyPairResponse build() {
return new GenerateDataKeyPairResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}