Record Class BuiltinToolDescriptor

java.lang.Object
java.lang.Record
com.github.copilot.generated.rpc.BuiltinToolDescriptor
@CopilotExperimental @Generated("copilot-sdk-codegen") public record BuiltinToolDescriptor(String name, String title, String description, BuiltinToolInputSchema inputSchema, String instructions, String type, BuiltinToolFormat format, Object safeForTelemetry, Boolean isTerminal, Boolean hasSummariseIntention) extends Record
Rust-owned metadata and input schema for a built-in tool.
Since:
1.0.0

  • Constructor Details

    • BuiltinToolDescriptor

      public BuiltinToolDescriptor(String name, String title, String description, BuiltinToolInputSchema inputSchema, String instructions, String type, BuiltinToolFormat format, Object safeForTelemetry, Boolean isTerminal, Boolean hasSummariseIntention)
      Creates an instance of a BuiltinToolDescriptor record class.
      Parameters:
      name - the value for the name record component
      title - the value for the title record component
      description - the value for the description record component
      inputSchema - the value for the inputSchema record component
      instructions - the value for the instructions record component
      type - the value for the type record component
      format - the value for the format record component
      safeForTelemetry - the value for the safeForTelemetry record component
      isTerminal - the value for the isTerminal record component
      hasSummariseIntention - the value for the hasSummariseIntention 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

    • title

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

    • description

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

    • inputSchema

      public BuiltinToolInputSchema inputSchema()
      Returns the value of the inputSchema record component.
      Returns:
      the value of the inputSchema record component

    • instructions

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

    • type

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

    • format

      public BuiltinToolFormat format()
      Returns the value of the format record component.
      Returns:
      the value of the format record component

    • safeForTelemetry

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

    • isTerminal

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

    • hasSummariseIntention

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