Record Class ResponseEntity<R,E>

java.lang.Object
java.lang.Record
org.springframework.ai.chat.client.ResponseEntity<R,E>
Type Parameters:
R - the entire response type.
E - the converted entity type.
Record Components:
response - the entire response object.
entity - the converted entity object.
public record ResponseEntity<R,E>(@Nullable R response, @Nullable E entity) extends Record
Represents a Model response that includes the entire response along with the specified response entity type.
Since:
1.0.0
Author:
Christian Tzolov, Thomas Vitale

  • Constructor Summary

    Constructors
    Constructor
    Description
    ResponseEntity(@Nullable R response, @Nullable E entity)
    Creates an instance of a ResponseEntity record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable E
    entity()
    Returns the value of the entity record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    @Nullable E
    getEntity()
     
    @Nullable R
    getResponse()
     
    final int
    hashCode()
    Returns a hash code value for this object.
    @Nullable R
    response()
    Returns the value of the response record component.
    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

    • ResponseEntity

      public ResponseEntity(@Nullable R response, @Nullable E entity)
      Creates an instance of a ResponseEntity record class.
      Parameters:
      response - the value for the response record component
      entity - the value for the entity record component

  • Method Details

    • getResponse

      public @Nullable R getResponse()

    • getEntity

      public @Nullable E getEntity()

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

    • response

      public @Nullable R response()
      Returns the value of the response record component.
      Returns:
      the value of the response record component

    • entity

      public @Nullable E entity()
      Returns the value of the entity record component.
      Returns:
      the value of the entity record component