com.ibm.cloud.objectstorage.services.kms.model.GetParametersForImportRequest 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 GetParametersForImportRequest extends com.ibm.cloud.objectstorage.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The identifier of the CMK into which you will import key material. The CMK's Origin must be
* EXTERNAL.
*
*
* A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
*
*
* -
*
* Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*
*/
private String keyId;
/**
*
* The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For
* more information, see Encrypt the
* Key Material in the AWS Key Management Service Developer Guide.
*
*/
private String wrappingAlgorithm;
/**
*
* The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.
*
*/
private String wrappingKeySpec;
/**
*
* The identifier of the CMK into which you will import key material. The CMK's Origin must be
* EXTERNAL.
*
*
* A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
*
*
* -
*
* Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*
*
* @param keyId
* The identifier of the CMK into which you will import key material. The CMK's Origin must be
* EXTERNAL.
*
* A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
*
*
* -
*
* Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*/
public void setKeyId(String keyId) {
this.keyId = keyId;
}
/**
*
* The identifier of the CMK into which you will import key material. The CMK's Origin must be
* EXTERNAL.
*
*
* A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
*
*
* -
*
* Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*
*
* @return The identifier of the CMK into which you will import key material. The CMK's Origin must be
* EXTERNAL.
*
* A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
*
*
* -
*
* Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*/
public String getKeyId() {
return this.keyId;
}
/**
*
* The identifier of the CMK into which you will import key material. The CMK's Origin must be
* EXTERNAL.
*
*
* A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
*
*
* -
*
* Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*
*
* @param keyId
* The identifier of the CMK into which you will import key material. The CMK's Origin must be
* EXTERNAL.
*
* A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
*
*
* -
*
* Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetParametersForImportRequest withKeyId(String keyId) {
setKeyId(keyId);
return this;
}
/**
*
* The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For
* more information, see Encrypt the
* Key Material in the AWS Key Management Service Developer Guide.
*
*
* @param wrappingAlgorithm
* The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial.
* For more information, see Encrypt the Key Material in the AWS Key Management Service Developer Guide.
* @see AlgorithmSpec
*/
public void setWrappingAlgorithm(String wrappingAlgorithm) {
this.wrappingAlgorithm = wrappingAlgorithm;
}
/**
*
* The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For
* more information, see Encrypt the
* Key Material in the AWS Key Management Service Developer Guide.
*
*
* @return The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial.
* For more information, see Encrypt the Key Material in the AWS Key Management Service Developer Guide.
* @see AlgorithmSpec
*/
public String getWrappingAlgorithm() {
return this.wrappingAlgorithm;
}
/**
*
* The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For
* more information, see Encrypt the
* Key Material in the AWS Key Management Service Developer Guide.
*
*
* @param wrappingAlgorithm
* The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial.
* For more information, see Encrypt the Key Material in the AWS Key Management Service Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AlgorithmSpec
*/
public GetParametersForImportRequest withWrappingAlgorithm(String wrappingAlgorithm) {
setWrappingAlgorithm(wrappingAlgorithm);
return this;
}
/**
*
* The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For
* more information, see Encrypt the
* Key Material in the AWS Key Management Service Developer Guide.
*
*
* @param wrappingAlgorithm
* The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial.
* For more information, see Encrypt the Key Material in the AWS Key Management Service Developer Guide.
* @see AlgorithmSpec
*/
public void setWrappingAlgorithm(AlgorithmSpec wrappingAlgorithm) {
this.wrappingAlgorithm = wrappingAlgorithm.toString();
}
/**
*
* The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For
* more information, see Encrypt the
* Key Material in the AWS Key Management Service Developer Guide.
*
*
* @param wrappingAlgorithm
* The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial.
* For more information, see Encrypt the Key Material in the AWS Key Management Service Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AlgorithmSpec
*/
public GetParametersForImportRequest withWrappingAlgorithm(AlgorithmSpec wrappingAlgorithm) {
setWrappingAlgorithm(wrappingAlgorithm);
return this;
}
/**
*
* The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.
*
*
* @param wrappingKeySpec
* The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are
* supported.
* @see WrappingKeySpec
*/
public void setWrappingKeySpec(String wrappingKeySpec) {
this.wrappingKeySpec = wrappingKeySpec;
}
/**
*
* The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.
*
*
* @return The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are
* supported.
* @see WrappingKeySpec
*/
public String getWrappingKeySpec() {
return this.wrappingKeySpec;
}
/**
*
* The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.
*
*
* @param wrappingKeySpec
* The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are
* supported.
* @return Returns a reference to this object so that method calls can be chained together.
* @see WrappingKeySpec
*/
public GetParametersForImportRequest withWrappingKeySpec(String wrappingKeySpec) {
setWrappingKeySpec(wrappingKeySpec);
return this;
}
/**
*
* The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.
*
*
* @param wrappingKeySpec
* The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are
* supported.
* @see WrappingKeySpec
*/
public void setWrappingKeySpec(WrappingKeySpec wrappingKeySpec) {
this.wrappingKeySpec = wrappingKeySpec.toString();
}
/**
*
* The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.
*
*
* @param wrappingKeySpec
* The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are
* supported.
* @return Returns a reference to this object so that method calls can be chained together.
* @see WrappingKeySpec
*/
public GetParametersForImportRequest withWrappingKeySpec(WrappingKeySpec wrappingKeySpec) {
setWrappingKeySpec(wrappingKeySpec);
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 (getWrappingAlgorithm() != null)
sb.append("WrappingAlgorithm: ").append(getWrappingAlgorithm()).append(",");
if (getWrappingKeySpec() != null)
sb.append("WrappingKeySpec: ").append(getWrappingKeySpec());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetParametersForImportRequest == false)
return false;
GetParametersForImportRequest other = (GetParametersForImportRequest) obj;
if (other.getKeyId() == null ^ this.getKeyId() == null)
return false;
if (other.getKeyId() != null && other.getKeyId().equals(this.getKeyId()) == false)
return false;
if (other.getWrappingAlgorithm() == null ^ this.getWrappingAlgorithm() == null)
return false;
if (other.getWrappingAlgorithm() != null && other.getWrappingAlgorithm().equals(this.getWrappingAlgorithm()) == false)
return false;
if (other.getWrappingKeySpec() == null ^ this.getWrappingKeySpec() == null)
return false;
if (other.getWrappingKeySpec() != null && other.getWrappingKeySpec().equals(this.getWrappingKeySpec()) == 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 + ((getWrappingAlgorithm() == null) ? 0 : getWrappingAlgorithm().hashCode());
hashCode = prime * hashCode + ((getWrappingKeySpec() == null) ? 0 : getWrappingKeySpec().hashCode());
return hashCode;
}
@Override
public GetParametersForImportRequest clone() {
return (GetParametersForImportRequest) super.clone();
}
}