Record Class ApiError

java.lang.Object
java.lang.Record
com.bluebell.greenhouse.platform.models.api.error.ApiError
Record Components:
httpStatus - HttpStatus
apiErrorReason - ApiErrorReason
publicErrorMessage - client-facing message
internalErrorMessage - internal message
path - request path
timestamp - LocalDateTime
data - optional data
public record ApiError(int httpStatus, ApiErrorReason apiErrorReason, String publicErrorMessage, String internalErrorMessage, String path, LocalDateTime timestamp, Object data) extends Record
Class representation of an erroneous api response.
Version:
3.0.6
Author:
Stephen Prizio

  • Constructor Details

    • ApiError

      public ApiError(int httpStatus, ApiErrorReason apiErrorReason, String publicErrorMessage, String internalErrorMessage, String path, LocalDateTime timestamp, Object data)
      Creates an instance of a ApiError record class.
      Parameters:
      httpStatus - the value for the httpStatus record component
      apiErrorReason - the value for the apiErrorReason record component
      publicErrorMessage - the value for the publicErrorMessage record component
      internalErrorMessage - the value for the internalErrorMessage record component
      path - the value for the path record component
      timestamp - the value for the timestamp record component
      data - the value for the data record component

  • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.

    • httpStatus

      public int httpStatus()
      Returns the value of the httpStatus record component.
      Returns:
      the value of the httpStatus record component

    • apiErrorReason

      public ApiErrorReason apiErrorReason()
      Returns the value of the apiErrorReason record component.
      Returns:
      the value of the apiErrorReason record component

    • publicErrorMessage

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

    • internalErrorMessage

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

    • path

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

    • timestamp

      public LocalDateTime timestamp()
      Returns the value of the timestamp record component.
      Returns:
      the value of the timestamp record component

    • data

      public Object data()
      Returns the value of the data record component.
      Returns:
      the value of the data record component