software.amazon.awssdk.services.kms.model.GenerateRandomRequest 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.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.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
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 GenerateRandomRequest extends KmsRequest implements
ToCopyableBuilder {
private static final SdkField NUMBER_OF_BYTES_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("NumberOfBytes").getter(getter(GenerateRandomRequest::numberOfBytes))
.setter(setter(Builder::numberOfBytes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NumberOfBytes").build()).build();
private static final SdkField CUSTOM_KEY_STORE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("CustomKeyStoreId").getter(getter(GenerateRandomRequest::customKeyStoreId))
.setter(setter(Builder::customKeyStoreId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CustomKeyStoreId").build()).build();
private static final SdkField RECIPIENT_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("Recipient").getter(getter(GenerateRandomRequest::recipient)).setter(setter(Builder::recipient))
.constructor(RecipientInfo::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Recipient").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NUMBER_OF_BYTES_FIELD,
CUSTOM_KEY_STORE_ID_FIELD, RECIPIENT_FIELD));
private final Integer numberOfBytes;
private final String customKeyStoreId;
private final RecipientInfo recipient;
private GenerateRandomRequest(BuilderImpl builder) {
super(builder);
this.numberOfBytes = builder.numberOfBytes;
this.customKeyStoreId = builder.customKeyStoreId;
this.recipient = builder.recipient;
}
/**
*
* The length of the random byte string. This parameter is required.
*
*
* @return The length of the random byte string. This parameter is required.
*/
public final Integer numberOfBytes() {
return numberOfBytes;
}
/**
*
* Generates the random byte string in the CloudHSM cluster that is associated with the specified CloudHSM key
* store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
*
*
* External key store IDs are not valid for this parameter. If you specify the ID of an external key store,
* GenerateRandom throws an UnsupportedOperationException.
*
*
* @return Generates the random byte string in the CloudHSM cluster that is associated with the specified CloudHSM
* key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
*
* External key store IDs are not valid for this parameter. If you specify the ID of an external key store,
* GenerateRandom throws an UnsupportedOperationException.
*/
public final String customKeyStoreId() {
return customKeyStoreId;
}
/**
*
* A signed attestation
* document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's
* public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256.
*
*
* This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this
* parameter, use the Amazon Web Services
* Nitro Enclaves SDK or any Amazon Web Services SDK.
*
*
* When you use this parameter, instead of returning plaintext bytes, KMS encrypts the plaintext bytes under the
* public key in the attestation document, and returns the resulting ciphertext in the
* CiphertextForRecipient field in the response. This ciphertext can be decrypted only with the private
* key in the enclave. The Plaintext field in the response is null or empty.
*
*
* 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 A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use
* with the enclave's public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256.
*
*
* This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include
* this parameter, use the Amazon Web
* Services Nitro Enclaves SDK or any Amazon Web Services SDK.
*
*
* When you use this parameter, instead of returning plaintext bytes, KMS encrypts the plaintext bytes under
* the public key in the attestation document, and returns the resulting ciphertext in the
* CiphertextForRecipient field in the response. This ciphertext can be decrypted only with the
* private key in the enclave. The Plaintext field in the response is null or empty.
*
*
* 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 RecipientInfo recipient() {
return recipient;
}
@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(numberOfBytes());
hashCode = 31 * hashCode + Objects.hashCode(customKeyStoreId());
hashCode = 31 * hashCode + Objects.hashCode(recipient());
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 GenerateRandomRequest)) {
return false;
}
GenerateRandomRequest other = (GenerateRandomRequest) obj;
return Objects.equals(numberOfBytes(), other.numberOfBytes())
&& Objects.equals(customKeyStoreId(), other.customKeyStoreId()) && Objects.equals(recipient(), other.recipient());
}
/**
* 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("GenerateRandomRequest").add("NumberOfBytes", numberOfBytes())
.add("CustomKeyStoreId", customKeyStoreId()).add("Recipient", recipient()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "NumberOfBytes":
return Optional.ofNullable(clazz.cast(numberOfBytes()));
case "CustomKeyStoreId":
return Optional.ofNullable(clazz.cast(customKeyStoreId()));
case "Recipient":
return Optional.ofNullable(clazz.cast(recipient()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GenerateRandomRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The length of the random byte string. This parameter is required.
*
*
* @param numberOfBytes
* The length of the random byte string. This parameter is required.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder numberOfBytes(Integer numberOfBytes);
/**
*
* Generates the random byte string in the CloudHSM cluster that is associated with the specified CloudHSM key
* store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
*
*
* External key store IDs are not valid for this parameter. If you specify the ID of an external key store,
* GenerateRandom throws an UnsupportedOperationException.
*
*
* @param customKeyStoreId
* Generates the random byte string in the CloudHSM cluster that is associated with the specified
* CloudHSM key store. To find the ID of a custom key store, use the DescribeCustomKeyStores
* operation.
*
* External key store IDs are not valid for this parameter. If you specify the ID of an external key
* store, GenerateRandom throws an UnsupportedOperationException.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder customKeyStoreId(String customKeyStoreId);
/**
*
* A signed
* attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with
* the enclave's public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256.
*
*
* This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this
* parameter, use the Amazon Web Services
* Nitro Enclaves SDK or any Amazon Web Services SDK.
*
*
* When you use this parameter, instead of returning plaintext bytes, KMS encrypts the plaintext bytes under the
* public key in the attestation document, and returns the resulting ciphertext in the
* CiphertextForRecipient field in the response. This ciphertext can be decrypted only with the
* private key in the enclave. The Plaintext field in the response is null or empty.
*
*
* 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 recipient
* A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to
* use with the enclave's public key. The only valid encryption algorithm is
* RSAES_OAEP_SHA_256.
*
* This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include
* this parameter, use the Amazon Web
* Services Nitro Enclaves SDK or any Amazon Web Services SDK.
*
*
* When you use this parameter, instead of returning plaintext bytes, KMS encrypts the plaintext bytes
* under the public key in the attestation document, and returns the resulting ciphertext in the
* CiphertextForRecipient field in the response. This ciphertext can be decrypted only with
* the private key in the enclave. The Plaintext field in the response is null or empty.
*
*
* 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 recipient(RecipientInfo recipient);
/**
*
* A signed
* attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with
* the enclave's public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256.
*
*
* This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this
* parameter, use the Amazon Web Services
* Nitro Enclaves SDK or any Amazon Web Services SDK.
*
*
* When you use this parameter, instead of returning plaintext bytes, KMS encrypts the plaintext bytes under the
* public key in the attestation document, and returns the resulting ciphertext in the
* CiphertextForRecipient field in the response. This ciphertext can be decrypted only with the
* private key in the enclave. The Plaintext field in the response is null or empty.
*
*
* 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.
*
* This is a convenience method that creates an instance of the {@link RecipientInfo.Builder} avoiding the need
* to create one manually via {@link RecipientInfo#builder()}.
*
*
* When the {@link Consumer} completes, {@link RecipientInfo.Builder#build()} is called immediately and its
* result is passed to {@link #recipient(RecipientInfo)}.
*
* @param recipient
* a consumer that will call methods on {@link RecipientInfo.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #recipient(RecipientInfo)
*/
default Builder recipient(Consumer recipient) {
return recipient(RecipientInfo.builder().applyMutation(recipient).build());
}
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends KmsRequest.BuilderImpl implements Builder {
private Integer numberOfBytes;
private String customKeyStoreId;
private RecipientInfo recipient;
private BuilderImpl() {
}
private BuilderImpl(GenerateRandomRequest model) {
super(model);
numberOfBytes(model.numberOfBytes);
customKeyStoreId(model.customKeyStoreId);
recipient(model.recipient);
}
public final Integer getNumberOfBytes() {
return numberOfBytes;
}
public final void setNumberOfBytes(Integer numberOfBytes) {
this.numberOfBytes = numberOfBytes;
}
@Override
public final Builder numberOfBytes(Integer numberOfBytes) {
this.numberOfBytes = numberOfBytes;
return this;
}
public final String getCustomKeyStoreId() {
return customKeyStoreId;
}
public final void setCustomKeyStoreId(String customKeyStoreId) {
this.customKeyStoreId = customKeyStoreId;
}
@Override
public final Builder customKeyStoreId(String customKeyStoreId) {
this.customKeyStoreId = customKeyStoreId;
return this;
}
public final RecipientInfo.Builder getRecipient() {
return recipient != null ? recipient.toBuilder() : null;
}
public final void setRecipient(RecipientInfo.BuilderImpl recipient) {
this.recipient = recipient != null ? recipient.build() : null;
}
@Override
public final Builder recipient(RecipientInfo recipient) {
this.recipient = recipient;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public GenerateRandomRequest build() {
return new GenerateRandomRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}