SignRequest (AWS Java SDK :: Services

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

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface SignRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SignRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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()` 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()`
`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 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.
    Returns:
    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.
  - message
```
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.
    
    Returns:
    
    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.
  - messageType
```
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().
    
    Returns:
    
    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.
    
    See Also:
    
    MessageType
  - messageTypeAsString
```
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().
    
    Returns:
    
    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.
    
    See Also:
    
    MessageType
  - hasGrantTokens
```
public final 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). For responses returned by the SDK, the sender is the AWS service.
  - grantTokens
```
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.
    
    Returns:
    
    A list of grant tokens.
    
    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
  - signingAlgorithm
```
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().
    
    Returns:
    
    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.
    
    See Also:
    
    SigningAlgorithmSpec
  - signingAlgorithmAsString
```
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().
    
    Returns:
    
    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.
    
    See Also:
    
    SigningAlgorithmSpec
  - toBuilder
```
public SignRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SignRequest.Builder,SignRequest>
    
    Specified by:
    
    toBuilder in class KmsRequest
  - builder
```
public static SignRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SignRequest.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

Class SignRequest

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

hasGrantTokens

grantTokens

signingAlgorithm

signingAlgorithmAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields