Package software.amazon.awssdk.services.kms.model

Interface VerifyMacResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<VerifyMacResponse.Builder,VerifyMacResponse>, KmsResponse.Builder, SdkBuilder<VerifyMacResponse.Builder,VerifyMacResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

VerifyMacResponse

@Mutable
@NotThreadSafe
public static interface VerifyMacResponse.Builder
extends KmsResponse.Builder, SdkPojo, CopyableBuilder<VerifyMacResponse.Builder,VerifyMacResponse>

Method Summary

Modifier and Type	Method	Description
VerifyMacResponse.Builder	keyId(String keyId)	The HMAC KMS key used in the verification.
VerifyMacResponse.Builder	macAlgorithm(String macAlgorithm)	The MAC algorithm used in the verification.
VerifyMacResponse.Builder	macAlgorithm(MacAlgorithmSpec macAlgorithm)	The MAC algorithm used in the verification.
VerifyMacResponse.Builder	macValid(Boolean macValid)	A Boolean value that indicates whether the HMAC was verified.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.kms.model.KmsResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

keyId

VerifyMacResponse.Builder keyId(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.

macValid

VerifyMacResponse.Builder macValid(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.

macAlgorithm

VerifyMacResponse.Builder macAlgorithm(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, MacAlgorithmSpec

macAlgorithm

VerifyMacResponse.Builder macAlgorithm(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, MacAlgorithmSpec