java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.kms.model.KmsRequest
    - - software.amazon.awssdk.services.kms.model.VerifyRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<VerifyRequest.Builder,VerifyRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface VerifyRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static VerifyRequest.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()`	Identifies the asymmetric KMS key that will be used to verify the signature.
`SdkBytes`	`message()`	Specifies the message that was signed.
`MessageType`	`messageType()`	Tells KMS whether the value of the `Message` parameter should be hashed as part of the signing algorithm.
`String`	`messageTypeAsString()`	Tells KMS whether the value of the `Message` parameter should be hashed as part of the signing algorithm.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends VerifyRequest.Builder>`	`serializableBuilderClass()`
`SdkBytes`	`signature()`	The signature that the `Sign` operation generated.
`SigningAlgorithmSpec`	`signingAlgorithm()`	The signing algorithm that was used to sign the message.
`String`	`signingAlgorithmAsString()`	The signing algorithm that was used to sign the message.
`VerifyRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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()
```
    Identifies the asymmetric KMS key that will be used to verify the signature. This must be the same KMS key that was used to generate the signature. If you specify a different KMS key, the signature verification fails.
    
    To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
    
    For example:
    
    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    
    Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    
    Alias name: alias/ExampleAlias
    
    Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
    
    To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
    Returns:
    
    Identifies the asymmetric KMS key that will be used to verify the signature. This must be the same KMS key that was used to generate the signature. If you specify a different KMS key, the signature verification fails.
    
    To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
    
    For example:
    
    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    
    Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    
    Alias name: alias/ExampleAlias
    
    Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
    
    To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
  - message
```
public final SdkBytes message()
```
    Specifies the message that was signed. You can submit a raw message of up to 4096 bytes, or a hash digest of the message. If you submit a digest, use the MessageType parameter with a value of DIGEST.
    
    If the message specified here is different from the message that was signed, the signature verification fails. A message and its hash digest are considered to be the same message.
    
    Returns:
    
    Specifies the message that was signed. You can submit a raw message of up to 4096 bytes, or a hash digest of the message. If you submit a digest, use the MessageType parameter with a value of DIGEST.
    
    If the message specified here is different from the message that was signed, the signature verification fails. A message and its hash digest are considered to be the same message.
  - messageType
```
public final MessageType messageType()
```
    Tells KMS whether the value of the Message parameter should be hashed as part of the signing algorithm. Use RAW for unhashed messages; use DIGEST for message digests, which are already hashed.
    
    When the value of MessageType is RAW, KMS uses the standard signing algorithm, which begins with a hash function. When the value is DIGEST, KMS skips the hashing step in the signing algorithm.
    
    Use the DIGEST value only when the value of the Message parameter is a message digest. If you use the DIGEST value with an unhashed message, the security of the verification operation can be compromised.
    
    When the value of MessageTypeis DIGEST, the length of the Message value must match the length of hashed messages for the specified signing algorithm.
    
    You can submit a message digest and omit the MessageType or specify RAW so the digest is hashed again while signing. However, if the signed message is hashed once while signing, but twice while verifying, verification fails, even when the message hasn't changed.
    
    The hashing algorithm in that Verify uses is based on the SigningAlgorithm value.
    
    Signing algorithms that end in SHA_256 use the SHA_256 hashing algorithm.
    
    Signing algorithms that end in SHA_384 use the SHA_384 hashing algorithm.
    
    Signing algorithms that end in SHA_512 use the SHA_512 hashing algorithm.
    
    SM2DSA uses the SM3 hashing algorithm. For details, see Offline verification with SM2 key pairs.
    
    If the service returns an enum value that is not available in the current SDK version, messageType will return MessageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageTypeAsString().
    Returns:
    
    Tells KMS whether the value of the Message parameter should be hashed as part of the signing algorithm. Use RAW for unhashed messages; use DIGEST for message digests, which are already hashed.
    
    When the value of MessageType is RAW, KMS uses the standard signing algorithm, which begins with a hash function. When the value is DIGEST, KMS skips the hashing step in the signing algorithm.
    
    Use the DIGEST value only when the value of the Message parameter is a message digest. If you use the DIGEST value with an unhashed message, the security of the verification operation can be compromised.
    
    When the value of MessageTypeis DIGEST, the length of the Message value must match the length of hashed messages for the specified signing algorithm.
    
    You can submit a message digest and omit the MessageType or specify RAW so the digest is hashed again while signing. However, if the signed message is hashed once while signing, but twice while verifying, verification fails, even when the message hasn't changed.
    
    The hashing algorithm in that Verify uses is based on the SigningAlgorithm value.
    
    Signing algorithms that end in SHA_256 use the SHA_256 hashing algorithm.
    
    Signing algorithms that end in SHA_384 use the SHA_384 hashing algorithm.
    
    Signing algorithms that end in SHA_512 use the SHA_512 hashing algorithm.
    
    SM2DSA uses the SM3 hashing algorithm. For details, see Offline verification with SM2 key pairs.
    
    See Also:
    
    MessageType
  - messageTypeAsString
```
public final String messageTypeAsString()
```
    Tells KMS whether the value of the Message parameter should be hashed as part of the signing algorithm. Use RAW for unhashed messages; use DIGEST for message digests, which are already hashed.
    
    When the value of MessageType is RAW, KMS uses the standard signing algorithm, which begins with a hash function. When the value is DIGEST, KMS skips the hashing step in the signing algorithm.
    
    Use the DIGEST value only when the value of the Message parameter is a message digest. If you use the DIGEST value with an unhashed message, the security of the verification operation can be compromised.
    
    When the value of MessageTypeis DIGEST, the length of the Message value must match the length of hashed messages for the specified signing algorithm.
    
    You can submit a message digest and omit the MessageType or specify RAW so the digest is hashed again while signing. However, if the signed message is hashed once while signing, but twice while verifying, verification fails, even when the message hasn't changed.
    
    The hashing algorithm in that Verify uses is based on the SigningAlgorithm value.
    
    Signing algorithms that end in SHA_256 use the SHA_256 hashing algorithm.
    
    Signing algorithms that end in SHA_384 use the SHA_384 hashing algorithm.
    
    Signing algorithms that end in SHA_512 use the SHA_512 hashing algorithm.
    
    SM2DSA uses the SM3 hashing algorithm. For details, see Offline verification with SM2 key pairs.
    
    If the service returns an enum value that is not available in the current SDK version, messageType will return MessageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageTypeAsString().
    Returns:
    
    Tells KMS whether the value of the Message parameter should be hashed as part of the signing algorithm. Use RAW for unhashed messages; use DIGEST for message digests, which are already hashed.
    
    When the value of MessageType is RAW, KMS uses the standard signing algorithm, which begins with a hash function. When the value is DIGEST, KMS skips the hashing step in the signing algorithm.
    
    Use the DIGEST value only when the value of the Message parameter is a message digest. If you use the DIGEST value with an unhashed message, the security of the verification operation can be compromised.
    
    When the value of MessageTypeis DIGEST, the length of the Message value must match the length of hashed messages for the specified signing algorithm.
    
    You can submit a message digest and omit the MessageType or specify RAW so the digest is hashed again while signing. However, if the signed message is hashed once while signing, but twice while verifying, verification fails, even when the message hasn't changed.
    
    The hashing algorithm in that Verify uses is based on the SigningAlgorithm value.
    
    Signing algorithms that end in SHA_256 use the SHA_256 hashing algorithm.
    
    Signing algorithms that end in SHA_384 use the SHA_384 hashing algorithm.
    
    Signing algorithms that end in SHA_512 use the SHA_512 hashing algorithm.
    
    SM2DSA uses the SM3 hashing algorithm. For details, see Offline verification with SM2 key pairs.
    
    See Also:
    
    MessageType
  - signature
```
public final SdkBytes signature()
```
    The signature that the Sign operation generated.
    
    Returns:
    
    The signature that the Sign operation generated.
  - signingAlgorithm
```
public final SigningAlgorithmSpec signingAlgorithm()
```
    The signing algorithm that was used to sign the message. If you submit a different algorithm, the signature verification fails.
    
    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 sign the message. If you submit a different algorithm, the signature verification fails.
    
    See Also:
    
    SigningAlgorithmSpec
  - signingAlgorithmAsString
```
public final String signingAlgorithmAsString()
```
    The signing algorithm that was used to sign the message. If you submit a different algorithm, the signature verification fails.
    
    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 sign the message. If you submit a different algorithm, the signature verification fails.
    
    See Also:
    
    SigningAlgorithmSpec
  - 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 the 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.
  - grantTokens
```
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.
    
    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
```
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.
    
    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
```
public VerifyRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<VerifyRequest.Builder,VerifyRequest>
    
    Specified by:
    
    toBuilder in class KmsRequest
  - builder
```
public static VerifyRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends VerifyRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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 SdkRequest
  - 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

Class VerifyRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

keyId

message

messageType

messageTypeAsString

signature

signingAlgorithm

signingAlgorithmAsString

hasGrantTokens

grantTokens

dryRun

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField