* The message to be hashed. Specify a message of up to 4,096 bytes. *
*
* GenerateMac and VerifyMac do not provide special handling for message digests. If you
* generate an HMAC for a hash digest of a message, you must verify the HMAC of the same hash digest.
*
* The HMAC KMS key to use in the operation. The MAC algorithm computes the HMAC for the message and the key as * described in RFC 2104. *
*
* To identify an HMAC KMS key, use the DescribeKey operation and see the KeySpec field in the
* response.
*
* The MAC algorithm used in the operation. *
*
* The algorithm must be compatible with the HMAC KMS key that you specify. To find the MAC algorithms that your
* HMAC KMS key supports, use the DescribeKey operation and see the MacAlgorithms field in the
* DescribeKey response.
*
* A list of grant tokens. *
** Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved * eventual consistency. For more information, see Grant token and Using a grant * token in the Key Management Service Developer Guide. *
*/ private com.amazonaws.internal.SdkInternalList
* Checks if your request will succeed. DryRun is an optional parameter.
*
* To learn more about how to use this parameter, see Testing your KMS API * calls in the Key Management Service Developer Guide. *
*/ private Boolean dryRun; /** ** The message to be hashed. Specify a message of up to 4,096 bytes. *
*
* GenerateMac and VerifyMac do not provide special handling for message digests. If you
* generate an HMAC for a hash digest of a message, you must verify the HMAC of the same hash digest.
*
* 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 message * The message to be hashed. Specify a message of up to 4,096 bytes. *
* GenerateMac and VerifyMac do not provide special handling for message digests. If you
* generate an HMAC for a hash digest of a message, you must verify the HMAC of the same hash digest.
*/
public void setMessage(java.nio.ByteBuffer message) {
this.message = message;
}
/**
*
* The message to be hashed. Specify a message of up to 4,096 bytes. *
*
* GenerateMac and VerifyMac do not provide special handling for message digests. If you
* generate an HMAC for a hash digest of a message, you must verify the HMAC of the same hash digest.
*
* {@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 message to be hashed. Specify a message of up to 4,096 bytes. *
* GenerateMac and VerifyMac do not provide special handling for message digests. If you
* generate an HMAC for a hash digest of a message, you must verify the HMAC of the same hash digest.
*/
public java.nio.ByteBuffer getMessage() {
return this.message;
}
/**
*
* The message to be hashed. Specify a message of up to 4,096 bytes. *
*
* GenerateMac and VerifyMac do not provide special handling for message digests. If you
* generate an HMAC for a hash digest of a message, you must verify the HMAC of the same hash digest.
*
* 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 message * The message to be hashed. Specify a message of up to 4,096 bytes. *
* GenerateMac and VerifyMac do not provide special handling for message digests. If you
* generate an HMAC for a hash digest of a message, you must verify the HMAC of the same hash digest.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GenerateMacRequest withMessage(java.nio.ByteBuffer message) {
setMessage(message);
return this;
}
/**
*
* The HMAC KMS key to use in the operation. The MAC algorithm computes the HMAC for the message and the key as * described in RFC 2104. *
*
* To identify an HMAC KMS key, use the DescribeKey operation and see the KeySpec field in the
* response.
*
* To identify an HMAC KMS key, use the DescribeKey operation and see the KeySpec field
* in the response.
*/
public void setKeyId(String keyId) {
this.keyId = keyId;
}
/**
*
* The HMAC KMS key to use in the operation. The MAC algorithm computes the HMAC for the message and the key as * described in RFC 2104. *
*
* To identify an HMAC KMS key, use the DescribeKey operation and see the KeySpec field in the
* response.
*
* To identify an HMAC KMS key, use the DescribeKey operation and see the KeySpec field
* in the response.
*/
public String getKeyId() {
return this.keyId;
}
/**
*
* The HMAC KMS key to use in the operation. The MAC algorithm computes the HMAC for the message and the key as * described in RFC 2104. *
*
* To identify an HMAC KMS key, use the DescribeKey operation and see the KeySpec field in the
* response.
*
* To identify an HMAC KMS key, use the DescribeKey operation and see the KeySpec field
* in the response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GenerateMacRequest withKeyId(String keyId) {
setKeyId(keyId);
return this;
}
/**
*
* The MAC algorithm used in the operation. *
*
* The algorithm must be compatible with the HMAC KMS key that you specify. To find the MAC algorithms that your
* HMAC KMS key supports, use the DescribeKey operation and see the MacAlgorithms field in the
* DescribeKey response.
*
* The algorithm must be compatible with the HMAC KMS key that you specify. To find the MAC algorithms that
* your HMAC KMS key supports, use the DescribeKey operation and see the MacAlgorithms
* field in the DescribeKey response.
* @see MacAlgorithmSpec
*/
public void setMacAlgorithm(String macAlgorithm) {
this.macAlgorithm = macAlgorithm;
}
/**
*
* The MAC algorithm used in the operation. *
*
* The algorithm must be compatible with the HMAC KMS key that you specify. To find the MAC algorithms that your
* HMAC KMS key supports, use the DescribeKey operation and see the MacAlgorithms field in the
* DescribeKey response.
*
* The algorithm must be compatible with the HMAC KMS key that you specify. To find the MAC algorithms that
* your HMAC KMS key supports, use the DescribeKey operation and see the MacAlgorithms
* field in the DescribeKey response.
* @see MacAlgorithmSpec
*/
public String getMacAlgorithm() {
return this.macAlgorithm;
}
/**
*
* The MAC algorithm used in the operation. *
*
* The algorithm must be compatible with the HMAC KMS key that you specify. To find the MAC algorithms that your
* HMAC KMS key supports, use the DescribeKey operation and see the MacAlgorithms field in the
* DescribeKey response.
*
* The algorithm must be compatible with the HMAC KMS key that you specify. To find the MAC algorithms that
* your HMAC KMS key supports, use the DescribeKey operation and see the MacAlgorithms
* field in the DescribeKey response.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MacAlgorithmSpec
*/
public GenerateMacRequest withMacAlgorithm(String macAlgorithm) {
setMacAlgorithm(macAlgorithm);
return this;
}
/**
*
* The MAC algorithm used in the operation. *
*
* The algorithm must be compatible with the HMAC KMS key that you specify. To find the MAC algorithms that your
* HMAC KMS key supports, use the DescribeKey operation and see the MacAlgorithms field in the
* DescribeKey response.
*
* The algorithm must be compatible with the HMAC KMS key that you specify. To find the MAC algorithms that
* your HMAC KMS key supports, use the DescribeKey operation and see the MacAlgorithms
* field in the DescribeKey response.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MacAlgorithmSpec
*/
public GenerateMacRequest withMacAlgorithm(MacAlgorithmSpec macAlgorithm) {
this.macAlgorithm = macAlgorithm.toString();
return this;
}
/**
*
* A list of grant tokens. *
** Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved * eventual consistency. For more information, see Grant token and Using a grant * token in the Key Management Service Developer Guide. *
* * @return A list of grant tokens. *
* Use a grant token when your permission to call this operation comes from a new grant that has not yet
* achieved eventual consistency. For more information, see Grant token and
* Using
* a grant token in the Key Management Service Developer Guide.
*/
public java.util.List
* A list of grant tokens.
*
* Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved
* eventual consistency. For more information, see Grant token and Using a grant
* token in the Key Management Service Developer Guide.
*
* Use a grant token when your permission to call this operation comes from a new grant that has not yet
* achieved eventual consistency. For more information, see Grant token and
* Using
* a grant token in the Key Management Service Developer Guide.
*/
public void setGrantTokens(java.util.Collection
* A list of grant tokens.
*
* Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved
* eventual consistency. For more information, see Grant token and Using a grant
* token in the 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.
*
* Use a grant token when your permission to call this operation comes from a new grant that has not yet
* achieved eventual consistency. For more information, see Grant token and
* Using
* a grant token in the Key Management Service Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GenerateMacRequest withGrantTokens(String... grantTokens) {
if (this.grantTokens == null) {
setGrantTokens(new com.amazonaws.internal.SdkInternalList
* A list of grant tokens.
*
* Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved
* eventual consistency. For more information, see Grant token and Using a grant
* token in the Key Management Service Developer Guide.
*
* Use a grant token when your permission to call this operation comes from a new grant that has not yet
* achieved eventual consistency. For more information, see Grant token and
* Using
* a grant token in the Key Management Service Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GenerateMacRequest withGrantTokens(java.util.Collection
* Checks if your request will succeed.
* To learn more about how to use this parameter, see Testing your KMS API
* calls in the Key Management Service Developer Guide.
* DryRun is an optional parameter.
* DryRun is an optional parameter.
* To learn more about how to use this parameter, see Testing your KMS API * calls in the Key Management Service Developer Guide. */ public void setDryRun(Boolean dryRun) { this.dryRun = dryRun; } /** *
* Checks if your request will succeed. DryRun is an optional parameter.
*
* To learn more about how to use this parameter, see Testing your KMS API * calls in the Key Management Service Developer Guide. *
* * @return Checks if your request will succeed.DryRun is an optional parameter.
* * To learn more about how to use this parameter, see Testing your KMS API * calls in the Key Management Service Developer Guide. */ public Boolean getDryRun() { return this.dryRun; } /** *
* Checks if your request will succeed. DryRun is an optional parameter.
*
* To learn more about how to use this parameter, see Testing your KMS API * calls in the Key Management Service Developer Guide. *
* * @param dryRun * Checks if your request will succeed.DryRun is an optional parameter.
* * To learn more about how to use this parameter, see Testing your KMS API * calls in the Key Management Service Developer Guide. * @return Returns a reference to this object so that method calls can be chained together. */ public GenerateMacRequest withDryRun(Boolean dryRun) { setDryRun(dryRun); return this; } /** *
* Checks if your request will succeed. DryRun is an optional parameter.
*
* To learn more about how to use this parameter, see Testing your KMS API * calls in the Key Management Service Developer Guide. *
* * @return Checks if your request will succeed.DryRun is an optional parameter.
* * To learn more about how to use this parameter, see Testing your KMS API * calls in the Key Management Service Developer Guide. */ public Boolean isDryRun() { return this.dryRun; } /** * 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 (getMessage() != null) sb.append("Message: ").append("***Sensitive Data Redacted***").append(","); if (getKeyId() != null) sb.append("KeyId: ").append(getKeyId()).append(","); if (getMacAlgorithm() != null) sb.append("MacAlgorithm: ").append(getMacAlgorithm()).append(","); if (getGrantTokens() != null) sb.append("GrantTokens: ").append(getGrantTokens()).append(","); if (getDryRun() != null) sb.append("DryRun: ").append(getDryRun()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof GenerateMacRequest == false) return false; GenerateMacRequest other = (GenerateMacRequest) obj; if (other.getMessage() == null ^ this.getMessage() == null) return false; if (other.getMessage() != null && other.getMessage().equals(this.getMessage()) == 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.getMacAlgorithm() == null ^ this.getMacAlgorithm() == null) return false; if (other.getMacAlgorithm() != null && other.getMacAlgorithm().equals(this.getMacAlgorithm()) == false) return false; if (other.getGrantTokens() == null ^ this.getGrantTokens() == null) return false; if (other.getGrantTokens() != null && other.getGrantTokens().equals(this.getGrantTokens()) == false) return false; if (other.getDryRun() == null ^ this.getDryRun() == null) return false; if (other.getDryRun() != null && other.getDryRun().equals(this.getDryRun()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getMessage() == null) ? 0 : getMessage().hashCode()); hashCode = prime * hashCode + ((getKeyId() == null) ? 0 : getKeyId().hashCode()); hashCode = prime * hashCode + ((getMacAlgorithm() == null) ? 0 : getMacAlgorithm().hashCode()); hashCode = prime * hashCode + ((getGrantTokens() == null) ? 0 : getGrantTokens().hashCode()); hashCode = prime * hashCode + ((getDryRun() == null) ? 0 : getDryRun().hashCode()); return hashCode; } @Override public GenerateMacRequest clone() { return (GenerateMacRequest) super.clone(); } }