Class GetPublicKeyResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetPublicKeyResponse.Builder,
GetPublicKeyResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic GetPublicKeyResponse.Builder
builder()
final CustomerMasterKeySpec
Deprecated.This field has been deprecated.final String
Deprecated.This field has been deprecated.final List
<EncryptionAlgorithmSpec> The encryption algorithms that KMS supports for this key.The encryption algorithms that KMS supports for this key.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the EncryptionAlgorithms property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SigningAlgorithms property.final String
keyId()
The Amazon Resource Name (key ARN) of the asymmetric KMS key from which the public key was downloaded.final KeySpec
keySpec()
The type of the of the public key that was downloaded.final String
The type of the of the public key that was downloaded.final KeyUsageType
keyUsage()
The permitted use of the public key.final String
The permitted use of the public key.final SdkBytes
The exported public key.static Class
<? extends GetPublicKeyResponse.Builder> final List
<SigningAlgorithmSpec> The signing algorithms that KMS supports for this key.The signing algorithms that KMS supports for this key.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.services.kms.model.KmsResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
keyId
The Amazon Resource Name (key ARN) of the asymmetric KMS key from which the public key was downloaded.
- Returns:
- The Amazon Resource Name (key ARN) of the asymmetric KMS key from which the public key was downloaded.
-
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.- Returns:
- 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.
-
customerMasterKeySpec
Deprecated.This field has been deprecated. Instead, use the KeySpec field.Instead, use the
KeySpec
field in theGetPublicKey
response.The
KeySpec
andCustomerMasterKeySpec
fields have the same value. We recommend that you use theKeySpec
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,
customerMasterKeySpec
will returnCustomerMasterKeySpec.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcustomerMasterKeySpecAsString()
.- Returns:
- Instead, use the
KeySpec
field in theGetPublicKey
response.The
KeySpec
andCustomerMasterKeySpec
fields have the same value. We recommend that you use theKeySpec
field in your code. However, to avoid breaking changes, KMS supports both fields. - See Also:
-
customerMasterKeySpecAsString
Deprecated.This field has been deprecated. Instead, use the KeySpec field.Instead, use the
KeySpec
field in theGetPublicKey
response.The
KeySpec
andCustomerMasterKeySpec
fields have the same value. We recommend that you use theKeySpec
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,
customerMasterKeySpec
will returnCustomerMasterKeySpec.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcustomerMasterKeySpecAsString()
.- Returns:
- Instead, use the
KeySpec
field in theGetPublicKey
response.The
KeySpec
andCustomerMasterKeySpec
fields have the same value. We recommend that you use theKeySpec
field in your code. However, to avoid breaking changes, KMS supports both fields. - See Also:
-
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 returnKeySpec.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeySpecAsString()
.- Returns:
- The type of the of the public key that was downloaded.
- See Also:
-
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 returnKeySpec.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeySpecAsString()
.- Returns:
- The type of the of the public key that was downloaded.
- See Also:
-
keyUsage
The permitted use of the public key. Valid values are
ENCRYPT_DECRYPT
orSIGN_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 returnKeyUsageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeyUsageAsString()
.- Returns:
- The permitted use of the public key. Valid values are
ENCRYPT_DECRYPT
orSIGN_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 Also:
-
keyUsageAsString
The permitted use of the public key. Valid values are
ENCRYPT_DECRYPT
orSIGN_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 returnKeyUsageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeyUsageAsString()
.- Returns:
- The permitted use of the public key. Valid values are
ENCRYPT_DECRYPT
orSIGN_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 Also:
-
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 isENCRYPT_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.- Returns:
- 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 isENCRYPT_DECRYPT
.
-
hasEncryptionAlgorithms
public final boolean hasEncryptionAlgorithms()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 theisEmpty()
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. -
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 isENCRYPT_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.- Returns:
- 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 isENCRYPT_DECRYPT
.
-
signingAlgorithms
The signing algorithms that KMS supports for this key.
This field appears in the response only when the
KeyUsage
of the public key isSIGN_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.- Returns:
- The signing algorithms that KMS supports for this key.
This field appears in the response only when the
KeyUsage
of the public key isSIGN_VERIFY
.
-
hasSigningAlgorithms
public final boolean hasSigningAlgorithms()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 theisEmpty()
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. -
signingAlgorithmsAsStrings
The signing algorithms that KMS supports for this key.
This field appears in the response only when the
KeyUsage
of the public key isSIGN_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.- Returns:
- The signing algorithms that KMS supports for this key.
This field appears in the response only when the
KeyUsage
of the public key isSIGN_VERIFY
.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetPublicKeyResponse.Builder,
GetPublicKeyResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-