@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)
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()
Returns true if the GrantTokens property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
int |
hashCode() |
String |
keyId()
Identifies an asymmetric CMK.
|
SdkBytes |
message()
Specifies the message or message digest to sign.
|
MessageType |
messageType()
Tells AWS KMS whether the value of the
Message parameter is a message or message digest. |
String |
messageTypeAsString()
Tells AWS 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()
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.
|
overrideConfiguration
copy
public final String keyId()
Identifies an asymmetric CMK. AWS KMS uses the private key in the asymmetric CMK to sign the message. The
KeyUsage
type of the CMK must be SIGN_VERIFY
. To find the KeyUsage
of a
CMK, use the DescribeKey operation.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name,
prefix it with "alias/"
. To specify a CMK in a different AWS 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 CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
KeyUsage
type of the CMK must be SIGN_VERIFY
. To find the KeyUsage
of a CMK, use the DescribeKey operation.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an
alias name, prefix it with "alias/"
. To specify a CMK in a different AWS 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 CMK, 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, AWS KMS generates a hash digest of the message and then signs it.
If you provide a message, AWS KMS generates a hash digest of the message and then signs it.
public final MessageType messageType()
Tells AWS 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 AWS 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()
public final List<String> grantTokens()
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasGrantTokens()
to see if a value was sent in this field.
For more information, see Grant Tokens in the AWS 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 CMK.
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 CMK.
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 CMK.
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 CMK.
SigningAlgorithmSpec
public SignRequest.Builder toBuilder()
ToCopyableBuilder
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)
SdkPojo
SdkPojo
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 SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. 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 SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.