Record Class ToolResultExpanded

java.lang.Object
java.lang.Record
com.github.copilot.generated.rpc.ToolResultExpanded
@CopilotExperimental @Generated("copilot-sdk-codegen") public record ToolResultExpanded(String textResultForLlm, ToolResultType resultType, List<ExternalToolTextResultForLlmBinaryResultsForLlm> binaryResultsForLlm, String sessionLog, String error, Object toolTelemetry, Boolean skipLargeOutputProcessing, List<ToolResultNewMessage> newMessages, List<Object> contents, List<String> toolReferences, List<Object> citableSources, Object skillInvocation, Boolean postToolUseFailureHooksProcessed, Object uiResource, Map<String,Object> mcpMeta, Object structuredContent, TaskCompletionDecision taskCompletionDecision) extends Record
Expanded canonical result returned by a session tool.
Since:
1.0.0

  • Constructor Details

    • ToolResultExpanded

      public ToolResultExpanded(String textResultForLlm, ToolResultType resultType, List<ExternalToolTextResultForLlmBinaryResultsForLlm> binaryResultsForLlm, String sessionLog, String error, Object toolTelemetry, Boolean skipLargeOutputProcessing, List<ToolResultNewMessage> newMessages, List<Object> contents, List<String> toolReferences, List<Object> citableSources, Object skillInvocation, Boolean postToolUseFailureHooksProcessed, Object uiResource, Map<String,Object> mcpMeta, Object structuredContent, TaskCompletionDecision taskCompletionDecision)
      Creates an instance of a ToolResultExpanded record class.
      Parameters:
      textResultForLlm - the value for the textResultForLlm record component
      resultType - the value for the resultType record component
      binaryResultsForLlm - the value for the binaryResultsForLlm record component
      sessionLog - the value for the sessionLog record component
      error - the value for the error record component
      toolTelemetry - the value for the toolTelemetry record component
      skipLargeOutputProcessing - the value for the skipLargeOutputProcessing record component
      newMessages - the value for the newMessages record component
      contents - the value for the contents record component
      toolReferences - the value for the toolReferences record component
      citableSources - the value for the citableSources record component
      skillInvocation - the value for the skillInvocation record component
      postToolUseFailureHooksProcessed - the value for the postToolUseFailureHooksProcessed record component
      uiResource - the value for the uiResource record component
      mcpMeta - the value for the mcpMeta record component
      structuredContent - the value for the structuredContent record component
      taskCompletionDecision - the value for the taskCompletionDecision 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.

    • textResultForLlm

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

    • resultType

      public ToolResultType resultType()
      Returns the value of the resultType record component.
      Returns:
      the value of the resultType record component

    • binaryResultsForLlm

      public List<ExternalToolTextResultForLlmBinaryResultsForLlm> binaryResultsForLlm()
      Returns the value of the binaryResultsForLlm record component.
      Returns:
      the value of the binaryResultsForLlm record component

    • sessionLog

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

    • error

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

    • toolTelemetry

      public Object toolTelemetry()
      Returns the value of the toolTelemetry record component.
      Returns:
      the value of the toolTelemetry record component

    • skipLargeOutputProcessing

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

    • newMessages

      public List<ToolResultNewMessage> newMessages()
      Returns the value of the newMessages record component.
      Returns:
      the value of the newMessages record component

    • contents

      public List<Object> contents()
      Returns the value of the contents record component.
      Returns:
      the value of the contents record component

    • toolReferences

      public List<String> toolReferences()
      Returns the value of the toolReferences record component.
      Returns:
      the value of the toolReferences record component

    • citableSources

      public List<Object> citableSources()
      Returns the value of the citableSources record component.
      Returns:
      the value of the citableSources record component

    • skillInvocation

      public Object skillInvocation()
      Returns the value of the skillInvocation record component.
      Returns:
      the value of the skillInvocation record component

    • postToolUseFailureHooksProcessed

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

    • uiResource

      public Object uiResource()
      Returns the value of the uiResource record component.
      Returns:
      the value of the uiResource record component

    • mcpMeta

      public Map<String,Object> mcpMeta()
      Returns the value of the mcpMeta record component.
      Returns:
      the value of the mcpMeta record component

    • structuredContent

      public Object structuredContent()
      Returns the value of the structuredContent record component.
      Returns:
      the value of the structuredContent record component

    • taskCompletionDecision

      public TaskCompletionDecision taskCompletionDecision()
      Returns the value of the taskCompletionDecision record component.
      Returns:
      the value of the taskCompletionDecision record component