Package com.github.copilot.sdk.events

Record Class ToolExecutionCompleteEvent.ToolExecutionCompleteData

java.lang.Object
java.lang.Record
com.github.copilot.sdk.events.ToolExecutionCompleteEvent.ToolExecutionCompleteData
Enclosing class:
ToolExecutionCompleteEvent
public static record ToolExecutionCompleteEvent.ToolExecutionCompleteData(String toolCallId, boolean success, Boolean isUserRequested, ToolExecutionCompleteEvent.ToolExecutionCompleteData.Result result, ToolExecutionCompleteEvent.ToolExecutionCompleteData.Error error, Map<String,Object> toolTelemetry, String parentToolCallId) extends Record

  • Constructor Details

    • ToolExecutionCompleteData

      public ToolExecutionCompleteData(String toolCallId, boolean success, Boolean isUserRequested, ToolExecutionCompleteEvent.ToolExecutionCompleteData.Result result, ToolExecutionCompleteEvent.ToolExecutionCompleteData.Error error, Map<String,Object> toolTelemetry, String parentToolCallId)
      Creates an instance of a ToolExecutionCompleteData record class.
      Parameters:
      toolCallId - the value for the toolCallId record component
      success - the value for the success record component
      isUserRequested - the value for the isUserRequested record component
      result - the value for the result record component
      error - the value for the error record component
      toolTelemetry - the value for the toolTelemetry record component
      parentToolCallId - the value for the parentToolCallId record component

  • Method Details

    • toolTelemetry

      public Map<String,Object> toolTelemetry()
      Returns a defensive copy of the tool telemetry map.

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • toolCallId

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

    • success

      public boolean success()
      Returns the value of the success record component.
      Returns:
      the value of the success record component

    • isUserRequested

      public Boolean isUserRequested()
      Returns the value of the isUserRequested record component.
      Returns:
      the value of the isUserRequested record component

    • result

      public ToolExecutionCompleteEvent.ToolExecutionCompleteData.Result result()
      Returns the value of the result record component.
      Returns:
      the value of the result record component

    • error

      public ToolExecutionCompleteEvent.ToolExecutionCompleteData.Error error()
      Returns the value of the error record component.
      Returns:
      the value of the error record component

    • parentToolCallId

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