VerifyResult (AWS SDK for Android - AWS KMS 2.16.13 API)

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

All Implemented Interfaces:: Serializable

public class VerifyResult
extends Object
implements Serializable

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

VerifyResult()

Constructors
Constructor and Description
`VerifyResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getKeyId()` The unique identifier for the asymmetric CMK that was used to verify the signature.
`Boolean`	`getSignatureValid()` A Boolean value that indicates whether the signature was verified.
`String`	`getSigningAlgorithm()` The signing algorithm that was used to verify the signature.
`int`	`hashCode()`
`Boolean`	`isSignatureValid()` A Boolean value that indicates whether the signature was verified.
`void`	`setKeyId(String keyId)` The unique identifier for the asymmetric CMK that was used to verify the signature.
`void`	`setSignatureValid(Boolean signatureValid)` A Boolean value that indicates whether the signature was verified.
`void`	`setSigningAlgorithm(SigningAlgorithmSpec signingAlgorithm)` The signing algorithm that was used to verify the signature.
`void`	`setSigningAlgorithm(String signingAlgorithm)` The signing algorithm that was used to verify the signature.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`VerifyResult`	`withKeyId(String keyId)` The unique identifier for the asymmetric CMK that was used to verify the signature.
`VerifyResult`	`withSignatureValid(Boolean signatureValid)` A Boolean value that indicates whether the signature was verified.
`VerifyResult`	`withSigningAlgorithm(SigningAlgorithmSpec signingAlgorithm)` The signing algorithm that was used to verify the signature.
`VerifyResult`	`withSigningAlgorithm(String signingAlgorithm)` The signing algorithm that was used to verify the signature.

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

- Constructor Detail
  - VerifyResult
```
public VerifyResult()
```
- Method Detail
  - getKeyId
```
public String getKeyId()
```
    The unique identifier for the asymmetric CMK that was used to verify the signature.
    
    Constraints:
    Length: 1 - 2048
    
    Returns:
    
    The unique identifier for the asymmetric CMK that was used to verify the signature.
  - setKeyId
```
public void setKeyId(String keyId)
```
    The unique identifier for the asymmetric CMK that was used to verify the signature.
    
    Constraints:
    Length: 1 - 2048
    
    Parameters:
    
    keyId -
    The unique identifier for the asymmetric CMK that was used to verify the signature.
  - withKeyId
```
public VerifyResult withKeyId(String keyId)
```
    The unique identifier for the asymmetric CMK that was used to verify the signature.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 2048
    
    Parameters:
    
    keyId -
    The unique identifier for the asymmetric CMK that was used to verify the signature.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - isSignatureValid
```
public Boolean isSignatureValid()
```
    A Boolean value that indicates whether the signature was verified. A value of True indicates that the Signature was produced by signing the Message with the specified KeyID and SigningAlgorithm. If the signature is not verified, the Verify operation fails with a KMSInvalidSignatureException exception.
    
    Returns:
    
    A Boolean value that indicates whether the signature was verified. A value of True indicates that the Signature was produced by signing the Message with the specified KeyID and SigningAlgorithm. If the signature is not verified, the Verify operation fails with a KMSInvalidSignatureException exception.
  - getSignatureValid
```
public Boolean getSignatureValid()
```
    A Boolean value that indicates whether the signature was verified. A value of True indicates that the Signature was produced by signing the Message with the specified KeyID and SigningAlgorithm. If the signature is not verified, the Verify operation fails with a KMSInvalidSignatureException exception.
    
    Returns:
    
    A Boolean value that indicates whether the signature was verified. A value of True indicates that the Signature was produced by signing the Message with the specified KeyID and SigningAlgorithm. If the signature is not verified, the Verify operation fails with a KMSInvalidSignatureException exception.
  - setSignatureValid
```
public void setSignatureValid(Boolean signatureValid)
```
    A Boolean value that indicates whether the signature was verified. A value of True indicates that the Signature was produced by signing the Message with the specified KeyID and SigningAlgorithm. If the signature is not verified, the Verify operation fails with a KMSInvalidSignatureException exception.
    
    Parameters:
    
    signatureValid -
    A Boolean value that indicates whether the signature was verified. A value of True indicates that the Signature was produced by signing the Message with the specified KeyID and SigningAlgorithm. If the signature is not verified, the Verify operation fails with a KMSInvalidSignatureException exception.
  - withSignatureValid
```
public VerifyResult withSignatureValid(Boolean signatureValid)
```
    A Boolean value that indicates whether the signature was verified. A value of True indicates that the Signature was produced by signing the Message with the specified KeyID and SigningAlgorithm. If the signature is not verified, the Verify operation fails with a KMSInvalidSignatureException exception.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    signatureValid -
    A Boolean value that indicates whether the signature was verified. A value of True indicates that the Signature was produced by signing the Message with the specified KeyID and SigningAlgorithm. If the signature is not verified, the Verify operation fails with a KMSInvalidSignatureException exception.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSigningAlgorithm
```
public String getSigningAlgorithm()
```
    The signing algorithm that was used to verify the signature.
    
    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 verify the signature.
    
    See Also:
    
    SigningAlgorithmSpec
  - setSigningAlgorithm
```
public void setSigningAlgorithm(String signingAlgorithm)
```
    The signing algorithm that was used to verify the signature.
    
    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 verify the signature.
    
    See Also:
    
    SigningAlgorithmSpec
  - withSigningAlgorithm
```
public VerifyResult withSigningAlgorithm(String signingAlgorithm)
```
    The signing algorithm that was used to verify the signature.
    
    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 verify the signature.
    
    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 verify the signature.
    
    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 verify the signature.
    
    See Also:
    
    SigningAlgorithmSpec
  - withSigningAlgorithm
```
public VerifyResult withSigningAlgorithm(SigningAlgorithmSpec signingAlgorithm)
```
    The signing algorithm that was used to verify the signature.
    
    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 verify the signature.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    SigningAlgorithmSpec
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class VerifyResult

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VerifyResult

Method Detail

getKeyId

setKeyId

withKeyId

isSignatureValid

getSignatureValid

setSignatureValid

withSignatureValid

getSigningAlgorithm

setSigningAlgorithm

withSigningAlgorithm

setSigningAlgorithm

withSigningAlgorithm

toString

hashCode

equals