GetPublicKeyResponse (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.kms.model.KmsResponse
    - - software.amazon.awssdk.services.kms.model.GetPublicKeyResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetPublicKeyResponse.Builder,GetPublicKeyResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetPublicKeyResponse
extends KmsResponse
implements ToCopyableBuilder<GetPublicKeyResponse.Builder,GetPublicKeyResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetPublicKeyResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GetPublicKeyResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GetPublicKeyResponse.Builder`	`builder()`
`CustomerMasterKeySpec`	`customerMasterKeySpec()` The type of the of the public key that was downloaded.
`String`	`customerMasterKeySpecAsString()` The type of the of the public key that was downloaded.
`List<EncryptionAlgorithmSpec>`	`encryptionAlgorithms()` The encryption algorithms that AWS KMS supports for this key.
`List<String>`	`encryptionAlgorithmsAsStrings()` The encryption algorithms that AWS KMS supports for this key.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasEncryptionAlgorithms()` Returns true if the EncryptionAlgorithms property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasSigningAlgorithms()` Returns true if the SigningAlgorithms property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`keyId()` The Amazon Resource Name (key ARN) of the asymmetric CMK from which the public key 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 AWS KMS supports for this key.
`List<String>`	`signingAlgorithmsAsStrings()` The signing algorithms that AWS KMS supports for this key.
`GetPublicKeyResponse.Builder`	`toBuilder()`
`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 class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - keyId
```
public final String keyId()
```
    The Amazon Resource Name (key ARN) of the asymmetric CMK from which the public key was downloaded.
    
    Returns:
    
    The Amazon Resource Name (key ARN) of the asymmetric CMK from which the public key was downloaded.
  - publicKey
```
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 AWS 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 AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
  - customerMasterKeySpec
```
public final CustomerMasterKeySpec 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, customerMasterKeySpec will return CustomerMasterKeySpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from customerMasterKeySpecAsString().
    
    Returns:
    
    The type of the of the public key that was downloaded.
    
    See Also:
    
    CustomerMasterKeySpec
  - customerMasterKeySpecAsString
```
public final String customerMasterKeySpecAsString()
```
    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, customerMasterKeySpec will return CustomerMasterKeySpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from customerMasterKeySpecAsString().
    
    Returns:
    
    The type of the of the public key that was downloaded.
    
    See Also:
    
    CustomerMasterKeySpec
  - keyUsage
```
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 AWS 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().
    
    Returns:
    
    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 AWS KMS, the ciphertext cannot be decrypted.
    
    See Also:
    
    KeyUsageType
  - keyUsageAsString
```
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 AWS 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().
    
    Returns:
    
    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 AWS KMS, the ciphertext cannot be decrypted.
    
    See Also:
    
    KeyUsageType
  - encryptionAlgorithms
```
public final List<EncryptionAlgorithmSpec> encryptionAlgorithms()
```
    The encryption algorithms that AWS KMS supports for this key.
    
    This information is critical. If a public key encrypts data outside of AWS 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.
    
    You can use hasEncryptionAlgorithms() to see if a value was sent in this field.
    
    Returns:
    
    The encryption algorithms that AWS KMS supports for this key.
    
    This information is critical. If a public key encrypts data outside of AWS 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.
  - hasEncryptionAlgorithms
```
public final boolean hasEncryptionAlgorithms()
```
    Returns true if the EncryptionAlgorithms property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - encryptionAlgorithmsAsStrings
```
public final List<String> encryptionAlgorithmsAsStrings()
```
    The encryption algorithms that AWS KMS supports for this key.
    
    This information is critical. If a public key encrypts data outside of AWS 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.
    
    You can use hasEncryptionAlgorithms() to see if a value was sent in this field.
    
    Returns:
    
    The encryption algorithms that AWS KMS supports for this key.
    
    This information is critical. If a public key encrypts data outside of AWS 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.
  - signingAlgorithms
```
public final List<SigningAlgorithmSpec> signingAlgorithms()
```
    The signing algorithms that AWS 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.
    
    You can use hasSigningAlgorithms() to see if a value was sent in this field.
    
    Returns:
    
    The signing algorithms that AWS KMS supports for this key.
    
    This field appears in the response only when the KeyUsage of the public key is SIGN_VERIFY.
  - hasSigningAlgorithms
```
public final boolean hasSigningAlgorithms()
```
    Returns true if the SigningAlgorithms property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - signingAlgorithmsAsStrings
```
public final List<String> signingAlgorithmsAsStrings()
```
    The signing algorithms that AWS 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.
    
    You can use hasSigningAlgorithms() to see if a value was sent in this field.
    
    Returns:
    
    The signing algorithms that AWS KMS supports for this key.
    
    This field appears in the response only when the KeyUsage of the public key is SIGN_VERIFY.
  - toBuilder
```
public GetPublicKeyResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetPublicKeyResponse.Builder,GetPublicKeyResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static GetPublicKeyResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetPublicKeyResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class GetPublicKeyResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.kms.model.KmsResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

keyId

publicKey

customerMasterKeySpec

customerMasterKeySpecAsString

keyUsage

keyUsageAsString

encryptionAlgorithms

hasEncryptionAlgorithms

encryptionAlgorithmsAsStrings

signingAlgorithms

hasSigningAlgorithms

signingAlgorithmsAsStrings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields