com.amazonaws.services.kms.model

Class GenerateMacResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.kms.model.GenerateMacResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GenerateMacResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
GenerateMacResult()

Method Summary

Modifier and Type	Method and Description
GenerateMacResult	clone()
boolean	equals(Object obj)
String	getKeyId() The HMAC KMS key used in the operation.
ByteBuffer	getMac() The hash-based message authentication code (HMAC) that was generated for the specified message, HMAC KMS key, and MAC algorithm.
String	getMacAlgorithm() The MAC algorithm that was used to generate the HMAC.
int	hashCode()
void	setKeyId(String keyId) The HMAC KMS key used in the operation.
void	setMac(ByteBuffer mac) The hash-based message authentication code (HMAC) that was generated for the specified message, HMAC KMS key, and MAC algorithm.
void	setMacAlgorithm(String macAlgorithm) The MAC algorithm that was used to generate the HMAC.
String	toString() Returns a string representation of this object.
GenerateMacResult	withKeyId(String keyId) The HMAC KMS key used in the operation.
GenerateMacResult	withMac(ByteBuffer mac) The hash-based message authentication code (HMAC) that was generated for the specified message, HMAC KMS key, and MAC algorithm.
GenerateMacResult	withMacAlgorithm(MacAlgorithmSpec macAlgorithm) The MAC algorithm that was used to generate the HMAC.
GenerateMacResult	withMacAlgorithm(String macAlgorithm) The MAC algorithm that was used to generate the HMAC.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GenerateMacResult

public GenerateMacResult()

Method Detail

setMac

public void setMac(ByteBuffer mac)

The hash-based message authentication code (HMAC) that was generated for the specified message, HMAC KMS key, and MAC algorithm.

This is the standard, raw HMAC defined in RFC 2104.

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.

Parameters:

mac - The hash-based message authentication code (HMAC) that was generated for the specified message, HMAC KMS key, and MAC algorithm.

This is the standard, raw HMAC defined in RFC 2104.

getMac

public ByteBuffer getMac()

The hash-based message authentication code (HMAC) that was generated for the specified message, HMAC KMS key, and MAC algorithm.

This is the standard, raw HMAC defined in RFC 2104.

ByteBuffers are stateful. Calling their get methods changes their position. We recommend using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent position, and calling get methods on this rather than directly on the returned ByteBuffer. Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the position.

Returns:

The hash-based message authentication code (HMAC) that was generated for the specified message, HMAC KMS key, and MAC algorithm.

This is the standard, raw HMAC defined in RFC 2104.

withMac

public GenerateMacResult withMac(ByteBuffer mac)

The hash-based message authentication code (HMAC) that was generated for the specified message, HMAC KMS key, and MAC algorithm.

This is the standard, raw HMAC defined in RFC 2104.

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.

Parameters:

mac - The hash-based message authentication code (HMAC) that was generated for the specified message, HMAC KMS key, and MAC algorithm.

This is the standard, raw HMAC defined in RFC 2104.

Returns:

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

setMacAlgorithm

public void setMacAlgorithm(String macAlgorithm)

The MAC algorithm that was used to generate the HMAC.

Parameters:

macAlgorithm - The MAC algorithm that was used to generate the HMAC.

See Also:

MacAlgorithmSpec

getMacAlgorithm

public String getMacAlgorithm()

The MAC algorithm that was used to generate the HMAC.

Returns:

The MAC algorithm that was used to generate the HMAC.

See Also:

MacAlgorithmSpec

withMacAlgorithm

public GenerateMacResult withMacAlgorithm(String macAlgorithm)

The MAC algorithm that was used to generate the HMAC.

Parameters:

macAlgorithm - The MAC algorithm that was used to generate the HMAC.

Returns:

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

See Also:

MacAlgorithmSpec

withMacAlgorithm

public GenerateMacResult withMacAlgorithm(MacAlgorithmSpec macAlgorithm)

The MAC algorithm that was used to generate the HMAC.

Parameters:

macAlgorithm - The MAC algorithm that was used to generate the HMAC.

Returns:

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

See Also:

MacAlgorithmSpec

setKeyId

public void setKeyId(String keyId)

The HMAC KMS key used in the operation.

Parameters:

keyId - The HMAC KMS key used in the operation.

getKeyId

public String getKeyId()

The HMAC KMS key used in the operation.

Returns:

The HMAC KMS key used in the operation.

withKeyId

public GenerateMacResult withKeyId(String keyId)

The HMAC KMS key used in the operation.

Parameters:

keyId - The HMAC KMS key used in the operation.

Returns:

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

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GenerateMacResult clone()

Overrides:

clone in class Object