@Generated(value="software.amazon.awssdk:codegen") public final class VerifyMacRequest extends KmsRequest implements ToCopyableBuilder<VerifyMacRequest.Builder,VerifyMacRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
VerifyMacRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static VerifyMacRequest.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 KMS key that will be used in the verification.
|
SdkBytes |
mac()
The HMAC to verify.
|
MacAlgorithmSpec |
macAlgorithm()
The MAC algorithm that will be used in the verification.
|
String |
macAlgorithmAsString()
The MAC algorithm that will be used in the verification.
|
SdkBytes |
message()
The message that will be used in the verification.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends VerifyMacRequest.Builder> |
serializableBuilderClass() |
VerifyMacRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final SdkBytes message()
The message that will be used in the verification. Enter the same message that was used to generate the HMAC.
GenerateMac and VerifyMac do not provide special handling for message digests. If you
generated an HMAC for a hash digest of a message, you must verify the HMAC for the same hash digest.
GenerateMac and VerifyMac do not provide special handling for message digests. If you
generated an HMAC for a hash digest of a message, you must verify the HMAC for the same hash digest.
public final String keyId()
The KMS key that will be used in the verification.
Enter a key ID of the KMS key that was used to generate the HMAC. If you identify a different KMS key, the
VerifyMac operation fails.
Enter a key ID of the KMS key that was used to generate the HMAC. If you identify a different KMS key,
the VerifyMac operation fails.
public final MacAlgorithmSpec macAlgorithm()
The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that was used to compute
the HMAC. This algorithm must be supported by the HMAC KMS key identified by the KeyId parameter.
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().
KeyId parameter.MacAlgorithmSpecpublic final String macAlgorithmAsString()
The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that was used to compute
the HMAC. This algorithm must be supported by the HMAC KMS key identified by the KeyId parameter.
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().
KeyId parameter.MacAlgorithmSpecpublic final SdkBytes mac()
The HMAC to verify. Enter the HMAC that was generated by the GenerateMac operation when you specified the same message, HMAC KMS key, and MAC algorithm as the values specified in this request.
public final boolean hasGrantTokens()
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.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.
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.
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.
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.
public VerifyMacRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<VerifyMacRequest.Builder,VerifyMacRequest>toBuilder in class KmsRequestpublic static VerifyMacRequest.Builder builder()
public static Class<? extends VerifyMacRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.