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

Class VerifyMacResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.kms.model.KmsResponse
software.amazon.awssdk.services.kms.model.VerifyMacResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<VerifyMacResponse.Builder,VerifyMacResponse>
@Generated("software.amazon.awssdk:codegen") public final class VerifyMacResponse extends KmsResponse implements ToCopyableBuilder<VerifyMacResponse.Builder,VerifyMacResponse>

  • Method Details

    • keyId

      public final String keyId()

      The HMAC KMS key used in the verification.

      Returns:
      The HMAC KMS key used in the verification.

    • macValid

      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.

      Returns:
      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.

    • macAlgorithm

      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().

      Returns:
      The MAC algorithm used in the verification.
      See Also:

    • macAlgorithmAsString

      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().

      Returns:
      The MAC algorithm used in the verification.
      See Also:

    • toBuilder

      public VerifyMacResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<VerifyMacResponse.Builder,VerifyMacResponse>
      Specified by:
      toBuilder in class AwsResponse

    • builder

      public static VerifyMacResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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 SdkResponse

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo