Record Class KmsEncryptResult

java.lang.Object
java.lang.Record
co.cryptoservice.sdk.KmsEncryptResult
Record Components:
ciphertext - the ciphertext; opaque, provider-specific string; pass it back unchanged
keyId - the provider's key identifier (local keys: local-<hex>)
provider - the provider that served the request (local, aws, gcp, vault)
context - encryption context, when the provider echoes it, or null when absent
keyVersion - key version used, when versioned, or null when absent

public record KmsEncryptResult(String ciphertext, String keyId, String provider, Map<String,String> context, Integer keyVersion) extends Record
What POST /v2/kms/encrypt answers: encrypt plaintext with a managed KMS key.
  • Constructor Details

    • KmsEncryptResult

      public KmsEncryptResult(String ciphertext, String keyId, String provider, Map<String,String> context, Integer keyVersion)
      Creates an instance of a KmsEncryptResult record class.
      Parameters:
      ciphertext - the value for the ciphertext record component
      keyId - the value for the keyId record component
      provider - the value for the provider record component
      context - the value for the context record component
      keyVersion - the value for the keyVersion record component
  • Method Details

    • 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.
    • ciphertext

      public String ciphertext()
      Returns the value of the ciphertext record component.
      Returns:
      the value of the ciphertext record component
    • 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
    • context

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

      public Integer keyVersion()
      Returns the value of the keyVersion record component.
      Returns:
      the value of the keyVersion record component