Module com.github.copilot.java
Package com.github.copilot.generated.rpc

Record Class CanvasAction

java.lang.Object
java.lang.Record
com.github.copilot.generated.rpc.CanvasAction
@Generated("copilot-sdk-codegen") public record CanvasAction(String name, String description, Object inputSchema) extends Record
Canvas action that the agent or host can invoke. To discover the input schema for a particular action, call the list_canvas_capabilities tool.
Since:
1.0.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    CanvasAction(String name, String description, Object inputSchema)
    Creates an instance of a CanvasAction record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    description()
    Returns the value of the description record component.
    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.
    Object
    inputSchema()
    Returns the value of the inputSchema record component.
    String
    name()
    Returns the value of the name record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • CanvasAction

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

    • inputSchema

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