Record Class EODApiErrorResponse

java.lang.Object
java.lang.Record
com.bluebell.greenhouse.sol.models.responses.eod.EODApiErrorResponse
Record Components:
error - provider error message
code - provider error code
All Implemented Interfaces:
GenericIntegrationResponse
public record EODApiErrorResponse(String error, Integer code) extends Record implements GenericIntegrationResponse
Standard error payload returned by EOD-backed endpoints.
Version:
1.0.12
Author:
Stephen Prizio

  • Constructor Summary

    Constructors
    Constructor
    Description
    EODApiErrorResponse(String error, Integer code)
    Creates an instance of a EODApiErrorResponse record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Integer
    code()
    Returns the value of the code record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    String
    error()
    Returns the value of the error record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    isEmpty()
    Returns true when the provider did not return an error payload.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • EODApiErrorResponse

      public EODApiErrorResponse(String error, Integer code)
      Creates an instance of a EODApiErrorResponse record class.
      Parameters:
      error - the value for the error record component
      code - the value for the code record component

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Returns true when the provider did not return an error payload.
      Specified by:
      isEmpty in interface GenericIntegrationResponse
      Returns:
      boolean

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

    • error

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

    • code

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