Record Class StreamPqEncryptRequest

java.lang.Object
java.lang.Record
co.cryptoservice.sdk.StreamPqEncryptRequest
Record Components:
x25519PublicKey - the X25519 public key as hex
mlKemPublicKey - the ML-KEM public key as hex
plaintext - the plaintext, as UTF-8 text
chunkSize - the stream chunk size in bytes, or null for the default

public record StreamPqEncryptRequest(String x25519PublicKey, String mlKemPublicKey, String plaintext, Integer chunkSize) extends Record
The body of POST /v2/stream/pq-encrypt.
  • Constructor Details

    • StreamPqEncryptRequest

      public StreamPqEncryptRequest(String x25519PublicKey, String mlKemPublicKey, String plaintext, Integer chunkSize)
      Checks that every required member is present.
      Throws:
      NullPointerException - when a required member is null
  • Method Details

    • of

      public static StreamPqEncryptRequest of(String x25519PublicKey, String mlKemPublicKey, String plaintext)
      A request with only the required members; the optional ones are null.
      Parameters:
      x25519PublicKey - the X25519 public key as hex
      mlKemPublicKey - the ML-KEM public key as hex
      plaintext - the plaintext, as UTF-8 text
      Returns:
      the request
    • withChunkSize

      public StreamPqEncryptRequest withChunkSize(Integer chunkSize)
      A copy with chunkSize replaced.
      Parameters:
      chunkSize - the stream chunk size in bytes, 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.
    • x25519PublicKey

      public String x25519PublicKey()
      Returns the value of the x25519PublicKey record component.
      Returns:
      the value of the x25519PublicKey record component
    • mlKemPublicKey

      public String mlKemPublicKey()
      Returns the value of the mlKemPublicKey record component.
      Returns:
      the value of the mlKemPublicKey record component
    • plaintext

      public String plaintext()
      Returns the value of the plaintext record component.
      Returns:
      the value of the plaintext record component
    • chunkSize

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