Record Class KmsGenerateDataKeyRequest

java.lang.Object
java.lang.Record
co.cryptoservice.sdk.KmsGenerateDataKeyRequest
Record Components:
keyId - the server-held key's identifier
keySpec - the data-key specification, or null for the default
provider - the KMS provider, or null for the default

public record KmsGenerateDataKeyRequest(String keyId, String keySpec, String provider) extends Record
The body of POST /v2/kms/generate-data-key.
  • Constructor Details

    • KmsGenerateDataKeyRequest

      public KmsGenerateDataKeyRequest(String keyId, String keySpec, String provider)
      Checks that every required member is present.
      Throws:
      NullPointerException - when a required member is null
  • Method Details

    • of

      public static KmsGenerateDataKeyRequest of(String keyId)
      A request with only the required members; the optional ones are null.
      Parameters:
      keyId - the server-held key's identifier
      Returns:
      the request
    • withKeySpec

      public KmsGenerateDataKeyRequest withKeySpec(String keySpec)
      A copy with keySpec replaced.
      Parameters:
      keySpec - the data-key specification, or null for the default
      Returns:
      the new request
    • withProvider

      public KmsGenerateDataKeyRequest withProvider(String provider)
      A copy with provider replaced.
      Parameters:
      provider - the KMS provider, or null for the default
      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
    • keySpec

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

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