Class SignResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<SignResponse.Builder,
SignResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic SignResponse.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final String
keyId()
The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to sign the message.static Class
<? extends SignResponse.Builder> final SdkBytes
The cryptographic signature that was generated for the message.final SigningAlgorithmSpec
The signing algorithm that was used to sign the message.final String
The signing algorithm that was used to sign the message.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.services.kms.model.KmsResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
keyId
The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to sign the message.
- Returns:
- The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to sign the message.
-
signature
The cryptographic signature that was generated for the message.
-
When used with the supported RSA signing algorithms, the encoding of this value is defined by PKCS #1 in RFC 8017.
-
When used with the
ECDSA_SHA_256
,ECDSA_SHA_384
, orECDSA_SHA_512
signing algorithms, this value is a DER-encoded object as defined by ANSI X9.62–2005 and RFC 3279 Section 2.2.3. This is the most commonly used signature format and is appropriate for most uses.
When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
- Returns:
- The cryptographic signature that was generated for the message.
-
When used with the supported RSA signing algorithms, the encoding of this value is defined by PKCS #1 in RFC 8017.
-
When used with the
ECDSA_SHA_256
,ECDSA_SHA_384
, orECDSA_SHA_512
signing algorithms, this value is a DER-encoded object as defined by ANSI X9.62–2005 and RFC 3279 Section 2.2.3. This is the most commonly used signature format and is appropriate for most uses.
When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
-
-
-
signingAlgorithm
The signing algorithm that was used to sign the message.
If the service returns an enum value that is not available in the current SDK version,
signingAlgorithm
will returnSigningAlgorithmSpec.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsigningAlgorithmAsString()
.- Returns:
- The signing algorithm that was used to sign the message.
- See Also:
-
signingAlgorithmAsString
The signing algorithm that was used to sign the message.
If the service returns an enum value that is not available in the current SDK version,
signingAlgorithm
will returnSigningAlgorithmSpec.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsigningAlgorithmAsString()
.- Returns:
- The signing algorithm that was used to sign the message.
- See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<SignResponse.Builder,
SignResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-