# Record Class St1AdminError

java.lang.Object
java.lang.Record
com.io7m.stonesignal.protocol.admin.v1.St1AdminError

Record Components:
  `errorCode` - The error code
  `message` - The error message

All Implemented Interfaces:
  `St1AdminMessageType`

public record St1AdminError(String errorCode, String message) extends Record implements St1AdminMessageType
An error message.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `St1AdminError(String errorCode, String message)`
  An error message.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `final boolean`
  `equals(Object o)`
  Indicates whether some other object is "equal to" this one.
  `String`
  `errorCode()`
  Returns the value of the `errorCode` record component.
  `final int`
  `hashCode()`
  Returns a hash code value for this object.
  `String`
  `message()`
  Returns the value of the `message` record component.
  `final String`
  `toString()`
  Returns a string representation of this record class.

  ### Methods inherited from class java.lang.Object

  `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- ## Constructor Details

  - ### St1AdminError

    public St1AdminError(@JsonPropertyDescription("The error code.") String errorCode, @JsonPropertyDescription("The human-readable error message.") String message)
    An error message.
    Parameters:
      `errorCode` - The error code
      `message` - The error message

- ## Method Details

  - ### toString

    public final String toString()
    Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
    Specified by:
      `toString` in class `Record`
    Returns:
      a string representation of this object

  - ### 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.

  - ### errorCode

    @JsonPropertyDescription("The error code.") public String errorCode()
    Returns the value of the `errorCode` record component.
    Returns:
      the value of the `errorCode` record component

  - ### message

    @JsonPropertyDescription("The human-readable error message.") public String message()
    Returns the value of the `message` record component.
    Returns:
      the value of the `message` record component