Record Class ToolResponseMessage.ToolResponse

java.lang.Object
java.lang.Record
org.springframework.ai.chat.messages.ToolResponseMessage.ToolResponse
Enclosing class:
ToolResponseMessage
public static record ToolResponseMessage.ToolResponse(String id, String name, String responseData) extends Record
Since:
1.0.0
Author:
Christian Tzolov, Eric Bottard

  • Constructor Summary

    Constructors
    Constructor
    Description
    ToolResponse(String id, String name, String responseData)
    Creates an instance of a ToolResponse record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    id()
    Returns the value of the id record component.
    String
    name()
    Returns the value of the name record component.
    String
    responseData()
    Returns the value of the responseData 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

    • ToolResponse

      public ToolResponse(String id, String name, String responseData)
      Creates an instance of a ToolResponse record class.
      Parameters:
      id - the value for the id record component
      name - the value for the name record component
      responseData - the value for the responseData 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. 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.

    • id

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

    • name

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

    • responseData

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