com.amazonaws.services.kms.model.GetParametersForImportResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kms Show documentation
/*
* Copyright 2019-2024 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;
import javax.annotation.Generated;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GetParametersForImportResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The Amazon Resource Name (key ARN) of the KMS
* key to use in a subsequent ImportKeyMaterial request. This is the same KMS key specified in the
* GetParametersForImport request.
*
*/
private String keyId;
/**
*
* The import token to send in a subsequent ImportKeyMaterial request.
*
*/
private java.nio.ByteBuffer importToken;
/**
*
* The public key to use to encrypt the key material before importing it with ImportKeyMaterial.
*
*/
private java.nio.ByteBuffer publicKey;
/**
*
* The time at which the import token and public key are no longer valid. After this time, you cannot use them to
* make an ImportKeyMaterial request and you must send another GetParametersForImport request to
* get new ones.
*
*/
private java.util.Date parametersValidTo;
/**
*
* The Amazon Resource Name (key ARN) of the KMS
* key to use in a subsequent ImportKeyMaterial request. This is the same KMS key specified in the
* GetParametersForImport request.
*
*
* @param keyId
* The Amazon Resource Name (key ARN) of
* the KMS key to use in a subsequent ImportKeyMaterial request. This is the same KMS key specified in
* the GetParametersForImport request.
*/
public void setKeyId(String keyId) {
this.keyId = keyId;
}
/**
*
* The Amazon Resource Name (key ARN) of the KMS
* key to use in a subsequent ImportKeyMaterial request. This is the same KMS key specified in the
* GetParametersForImport request.
*
*
* @return The Amazon Resource Name (key ARN) of
* the KMS key to use in a subsequent ImportKeyMaterial request. This is the same KMS key specified
* in the GetParametersForImport request.
*/
public String getKeyId() {
return this.keyId;
}
/**
*
* The Amazon Resource Name (key ARN) of the KMS
* key to use in a subsequent ImportKeyMaterial request. This is the same KMS key specified in the
* GetParametersForImport request.
*
*
* @param keyId
* The Amazon Resource Name (key ARN) of
* the KMS key to use in a subsequent ImportKeyMaterial request. This is the same KMS key specified in
* the GetParametersForImport request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetParametersForImportResult withKeyId(String keyId) {
setKeyId(keyId);
return this;
}
/**
*
* The import token to send in a subsequent ImportKeyMaterial request.
*
*
* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service.
* Users of the SDK should not perform Base64 encoding on this field.
*
*
* Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will
* be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or
* ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future
* major version of the SDK.
*
*
* @param importToken
* The import token to send in a subsequent ImportKeyMaterial request.
*/
public void setImportToken(java.nio.ByteBuffer importToken) {
this.importToken = importToken;
}
/**
*
* The import token to send in a subsequent ImportKeyMaterial request.
*
*
* {@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend
* using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent
* {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}.
* Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the
* {@code position}.
*
*
* @return The import token to send in a subsequent ImportKeyMaterial request.
*/
public java.nio.ByteBuffer getImportToken() {
return this.importToken;
}
/**
*
* The import token to send in a subsequent ImportKeyMaterial request.
*
*
* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service.
* Users of the SDK should not perform Base64 encoding on this field.
*
*
* Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will
* be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or
* ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future
* major version of the SDK.
*
*
* @param importToken
* The import token to send in a subsequent ImportKeyMaterial request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetParametersForImportResult withImportToken(java.nio.ByteBuffer importToken) {
setImportToken(importToken);
return this;
}
/**
*
* The public key to use to encrypt the key material before importing it with ImportKeyMaterial.
*
*
* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service.
* Users of the SDK should not perform Base64 encoding on this field.
*
*
* Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will
* be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or
* ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future
* major version of the SDK.
*
*
* @param publicKey
* The public key to use to encrypt the key material before importing it with ImportKeyMaterial.
*/
public void setPublicKey(java.nio.ByteBuffer publicKey) {
this.publicKey = publicKey;
}
/**
*
* The public key to use to encrypt the key material before importing it with ImportKeyMaterial.
*
*
* {@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend
* using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent
* {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}.
* Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the
* {@code position}.
*
*
* @return The public key to use to encrypt the key material before importing it with ImportKeyMaterial.
*/
public java.nio.ByteBuffer getPublicKey() {
return this.publicKey;
}
/**
*
* The public key to use to encrypt the key material before importing it with ImportKeyMaterial.
*
*
* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service.
* Users of the SDK should not perform Base64 encoding on this field.
*
*
* Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will
* be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or
* ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future
* major version of the SDK.
*
*
* @param publicKey
* The public key to use to encrypt the key material before importing it with ImportKeyMaterial.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetParametersForImportResult withPublicKey(java.nio.ByteBuffer publicKey) {
setPublicKey(publicKey);
return this;
}
/**
*
* The time at which the import token and public key are no longer valid. After this time, you cannot use them to
* make an ImportKeyMaterial request and you must send another GetParametersForImport request to
* get new ones.
*
*
* @param parametersValidTo
* The time at which the import token and public key are no longer valid. After this time, you cannot use
* them to make an ImportKeyMaterial request and you must send another
* GetParametersForImport request to get new ones.
*/
public void setParametersValidTo(java.util.Date parametersValidTo) {
this.parametersValidTo = parametersValidTo;
}
/**
*
* The time at which the import token and public key are no longer valid. After this time, you cannot use them to
* make an ImportKeyMaterial request and you must send another GetParametersForImport request to
* get new ones.
*
*
* @return The time at which the import token and public key are no longer valid. After this time, you cannot use
* them to make an ImportKeyMaterial request and you must send another
* GetParametersForImport request to get new ones.
*/
public java.util.Date getParametersValidTo() {
return this.parametersValidTo;
}
/**
*
* The time at which the import token and public key are no longer valid. After this time, you cannot use them to
* make an ImportKeyMaterial request and you must send another GetParametersForImport request to
* get new ones.
*
*
* @param parametersValidTo
* The time at which the import token and public key are no longer valid. After this time, you cannot use
* them to make an ImportKeyMaterial request and you must send another
* GetParametersForImport request to get new ones.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetParametersForImportResult withParametersValidTo(java.util.Date parametersValidTo) {
setParametersValidTo(parametersValidTo);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @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 (getImportToken() != null)
sb.append("ImportToken: ").append(getImportToken()).append(",");
if (getPublicKey() != null)
sb.append("PublicKey: ").append("***Sensitive Data Redacted***").append(",");
if (getParametersValidTo() != null)
sb.append("ParametersValidTo: ").append(getParametersValidTo());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetParametersForImportResult == false)
return false;
GetParametersForImportResult other = (GetParametersForImportResult) obj;
if (other.getKeyId() == null ^ this.getKeyId() == null)
return false;
if (other.getKeyId() != null && other.getKeyId().equals(this.getKeyId()) == false)
return false;
if (other.getImportToken() == null ^ this.getImportToken() == null)
return false;
if (other.getImportToken() != null && other.getImportToken().equals(this.getImportToken()) == 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.getParametersValidTo() == null ^ this.getParametersValidTo() == null)
return false;
if (other.getParametersValidTo() != null && other.getParametersValidTo().equals(this.getParametersValidTo()) == 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 + ((getImportToken() == null) ? 0 : getImportToken().hashCode());
hashCode = prime * hashCode + ((getPublicKey() == null) ? 0 : getPublicKey().hashCode());
hashCode = prime * hashCode + ((getParametersValidTo() == null) ? 0 : getParametersValidTo().hashCode());
return hashCode;
}
@Override
public GetParametersForImportResult clone() {
try {
return (GetParametersForImportResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}