software.amazon.awssdk.services.kms.model.RecipientInfo Maven / Gradle / Ivy
/*
* 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.io.Serializable;
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;
/**
*
* Contains information about the party that receives the response from the API operation.
*
*
* This data type is designed to support Amazon Web Services Nitro Enclaves, which lets you create an isolated compute
* environment in Amazon EC2. 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.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class RecipientInfo implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField KEY_ENCRYPTION_ALGORITHM_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("KeyEncryptionAlgorithm").getter(getter(RecipientInfo::keyEncryptionAlgorithmAsString))
.setter(setter(Builder::keyEncryptionAlgorithm))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KeyEncryptionAlgorithm").build())
.build();
private static final SdkField ATTESTATION_DOCUMENT_FIELD = SdkField. builder(MarshallingType.SDK_BYTES)
.memberName("AttestationDocument").getter(getter(RecipientInfo::attestationDocument))
.setter(setter(Builder::attestationDocument))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AttestationDocument").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(
KEY_ENCRYPTION_ALGORITHM_FIELD, ATTESTATION_DOCUMENT_FIELD));
private static final long serialVersionUID = 1L;
private final String keyEncryptionAlgorithm;
private final SdkBytes attestationDocument;
private RecipientInfo(BuilderImpl builder) {
this.keyEncryptionAlgorithm = builder.keyEncryptionAlgorithm;
this.attestationDocument = builder.attestationDocument;
}
/**
*
* The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave to
* encrypt plaintext values for the response. The only valid value is RSAES_OAEP_SHA_256.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #keyEncryptionAlgorithm} will return {@link KeyEncryptionMechanism#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #keyEncryptionAlgorithmAsString}.
*
*
* @return The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave
* to encrypt plaintext values for the response. The only valid value is RSAES_OAEP_SHA_256.
* @see KeyEncryptionMechanism
*/
public final KeyEncryptionMechanism keyEncryptionAlgorithm() {
return KeyEncryptionMechanism.fromValue(keyEncryptionAlgorithm);
}
/**
*
* The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave to
* encrypt plaintext values for the response. The only valid value is RSAES_OAEP_SHA_256.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #keyEncryptionAlgorithm} will return {@link KeyEncryptionMechanism#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #keyEncryptionAlgorithmAsString}.
*
*
* @return The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave
* to encrypt plaintext values for the response. The only valid value is RSAES_OAEP_SHA_256.
* @see KeyEncryptionMechanism
*/
public final String keyEncryptionAlgorithmAsString() {
return keyEncryptionAlgorithm;
}
/**
*
* The attestation document for an Amazon Web Services Nitro Enclave. This document includes the enclave's public
* key.
*
*
* @return The attestation document for an Amazon Web Services Nitro Enclave. This document includes the enclave's
* public key.
*/
public final SdkBytes attestationDocument() {
return attestationDocument;
}
@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 + Objects.hashCode(keyEncryptionAlgorithmAsString());
hashCode = 31 * hashCode + Objects.hashCode(attestationDocument());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof RecipientInfo)) {
return false;
}
RecipientInfo other = (RecipientInfo) obj;
return Objects.equals(keyEncryptionAlgorithmAsString(), other.keyEncryptionAlgorithmAsString())
&& Objects.equals(attestationDocument(), other.attestationDocument());
}
/**
* 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("RecipientInfo").add("KeyEncryptionAlgorithm", keyEncryptionAlgorithmAsString())
.add("AttestationDocument", attestationDocument()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "KeyEncryptionAlgorithm":
return Optional.ofNullable(clazz.cast(keyEncryptionAlgorithmAsString()));
case "AttestationDocument":
return Optional.ofNullable(clazz.cast(attestationDocument()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((RecipientInfo) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave to
* encrypt plaintext values for the response. The only valid value is RSAES_OAEP_SHA_256.
*
*
* @param keyEncryptionAlgorithm
* The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro
* Enclave to encrypt plaintext values for the response. The only valid value is
* RSAES_OAEP_SHA_256.
* @see KeyEncryptionMechanism
* @return Returns a reference to this object so that method calls can be chained together.
* @see KeyEncryptionMechanism
*/
Builder keyEncryptionAlgorithm(String keyEncryptionAlgorithm);
/**
*
* The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave to
* encrypt plaintext values for the response. The only valid value is RSAES_OAEP_SHA_256.
*
*
* @param keyEncryptionAlgorithm
* The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro
* Enclave to encrypt plaintext values for the response. The only valid value is
* RSAES_OAEP_SHA_256.
* @see KeyEncryptionMechanism
* @return Returns a reference to this object so that method calls can be chained together.
* @see KeyEncryptionMechanism
*/
Builder keyEncryptionAlgorithm(KeyEncryptionMechanism keyEncryptionAlgorithm);
/**
*
* The attestation document for an Amazon Web Services Nitro Enclave. This document includes the enclave's
* public key.
*
*
* @param attestationDocument
* The attestation document for an Amazon Web Services Nitro Enclave. This document includes the
* enclave's public key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder attestationDocument(SdkBytes attestationDocument);
}
static final class BuilderImpl implements Builder {
private String keyEncryptionAlgorithm;
private SdkBytes attestationDocument;
private BuilderImpl() {
}
private BuilderImpl(RecipientInfo model) {
keyEncryptionAlgorithm(model.keyEncryptionAlgorithm);
attestationDocument(model.attestationDocument);
}
public final String getKeyEncryptionAlgorithm() {
return keyEncryptionAlgorithm;
}
public final void setKeyEncryptionAlgorithm(String keyEncryptionAlgorithm) {
this.keyEncryptionAlgorithm = keyEncryptionAlgorithm;
}
@Override
public final Builder keyEncryptionAlgorithm(String keyEncryptionAlgorithm) {
this.keyEncryptionAlgorithm = keyEncryptionAlgorithm;
return this;
}
@Override
public final Builder keyEncryptionAlgorithm(KeyEncryptionMechanism keyEncryptionAlgorithm) {
this.keyEncryptionAlgorithm(keyEncryptionAlgorithm == null ? null : keyEncryptionAlgorithm.toString());
return this;
}
public final ByteBuffer getAttestationDocument() {
return attestationDocument == null ? null : attestationDocument.asByteBuffer();
}
public final void setAttestationDocument(ByteBuffer attestationDocument) {
attestationDocument(attestationDocument == null ? null : SdkBytes.fromByteBuffer(attestationDocument));
}
@Override
public final Builder attestationDocument(SdkBytes attestationDocument) {
this.attestationDocument = attestationDocument;
return this;
}
@Override
public RecipientInfo build() {
return new RecipientInfo(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}