@Generated(value="software.amazon.awssdk:codegen") public final class VerifyMacResponse extends KmsResponse implements ToCopyableBuilder<VerifyMacResponse.Builder,VerifyMacResponse>
Modifier and Type | Class and Description |
---|---|
static interface |
VerifyMacResponse.Builder |
Modifier and Type | Method and Description |
---|---|
static VerifyMacResponse.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
keyId()
The HMAC KMS key used in the verification.
|
MacAlgorithmSpec |
macAlgorithm()
The MAC algorithm used in the verification.
|
String |
macAlgorithmAsString()
The MAC algorithm used in the verification.
|
Boolean |
macValid()
A Boolean value that indicates whether the HMAC was verified.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends VerifyMacResponse.Builder> |
serializableBuilderClass() |
VerifyMacResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
responseMetadata
sdkHttpResponse
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String keyId()
The HMAC KMS key used in the verification.
public final 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.
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.
public final MacAlgorithmSpec macAlgorithm()
The MAC algorithm used in the verification.
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()
.
MacAlgorithmSpec
public final String macAlgorithmAsString()
The MAC algorithm used in the verification.
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()
.
MacAlgorithmSpec
public VerifyMacResponse.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<VerifyMacResponse.Builder,VerifyMacResponse>
toBuilder
in class AwsResponse
public static VerifyMacResponse.Builder builder()
public static Class<? extends VerifyMacResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsResponse
public final boolean equals(Object obj)
equals
in class AwsResponse
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkResponse
Copyright © 2022. All rights reserved.