SignResult (AWS SDK for Android

java.lang.Object
- com.amazonaws.services.kms.model.SignResult

All Implemented Interfaces:: java.io.Serializable

public class SignResult
extends java.lang.Object
implements java.io.Serializable

See Also:: 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
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getKeyId()` The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to sign the message.
`java.nio.ByteBuffer`	`getSignature()` The cryptographic signature that was generated for the message.
`java.lang.String`	`getSigningAlgorithm()` The signing algorithm that was used to sign the message.
`int`	`hashCode()`
`void`	`setKeyId(java.lang.String keyId)` The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to sign the message.
`void`	`setSignature(java.nio.ByteBuffer signature)` The cryptographic signature that was generated for the message.
`void`	`setSigningAlgorithm(SigningAlgorithmSpec signingAlgorithm)` The signing algorithm that was used to sign the message.
`void`	`setSigningAlgorithm(java.lang.String signingAlgorithm)` The signing algorithm that was used to sign the message.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`SignResult`	`withKeyId(java.lang.String keyId)` The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to sign the message.
`SignResult`	`withSignature(java.nio.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(java.lang.String signingAlgorithm)` The signing algorithm that was used to sign the message.

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

- Constructor Detail
  - SignResult
```
public SignResult()
```
- Method Detail
  - getKeyId
```
public java.lang.String getKeyId()
```
    The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to sign the message.
    
    Constraints:
    Length: 1 - 2048
    
    Returns:
    
    The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to sign the message.
  - setKeyId
```
public void setKeyId(java.lang.String keyId)
```
    The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to sign the message.
    
    Constraints:
    Length: 1 - 2048
    
    Parameters:
    
    keyId -
    The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to sign the message.
  - withKeyId
```
public SignResult withKeyId(java.lang.String keyId)
```
    The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to sign the message.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 2048
    
    Parameters:
    
    keyId -
    The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to sign the message.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSignature
```
public java.nio.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.
    
    Constraints:
    Length: 1 - 6144
    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.
  - setSignature
```
public void setSignature(java.nio.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.
    
    Constraints:
    Length: 1 - 6144
    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.
  - withSignature
```
public SignResult withSignature(java.nio.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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 6144
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getSigningAlgorithm
```
public java.lang.String getSigningAlgorithm()
```
    The signing algorithm that was used to sign the message.
    
    Constraints:
    Allowed Values: RSASSA_PSS_SHA_256, RSASSA_PSS_SHA_384, RSASSA_PSS_SHA_512, RSASSA_PKCS1_V1_5_SHA_256, RSASSA_PKCS1_V1_5_SHA_384, RSASSA_PKCS1_V1_5_SHA_512, ECDSA_SHA_256, ECDSA_SHA_384, ECDSA_SHA_512
    
    Returns:
    
    The signing algorithm that was used to sign the message.
    
    See Also:
    
    SigningAlgorithmSpec
  - setSigningAlgorithm
```
public void setSigningAlgorithm(java.lang.String signingAlgorithm)
```
    The signing algorithm that was used to sign the message.
    
    Constraints:
    Allowed Values: RSASSA_PSS_SHA_256, RSASSA_PSS_SHA_384, RSASSA_PSS_SHA_512, RSASSA_PKCS1_V1_5_SHA_256, RSASSA_PKCS1_V1_5_SHA_384, RSASSA_PKCS1_V1_5_SHA_512, ECDSA_SHA_256, ECDSA_SHA_384, ECDSA_SHA_512
    
    Parameters:
    
    signingAlgorithm -
    The signing algorithm that was used to sign the message.
    
    See Also:
    
    SigningAlgorithmSpec
  - withSigningAlgorithm
```
public SignResult withSigningAlgorithm(java.lang.String signingAlgorithm)
```
    The signing algorithm that was used to sign the message.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: RSASSA_PSS_SHA_256, RSASSA_PSS_SHA_384, RSASSA_PSS_SHA_512, RSASSA_PKCS1_V1_5_SHA_256, RSASSA_PKCS1_V1_5_SHA_384, RSASSA_PKCS1_V1_5_SHA_512, ECDSA_SHA_256, ECDSA_SHA_384, ECDSA_SHA_512
    
    Parameters:
    
    signingAlgorithm -
    The signing algorithm that was used to sign the message.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    SigningAlgorithmSpec
  - setSigningAlgorithm
```
public void setSigningAlgorithm(SigningAlgorithmSpec signingAlgorithm)
```
    The signing algorithm that was used to sign the message.
    
    Constraints:
    Allowed Values: RSASSA_PSS_SHA_256, RSASSA_PSS_SHA_384, RSASSA_PSS_SHA_512, RSASSA_PKCS1_V1_5_SHA_256, RSASSA_PKCS1_V1_5_SHA_384, RSASSA_PKCS1_V1_5_SHA_512, ECDSA_SHA_256, ECDSA_SHA_384, ECDSA_SHA_512
    
    Parameters:
    
    signingAlgorithm -
    The signing algorithm that was used to sign the message.
    
    See Also:
    
    SigningAlgorithmSpec
  - withSigningAlgorithm
```
public SignResult withSigningAlgorithm(SigningAlgorithmSpec signingAlgorithm)
```
    The signing algorithm that was used to sign the message.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: RSASSA_PSS_SHA_256, RSASSA_PSS_SHA_384, RSASSA_PSS_SHA_512, RSASSA_PKCS1_V1_5_SHA_256, RSASSA_PKCS1_V1_5_SHA_384, RSASSA_PKCS1_V1_5_SHA_512, ECDSA_SHA_256, ECDSA_SHA_384, ECDSA_SHA_512
    
    Parameters:
    
    signingAlgorithm -
    The signing algorithm that was used to sign the message.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    SigningAlgorithmSpec
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class SignResult

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SignResult

Method Detail

getKeyId

setKeyId

withKeyId

getSignature

setSignature

withSignature

getSigningAlgorithm

setSigningAlgorithm

withSigningAlgorithm

setSigningAlgorithm

withSigningAlgorithm

toString

hashCode

equals