Record Class KmsUnwrapRequest

java.lang.Object
java.lang.Record
co.cryptoservice.sdk.KmsUnwrapRequest
Record Components:
keyId - the server-held key's identifier
wrappedKey - the wrapped key, as the server returned it
provider - the KMS provider, or null for the default
context - the encryption context, or null

public record KmsUnwrapRequest(String keyId, String wrappedKey, String provider, Map<String,String> context) extends Record
The body of POST /v2/kms/unwrap.
  • Constructor Details

  • Method Details

    • of

      public static KmsUnwrapRequest of(String keyId, String wrappedKey)
      A request with only the required members; the optional ones are null.
      Parameters:
      keyId - the server-held key's identifier
      wrappedKey - the wrapped key, as the server returned it
      Returns:
      the request
    • withProvider

      public KmsUnwrapRequest withProvider(String provider)
      A copy with provider replaced.
      Parameters:
      provider - the KMS provider, or null for the default
      Returns:
      the new request
    • withContext

      public KmsUnwrapRequest withContext(Map<String,String> context)
      A copy with context replaced.
      Parameters:
      context - the encryption context, or null
      Returns:
      the new request
    • 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
    • wrappedKey

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

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

      public Map<String,String> context()
      Returns the value of the context record component.
      Returns:
      the value of the context record component