Record Class BatchItemResult.Failure<T>

java.lang.Object
java.lang.Record
dev.langchain4j.model.batch.BatchItemResult.Failure<T>
Type Parameters:
T - the type of the response payload that would have been produced on success
Record Components:
error - the error describing the failure, never null
All Implemented Interfaces:
BatchItemResult<T>
Enclosing interface:
BatchItemResult<T>
public static record BatchItemResult.Failure<T>(BatchError error) extends Record implements BatchItemResult<T>
The failed outcome of a single batch request.

  • Constructor Details

    • Failure

      public Failure(BatchError error)
      Creates an instance of a Failure record class.
      Parameters:
      error - the value for the error record component

  • Method Details

    • isSuccess

      public boolean isSuccess()
      Description copied from interface: BatchItemResult
      Returns true if this request succeeded.
      Specified by:
      isSuccess in interface BatchItemResult<T>

    • response

      public @Nullable T response()
      Description copied from interface: BatchItemResult
      Returns the successful response, or null if this request failed.
      Specified by:
      response in interface BatchItemResult<T>

    • 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 BatchError error()
      Returns the value of the error record component.
      Specified by:
      error in interface BatchItemResult<T>
      Returns:
      the value of the error record component