Record Class KmsCreateKeyRequest

java.lang.Object
java.lang.Record
co.cryptoservice.sdk.KmsCreateKeyRequest
Record Components:
provider - the KMS provider, or null for the default
algorithm - the algorithm
usage - the key usage, or null for encrypt
metadata - the key metadata, or null

public record KmsCreateKeyRequest(String provider, String algorithm, KmsKeyUsage usage, Map<String,String> metadata) extends Record
The body of POST /v2/kms/create-key.
  • Constructor Details

    • KmsCreateKeyRequest

      public KmsCreateKeyRequest(String provider, String algorithm, KmsKeyUsage usage, Map<String,String> metadata)
      Creates an instance of a KmsCreateKeyRequest record class.
      Parameters:
      provider - the value for the provider record component
      algorithm - the value for the algorithm record component
      usage - the value for the usage record component
      metadata - the value for the metadata record component
  • Method Details

    • withProvider

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

      public KmsCreateKeyRequest withAlgorithm(String algorithm)
      A copy with algorithm replaced.
      Parameters:
      algorithm - the algorithm
      Returns:
      the new request
    • withUsage

      public KmsCreateKeyRequest withUsage(KmsKeyUsage usage)
      A copy with usage replaced.
      Parameters:
      usage - the key usage, or null for encrypt
      Returns:
      the new request
    • withMetadata

      public KmsCreateKeyRequest withMetadata(Map<String,String> metadata)
      A copy with metadata replaced.
      Parameters:
      metadata - the key metadata, 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.
    • provider

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

      public String algorithm()
      Returns the value of the algorithm record component.
      Returns:
      the value of the algorithm record component
    • usage

      public KmsKeyUsage usage()
      Returns the value of the usage record component.
      Returns:
      the value of the usage record component
    • metadata

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