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

Class VerifyResponse

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.VerifyResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<VerifyResponse.Builder,VerifyResponse>

@Generated("software.amazon.awssdk:codegen")
public final class VerifyResponse
extends KmsResponse
implements ToCopyableBuilder<VerifyResponse.Builder,VerifyResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	VerifyResponse.Builder

Method Summary

Modifier and Type	Method	Description
static VerifyResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	keyId()	The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to verify the signature.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends VerifyResponse.Builder>	serializableBuilderClass()
Boolean	signatureValid()	A Boolean value that indicates whether the signature was verified.
SigningAlgorithmSpec	signingAlgorithm()	The signing algorithm that was used to verify the signature.
String	signingAlgorithmAsString()	The signing algorithm that was used to verify the signature.
VerifyResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.kms.model.KmsResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

keyId

public final String keyId()

The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to verify the signature.

Returns:

The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to verify the signature.

signatureValid

public final Boolean signatureValid()

A Boolean value that indicates whether the signature was verified. A value of True indicates that the Signature was produced by signing the Message with the specified KeyID and SigningAlgorithm. If the signature is not verified, the Verify operation fails with a KMSInvalidSignatureException exception.

Returns:

A Boolean value that indicates whether the signature was verified. A value of True indicates that the Signature was produced by signing the Message with the specified KeyID and SigningAlgorithm. If the signature is not verified, the Verify operation fails with a KMSInvalidSignatureException exception.

signingAlgorithm

public final SigningAlgorithmSpec signingAlgorithm()

The signing algorithm that was used to verify the signature.

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

Returns:

The signing algorithm that was used to verify the signature.

See Also:

SigningAlgorithmSpec

signingAlgorithmAsString

public final String signingAlgorithmAsString()

The signing algorithm that was used to verify the signature.

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

Returns:

The signing algorithm that was used to verify the signature.

See Also:

SigningAlgorithmSpec

toBuilder

public VerifyResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<VerifyResponse.Builder,VerifyResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static VerifyResponse.Builder builder()

serializableBuilderClass

public static Class<? extends VerifyResponse.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