Record Class PasswordHashRequest

java.lang.Object
java.lang.Record
co.cryptoservice.sdk.PasswordHashRequest
Record Components:
password - the password
timeCost - the Argon2id passes, or null for the default
memoryCost - the Argon2id memory in KiB, or null for the default
parallelism - the Argon2id lanes, or null for the default

public record PasswordHashRequest(String password, Integer timeCost, Integer memoryCost, Integer parallelism) extends Record
The body of POST /v2/password/hash.
  • Constructor Details

    • PasswordHashRequest

      public PasswordHashRequest(String password, Integer timeCost, Integer memoryCost, Integer parallelism)
      Checks that every required member is present.
      Throws:
      NullPointerException - when a required member is null
  • Method Details

    • of

      public static PasswordHashRequest of(String password)
      A request with only the required members; the optional ones are null.
      Parameters:
      password - the password
      Returns:
      the request
    • withTimeCost

      public PasswordHashRequest withTimeCost(Integer timeCost)
      A copy with timeCost replaced.
      Parameters:
      timeCost - the Argon2id passes, or null for the default
      Returns:
      the new request
    • withMemoryCost

      public PasswordHashRequest withMemoryCost(Integer memoryCost)
      A copy with memoryCost replaced.
      Parameters:
      memoryCost - the Argon2id memory in KiB, or null for the default
      Returns:
      the new request
    • withParallelism

      public PasswordHashRequest withParallelism(Integer parallelism)
      A copy with parallelism replaced.
      Parameters:
      parallelism - the Argon2id lanes, 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.
    • password

      public String password()
      Returns the value of the password record component.
      Returns:
      the value of the password record component
    • timeCost

      public Integer timeCost()
      Returns the value of the timeCost record component.
      Returns:
      the value of the timeCost record component
    • memoryCost

      public Integer memoryCost()
      Returns the value of the memoryCost record component.
      Returns:
      the value of the memoryCost record component
    • parallelism

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