@Generated(value="software.amazon.awssdk:codegen") public final class GetPublicKeyResponse extends KmsResponse implements ToCopyableBuilder<GetPublicKeyResponse.Builder,GetPublicKeyResponse>
Modifier and Type | Class and Description |
---|---|
static interface |
GetPublicKeyResponse.Builder |
Modifier and Type | Method and Description |
---|---|
static GetPublicKeyResponse.Builder |
builder() |
CustomerMasterKeySpec |
customerMasterKeySpec()
Deprecated.
This field has been deprecated. Instead, use the KeySpec field.
|
String |
customerMasterKeySpecAsString()
Deprecated.
This field has been deprecated. Instead, use the KeySpec field.
|
List<EncryptionAlgorithmSpec> |
encryptionAlgorithms()
The encryption algorithms that KMS supports for this key.
|
List<String> |
encryptionAlgorithmsAsStrings()
The encryption algorithms that KMS supports for this key.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasEncryptionAlgorithms()
For responses, this returns true if the service returned a value for the EncryptionAlgorithms property.
|
int |
hashCode() |
boolean |
hasSigningAlgorithms()
For responses, this returns true if the service returned a value for the SigningAlgorithms property.
|
String |
keyId()
The Amazon Resource Name (key ARN) of the
asymmetric KMS key from which the public key was downloaded.
|
KeySpec |
keySpec()
The type of the of the public key that was downloaded.
|
String |
keySpecAsString()
The type of the of the public key that was downloaded.
|
KeyUsageType |
keyUsage()
The permitted use of the public key.
|
String |
keyUsageAsString()
The permitted use of the public key.
|
SdkBytes |
publicKey()
The exported public key.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends GetPublicKeyResponse.Builder> |
serializableBuilderClass() |
List<SigningAlgorithmSpec> |
signingAlgorithms()
The signing algorithms that KMS supports for this key.
|
List<String> |
signingAlgorithmsAsStrings()
The signing algorithms that KMS supports for this key.
|
GetPublicKeyResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
responseMetadata
sdkHttpResponse
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String keyId()
The Amazon Resource Name (key ARN) of the asymmetric KMS key from which the public key was downloaded.
public final SdkBytes 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.
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.
@Deprecated public final CustomerMasterKeySpec 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 will support both
fields.
If the service returns an enum value that is not available in the current SDK version,
customerMasterKeySpec
will return CustomerMasterKeySpec.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from customerMasterKeySpecAsString()
.
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 will
support both fields.
CustomerMasterKeySpec
@Deprecated public final String customerMasterKeySpecAsString()
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 will support both
fields.
If the service returns an enum value that is not available in the current SDK version,
customerMasterKeySpec
will return CustomerMasterKeySpec.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from customerMasterKeySpecAsString()
.
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 will
support both fields.
CustomerMasterKeySpec
public final KeySpec 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, keySpec
will
return KeySpec.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
keySpecAsString()
.
KeySpec
public final String keySpecAsString()
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, keySpec
will
return KeySpec.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
keySpecAsString()
.
KeySpec
public final KeyUsageType 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, keyUsage
will
return KeyUsageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
keyUsageAsString()
.
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.
KeyUsageType
public final String keyUsageAsString()
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, keyUsage
will
return KeyUsageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
keyUsageAsString()
.
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.
KeyUsageType
public final List<EncryptionAlgorithmSpec> 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
.
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 hasEncryptionAlgorithms()
method.
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 boolean hasEncryptionAlgorithms()
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 List<String> encryptionAlgorithmsAsStrings()
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 hasEncryptionAlgorithms()
method.
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<SigningAlgorithmSpec> 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
.
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 hasSigningAlgorithms()
method.
This field appears in the response only when the KeyUsage
of the public key is
SIGN_VERIFY
.
public final boolean hasSigningAlgorithms()
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 List<String> signingAlgorithmsAsStrings()
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 hasSigningAlgorithms()
method.
This field appears in the response only when the KeyUsage
of the public key is
SIGN_VERIFY
.
public GetPublicKeyResponse.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<GetPublicKeyResponse.Builder,GetPublicKeyResponse>
toBuilder
in class AwsResponse
public static GetPublicKeyResponse.Builder builder()
public static Class<? extends GetPublicKeyResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsResponse
public final boolean equals(Object obj)
equals
in class AwsResponse
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkResponse
Copyright © 2022. All rights reserved.