/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.kms.model; import java.io.Serializable; public class GenerateDataKeyPairResult implements Serializable { /** *

* The encrypted copy of the private key. When you use the HTTP API or the * Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is * not Base64-encoded. *

* Constraints:
* Length: 1 - 6144
*/ private java.nio.ByteBuffer privateKeyCiphertextBlob; /** *

* The plaintext copy of the private key. When you use the HTTP API or the * Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is * not Base64-encoded. *

* If the response includes the CiphertextForRecipient field, * the PrivateKeyPlaintext field is null or empty. *

* Constraints:
* Length: 1 - 4096
*/ private java.nio.ByteBuffer privateKeyPlaintext; /** *

* The public key (in plaintext). When you use the HTTP API or the Amazon * Web Services CLI, the value is Base64-encoded. Otherwise, it is not * Base64-encoded. *

* Constraints:
* Length: 1 - 8192
*/ private java.nio.ByteBuffer publicKey; /** *

* The Amazon Resource Name (key ARN) of the KMS key that encrypted the private key. *

* Constraints:
* Length: 1 - 2048
*/ private String keyId; /** *

* 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, SM2 */ private String keyPairSpec; /** *

* The plaintext private data key encrypted with the public key from the * Nitro enclave. This ciphertext can be decrypted only by using a private * key in the Nitro enclave. *

* This field is included in the response only when the * Recipient parameter in the request includes a valid * attestation document from an Amazon Web Services Nitro enclave. For * information about the interaction between KMS and Amazon Web Services * Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key * Management Service Developer Guide. *

* Constraints:
* Length: 1 - 6144
*/ private java.nio.ByteBuffer ciphertextForRecipient; /** *

* The encrypted copy of the private key. When you use the HTTP API or the * Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is * not Base64-encoded. *

* Constraints:
* Length: 1 - 6144
* * @return

* The encrypted copy of the private key. When you use the HTTP API * or the Amazon Web Services CLI, the value is Base64-encoded. * Otherwise, it is not Base64-encoded. *

*/ public java.nio.ByteBuffer getPrivateKeyCiphertextBlob() { return privateKeyCiphertextBlob; } /** *

* The encrypted copy of the private key. When you use the HTTP API or the * Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is * not Base64-encoded. *

* Constraints:
* Length: 1 - 6144
* * @param privateKeyCiphertextBlob

* The encrypted copy of the private key. When you use the HTTP * API or the Amazon Web Services CLI, the value is * Base64-encoded. Otherwise, it is not Base64-encoded. *

*/ public void setPrivateKeyCiphertextBlob(java.nio.ByteBuffer privateKeyCiphertextBlob) { this.privateKeyCiphertextBlob = privateKeyCiphertextBlob; } /** *

* The encrypted copy of the private key. When you use the HTTP API or the * Amazon Web Services 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
* * @param privateKeyCiphertextBlob

* The encrypted copy of the private key. When you use the HTTP * API or the Amazon Web Services CLI, the value is * Base64-encoded. Otherwise, it is not Base64-encoded. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GenerateDataKeyPairResult withPrivateKeyCiphertextBlob( java.nio.ByteBuffer privateKeyCiphertextBlob) { this.privateKeyCiphertextBlob = privateKeyCiphertextBlob; return this; } /** *

* The plaintext copy of the private key. When you use the HTTP API or the * Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is * not Base64-encoded. *

* If the response includes the CiphertextForRecipient field, * the PrivateKeyPlaintext field is null or empty. *

* Constraints:
* Length: 1 - 4096
* * @return

* The plaintext copy of the private key. When you use the HTTP API * or the Amazon Web Services CLI, the value is Base64-encoded. * Otherwise, it is not Base64-encoded. *

* If the response includes the CiphertextForRecipient * field, the PrivateKeyPlaintext field is null or * empty. *

*/ public java.nio.ByteBuffer getPrivateKeyPlaintext() { return privateKeyPlaintext; } /** *

* The plaintext copy of the private key. When you use the HTTP API or the * Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is * not Base64-encoded. *

* If the response includes the CiphertextForRecipient field, * the PrivateKeyPlaintext field is null or empty. *

* Constraints:
* Length: 1 - 4096
* * @param privateKeyPlaintext

* The plaintext copy of the private key. When you use the HTTP * API or the Amazon Web Services CLI, the value is * Base64-encoded. Otherwise, it is not Base64-encoded. *

* If the response includes the * CiphertextForRecipient field, the * PrivateKeyPlaintext field is null or empty. *

*/ public void setPrivateKeyPlaintext(java.nio.ByteBuffer privateKeyPlaintext) { this.privateKeyPlaintext = privateKeyPlaintext; } /** *

* The plaintext copy of the private key. When you use the HTTP API or the * Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is * not Base64-encoded. *

* If the response includes the CiphertextForRecipient field, * the PrivateKeyPlaintext field is null or empty. *

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 4096
* * @param privateKeyPlaintext

* The plaintext copy of the private key. When you use the HTTP * API or the Amazon Web Services CLI, the value is * Base64-encoded. Otherwise, it is not Base64-encoded. *

* If the response includes the * CiphertextForRecipient field, the * PrivateKeyPlaintext field is null or empty. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GenerateDataKeyPairResult withPrivateKeyPlaintext(java.nio.ByteBuffer privateKeyPlaintext) { this.privateKeyPlaintext = privateKeyPlaintext; return this; } /** *

* The public key (in plaintext). When you use the HTTP API or the Amazon * Web Services CLI, the value is Base64-encoded. Otherwise, it is not * Base64-encoded. *

* Constraints:
* Length: 1 - 8192
* * @return

* The public key (in plaintext). When you use the HTTP API or the * Amazon Web Services CLI, the value is Base64-encoded. Otherwise, * it is not Base64-encoded. *

*/ public java.nio.ByteBuffer getPublicKey() { return publicKey; } /** *

* The public key (in plaintext). When you use the HTTP API or the Amazon * Web Services CLI, the value is Base64-encoded. Otherwise, it is not * Base64-encoded. *

* Constraints:
* Length: 1 - 8192
* * @param publicKey

* The public key (in plaintext). When you use the HTTP API or * the Amazon Web Services CLI, the value is Base64-encoded. * Otherwise, it is not Base64-encoded. *

*/ public void setPublicKey(java.nio.ByteBuffer publicKey) { this.publicKey = publicKey; } /** *

* The public key (in plaintext). When you use the HTTP API or the Amazon * Web Services 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
* * @param publicKey

* The public key (in plaintext). When you use the HTTP API or * the Amazon Web Services CLI, the value is Base64-encoded. * Otherwise, it is not Base64-encoded. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GenerateDataKeyPairResult withPublicKey(java.nio.ByteBuffer publicKey) { this.publicKey = publicKey; return this; } /** *

* The Amazon Resource Name (key ARN) of the KMS key that encrypted the private key. *

* Constraints:
* Length: 1 - 2048
* * @return

* The Amazon Resource Name (key ARN) of the KMS key that encrypted the private key. *

*/ public String getKeyId() { return keyId; } /** *

* The Amazon Resource Name (key ARN) of the KMS key that encrypted the private key. *

* Constraints:
* Length: 1 - 2048
* * @param keyId

* The Amazon Resource Name (key ARN) of the KMS key that encrypted the private key. *

*/ public void setKeyId(String keyId) { this.keyId = keyId; } /** *

* The Amazon Resource Name (key ARN) of the KMS key that encrypted the private key. *

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 2048
* * @param keyId

* The Amazon Resource Name (key ARN) of the KMS key that encrypted the private key. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GenerateDataKeyPairResult withKeyId(String keyId) { this.keyId = keyId; return this; } /** *

* 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, SM2 * * @return

* The type of data key pair that was generated. *

* @see DataKeyPairSpec */ public String getKeyPairSpec() { return 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, SM2 * * @param keyPairSpec

* The type of data key pair that was generated. *

* @see DataKeyPairSpec */ public void setKeyPairSpec(String keyPairSpec) { this.keyPairSpec = 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, SM2 * * @param keyPairSpec

* The type of data key pair that was generated. *

* @return A reference to this updated object so that method calls can be * chained together. * @see DataKeyPairSpec */ public GenerateDataKeyPairResult withKeyPairSpec(String keyPairSpec) { this.keyPairSpec = keyPairSpec; return this; } /** *

* 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, SM2 * * @param keyPairSpec

* The type of data key pair that was generated. *

* @see DataKeyPairSpec */ public void setKeyPairSpec(DataKeyPairSpec keyPairSpec) { this.keyPairSpec = keyPairSpec.toString(); } /** *

* 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, SM2 * * @param keyPairSpec

* The type of data key pair that was generated. *

* @return A reference to this updated object so that method calls can be * chained together. * @see DataKeyPairSpec */ public GenerateDataKeyPairResult withKeyPairSpec(DataKeyPairSpec keyPairSpec) { this.keyPairSpec = keyPairSpec.toString(); return this; } /** *

* The plaintext private data key encrypted with the public key from the * Nitro enclave. This ciphertext can be decrypted only by using a private * key in the Nitro enclave. *

* Constraints:
* Length: 1 - 6144
* * @return

* The plaintext private data key encrypted with the public key from * the Nitro enclave. This ciphertext can be decrypted only by using * a private key in the Nitro enclave. *

* This field is included in the response only when the * Recipient parameter in the request includes a valid * attestation document from an Amazon Web Services Nitro enclave. * For information about the interaction between KMS and Amazon Web * Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the * Key Management Service Developer Guide. *

*/ public java.nio.ByteBuffer getCiphertextForRecipient() { return ciphertextForRecipient; } /** *

* The plaintext private data key encrypted with the public key from the * Nitro enclave. This ciphertext can be decrypted only by using a private * key in the Nitro enclave. *

* Constraints:
* Length: 1 - 6144
* * @param ciphertextForRecipient

* The plaintext private data key encrypted with the public key * from the Nitro enclave. This ciphertext can be decrypted only * by using a private key in the Nitro enclave. *

* This field is included in the response only when the * Recipient parameter in the request includes a * valid attestation document from an Amazon Web Services Nitro * enclave. For information about the interaction between KMS and * Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the * Key Management Service Developer Guide. *

*/ public void setCiphertextForRecipient(java.nio.ByteBuffer ciphertextForRecipient) { this.ciphertextForRecipient = ciphertextForRecipient; } /** *

* The plaintext private data key encrypted with the public key from the * Nitro enclave. This ciphertext can be decrypted only by using a private * key in the Nitro enclave. *

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 6144
* * @param ciphertextForRecipient

* The plaintext private data key encrypted with the public key * from the Nitro enclave. This ciphertext can be decrypted only * by using a private key in the Nitro enclave. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GenerateDataKeyPairResult withCiphertextForRecipient( java.nio.ByteBuffer ciphertextForRecipient) { this.ciphertextForRecipient = ciphertextForRecipient; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getPrivateKeyCiphertextBlob() != null) sb.append("PrivateKeyCiphertextBlob: " + getPrivateKeyCiphertextBlob() + ","); if (getPrivateKeyPlaintext() != null) sb.append("PrivateKeyPlaintext: " + getPrivateKeyPlaintext() + ","); if (getPublicKey() != null) sb.append("PublicKey: " + getPublicKey() + ","); if (getKeyId() != null) sb.append("KeyId: " + getKeyId() + ","); if (getKeyPairSpec() != null) sb.append("KeyPairSpec: " + getKeyPairSpec() + ","); if (getCiphertextForRecipient() != null) sb.append("CiphertextForRecipient: " + getCiphertextForRecipient()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getPrivateKeyCiphertextBlob() == null) ? 0 : getPrivateKeyCiphertextBlob() .hashCode()); hashCode = prime * hashCode + ((getPrivateKeyPlaintext() == null) ? 0 : getPrivateKeyPlaintext().hashCode()); hashCode = prime * hashCode + ((getPublicKey() == null) ? 0 : getPublicKey().hashCode()); hashCode = prime * hashCode + ((getKeyId() == null) ? 0 : getKeyId().hashCode()); hashCode = prime * hashCode + ((getKeyPairSpec() == null) ? 0 : getKeyPairSpec().hashCode()); hashCode = prime * hashCode + ((getCiphertextForRecipient() == null) ? 0 : getCiphertextForRecipient() .hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof GenerateDataKeyPairResult == false) return false; GenerateDataKeyPairResult other = (GenerateDataKeyPairResult) obj; if (other.getPrivateKeyCiphertextBlob() == null ^ this.getPrivateKeyCiphertextBlob() == null) return false; if (other.getPrivateKeyCiphertextBlob() != null && other.getPrivateKeyCiphertextBlob().equals(this.getPrivateKeyCiphertextBlob()) == false) return false; if (other.getPrivateKeyPlaintext() == null ^ this.getPrivateKeyPlaintext() == null) return false; if (other.getPrivateKeyPlaintext() != null && other.getPrivateKeyPlaintext().equals(this.getPrivateKeyPlaintext()) == false) return false; if (other.getPublicKey() == null ^ this.getPublicKey() == null) return false; if (other.getPublicKey() != null && other.getPublicKey().equals(this.getPublicKey()) == false) return false; if (other.getKeyId() == null ^ this.getKeyId() == null) return false; if (other.getKeyId() != null && other.getKeyId().equals(this.getKeyId()) == false) return false; if (other.getKeyPairSpec() == null ^ this.getKeyPairSpec() == null) return false; if (other.getKeyPairSpec() != null && other.getKeyPairSpec().equals(this.getKeyPairSpec()) == false) return false; if (other.getCiphertextForRecipient() == null ^ this.getCiphertextForRecipient() == null) return false; if (other.getCiphertextForRecipient() != null && other.getCiphertextForRecipient().equals(this.getCiphertextForRecipient()) == false) return false; return true; } }