Record Class KmsDecryptResult

java.lang.Object
java.lang.Record
co.cryptoservice.sdk.KmsDecryptResult
Record Components:
hex - the decrypted bytes; lowercase hex
keyId - the provider's key identifier (local keys: local-<hex>)
plaintext - the decrypted bytes, decoded as UTF-8 (invalid sequences become U+FFFD); UTF-8 text
provider - the provider that served the request (local, aws, gcp, vault)

public record KmsDecryptResult(String hex, String keyId, String plaintext, String provider) extends Record
What POST /v2/kms/decrypt answers: decrypt ciphertext with a managed KMS key.
  • Constructor Details

    • KmsDecryptResult

      public KmsDecryptResult(String hex, String keyId, String plaintext, String provider)
      Creates an instance of a KmsDecryptResult record class.
      Parameters:
      hex - the value for the hex record component
      keyId - the value for the keyId record component
      plaintext - the value for the plaintext record component
      provider - the value for the provider record component
  • Method Details

    • hexBytes

      public byte[] hexBytes()
      hex() decoded from hex.
      Returns:
      the bytes, or null when hex is absent
      Throws:
      IllegalArgumentException - when the server sent malformed hex
    • toString

      public String toString()
      Names the members; values that may be secret (keys, plaintexts, passwords, signatures) are redacted.
      Specified by:
      toString in class Record
      Returns:
      a description safe to log
    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object
    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.
    • hex

      public String hex()
      Returns the value of the hex record component.
      Returns:
      the value of the hex record component
    • keyId

      public String keyId()
      Returns the value of the keyId record component.
      Returns:
      the value of the keyId record component
    • plaintext

      public String plaintext()
      Returns the value of the plaintext record component.
      Returns:
      the value of the plaintext record component
    • provider

      public String provider()
      Returns the value of the provider record component.
      Returns:
      the value of the provider record component