GetPublicKeyResult (AWS SDK for Android

java.lang.Object
- com.amazonaws.services.kms.model.GetPublicKeyResult

All Implemented Interfaces:: Serializable

public class GetPublicKeyResult
extends Object
implements Serializable

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetPublicKeyResult()

Constructors
Constructor and Description
`GetPublicKeyResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getCustomerMasterKeySpec()` The type of the of the public key that was downloaded.
`List<String>`	`getEncryptionAlgorithms()` The encryption algorithms that AWS KMS supports for this key.
`String`	`getKeyId()` The identifier of the asymmetric CMK from which the public key was downloaded.
`String`	`getKeyUsage()` The permitted use of the public key.
`ByteBuffer`	`getPublicKey()` The exported public key.
`List<String>`	`getSigningAlgorithms()` The signing algorithms that AWS KMS supports for this key.
`int`	`hashCode()`
`void`	`setCustomerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec)` The type of the of the public key that was downloaded.
`void`	`setCustomerMasterKeySpec(String customerMasterKeySpec)` The type of the of the public key that was downloaded.
`void`	`setEncryptionAlgorithms(Collection<String> encryptionAlgorithms)` The encryption algorithms that AWS KMS supports for this key.
`void`	`setKeyId(String keyId)` The identifier of the asymmetric CMK from which the public key was downloaded.
`void`	`setKeyUsage(KeyUsageType keyUsage)` The permitted use of the public key.
`void`	`setKeyUsage(String keyUsage)` The permitted use of the public key.
`void`	`setPublicKey(ByteBuffer publicKey)` The exported public key.
`void`	`setSigningAlgorithms(Collection<String> signingAlgorithms)` The signing algorithms that AWS KMS supports for this key.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`GetPublicKeyResult`	`withCustomerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec)` The type of the of the public key that was downloaded.
`GetPublicKeyResult`	`withCustomerMasterKeySpec(String customerMasterKeySpec)` The type of the of the public key that was downloaded.
`GetPublicKeyResult`	`withEncryptionAlgorithms(Collection<String> encryptionAlgorithms)` The encryption algorithms that AWS KMS supports for this key.
`GetPublicKeyResult`	`withEncryptionAlgorithms(String... encryptionAlgorithms)` The encryption algorithms that AWS KMS supports for this key.
`GetPublicKeyResult`	`withKeyId(String keyId)` The identifier of the asymmetric CMK from which the public key was downloaded.
`GetPublicKeyResult`	`withKeyUsage(KeyUsageType keyUsage)` The permitted use of the public key.
`GetPublicKeyResult`	`withKeyUsage(String keyUsage)` The permitted use of the public key.
`GetPublicKeyResult`	`withPublicKey(ByteBuffer publicKey)` The exported public key.
`GetPublicKeyResult`	`withSigningAlgorithms(Collection<String> signingAlgorithms)` The signing algorithms that AWS KMS supports for this key.
`GetPublicKeyResult`	`withSigningAlgorithms(String... signingAlgorithms)` The signing algorithms that AWS KMS supports for this key.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GetPublicKeyResult
```
public GetPublicKeyResult()
```
- Method Detail
  - getKeyId
```
public String getKeyId()
```
    The identifier of the asymmetric CMK from which the public key was downloaded.
    
    Constraints:
    Length: 1 - 2048
    
    Returns:
    
    The identifier of the asymmetric CMK from which the public key was downloaded.
  - setKeyId
```
public void setKeyId(String keyId)
```
    The identifier of the asymmetric CMK from which the public key was downloaded.
    
    Constraints:
    Length: 1 - 2048
    
    Parameters:
    
    keyId -
    The identifier of the asymmetric CMK from which the public key was downloaded.
  - withKeyId
```
public GetPublicKeyResult withKeyId(String keyId)
```
    The identifier of the asymmetric CMK from which the public key was downloaded.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 2048
    
    Parameters:
    
    keyId -
    The identifier of the asymmetric CMK from which the public key was downloaded.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getPublicKey
```
public ByteBuffer getPublicKey()
```
    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.
    
    Constraints:
    Length: 1 - 8192
    
    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.
  - setPublicKey
```
public void setPublicKey(ByteBuffer 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.
    
    Constraints:
    Length: 1 - 8192
    
    Parameters:
    
    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.
  - withPublicKey
```
public GetPublicKeyResult withPublicKey(ByteBuffer 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 a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 8192
    
    Parameters:
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getCustomerMasterKeySpec
```
public String getCustomerMasterKeySpec()
```
    The type of the of the public key that was downloaded.
    
    Constraints:
    Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SYMMETRIC_DEFAULT
    
    Returns:
    
    The type of the of the public key that was downloaded.
    
    See Also:
    
    CustomerMasterKeySpec
  - setCustomerMasterKeySpec
```
public void setCustomerMasterKeySpec(String customerMasterKeySpec)
```
    The type of the of the public key that was downloaded.
    
    Constraints:
    Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SYMMETRIC_DEFAULT
    
    Parameters:
    
    customerMasterKeySpec -
    The type of the of the public key that was downloaded.
    
    See Also:
    
    CustomerMasterKeySpec
  - withCustomerMasterKeySpec
```
public GetPublicKeyResult withCustomerMasterKeySpec(String customerMasterKeySpec)
```
    The type of the of the public key that was downloaded.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SYMMETRIC_DEFAULT
    
    Parameters:
    
    customerMasterKeySpec -
    The type of the of the public key that was downloaded.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    CustomerMasterKeySpec
  - setCustomerMasterKeySpec
```
public void setCustomerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec)
```
    The type of the of the public key that was downloaded.
    
    Constraints:
    Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SYMMETRIC_DEFAULT
    
    Parameters:
    
    customerMasterKeySpec -
    The type of the of the public key that was downloaded.
    
    See Also:
    
    CustomerMasterKeySpec
  - withCustomerMasterKeySpec
```
public GetPublicKeyResult withCustomerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec)
```
    The type of the of the public key that was downloaded.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SYMMETRIC_DEFAULT
    
    Parameters:
    
    customerMasterKeySpec -
    The type of the of the public key that was downloaded.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    CustomerMasterKeySpec
  - getKeyUsage
```
public String getKeyUsage()
```
    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.
    
    Constraints:
    Allowed Values: SIGN_VERIFY, ENCRYPT_DECRYPT
    
    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
  - setKeyUsage
```
public void setKeyUsage(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 AWS KMS, the ciphertext cannot be decrypted.
    
    Constraints:
    Allowed Values: SIGN_VERIFY, ENCRYPT_DECRYPT
    
    Parameters:
    
    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.
    
    See Also:
    
    KeyUsageType
  - withKeyUsage
```
public GetPublicKeyResult withKeyUsage(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 AWS KMS, the ciphertext cannot be decrypted.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: SIGN_VERIFY, ENCRYPT_DECRYPT
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    KeyUsageType
  - setKeyUsage
```
public void setKeyUsage(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.
    
    Constraints:
    Allowed Values: SIGN_VERIFY, ENCRYPT_DECRYPT
    
    Parameters:
    
    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.
    
    See Also:
    
    KeyUsageType
  - withKeyUsage
```
public GetPublicKeyResult withKeyUsage(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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: SIGN_VERIFY, ENCRYPT_DECRYPT
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    KeyUsageType
  - getEncryptionAlgorithms
```
public List<String> getEncryptionAlgorithms()
```
    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.
    
    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.
  - setEncryptionAlgorithms
```
public void setEncryptionAlgorithms(Collection<String> 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.
    
    Parameters:
    
    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.
  - withEncryptionAlgorithms
```
public GetPublicKeyResult withEncryptionAlgorithms(String... 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withEncryptionAlgorithms
```
public GetPublicKeyResult withEncryptionAlgorithms(Collection<String> 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSigningAlgorithms
```
public List<String> getSigningAlgorithms()
```
    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.
    
    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.
  - setSigningAlgorithms
```
public void setSigningAlgorithms(Collection<String> 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.
    
    Parameters:
    
    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.
  - withSigningAlgorithms
```
public GetPublicKeyResult withSigningAlgorithms(String... 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withSigningAlgorithms
```
public GetPublicKeyResult withSigningAlgorithms(Collection<String> 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class GetPublicKeyResult

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GetPublicKeyResult

Method Detail

getKeyId

setKeyId

withKeyId

getPublicKey

setPublicKey

withPublicKey

getCustomerMasterKeySpec

setCustomerMasterKeySpec

withCustomerMasterKeySpec

setCustomerMasterKeySpec

withCustomerMasterKeySpec

getKeyUsage

setKeyUsage

withKeyUsage

setKeyUsage

withKeyUsage

getEncryptionAlgorithms

setEncryptionAlgorithms

withEncryptionAlgorithms

withEncryptionAlgorithms

getSigningAlgorithms

setSigningAlgorithms

withSigningAlgorithms

withSigningAlgorithms

toString

hashCode

equals