com.ibm.cloud.objectstorage.services.kms.model.GenerateDataKeyWithoutPlaintextRequest Maven / Gradle / Ivy
Show all versions of ibm-cos-java-sdk-bundle Show documentation
/*
* Copyright 2012-2017 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.ibm.cloud.objectstorage.services.kms.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.ibm.cloud.objectstorage.AmazonWebServiceRequest;
/**
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GenerateDataKeyWithoutPlaintextRequest extends com.ibm.cloud.objectstorage.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The identifier of the CMK under which to generate and encrypt the data encryption key.
*
*
* A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK, or the alias name or ARN of
* an alias that refers to the CMK. Examples:
*
*
* -
*
* Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* CMK 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
*
*
*
*/
private String keyId;
/**
*
* A set of key-value pairs that represents additional authenticated data.
*
*
* For more information, see Encryption Context in the
* AWS Key Management Service Developer Guide.
*
*/
private com.ibm.cloud.objectstorage.internal.SdkInternalMap encryptionContext;
/**
*
* The length of the data encryption key. Use AES_128 to generate a 128-bit symmetric key, or
* AES_256 to generate a 256-bit symmetric key.
*
*/
private String keySpec;
/**
*
* The length of the data encryption key in bytes. For example, use the value 64 to generate a 512-bit data key (64
* bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the
* KeySpec field instead of this one.
*
*/
private Integer numberOfBytes;
/**
*
* A list of grant tokens.
*
*
* For more information, see Grant Tokens in the
* AWS Key Management Service Developer Guide.
*
*/
private com.ibm.cloud.objectstorage.internal.SdkInternalList grantTokens;
/**
*
* The identifier of the CMK under which to generate and encrypt the data encryption key.
*
*
* A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK, or the alias name or ARN of
* an alias that refers to the CMK. Examples:
*
*
* -
*
* Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* CMK 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
*
*
*
*
* @param keyId
* The identifier of the CMK under which to generate and encrypt the data encryption key.
*
* A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK, or the alias name or
* ARN of an alias that refers to the CMK. Examples:
*
*
* -
*
* Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* CMK 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
*
*
*/
public void setKeyId(String keyId) {
this.keyId = keyId;
}
/**
*
* The identifier of the CMK under which to generate and encrypt the data encryption key.
*
*
* A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK, or the alias name or ARN of
* an alias that refers to the CMK. Examples:
*
*
* -
*
* Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* CMK 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
*
*
*
*
* @return The identifier of the CMK under which to generate and encrypt the data encryption key.
*
* A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK, or the alias name
* or ARN of an alias that refers to the CMK. Examples:
*
*
* -
*
* Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* CMK 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
*
*
*/
public String getKeyId() {
return this.keyId;
}
/**
*
* The identifier of the CMK under which to generate and encrypt the data encryption key.
*
*
* A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK, or the alias name or ARN of
* an alias that refers to the CMK. Examples:
*
*
* -
*
* Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* CMK 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
*
*
*
*
* @param keyId
* The identifier of the CMK under which to generate and encrypt the data encryption key.
*
* A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK, or the alias name or
* ARN of an alias that refers to the CMK. Examples:
*
*
* -
*
* Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* CMK 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
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GenerateDataKeyWithoutPlaintextRequest withKeyId(String keyId) {
setKeyId(keyId);
return this;
}
/**
*
* A set of key-value pairs that represents additional authenticated data.
*
*
* For more information, see Encryption Context in the
* AWS Key Management Service Developer Guide.
*
*
* @return A set of key-value pairs that represents additional authenticated data.
*
* For more information, see Encryption
* Context in the AWS Key Management Service Developer Guide.
*/
public java.util.Map getEncryptionContext() {
if (encryptionContext == null) {
encryptionContext = new com.ibm.cloud.objectstorage.internal.SdkInternalMap();
}
return encryptionContext;
}
/**
*
* A set of key-value pairs that represents additional authenticated data.
*
*
* For more information, see Encryption Context in the
* AWS Key Management Service Developer Guide.
*
*
* @param encryptionContext
* A set of key-value pairs that represents additional authenticated data.
*
* For more information, see Encryption Context
* in the AWS Key Management Service Developer Guide.
*/
public void setEncryptionContext(java.util.Map encryptionContext) {
this.encryptionContext = encryptionContext == null ? null : new com.ibm.cloud.objectstorage.internal.SdkInternalMap(encryptionContext);
}
/**
*
* A set of key-value pairs that represents additional authenticated data.
*
*
* For more information, see Encryption Context in the
* AWS Key Management Service Developer Guide.
*
*
* @param encryptionContext
* A set of key-value pairs that represents additional authenticated data.
*
* For more information, see Encryption Context
* in the AWS Key Management Service Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GenerateDataKeyWithoutPlaintextRequest withEncryptionContext(java.util.Map encryptionContext) {
setEncryptionContext(encryptionContext);
return this;
}
public GenerateDataKeyWithoutPlaintextRequest addEncryptionContextEntry(String key, String value) {
if (null == this.encryptionContext) {
this.encryptionContext = new com.ibm.cloud.objectstorage.internal.SdkInternalMap();
}
if (this.encryptionContext.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.encryptionContext.put(key, value);
return this;
}
/**
* Removes all the entries added into EncryptionContext.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GenerateDataKeyWithoutPlaintextRequest clearEncryptionContextEntries() {
this.encryptionContext = null;
return this;
}
/**
*
* The length of the data encryption key. Use AES_128 to generate a 128-bit symmetric key, or
* AES_256 to generate a 256-bit symmetric key.
*
*
* @param keySpec
* The length of the data encryption key. Use AES_128 to generate a 128-bit symmetric key, or
* AES_256 to generate a 256-bit symmetric key.
* @see DataKeySpec
*/
public void setKeySpec(String keySpec) {
this.keySpec = keySpec;
}
/**
*
* The length of the data encryption key. Use AES_128 to generate a 128-bit symmetric key, or
* AES_256 to generate a 256-bit symmetric key.
*
*
* @return The length of the data encryption key. Use AES_128 to generate a 128-bit symmetric key, or
* AES_256 to generate a 256-bit symmetric key.
* @see DataKeySpec
*/
public String getKeySpec() {
return this.keySpec;
}
/**
*
* The length of the data encryption key. Use AES_128 to generate a 128-bit symmetric key, or
* AES_256 to generate a 256-bit symmetric key.
*
*
* @param keySpec
* The length of the data encryption key. Use AES_128 to generate a 128-bit symmetric key, or
* AES_256 to generate a 256-bit symmetric key.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DataKeySpec
*/
public GenerateDataKeyWithoutPlaintextRequest withKeySpec(String keySpec) {
setKeySpec(keySpec);
return this;
}
/**
*
* The length of the data encryption key. Use AES_128 to generate a 128-bit symmetric key, or
* AES_256 to generate a 256-bit symmetric key.
*
*
* @param keySpec
* The length of the data encryption key. Use AES_128 to generate a 128-bit symmetric key, or
* AES_256 to generate a 256-bit symmetric key.
* @see DataKeySpec
*/
public void setKeySpec(DataKeySpec keySpec) {
this.keySpec = keySpec.toString();
}
/**
*
* The length of the data encryption key. Use AES_128 to generate a 128-bit symmetric key, or
* AES_256 to generate a 256-bit symmetric key.
*
*
* @param keySpec
* The length of the data encryption key. Use AES_128 to generate a 128-bit symmetric key, or
* AES_256 to generate a 256-bit symmetric key.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DataKeySpec
*/
public GenerateDataKeyWithoutPlaintextRequest withKeySpec(DataKeySpec keySpec) {
setKeySpec(keySpec);
return this;
}
/**
*
* The length of the data encryption key in bytes. For example, use the value 64 to generate a 512-bit data key (64
* bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the
* KeySpec field instead of this one.
*
*
* @param numberOfBytes
* The length of the data encryption key in bytes. For example, use the value 64 to generate a 512-bit data
* key (64 bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that
* you use the KeySpec field instead of this one.
*/
public void setNumberOfBytes(Integer numberOfBytes) {
this.numberOfBytes = numberOfBytes;
}
/**
*
* The length of the data encryption key in bytes. For example, use the value 64 to generate a 512-bit data key (64
* bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the
* KeySpec field instead of this one.
*
*
* @return The length of the data encryption key in bytes. For example, use the value 64 to generate a 512-bit data
* key (64 bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend
* that you use the KeySpec field instead of this one.
*/
public Integer getNumberOfBytes() {
return this.numberOfBytes;
}
/**
*
* The length of the data encryption key in bytes. For example, use the value 64 to generate a 512-bit data key (64
* bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the
* KeySpec field instead of this one.
*
*
* @param numberOfBytes
* The length of the data encryption key in bytes. For example, use the value 64 to generate a 512-bit data
* key (64 bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that
* you use the KeySpec field instead of this one.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GenerateDataKeyWithoutPlaintextRequest withNumberOfBytes(Integer numberOfBytes) {
setNumberOfBytes(numberOfBytes);
return this;
}
/**
*
* A list of grant tokens.
*
*
* For more information, see Grant Tokens in the
* AWS Key Management Service Developer Guide.
*
*
* @return A list of grant tokens.
*
* For more information, see Grant Tokens in
* the AWS Key Management Service Developer Guide.
*/
public java.util.List getGrantTokens() {
if (grantTokens == null) {
grantTokens = new com.ibm.cloud.objectstorage.internal.SdkInternalList();
}
return grantTokens;
}
/**
*
* A list of grant tokens.
*
*
* For more information, see Grant Tokens in the
* AWS Key Management Service Developer Guide.
*
*
* @param grantTokens
* A list of grant tokens.
*
* For more information, see Grant Tokens in
* the AWS Key Management Service Developer Guide.
*/
public void setGrantTokens(java.util.Collection grantTokens) {
if (grantTokens == null) {
this.grantTokens = null;
return;
}
this.grantTokens = new com.ibm.cloud.objectstorage.internal.SdkInternalList(grantTokens);
}
/**
*
* A list of grant tokens.
*
*
* For more information, see Grant Tokens in the
* AWS Key Management Service Developer Guide.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setGrantTokens(java.util.Collection)} or {@link #withGrantTokens(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param grantTokens
* A list of grant tokens.
*
* For more information, see Grant Tokens in
* the AWS Key Management Service Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GenerateDataKeyWithoutPlaintextRequest withGrantTokens(String... grantTokens) {
if (this.grantTokens == null) {
setGrantTokens(new com.ibm.cloud.objectstorage.internal.SdkInternalList(grantTokens.length));
}
for (String ele : grantTokens) {
this.grantTokens.add(ele);
}
return this;
}
/**
*
* A list of grant tokens.
*
*
* For more information, see Grant Tokens in the
* AWS Key Management Service Developer Guide.
*
*
* @param grantTokens
* A list of grant tokens.
*
* For more information, see Grant Tokens in
* the AWS Key Management Service Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GenerateDataKeyWithoutPlaintextRequest withGrantTokens(java.util.Collection grantTokens) {
setGrantTokens(grantTokens);
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 (getKeyId() != null)
sb.append("KeyId: ").append(getKeyId()).append(",");
if (getEncryptionContext() != null)
sb.append("EncryptionContext: ").append(getEncryptionContext()).append(",");
if (getKeySpec() != null)
sb.append("KeySpec: ").append(getKeySpec()).append(",");
if (getNumberOfBytes() != null)
sb.append("NumberOfBytes: ").append(getNumberOfBytes()).append(",");
if (getGrantTokens() != null)
sb.append("GrantTokens: ").append(getGrantTokens());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GenerateDataKeyWithoutPlaintextRequest == false)
return false;
GenerateDataKeyWithoutPlaintextRequest other = (GenerateDataKeyWithoutPlaintextRequest) obj;
if (other.getKeyId() == null ^ this.getKeyId() == null)
return false;
if (other.getKeyId() != null && other.getKeyId().equals(this.getKeyId()) == false)
return false;
if (other.getEncryptionContext() == null ^ this.getEncryptionContext() == null)
return false;
if (other.getEncryptionContext() != null && other.getEncryptionContext().equals(this.getEncryptionContext()) == false)
return false;
if (other.getKeySpec() == null ^ this.getKeySpec() == null)
return false;
if (other.getKeySpec() != null && other.getKeySpec().equals(this.getKeySpec()) == false)
return false;
if (other.getNumberOfBytes() == null ^ this.getNumberOfBytes() == null)
return false;
if (other.getNumberOfBytes() != null && other.getNumberOfBytes().equals(this.getNumberOfBytes()) == false)
return false;
if (other.getGrantTokens() == null ^ this.getGrantTokens() == null)
return false;
if (other.getGrantTokens() != null && other.getGrantTokens().equals(this.getGrantTokens()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getKeyId() == null) ? 0 : getKeyId().hashCode());
hashCode = prime * hashCode + ((getEncryptionContext() == null) ? 0 : getEncryptionContext().hashCode());
hashCode = prime * hashCode + ((getKeySpec() == null) ? 0 : getKeySpec().hashCode());
hashCode = prime * hashCode + ((getNumberOfBytes() == null) ? 0 : getNumberOfBytes().hashCode());
hashCode = prime * hashCode + ((getGrantTokens() == null) ? 0 : getGrantTokens().hashCode());
return hashCode;
}
@Override
public GenerateDataKeyWithoutPlaintextRequest clone() {
return (GenerateDataKeyWithoutPlaintextRequest) super.clone();
}
}