Record Class ProtocolExternalToolDefinition

java.lang.Object
java.lang.Record
com.github.copilot.generated.rpc.ProtocolExternalToolDefinition
@CopilotExperimental @Generated("copilot-sdk-codegen") public record ProtocolExternalToolDefinition(String name, String description, String title, Map<String,Object> parameters, Boolean overridesBuiltInTool, Boolean skipPermission, ProtocolExternalToolDefer defer, Boolean isTerminal, Map<String,Object> metadata) extends Record
Serializable definition of a caller-implemented tool whose execution is handled over the SDK connection.
Since:
1.0.0

  • Constructor Details

    • ProtocolExternalToolDefinition

      public ProtocolExternalToolDefinition(String name, String description, String title, Map<String,Object> parameters, Boolean overridesBuiltInTool, Boolean skipPermission, ProtocolExternalToolDefer defer, Boolean isTerminal, Map<String,Object> metadata)
      Creates an instance of a ProtocolExternalToolDefinition record class.
      Parameters:
      name - the value for the name record component
      description - the value for the description record component
      title - the value for the title record component
      parameters - the value for the parameters record component
      overridesBuiltInTool - the value for the overridesBuiltInTool record component
      skipPermission - the value for the skipPermission record component
      defer - the value for the defer record component
      isTerminal - the value for the isTerminal record component
      metadata - the value for the metadata 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.

    • name

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

    • description

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

    • title

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

    • parameters

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

    • overridesBuiltInTool

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

    • skipPermission

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

    • defer

      public ProtocolExternalToolDefer defer()
      Returns the value of the defer record component.
      Returns:
      the value of the defer record component

    • isTerminal

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

    • metadata

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