Class GenerateMacRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GenerateMacRequest.Builder,
GenerateMacRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic GenerateMacRequest.Builder
builder()
final Boolean
dryRun()
Checks if your request will succeed.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.A list of grant tokens.final boolean
For responses, this returns true if the service returned a value for the GrantTokens property.final int
hashCode()
final String
keyId()
The HMAC KMS key to use in the operation.final MacAlgorithmSpec
The MAC algorithm used in the operation.final String
The MAC algorithm used in the operation.final SdkBytes
message()
The message to be hashed.static Class
<? extends GenerateMacRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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 theDescribeKey
response.If the service returns an enum value that is not available in the current SDK version,
macAlgorithm
will returnMacAlgorithmSpec.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommacAlgorithmAsString()
.- 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 theDescribeKey
response. - See Also:
-
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 theDescribeKey
response.If the service returns an enum value that is not available in the current SDK version,
macAlgorithm
will returnMacAlgorithmSpec.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommacAlgorithmAsString()
.- 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 theDescribeKey
response. - See Also:
-
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 theisEmpty()
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
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<GenerateMacRequest.Builder,
GenerateMacRequest> - Specified by:
toBuilder
in classKmsRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-