@Generated(value="software.amazon.awssdk:codegen") public final class VerifyRequest extends KmsRequest implements ToCopyableBuilder<VerifyRequest.Builder,VerifyRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
VerifyRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static VerifyRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
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 is a message or message digest. |
String |
messageTypeAsString()
Tells KMS whether the value of the
Message parameter is a message or message digest. |
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()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationcopypublic 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.
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.
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.
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.
public final MessageType messageType()
Tells KMS whether the value of the Message parameter is a message or message digest. The default
value, RAW, indicates a message. To indicate a message digest, enter DIGEST.
Use the DIGEST value only when the value of the Message parameter is a message digest.
If you use the DIGEST value with a raw message, the security of the verification operation can be
compromised.
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().
Message parameter is a message or message digest. The
default value, RAW, indicates a message. To indicate a message digest, enter DIGEST.
Use the DIGEST value only when the value of the Message parameter is a message
digest. If you use the DIGEST value with a raw message, the security of the verification
operation can be compromised.
MessageTypepublic final String messageTypeAsString()
Tells KMS whether the value of the Message parameter is a message or message digest. The default
value, RAW, indicates a message. To indicate a message digest, enter DIGEST.
Use the DIGEST value only when the value of the Message parameter is a message digest.
If you use the DIGEST value with a raw message, the security of the verification operation can be
compromised.
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().
Message parameter is a message or message digest. The
default value, RAW, indicates a message. To indicate a message digest, enter DIGEST.
Use the DIGEST value only when the value of the Message parameter is a message
digest. If you use the DIGEST value with a raw message, the security of the verification
operation can be compromised.
MessageTypepublic final SdkBytes signature()
The signature that the Sign operation generated.
Sign operation generated.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().
SigningAlgorithmSpecpublic 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().
SigningAlgorithmSpecpublic 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 VerifyRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<VerifyRequest.Builder,VerifyRequest>toBuilder in class KmsRequestpublic static VerifyRequest.Builder builder()
public static Class<? extends VerifyRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo class,
and is generated based on a service model.
If an SdkPojo class does not have any inherited fields, equalsBySdkFields
and equals are essentially the same.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will
again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.