software.amazon.awssdk.services.kms.model.GetPublicKeyResponse 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.Collection;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
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 GetPublicKeyResponse extends KmsResponse implements
ToCopyableBuilder {
private static final SdkField KEY_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("KeyId")
.getter(getter(GetPublicKeyResponse::keyId)).setter(setter(Builder::keyId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KeyId").build()).build();
private static final SdkField PUBLIC_KEY_FIELD = SdkField. builder(MarshallingType.SDK_BYTES)
.memberName("PublicKey").getter(getter(GetPublicKeyResponse::publicKey)).setter(setter(Builder::publicKey))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PublicKey").build()).build();
private static final SdkField CUSTOMER_MASTER_KEY_SPEC_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("CustomerMasterKeySpec").getter(getter(GetPublicKeyResponse::customerMasterKeySpecAsString))
.setter(setter(Builder::customerMasterKeySpec))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CustomerMasterKeySpec").build())
.build();
private static final SdkField KEY_SPEC_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("KeySpec").getter(getter(GetPublicKeyResponse::keySpecAsString)).setter(setter(Builder::keySpec))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KeySpec").build()).build();
private static final SdkField KEY_USAGE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("KeyUsage").getter(getter(GetPublicKeyResponse::keyUsageAsString)).setter(setter(Builder::keyUsage))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KeyUsage").build()).build();
private static final SdkField> ENCRYPTION_ALGORITHMS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("EncryptionAlgorithms")
.getter(getter(GetPublicKeyResponse::encryptionAlgorithmsAsStrings))
.setter(setter(Builder::encryptionAlgorithmsWithStrings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EncryptionAlgorithms").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> SIGNING_ALGORITHMS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("SigningAlgorithms")
.getter(getter(GetPublicKeyResponse::signingAlgorithmsAsStrings))
.setter(setter(Builder::signingAlgorithmsWithStrings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SigningAlgorithms").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(KEY_ID_FIELD,
PUBLIC_KEY_FIELD, CUSTOMER_MASTER_KEY_SPEC_FIELD, KEY_SPEC_FIELD, KEY_USAGE_FIELD, ENCRYPTION_ALGORITHMS_FIELD,
SIGNING_ALGORITHMS_FIELD));
private final String keyId;
private final SdkBytes publicKey;
private final String customerMasterKeySpec;
private final String keySpec;
private final String keyUsage;
private final List encryptionAlgorithms;
private final List signingAlgorithms;
private GetPublicKeyResponse(BuilderImpl builder) {
super(builder);
this.keyId = builder.keyId;
this.publicKey = builder.publicKey;
this.customerMasterKeySpec = builder.customerMasterKeySpec;
this.keySpec = builder.keySpec;
this.keyUsage = builder.keyUsage;
this.encryptionAlgorithms = builder.encryptionAlgorithms;
this.signingAlgorithms = builder.signingAlgorithms;
}
/**
*
* The Amazon Resource Name (key ARN) of the
* asymmetric KMS key from which the public key was downloaded.
*
*
* @return The Amazon Resource Name (key ARN) of
* the asymmetric KMS key from which the public key was downloaded.
*/
public final String keyId() {
return keyId;
}
/**
*
* The exported public key.
*
*
* The value is a DER-encoded X.509 public key, also known as SubjectPublicKeyInfo (SPKI), as defined
* in RFC 5280. 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 exported public key.
*
*
* The value is a DER-encoded X.509 public key, also known as SubjectPublicKeyInfo (SPKI), as
* defined in RFC 5280. 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;
}
/**
*
* Instead, use the KeySpec field in the GetPublicKey response.
*
*
* The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you
* use the KeySpec field in your code. However, to avoid breaking changes, KMS supports both fields.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #customerMasterKeySpec} will return {@link CustomerMasterKeySpec#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #customerMasterKeySpecAsString}.
*
*
* @return Instead, use the KeySpec field in the GetPublicKey response.
*
* The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend
* that you use the KeySpec field in your code. However, to avoid breaking changes, KMS
* supports both fields.
* @see CustomerMasterKeySpec
* @deprecated This field has been deprecated. Instead, use the KeySpec field.
*/
@Deprecated
public final CustomerMasterKeySpec customerMasterKeySpec() {
return CustomerMasterKeySpec.fromValue(customerMasterKeySpec);
}
/**
*
* Instead, use the KeySpec field in the GetPublicKey response.
*
*
* The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you
* use the KeySpec field in your code. However, to avoid breaking changes, KMS supports both fields.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #customerMasterKeySpec} will return {@link CustomerMasterKeySpec#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #customerMasterKeySpecAsString}.
*
*
* @return Instead, use the KeySpec field in the GetPublicKey response.
*
* The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend
* that you use the KeySpec field in your code. However, to avoid breaking changes, KMS
* supports both fields.
* @see CustomerMasterKeySpec
* @deprecated This field has been deprecated. Instead, use the KeySpec field.
*/
@Deprecated
public final String customerMasterKeySpecAsString() {
return customerMasterKeySpec;
}
/**
*
* The type of the of the public key that was downloaded.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #keySpec} will
* return {@link KeySpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #keySpecAsString}.
*
*
* @return The type of the of the public key that was downloaded.
* @see KeySpec
*/
public final KeySpec keySpec() {
return KeySpec.fromValue(keySpec);
}
/**
*
* The type of the of the public key that was downloaded.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #keySpec} will
* return {@link KeySpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #keySpecAsString}.
*
*
* @return The type of the of the public key that was downloaded.
* @see KeySpec
*/
public final String keySpecAsString() {
return keySpec;
}
/**
*
* The permitted use of the public key. Valid values are ENCRYPT_DECRYPT or SIGN_VERIFY.
*
*
* This information is critical. If a public key with SIGN_VERIFY key usage encrypts data outside of
* KMS, the ciphertext cannot be decrypted.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #keyUsage} will
* return {@link KeyUsageType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #keyUsageAsString}.
*
*
* @return The permitted use of the public key. Valid values are ENCRYPT_DECRYPT or
* SIGN_VERIFY.
*
* This information is critical. If a public key with SIGN_VERIFY key usage encrypts data
* outside of KMS, the ciphertext cannot be decrypted.
* @see KeyUsageType
*/
public final KeyUsageType keyUsage() {
return KeyUsageType.fromValue(keyUsage);
}
/**
*
* The permitted use of the public key. Valid values are ENCRYPT_DECRYPT or SIGN_VERIFY.
*
*
* This information is critical. If a public key with SIGN_VERIFY key usage encrypts data outside of
* KMS, the ciphertext cannot be decrypted.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #keyUsage} will
* return {@link KeyUsageType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #keyUsageAsString}.
*
*
* @return The permitted use of the public key. Valid values are ENCRYPT_DECRYPT or
* SIGN_VERIFY.
*
* This information is critical. If a public key with SIGN_VERIFY key usage encrypts data
* outside of KMS, the ciphertext cannot be decrypted.
* @see KeyUsageType
*/
public final String keyUsageAsString() {
return keyUsage;
}
/**
*
* The encryption algorithms that KMS supports for this key.
*
*
* This information is critical. If a public key encrypts data outside of KMS by using an unsupported encryption
* algorithm, the ciphertext cannot be decrypted.
*
*
* This field appears in the response only when the KeyUsage of the public key is
* ENCRYPT_DECRYPT.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasEncryptionAlgorithms} method.
*
*
* @return The encryption algorithms that KMS supports for this key.
*
* This information is critical. If a public key encrypts data outside of KMS by using an unsupported
* encryption algorithm, the ciphertext cannot be decrypted.
*
*
* This field appears in the response only when the KeyUsage of the public key is
* ENCRYPT_DECRYPT.
*/
public final List encryptionAlgorithms() {
return EncryptionAlgorithmSpecListCopier.copyStringToEnum(encryptionAlgorithms);
}
/**
* For responses, this returns true if the service returned a value for the EncryptionAlgorithms property. This DOES
* NOT check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasEncryptionAlgorithms() {
return encryptionAlgorithms != null && !(encryptionAlgorithms instanceof SdkAutoConstructList);
}
/**
*
* The encryption algorithms that KMS supports for this key.
*
*
* This information is critical. If a public key encrypts data outside of KMS by using an unsupported encryption
* algorithm, the ciphertext cannot be decrypted.
*
*
* This field appears in the response only when the KeyUsage of the public key is
* ENCRYPT_DECRYPT.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasEncryptionAlgorithms} method.
*
*
* @return The encryption algorithms that KMS supports for this key.
*
* This information is critical. If a public key encrypts data outside of KMS by using an unsupported
* encryption algorithm, the ciphertext cannot be decrypted.
*
*
* This field appears in the response only when the KeyUsage of the public key is
* ENCRYPT_DECRYPT.
*/
public final List encryptionAlgorithmsAsStrings() {
return encryptionAlgorithms;
}
/**
*
* The signing algorithms that KMS supports for this key.
*
*
* This field appears in the response only when the KeyUsage of the public key is
* SIGN_VERIFY.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasSigningAlgorithms} method.
*
*
* @return The signing algorithms that KMS supports for this key.
*
* This field appears in the response only when the KeyUsage of the public key is
* SIGN_VERIFY.
*/
public final List signingAlgorithms() {
return SigningAlgorithmSpecListCopier.copyStringToEnum(signingAlgorithms);
}
/**
* For responses, this returns true if the service returned a value for the SigningAlgorithms property. This DOES
* NOT check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasSigningAlgorithms() {
return signingAlgorithms != null && !(signingAlgorithms instanceof SdkAutoConstructList);
}
/**
*
* The signing algorithms that KMS supports for this key.
*
*
* This field appears in the response only when the KeyUsage of the public key is
* SIGN_VERIFY.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasSigningAlgorithms} method.
*
*
* @return The signing algorithms that KMS supports for this key.
*
* This field appears in the response only when the KeyUsage of the public key is
* SIGN_VERIFY.
*/
public final List signingAlgorithmsAsStrings() {
return signingAlgorithms;
}
@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(publicKey());
hashCode = 31 * hashCode + Objects.hashCode(customerMasterKeySpecAsString());
hashCode = 31 * hashCode + Objects.hashCode(keySpecAsString());
hashCode = 31 * hashCode + Objects.hashCode(keyUsageAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasEncryptionAlgorithms() ? encryptionAlgorithmsAsStrings() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasSigningAlgorithms() ? signingAlgorithmsAsStrings() : null);
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 GetPublicKeyResponse)) {
return false;
}
GetPublicKeyResponse other = (GetPublicKeyResponse) obj;
return Objects.equals(keyId(), other.keyId()) && Objects.equals(publicKey(), other.publicKey())
&& Objects.equals(customerMasterKeySpecAsString(), other.customerMasterKeySpecAsString())
&& Objects.equals(keySpecAsString(), other.keySpecAsString())
&& Objects.equals(keyUsageAsString(), other.keyUsageAsString())
&& hasEncryptionAlgorithms() == other.hasEncryptionAlgorithms()
&& Objects.equals(encryptionAlgorithmsAsStrings(), other.encryptionAlgorithmsAsStrings())
&& hasSigningAlgorithms() == other.hasSigningAlgorithms()
&& Objects.equals(signingAlgorithmsAsStrings(), other.signingAlgorithmsAsStrings());
}
/**
* 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("GetPublicKeyResponse").add("KeyId", keyId()).add("PublicKey", publicKey())
.add("CustomerMasterKeySpec", customerMasterKeySpecAsString()).add("KeySpec", keySpecAsString())
.add("KeyUsage", keyUsageAsString())
.add("EncryptionAlgorithms", hasEncryptionAlgorithms() ? encryptionAlgorithmsAsStrings() : null)
.add("SigningAlgorithms", hasSigningAlgorithms() ? signingAlgorithmsAsStrings() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "KeyId":
return Optional.ofNullable(clazz.cast(keyId()));
case "PublicKey":
return Optional.ofNullable(clazz.cast(publicKey()));
case "CustomerMasterKeySpec":
return Optional.ofNullable(clazz.cast(customerMasterKeySpecAsString()));
case "KeySpec":
return Optional.ofNullable(clazz.cast(keySpecAsString()));
case "KeyUsage":
return Optional.ofNullable(clazz.cast(keyUsageAsString()));
case "EncryptionAlgorithms":
return Optional.ofNullable(clazz.cast(encryptionAlgorithmsAsStrings()));
case "SigningAlgorithms":
return Optional.ofNullable(clazz.cast(signingAlgorithmsAsStrings()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetPublicKeyResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends KmsResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* The Amazon Resource Name (key ARN) of the
* asymmetric KMS key from which the public key was downloaded.
*
*
* @param keyId
* The Amazon Resource Name (key ARN)
* of the asymmetric KMS key from which the public key was downloaded.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder keyId(String keyId);
/**
*
* The exported public key.
*
*
* The value is a DER-encoded X.509 public key, also known as SubjectPublicKeyInfo (SPKI), as
* defined in RFC 5280. 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 exported public key.
*
*
* The value is a DER-encoded X.509 public key, also known as SubjectPublicKeyInfo (SPKI),
* as defined in RFC 5280. 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);
/**
*
* Instead, use the KeySpec field in the GetPublicKey response.
*
*
* The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that
* you use the KeySpec field in your code. However, to avoid breaking changes, KMS supports both
* fields.
*
*
* @param customerMasterKeySpec
* Instead, use the KeySpec field in the GetPublicKey response.
*
* The KeySpec and CustomerMasterKeySpec fields have the same value. We
* recommend that you use the KeySpec field in your code. However, to avoid breaking
* changes, KMS supports both fields.
* @see CustomerMasterKeySpec
* @return Returns a reference to this object so that method calls can be chained together.
* @see CustomerMasterKeySpec
* @deprecated This field has been deprecated. Instead, use the KeySpec field.
*/
@Deprecated
Builder customerMasterKeySpec(String customerMasterKeySpec);
/**
*
* Instead, use the KeySpec field in the GetPublicKey response.
*
*
* The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that
* you use the KeySpec field in your code. However, to avoid breaking changes, KMS supports both
* fields.
*
*
* @param customerMasterKeySpec
* Instead, use the KeySpec field in the GetPublicKey response.
*
* The KeySpec and CustomerMasterKeySpec fields have the same value. We
* recommend that you use the KeySpec field in your code. However, to avoid breaking
* changes, KMS supports both fields.
* @see CustomerMasterKeySpec
* @return Returns a reference to this object so that method calls can be chained together.
* @see CustomerMasterKeySpec
* @deprecated This field has been deprecated. Instead, use the KeySpec field.
*/
@Deprecated
Builder customerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec);
/**
*
* The type of the of the public key that was downloaded.
*
*
* @param keySpec
* The type of the of the public key that was downloaded.
* @see KeySpec
* @return Returns a reference to this object so that method calls can be chained together.
* @see KeySpec
*/
Builder keySpec(String keySpec);
/**
*
* The type of the of the public key that was downloaded.
*
*
* @param keySpec
* The type of the of the public key that was downloaded.
* @see KeySpec
* @return Returns a reference to this object so that method calls can be chained together.
* @see KeySpec
*/
Builder keySpec(KeySpec keySpec);
/**
*
* The permitted use of the public key. Valid values are ENCRYPT_DECRYPT or
* SIGN_VERIFY.
*
*
* This information is critical. If a public key with SIGN_VERIFY key usage encrypts data outside
* of KMS, the ciphertext cannot be decrypted.
*
*
* @param keyUsage
* The permitted use of the public key. Valid values are ENCRYPT_DECRYPT or
* SIGN_VERIFY.
*
* This information is critical. If a public key with SIGN_VERIFY key usage encrypts data
* outside of KMS, the ciphertext cannot be decrypted.
* @see KeyUsageType
* @return Returns a reference to this object so that method calls can be chained together.
* @see KeyUsageType
*/
Builder keyUsage(String keyUsage);
/**
*
* The permitted use of the public key. Valid values are ENCRYPT_DECRYPT or
* SIGN_VERIFY.
*
*
* This information is critical. If a public key with SIGN_VERIFY key usage encrypts data outside
* of KMS, the ciphertext cannot be decrypted.
*
*
* @param keyUsage
* The permitted use of the public key. Valid values are ENCRYPT_DECRYPT or
* SIGN_VERIFY.
*
* This information is critical. If a public key with SIGN_VERIFY key usage encrypts data
* outside of KMS, the ciphertext cannot be decrypted.
* @see KeyUsageType
* @return Returns a reference to this object so that method calls can be chained together.
* @see KeyUsageType
*/
Builder keyUsage(KeyUsageType keyUsage);
/**
*
* The encryption algorithms that KMS supports for this key.
*
*
* This information is critical. If a public key encrypts data outside of KMS by using an unsupported encryption
* algorithm, the ciphertext cannot be decrypted.
*
*
* This field appears in the response only when the KeyUsage of the public key is
* ENCRYPT_DECRYPT.
*
*
* @param encryptionAlgorithms
* The encryption algorithms that KMS supports for this key.
*
* This information is critical. If a public key encrypts data outside of KMS by using an unsupported
* encryption algorithm, the ciphertext cannot be decrypted.
*
*
* This field appears in the response only when the KeyUsage of the public key is
* ENCRYPT_DECRYPT.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder encryptionAlgorithmsWithStrings(Collection encryptionAlgorithms);
/**
*
* The encryption algorithms that KMS supports for this key.
*
*
* This information is critical. If a public key encrypts data outside of KMS by using an unsupported encryption
* algorithm, the ciphertext cannot be decrypted.
*
*
* This field appears in the response only when the KeyUsage of the public key is
* ENCRYPT_DECRYPT.
*
*
* @param encryptionAlgorithms
* The encryption algorithms that KMS supports for this key.
*
* This information is critical. If a public key encrypts data outside of KMS by using an unsupported
* encryption algorithm, the ciphertext cannot be decrypted.
*
*
* This field appears in the response only when the KeyUsage of the public key is
* ENCRYPT_DECRYPT.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder encryptionAlgorithmsWithStrings(String... encryptionAlgorithms);
/**
*
* The encryption algorithms that KMS supports for this key.
*
*
* This information is critical. If a public key encrypts data outside of KMS by using an unsupported encryption
* algorithm, the ciphertext cannot be decrypted.
*
*
* This field appears in the response only when the KeyUsage of the public key is
* ENCRYPT_DECRYPT.
*
*
* @param encryptionAlgorithms
* The encryption algorithms that KMS supports for this key.
*
* This information is critical. If a public key encrypts data outside of KMS by using an unsupported
* encryption algorithm, the ciphertext cannot be decrypted.
*
*
* This field appears in the response only when the KeyUsage of the public key is
* ENCRYPT_DECRYPT.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder encryptionAlgorithms(Collection encryptionAlgorithms);
/**
*
* The encryption algorithms that KMS supports for this key.
*
*
* This information is critical. If a public key encrypts data outside of KMS by using an unsupported encryption
* algorithm, the ciphertext cannot be decrypted.
*
*
* This field appears in the response only when the KeyUsage of the public key is
* ENCRYPT_DECRYPT.
*
*
* @param encryptionAlgorithms
* The encryption algorithms that KMS supports for this key.
*
* This information is critical. If a public key encrypts data outside of KMS by using an unsupported
* encryption algorithm, the ciphertext cannot be decrypted.
*
*
* This field appears in the response only when the KeyUsage of the public key is
* ENCRYPT_DECRYPT.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder encryptionAlgorithms(EncryptionAlgorithmSpec... encryptionAlgorithms);
/**
*
* The signing algorithms that KMS supports for this key.
*
*
* This field appears in the response only when the KeyUsage of the public key is
* SIGN_VERIFY.
*
*
* @param signingAlgorithms
* The signing algorithms that KMS supports for this key.
*
* This field appears in the response only when the KeyUsage of the public key is
* SIGN_VERIFY.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder signingAlgorithmsWithStrings(Collection signingAlgorithms);
/**
*
* The signing algorithms that KMS supports for this key.
*
*
* This field appears in the response only when the KeyUsage of the public key is
* SIGN_VERIFY.
*
*
* @param signingAlgorithms
* The signing algorithms that KMS supports for this key.
*
* This field appears in the response only when the KeyUsage of the public key is
* SIGN_VERIFY.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder signingAlgorithmsWithStrings(String... signingAlgorithms);
/**
*
* The signing algorithms that KMS supports for this key.
*
*
* This field appears in the response only when the KeyUsage of the public key is
* SIGN_VERIFY.
*
*
* @param signingAlgorithms
* The signing algorithms that KMS supports for this key.
*
* This field appears in the response only when the KeyUsage of the public key is
* SIGN_VERIFY.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder signingAlgorithms(Collection signingAlgorithms);
/**
*
* The signing algorithms that KMS supports for this key.
*
*
* This field appears in the response only when the KeyUsage of the public key is
* SIGN_VERIFY.
*
*
* @param signingAlgorithms
* The signing algorithms that KMS supports for this key.
*
* This field appears in the response only when the KeyUsage of the public key is
* SIGN_VERIFY.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder signingAlgorithms(SigningAlgorithmSpec... signingAlgorithms);
}
static final class BuilderImpl extends KmsResponse.BuilderImpl implements Builder {
private String keyId;
private SdkBytes publicKey;
private String customerMasterKeySpec;
private String keySpec;
private String keyUsage;
private List encryptionAlgorithms = DefaultSdkAutoConstructList.getInstance();
private List signingAlgorithms = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(GetPublicKeyResponse model) {
super(model);
keyId(model.keyId);
publicKey(model.publicKey);
customerMasterKeySpec(model.customerMasterKeySpec);
keySpec(model.keySpec);
keyUsage(model.keyUsage);
encryptionAlgorithmsWithStrings(model.encryptionAlgorithms);
signingAlgorithmsWithStrings(model.signingAlgorithms);
}
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 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;
}
@Deprecated
public final String getCustomerMasterKeySpec() {
return customerMasterKeySpec;
}
@Deprecated
public final void setCustomerMasterKeySpec(String customerMasterKeySpec) {
this.customerMasterKeySpec = customerMasterKeySpec;
}
@Override
@Deprecated
public final Builder customerMasterKeySpec(String customerMasterKeySpec) {
this.customerMasterKeySpec = customerMasterKeySpec;
return this;
}
@Override
@Deprecated
public final Builder customerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec) {
this.customerMasterKeySpec(customerMasterKeySpec == null ? null : customerMasterKeySpec.toString());
return this;
}
public final String getKeySpec() {
return keySpec;
}
public final void setKeySpec(String keySpec) {
this.keySpec = keySpec;
}
@Override
public final Builder keySpec(String keySpec) {
this.keySpec = keySpec;
return this;
}
@Override
public final Builder keySpec(KeySpec keySpec) {
this.keySpec(keySpec == null ? null : keySpec.toString());
return this;
}
public final String getKeyUsage() {
return keyUsage;
}
public final void setKeyUsage(String keyUsage) {
this.keyUsage = keyUsage;
}
@Override
public final Builder keyUsage(String keyUsage) {
this.keyUsage = keyUsage;
return this;
}
@Override
public final Builder keyUsage(KeyUsageType keyUsage) {
this.keyUsage(keyUsage == null ? null : keyUsage.toString());
return this;
}
public final Collection getEncryptionAlgorithms() {
if (encryptionAlgorithms instanceof SdkAutoConstructList) {
return null;
}
return encryptionAlgorithms;
}
public final void setEncryptionAlgorithms(Collection encryptionAlgorithms) {
this.encryptionAlgorithms = EncryptionAlgorithmSpecListCopier.copy(encryptionAlgorithms);
}
@Override
public final Builder encryptionAlgorithmsWithStrings(Collection encryptionAlgorithms) {
this.encryptionAlgorithms = EncryptionAlgorithmSpecListCopier.copy(encryptionAlgorithms);
return this;
}
@Override
@SafeVarargs
public final Builder encryptionAlgorithmsWithStrings(String... encryptionAlgorithms) {
encryptionAlgorithmsWithStrings(Arrays.asList(encryptionAlgorithms));
return this;
}
@Override
public final Builder encryptionAlgorithms(Collection encryptionAlgorithms) {
this.encryptionAlgorithms = EncryptionAlgorithmSpecListCopier.copyEnumToString(encryptionAlgorithms);
return this;
}
@Override
@SafeVarargs
public final Builder encryptionAlgorithms(EncryptionAlgorithmSpec... encryptionAlgorithms) {
encryptionAlgorithms(Arrays.asList(encryptionAlgorithms));
return this;
}
public final Collection getSigningAlgorithms() {
if (signingAlgorithms instanceof SdkAutoConstructList) {
return null;
}
return signingAlgorithms;
}
public final void setSigningAlgorithms(Collection signingAlgorithms) {
this.signingAlgorithms = SigningAlgorithmSpecListCopier.copy(signingAlgorithms);
}
@Override
public final Builder signingAlgorithmsWithStrings(Collection signingAlgorithms) {
this.signingAlgorithms = SigningAlgorithmSpecListCopier.copy(signingAlgorithms);
return this;
}
@Override
@SafeVarargs
public final Builder signingAlgorithmsWithStrings(String... signingAlgorithms) {
signingAlgorithmsWithStrings(Arrays.asList(signingAlgorithms));
return this;
}
@Override
public final Builder signingAlgorithms(Collection signingAlgorithms) {
this.signingAlgorithms = SigningAlgorithmSpecListCopier.copyEnumToString(signingAlgorithms);
return this;
}
@Override
@SafeVarargs
public final Builder signingAlgorithms(SigningAlgorithmSpec... signingAlgorithms) {
signingAlgorithms(Arrays.asList(signingAlgorithms));
return this;
}
@Override
public GetPublicKeyResponse build() {
return new GetPublicKeyResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}