software.amazon.awssdk.services.kms.model

Class GenerateMacRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kms.model.KmsRequest

software.amazon.awssdk.services.kms.model.GenerateMacRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GenerateMacRequest.Builder,GenerateMacRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GenerateMacRequest
extends KmsRequest
implements ToCopyableBuilder<GenerateMacRequest.Builder,GenerateMacRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GenerateMacRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GenerateMacRequest.Builder	builder()
Boolean	dryRun() Checks if your request will succeed.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
List<String>	grantTokens() A list of grant tokens.
boolean	hasGrantTokens() For responses, this returns true if the service returned a value for the GrantTokens property.
int	hashCode()
String	keyId() The HMAC KMS key to use in the operation.
MacAlgorithmSpec	macAlgorithm() The MAC algorithm used in the operation.
String	macAlgorithmAsString() The MAC algorithm used in the operation.
SdkBytes	message() The message to be hashed.
List<SdkField<?>>	sdkFields()
static Class<? extends GenerateMacRequest.Builder>	serializableBuilderClass()
GenerateMacRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

message

public final SdkBytes 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.

Returns:

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.

keyId

public final String 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.

Returns:

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.

macAlgorithm

public final MacAlgorithmSpec 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.

If the service returns an enum value that is not available in the current SDK version, macAlgorithm will return MacAlgorithmSpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from macAlgorithmAsString().

Returns:

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.

See Also:

MacAlgorithmSpec

macAlgorithmAsString

public final String macAlgorithmAsString()

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.

If the service returns an enum value that is not available in the current SDK version, macAlgorithm will return MacAlgorithmSpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from macAlgorithmAsString().

Returns:

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.

See Also:

MacAlgorithmSpec

hasGrantTokens

public final boolean hasGrantTokens()

For responses, this returns true if the service returned a value for the GrantTokens property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

grantTokens

public final List<String> grantTokens()

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGrantTokens() method.

Returns:

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.

dryRun

public final Boolean 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.

Returns:

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.

toBuilder

public GenerateMacRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GenerateMacRequest.Builder,GenerateMacRequest>

Specified by:

toBuilder in class KmsRequest

builder

public static GenerateMacRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GenerateMacRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo