SignResult (AWS Java SDK for AWS KMS 1.11.721 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.kms.model.SignResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SignResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SignResult()

Constructors
Constructor and Description
`SignResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SignResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getKeyId()` The Amazon Resource Name (ARN) of the asymmetric CMK that was used to sign the message.
`ByteBuffer`	`getSignature()` The cryptographic signature that was generated for the message.
`String`	`getSigningAlgorithm()` The signing algorithm that was used to sign the message.
`int`	`hashCode()`
`void`	`setKeyId(String keyId)` The Amazon Resource Name (ARN) of the asymmetric CMK that was used to sign the message.
`void`	`setSignature(ByteBuffer signature)` The cryptographic signature that was generated for the message.
`void`	`setSigningAlgorithm(String signingAlgorithm)` The signing algorithm that was used to sign the message.
`String`	`toString()` Returns a string representation of this object.
`SignResult`	`withKeyId(String keyId)` The Amazon Resource Name (ARN) of the asymmetric CMK that was used to sign the message.
`SignResult`	`withSignature(ByteBuffer signature)` The cryptographic signature that was generated for the message.
`SignResult`	`withSigningAlgorithm(SigningAlgorithmSpec signingAlgorithm)` The signing algorithm that was used to sign the message.
`SignResult`	`withSigningAlgorithm(String signingAlgorithm)` The signing algorithm that was used to sign the message.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SignResult
```
public SignResult()
```
- Method Detail
  - setKeyId
```
public void setKeyId(String keyId)
```
    The Amazon Resource Name (ARN) of the asymmetric CMK that was used to sign the message.
    
    Parameters:
    
    keyId - The Amazon Resource Name (ARN) of the asymmetric CMK that was used to sign the message.
  - getKeyId
```
public String getKeyId()
```
    The Amazon Resource Name (ARN) of the asymmetric CMK that was used to sign the message.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the asymmetric CMK that was used to sign the message.
  - withKeyId
```
public SignResult withKeyId(String keyId)
```
    The Amazon Resource Name (ARN) of the asymmetric CMK that was used to sign the message.
    
    Parameters:
    
    keyId - The Amazon Resource Name (ARN) of the asymmetric CMK that was used to sign the message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSignature
```
public void setSignature(ByteBuffer 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, or ECDSA_SHA_512 signing algorithms, this value is a DER-encoded object as defined by ANS 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 AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
    
    The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
    
    Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.
    Parameters:
    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, or ECDSA_SHA_512 signing algorithms, this value is a DER-encoded object as defined by ANS 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 AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
  - getSignature
```
public ByteBuffer getSignature()
```
    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, or ECDSA_SHA_512 signing algorithms, this value is a DER-encoded object as defined by ANS 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 AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
    
    ByteBuffers are stateful. Calling their get methods changes their position. We recommend using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent position, and calling get methods on this rather than directly on the returned ByteBuffer. Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the position.
    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, or ECDSA_SHA_512 signing algorithms, this value is a DER-encoded object as defined by ANS 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 AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
  - withSignature
```
public SignResult withSignature(ByteBuffer 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, or ECDSA_SHA_512 signing algorithms, this value is a DER-encoded object as defined by ANS 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 AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
    
    The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
    
    Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.
    Parameters:
    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, or ECDSA_SHA_512 signing algorithms, this value is a DER-encoded object as defined by ANS 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 AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSigningAlgorithm
```
public void setSigningAlgorithm(String signingAlgorithm)
```
    The signing algorithm that was used to sign the message.
    
    Parameters:
    
    signingAlgorithm - The signing algorithm that was used to sign the message.
    
    See Also:
    
    SigningAlgorithmSpec
  - getSigningAlgorithm
```
public String getSigningAlgorithm()
```
    The signing algorithm that was used to sign the message.
    
    Returns:
    
    The signing algorithm that was used to sign the message.
    
    See Also:
    
    SigningAlgorithmSpec
  - withSigningAlgorithm
```
public SignResult withSigningAlgorithm(String signingAlgorithm)
```
    The signing algorithm that was used to sign the message.
    
    Parameters:
    
    signingAlgorithm - The signing algorithm that was used to sign the message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SigningAlgorithmSpec
  - withSigningAlgorithm
```
public SignResult withSigningAlgorithm(SigningAlgorithmSpec signingAlgorithm)
```
    The signing algorithm that was used to sign the message.
    
    Parameters:
    
    signingAlgorithm - The signing algorithm that was used to sign the message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SigningAlgorithmSpec
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public SignResult clone()
```
    Overrides:
    
    clone in class Object

Class SignResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

SignResult

Method Detail

setKeyId

getKeyId

withKeyId

setSignature

getSignature

withSignature

setSigningAlgorithm

getSigningAlgorithm

withSigningAlgorithm

withSigningAlgorithm

toString

equals

hashCode

clone