com.amazonaws.services.kms.model

Class VerifyMacResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.kms.model.VerifyMacResult

All Implemented Interfaces:

Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
VerifyMacResult()

Method Summary

Modifier and Type	Method and Description
VerifyMacResult	clone()
boolean	equals(Object obj)
String	getKeyId() The HMAC KMS key used in the verification.
String	getMacAlgorithm() The MAC algorithm used in the verification.
Boolean	getMacValid() A Boolean value that indicates whether the HMAC was verified.
int	hashCode()
Boolean	isMacValid() A Boolean value that indicates whether the HMAC was verified.
void	setKeyId(String keyId) The HMAC KMS key used in the verification.
void	setMacAlgorithm(String macAlgorithm) The MAC algorithm used in the verification.
void	setMacValid(Boolean macValid) A Boolean value that indicates whether the HMAC was verified.
String	toString() Returns a string representation of this object.
VerifyMacResult	withKeyId(String keyId) The HMAC KMS key used in the verification.
VerifyMacResult	withMacAlgorithm(MacAlgorithmSpec macAlgorithm) The MAC algorithm used in the verification.
VerifyMacResult	withMacAlgorithm(String macAlgorithm) The MAC algorithm used in the verification.
VerifyMacResult	withMacValid(Boolean macValid) A Boolean value that indicates whether the HMAC was verified.

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

VerifyMacResult

public VerifyMacResult()

Method Detail

setKeyId

public void setKeyId(String keyId)

The HMAC KMS key used in the verification.

Parameters:

keyId - The HMAC KMS key used in the verification.

getKeyId

public String getKeyId()

The HMAC KMS key used in the verification.

Returns:

The HMAC KMS key used in the verification.

withKeyId

public VerifyMacResult withKeyId(String keyId)

The HMAC KMS key used in the verification.

Parameters:

keyId - The HMAC KMS key used in the verification.

Returns:

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

setMacValid

public void setMacValid(Boolean macValid)

A Boolean value that indicates whether the HMAC was verified. A value of True indicates that the HMAC (Mac) was generated with the specified Message, HMAC KMS key (KeyID) and MacAlgorithm..

If the HMAC is not verified, the VerifyMac operation fails with a KMSInvalidMacException exception. This exception indicates that one or more of the inputs changed since the HMAC was computed.

Parameters:

macValid - A Boolean value that indicates whether the HMAC was verified. A value of True indicates that the HMAC (Mac) was generated with the specified Message, HMAC KMS key ( KeyID) and MacAlgorithm..

If the HMAC is not verified, the VerifyMac operation fails with a KMSInvalidMacException exception. This exception indicates that one or more of the inputs changed since the HMAC was computed.

getMacValid

public Boolean getMacValid()

A Boolean value that indicates whether the HMAC was verified. A value of True indicates that the HMAC (Mac) was generated with the specified Message, HMAC KMS key (KeyID) and MacAlgorithm..

If the HMAC is not verified, the VerifyMac operation fails with a KMSInvalidMacException exception. This exception indicates that one or more of the inputs changed since the HMAC was computed.

Returns:

A Boolean value that indicates whether the HMAC was verified. A value of True indicates that the HMAC (Mac) was generated with the specified Message, HMAC KMS key ( KeyID) and MacAlgorithm..

If the HMAC is not verified, the VerifyMac operation fails with a KMSInvalidMacException exception. This exception indicates that one or more of the inputs changed since the HMAC was computed.

withMacValid

public VerifyMacResult withMacValid(Boolean macValid)

A Boolean value that indicates whether the HMAC was verified. A value of True indicates that the HMAC (Mac) was generated with the specified Message, HMAC KMS key (KeyID) and MacAlgorithm..

If the HMAC is not verified, the VerifyMac operation fails with a KMSInvalidMacException exception. This exception indicates that one or more of the inputs changed since the HMAC was computed.

Parameters:

macValid - A Boolean value that indicates whether the HMAC was verified. A value of True indicates that the HMAC (Mac) was generated with the specified Message, HMAC KMS key ( KeyID) and MacAlgorithm..

If the HMAC is not verified, the VerifyMac operation fails with a KMSInvalidMacException exception. This exception indicates that one or more of the inputs changed since the HMAC was computed.

Returns:

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

isMacValid

public Boolean isMacValid()

A Boolean value that indicates whether the HMAC was verified. A value of True indicates that the HMAC (Mac) was generated with the specified Message, HMAC KMS key (KeyID) and MacAlgorithm..

If the HMAC is not verified, the VerifyMac operation fails with a KMSInvalidMacException exception. This exception indicates that one or more of the inputs changed since the HMAC was computed.

Returns:

A Boolean value that indicates whether the HMAC was verified. A value of True indicates that the HMAC (Mac) was generated with the specified Message, HMAC KMS key ( KeyID) and MacAlgorithm..

If the HMAC is not verified, the VerifyMac operation fails with a KMSInvalidMacException exception. This exception indicates that one or more of the inputs changed since the HMAC was computed.

setMacAlgorithm

public void setMacAlgorithm(String macAlgorithm)

The MAC algorithm used in the verification.

Parameters:

macAlgorithm - The MAC algorithm used in the verification.

See Also:

MacAlgorithmSpec

getMacAlgorithm

public String getMacAlgorithm()

The MAC algorithm used in the verification.

Returns:

The MAC algorithm used in the verification.

See Also:

MacAlgorithmSpec

withMacAlgorithm

public VerifyMacResult withMacAlgorithm(String macAlgorithm)

The MAC algorithm used in the verification.

Parameters:

macAlgorithm - The MAC algorithm used in the verification.

Returns:

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

See Also:

MacAlgorithmSpec

withMacAlgorithm

public VerifyMacResult withMacAlgorithm(MacAlgorithmSpec macAlgorithm)

The MAC algorithm used in the verification.

Parameters:

macAlgorithm - The MAC algorithm used in the verification.

Returns:

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

See Also:

MacAlgorithmSpec

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 VerifyMacResult clone()

Overrides:

clone in class Object