Package com.github.copilot.sdk.json

Record Class PreToolUseHookOutput

java.lang.Object
java.lang.Record
com.github.copilot.sdk.json.PreToolUseHookOutput
Record Components:
permissionDecision - "allow", "deny", or "ask"
permissionDecisionReason - the reason for the permission decision
modifiedArgs - the modified tool arguments, or null to use original
additionalContext - additional context to provide to the model
suppressOutput - true to suppress output
public record PreToolUseHookOutput(String permissionDecision, String permissionDecisionReason, com.fasterxml.jackson.databind.JsonNode modifiedArgs, String additionalContext, Boolean suppressOutput) extends Record
Output for a pre-tool-use hook.
Since:
1.0.6

  • Constructor Details

    • PreToolUseHookOutput

      public PreToolUseHookOutput(String permissionDecision, String permissionDecisionReason, com.fasterxml.jackson.databind.JsonNode modifiedArgs, String additionalContext, Boolean suppressOutput)
      Creates an instance of a PreToolUseHookOutput record class.
      Parameters:
      permissionDecision - the value for the permissionDecision record component
      permissionDecisionReason - the value for the permissionDecisionReason record component
      modifiedArgs - the value for the modifiedArgs record component
      additionalContext - the value for the additionalContext record component
      suppressOutput - the value for the suppressOutput record component

  • Method Details

    • allow

      public static PreToolUseHookOutput allow()
      Creates an output that allows the tool to execute.
      Returns:
      a new PreToolUseHookOutput with permission decision "allow"

    • deny

      public static PreToolUseHookOutput deny()
      Creates an output that denies the tool execution.
      Returns:
      a new PreToolUseHookOutput with permission decision "deny"

    • deny

      public static PreToolUseHookOutput deny(String reason)
      Creates an output that denies the tool execution with a reason.
      Parameters:
      reason - the reason for denying the tool execution
      Returns:
      a new PreToolUseHookOutput with permission decision "deny" and reason

    • ask

      public static PreToolUseHookOutput ask()
      Creates an output that asks for user confirmation before executing the tool.
      Returns:
      a new PreToolUseHookOutput with permission decision "ask"

    • withModifiedArgs

      public static PreToolUseHookOutput withModifiedArgs(String permissionDecision, com.fasterxml.jackson.databind.JsonNode modifiedArgs)
      Creates an output with modified tool arguments.
      Parameters:
      permissionDecision - "allow", "deny", or "ask"
      modifiedArgs - the modified tool arguments
      Returns:
      a new PreToolUseHookOutput with the specified permission and modified arguments

    • 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.

    • permissionDecision

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

    • permissionDecisionReason

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

    • modifiedArgs

      public com.fasterxml.jackson.databind.JsonNode modifiedArgs()
      Returns the value of the modifiedArgs record component.
      Returns:
      the value of the modifiedArgs record component

    • additionalContext

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

    • suppressOutput

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