@Generated(value="software.amazon.awssdk:codegen") public final class SignRequest extends KmsRequest implements ToCopyableBuilder<SignRequest.Builder,SignRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
SignRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static SignRequest.Builder |
builder() |
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 an asymmetric KMS key.
|
SdkBytes |
message()
Specifies the message or message digest to sign.
|
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 SignRequest.Builder> |
serializableBuilderClass() |
SigningAlgorithmSpec |
signingAlgorithm()
Specifies the signing algorithm to use when signing the message.
|
String |
signingAlgorithmAsString()
Specifies the signing algorithm to use when signing the message.
|
SignRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String keyId()
Identifies an asymmetric KMS key. KMS uses the private key in the asymmetric KMS key to sign the message. The
KeyUsage
type of the KMS key must be SIGN_VERIFY
. To find the KeyUsage
of
a KMS key, use the DescribeKey operation.
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.
KeyUsage
type of the KMS key must be SIGN_VERIFY
. To find the
KeyUsage
of a KMS key, use the DescribeKey operation.
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 or message digest to sign. Messages can be 0-4096 bytes. To sign a larger message, provide the message digest.
If you provide a message, KMS generates a hash digest of the message and then signs it.
If you provide a message, KMS generates a hash digest of the message and then signs it.
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
.
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
.MessageType
public 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
.
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
.MessageType
public 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 final SigningAlgorithmSpec signingAlgorithm()
Specifies the signing algorithm to use when signing the message.
Choose an algorithm that is compatible with the type and size of the specified asymmetric KMS key.
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()
.
Choose an algorithm that is compatible with the type and size of the specified asymmetric KMS key.
SigningAlgorithmSpec
public final String signingAlgorithmAsString()
Specifies the signing algorithm to use when signing the message.
Choose an algorithm that is compatible with the type and size of the specified asymmetric KMS key.
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()
.
Choose an algorithm that is compatible with the type and size of the specified asymmetric KMS key.
SigningAlgorithmSpec
public SignRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<SignRequest.Builder,SignRequest>
toBuilder
in class KmsRequest
public static SignRequest.Builder builder()
public static Class<? extends SignRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
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 SdkRequest
Copyright © 2022. All rights reserved.