software.amazon.awssdk.services.kms.model.GetParametersForImportRequest 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 GetParametersForImportRequest extends KmsRequest implements
ToCopyableBuilder {
private static final SdkField KEY_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("KeyId")
.getter(getter(GetParametersForImportRequest::keyId)).setter(setter(Builder::keyId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KeyId").build()).build();
private static final SdkField WRAPPING_ALGORITHM_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("WrappingAlgorithm").getter(getter(GetParametersForImportRequest::wrappingAlgorithmAsString))
.setter(setter(Builder::wrappingAlgorithm))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("WrappingAlgorithm").build()).build();
private static final SdkField WRAPPING_KEY_SPEC_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("WrappingKeySpec").getter(getter(GetParametersForImportRequest::wrappingKeySpecAsString))
.setter(setter(Builder::wrappingKeySpec))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("WrappingKeySpec").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(KEY_ID_FIELD,
WRAPPING_ALGORITHM_FIELD, WRAPPING_KEY_SPEC_FIELD));
private final String keyId;
private final String wrappingAlgorithm;
private final String wrappingKeySpec;
private GetParametersForImportRequest(BuilderImpl builder) {
super(builder);
this.keyId = builder.keyId;
this.wrappingAlgorithm = builder.wrappingAlgorithm;
this.wrappingKeySpec = builder.wrappingKeySpec;
}
/**
*
* The identifier of the symmetric encryption KMS key into which you will import key material. The
* Origin of the KMS key must be EXTERNAL.
*
*
* Specify the key ID or key ARN of the KMS key.
*
*
* For example:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*
*
* To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
*
*
* @return The identifier of the symmetric encryption KMS key into which you will import key material. The
* Origin of the KMS key must be EXTERNAL.
*
* Specify the key ID or key ARN of the KMS key.
*
*
* For example:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*
*
* To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
*/
public final String keyId() {
return keyId;
}
/**
*
* The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For
* more information, see Encrypt the
* Key Material in the Key Management Service Developer Guide.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #wrappingAlgorithm}
* will return {@link AlgorithmSpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #wrappingAlgorithmAsString}.
*
*
* @return The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial.
* For more information, see Encrypt the Key Material in the Key Management Service Developer Guide.
* @see AlgorithmSpec
*/
public final AlgorithmSpec wrappingAlgorithm() {
return AlgorithmSpec.fromValue(wrappingAlgorithm);
}
/**
*
* The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For
* more information, see Encrypt the
* Key Material in the Key Management Service Developer Guide.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #wrappingAlgorithm}
* will return {@link AlgorithmSpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #wrappingAlgorithmAsString}.
*
*
* @return The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial.
* For more information, see Encrypt the Key Material in the Key Management Service Developer Guide.
* @see AlgorithmSpec
*/
public final String wrappingAlgorithmAsString() {
return wrappingAlgorithm;
}
/**
*
* The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #wrappingKeySpec}
* will return {@link WrappingKeySpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #wrappingKeySpecAsString}.
*
*
* @return The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are
* supported.
* @see WrappingKeySpec
*/
public final WrappingKeySpec wrappingKeySpec() {
return WrappingKeySpec.fromValue(wrappingKeySpec);
}
/**
*
* The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #wrappingKeySpec}
* will return {@link WrappingKeySpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #wrappingKeySpecAsString}.
*
*
* @return The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are
* supported.
* @see WrappingKeySpec
*/
public final String wrappingKeySpecAsString() {
return wrappingKeySpec;
}
@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(keyId());
hashCode = 31 * hashCode + Objects.hashCode(wrappingAlgorithmAsString());
hashCode = 31 * hashCode + Objects.hashCode(wrappingKeySpecAsString());
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 GetParametersForImportRequest)) {
return false;
}
GetParametersForImportRequest other = (GetParametersForImportRequest) obj;
return Objects.equals(keyId(), other.keyId())
&& Objects.equals(wrappingAlgorithmAsString(), other.wrappingAlgorithmAsString())
&& Objects.equals(wrappingKeySpecAsString(), other.wrappingKeySpecAsString());
}
/**
* 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("GetParametersForImportRequest").add("KeyId", keyId())
.add("WrappingAlgorithm", wrappingAlgorithmAsString()).add("WrappingKeySpec", wrappingKeySpecAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "KeyId":
return Optional.ofNullable(clazz.cast(keyId()));
case "WrappingAlgorithm":
return Optional.ofNullable(clazz.cast(wrappingAlgorithmAsString()));
case "WrappingKeySpec":
return Optional.ofNullable(clazz.cast(wrappingKeySpecAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetParametersForImportRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The identifier of the symmetric encryption KMS key into which you will import key material. The
* Origin of the KMS key must be EXTERNAL.
*
*
* Specify the key ID or key ARN of the KMS key.
*
*
* For example:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*
*
* To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
*
*
* @param keyId
* The identifier of the symmetric encryption KMS key into which you will import key material. The
* Origin of the KMS key must be EXTERNAL.
*
* Specify the key ID or key ARN of the KMS key.
*
*
* For example:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*
*
* To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder keyId(String keyId);
/**
*
* The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For
* more information, see Encrypt
* the Key Material in the Key Management Service Developer Guide.
*
*
* @param wrappingAlgorithm
* The algorithm you will use to encrypt the key material before importing it with
* ImportKeyMaterial. For more information, see Encrypt the Key Material in the Key Management Service Developer Guide.
* @see AlgorithmSpec
* @return Returns a reference to this object so that method calls can be chained together.
* @see AlgorithmSpec
*/
Builder wrappingAlgorithm(String wrappingAlgorithm);
/**
*
* The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For
* more information, see Encrypt
* the Key Material in the Key Management Service Developer Guide.
*
*
* @param wrappingAlgorithm
* The algorithm you will use to encrypt the key material before importing it with
* ImportKeyMaterial. For more information, see Encrypt the Key Material in the Key Management Service Developer Guide.
* @see AlgorithmSpec
* @return Returns a reference to this object so that method calls can be chained together.
* @see AlgorithmSpec
*/
Builder wrappingAlgorithm(AlgorithmSpec wrappingAlgorithm);
/**
*
* The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.
*
*
* @param wrappingKeySpec
* The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are
* supported.
* @see WrappingKeySpec
* @return Returns a reference to this object so that method calls can be chained together.
* @see WrappingKeySpec
*/
Builder wrappingKeySpec(String wrappingKeySpec);
/**
*
* The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.
*
*
* @param wrappingKeySpec
* The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are
* supported.
* @see WrappingKeySpec
* @return Returns a reference to this object so that method calls can be chained together.
* @see WrappingKeySpec
*/
Builder wrappingKeySpec(WrappingKeySpec wrappingKeySpec);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends KmsRequest.BuilderImpl implements Builder {
private String keyId;
private String wrappingAlgorithm;
private String wrappingKeySpec;
private BuilderImpl() {
}
private BuilderImpl(GetParametersForImportRequest model) {
super(model);
keyId(model.keyId);
wrappingAlgorithm(model.wrappingAlgorithm);
wrappingKeySpec(model.wrappingKeySpec);
}
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 getWrappingAlgorithm() {
return wrappingAlgorithm;
}
public final void setWrappingAlgorithm(String wrappingAlgorithm) {
this.wrappingAlgorithm = wrappingAlgorithm;
}
@Override
public final Builder wrappingAlgorithm(String wrappingAlgorithm) {
this.wrappingAlgorithm = wrappingAlgorithm;
return this;
}
@Override
public final Builder wrappingAlgorithm(AlgorithmSpec wrappingAlgorithm) {
this.wrappingAlgorithm(wrappingAlgorithm == null ? null : wrappingAlgorithm.toString());
return this;
}
public final String getWrappingKeySpec() {
return wrappingKeySpec;
}
public final void setWrappingKeySpec(String wrappingKeySpec) {
this.wrappingKeySpec = wrappingKeySpec;
}
@Override
public final Builder wrappingKeySpec(String wrappingKeySpec) {
this.wrappingKeySpec = wrappingKeySpec;
return this;
}
@Override
public final Builder wrappingKeySpec(WrappingKeySpec wrappingKeySpec) {
this.wrappingKeySpec(wrappingKeySpec == null ? null : wrappingKeySpec.toString());
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 GetParametersForImportRequest build() {
return new GetParametersForImportRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}