Record Class KmsUnwrapResult

java.lang.Object
java.lang.Record
co.cryptoservice.sdk.KmsUnwrapResult
Record Components:
keyId - the provider's key identifier (local keys: local-<hex>)
provider - the provider that served the request (local, aws, gcp, vault)
unwrappedKey - the unwrapped key bytes; lowercase hex

public record KmsUnwrapResult(String keyId, String provider, String unwrappedKey) extends Record
What POST /v2/kms/unwrap answers: unwrap a wrapped key using a managed KMS key.
  • Constructor Details

    • KmsUnwrapResult

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

    • unwrappedKeyBytes

      public byte[] unwrappedKeyBytes()
      unwrappedKey() decoded from hex.
      Returns:
      the bytes, or null when unwrappedKey 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.
    • keyId

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

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

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