Package net.ygbstudio.jbrave.api.response

Record Class ErrorResponse

java.lang.Object
java.lang.Record
net.ygbstudio.jbrave.api.response.ErrorResponse
Record Components:
type - name of the error
error - error response object
time - timestamp
All Implemented Interfaces:
ApiResponse
public record ErrorResponse(String type, ApiErrorModel error, Integer time) extends Record implements ApiResponse
Error response object that the Brave Search API sends in case the client's request results in either 404, 422, or 429 http status codes.

This response record contains methods to deserialise and serialise instances.

Factory methods are available for String, File, Reader, and HttpResponse inputs. You can also write the contents of a response object to the filesystem; ApiResponse.write(File) can be useful for that purpose.

  • Constructor Details

    • ErrorResponse

      public ErrorResponse(String type, ApiErrorModel error, Integer time)
      Creates an instance of a ErrorResponse record class.
      Parameters:
      type - the value for the type record component
      error - the value for the error record component
      time - the value for the time record component

  • Method Details

    • from

      public static ErrorResponse from(File dataFile)
      Deserializes a ErrorResponse from a JSON File.
      Parameters:
      dataFile - the file containing the JSON response data
      Returns:
      the deserialized response

    • from

      public static ErrorResponse from(String dataString)
      Deserializes a ErrorResponse from a JSON String.
      Parameters:
      dataString - the string containing the JSON response data
      Returns:
      the deserialized response

    • from

      public static ErrorResponse from(Reader dataReader)
      Deserializes a ErrorResponse from a JSON Reader.
      Parameters:
      dataReader - the reader supplying the JSON response data
      Returns:
      the deserialized response

    • from

      public static ErrorResponse from(@NotNull @NotNull HttpResponse<String> dataResponse)
      Deserializes a ErrorResponse from the body of an HTTP response.
      Parameters:
      dataResponse - the HTTP response whose body contains the JSON response data
      Returns:
      the deserialized response

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

    • type

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

    • error

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

    • time

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