GenerateDataKeyPairWithoutPlaintextResult (AWS SDK for Android

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

All Implemented Interfaces:: Serializable

public class GenerateDataKeyPairWithoutPlaintextResult
extends Object
implements Serializable

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

GenerateDataKeyPairWithoutPlaintextResult()

Constructors
Constructor and Description
`GenerateDataKeyPairWithoutPlaintextResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getKeyId()` Specifies the CMK that encrypted the private key in the data key pair.
`String`	`getKeyPairSpec()` The type of data key pair that was generated.
`ByteBuffer`	`getPrivateKeyCiphertextBlob()` The encrypted copy of the private key.
`ByteBuffer`	`getPublicKey()` The public key (in plaintext).
`int`	`hashCode()`
`void`	`setKeyId(String keyId)` Specifies the CMK that encrypted the private key in the data key pair.
`void`	`setKeyPairSpec(DataKeyPairSpec keyPairSpec)` The type of data key pair that was generated.
`void`	`setKeyPairSpec(String keyPairSpec)` The type of data key pair that was generated.
`void`	`setPrivateKeyCiphertextBlob(ByteBuffer privateKeyCiphertextBlob)` The encrypted copy of the private key.
`void`	`setPublicKey(ByteBuffer publicKey)` The public key (in plaintext).
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`GenerateDataKeyPairWithoutPlaintextResult`	`withKeyId(String keyId)` Specifies the CMK that encrypted the private key in the data key pair.
`GenerateDataKeyPairWithoutPlaintextResult`	`withKeyPairSpec(DataKeyPairSpec keyPairSpec)` The type of data key pair that was generated.
`GenerateDataKeyPairWithoutPlaintextResult`	`withKeyPairSpec(String keyPairSpec)` The type of data key pair that was generated.
`GenerateDataKeyPairWithoutPlaintextResult`	`withPrivateKeyCiphertextBlob(ByteBuffer privateKeyCiphertextBlob)` The encrypted copy of the private key.
`GenerateDataKeyPairWithoutPlaintextResult`	`withPublicKey(ByteBuffer publicKey)` The public key (in plaintext).

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

- Constructor Detail
  - GenerateDataKeyPairWithoutPlaintextResult
```
public GenerateDataKeyPairWithoutPlaintextResult()
```
- Method Detail
  - getPrivateKeyCiphertextBlob
```
public ByteBuffer getPrivateKeyCiphertextBlob()
```
    The encrypted copy of the private key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
    
    Constraints:
    Length: 1 - 6144
    
    Returns:
    
    The encrypted copy of the private key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
  - setPrivateKeyCiphertextBlob
```
public void setPrivateKeyCiphertextBlob(ByteBuffer privateKeyCiphertextBlob)
```
    The encrypted copy of the private key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
    
    Constraints:
    Length: 1 - 6144
    
    Parameters:
    
    privateKeyCiphertextBlob -
    The encrypted copy of the private key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
  - withPrivateKeyCiphertextBlob
```
public GenerateDataKeyPairWithoutPlaintextResult withPrivateKeyCiphertextBlob(ByteBuffer privateKeyCiphertextBlob)
```
    The encrypted copy of the private key. 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 - 6144
    
    Parameters:
    
    privateKeyCiphertextBlob -
    The encrypted copy of the private key. 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.
  - getPublicKey
```
public ByteBuffer getPublicKey()
```
    The public key (in plaintext).
    
    Constraints:
    Length: 1 - 8192
    
    Returns:
    
    The public key (in plaintext).
  - setPublicKey
```
public void setPublicKey(ByteBuffer publicKey)
```
    The public key (in plaintext).
    
    Constraints:
    Length: 1 - 8192
    
    Parameters:
    
    publicKey -
    The public key (in plaintext).
  - withPublicKey
```
public GenerateDataKeyPairWithoutPlaintextResult withPublicKey(ByteBuffer publicKey)
```
    The public key (in plaintext).
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 8192
    
    Parameters:
    
    publicKey -
    The public key (in plaintext).
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getKeyId
```
public String getKeyId()
```
    Specifies the CMK that encrypted the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK. To get the type of your CMK, use the DescribeKey operation.
    
    To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/".
    
    For example:
    - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    - Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    - Alias name: alias/ExampleAlias
    - Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
    
    Constraints:
    Length: 1 - 2048
    Returns:
    Specifies the CMK that encrypted the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK. To get the type of your CMK, use the DescribeKey operation.
    
    To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/".
    
    For example:
    
    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    
    Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    
    Alias name: alias/ExampleAlias
    
    Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
    
    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
  - setKeyId
```
public void setKeyId(String keyId)
```
    Specifies the CMK that encrypted the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK. To get the type of your CMK, use the DescribeKey operation.
    
    To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/".
    
    For example:
    - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    - Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    - Alias name: alias/ExampleAlias
    - Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
    
    Constraints:
    Length: 1 - 2048
    Parameters:
    keyId -
    Specifies the CMK that encrypted the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK. To get the type of your CMK, use the DescribeKey operation.
    
    To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/".
    
    For example:
    
    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    
    Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    
    Alias name: alias/ExampleAlias
    
    Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
    
    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
  - withKeyId
```
public GenerateDataKeyPairWithoutPlaintextResult withKeyId(String keyId)
```
    Specifies the CMK that encrypted the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK. To get the type of your CMK, use the DescribeKey operation.
    
    To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/".
    
    For example:
    - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    - Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    - Alias name: alias/ExampleAlias
    - Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 2048
    Parameters:
    keyId -
    Specifies the CMK that encrypted the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK. To get the type of your CMK, use the DescribeKey operation.
    
    To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/".
    
    For example:
    
    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    
    Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    
    Alias name: alias/ExampleAlias
    
    Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
    
    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getKeyPairSpec
```
public String getKeyPairSpec()
```
    The type of data key pair that was generated.
    
    Constraints:
    Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1
    
    Returns:
    
    The type of data key pair that was generated.
    
    See Also:
    
    DataKeyPairSpec
  - setKeyPairSpec
```
public void setKeyPairSpec(String keyPairSpec)
```
    The type of data key pair that was generated.
    
    Constraints:
    Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1
    
    Parameters:
    
    keyPairSpec -
    The type of data key pair that was generated.
    
    See Also:
    
    DataKeyPairSpec
  - withKeyPairSpec
```
public GenerateDataKeyPairWithoutPlaintextResult withKeyPairSpec(String keyPairSpec)
```
    The type of data key pair that was generated.
    
    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
    
    Parameters:
    
    keyPairSpec -
    The type of data key pair that was generated.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    DataKeyPairSpec
  - setKeyPairSpec
```
public void setKeyPairSpec(DataKeyPairSpec keyPairSpec)
```
    The type of data key pair that was generated.
    
    Constraints:
    Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1
    
    Parameters:
    
    keyPairSpec -
    The type of data key pair that was generated.
    
    See Also:
    
    DataKeyPairSpec
  - withKeyPairSpec
```
public GenerateDataKeyPairWithoutPlaintextResult withKeyPairSpec(DataKeyPairSpec keyPairSpec)
```
    The type of data key pair that was generated.
    
    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
    
    Parameters:
    
    keyPairSpec -
    The type of data key pair that was generated.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    DataKeyPairSpec
  - 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 GenerateDataKeyPairWithoutPlaintextResult

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GenerateDataKeyPairWithoutPlaintextResult

Method Detail

getPrivateKeyCiphertextBlob

setPrivateKeyCiphertextBlob

withPrivateKeyCiphertextBlob

getPublicKey

setPublicKey

withPublicKey

getKeyId

setKeyId

withKeyId

getKeyPairSpec

setKeyPairSpec

withKeyPairSpec

setKeyPairSpec

withKeyPairSpec

toString

hashCode

equals