Package com.github.copilot.sdk.json

Class PreToolUseHookOutput

java.lang.Object
com.github.copilot.sdk.json.PreToolUseHookOutput
public class PreToolUseHookOutput extends Object
Output for a pre-tool-use hook.
Since:
1.0.6

  • Constructor Details

    • PreToolUseHookOutput

      public PreToolUseHookOutput()

  • Method Details

    • getPermissionDecision

      public String getPermissionDecision()
      Gets the permission decision.
      Returns:
      "allow", "deny", or "ask"

    • setPermissionDecision

      public PreToolUseHookOutput setPermissionDecision(String permissionDecision)
      Sets the permission decision.
      Parameters:
      permissionDecision - "allow", "deny", or "ask"
      Returns:
      this instance for method chaining

    • getPermissionDecisionReason

      public String getPermissionDecisionReason()
      Gets the reason for the permission decision.
      Returns:
      the reason text

    • setPermissionDecisionReason

      public PreToolUseHookOutput setPermissionDecisionReason(String permissionDecisionReason)
      Sets the reason for the permission decision.
      Parameters:
      permissionDecisionReason - the reason text
      Returns:
      this instance for method chaining

    • getModifiedArgs

      public com.fasterxml.jackson.databind.JsonNode getModifiedArgs()
      Gets the modified tool arguments.
      Returns:
      the modified arguments, or null to use original

    • setModifiedArgs

      public PreToolUseHookOutput setModifiedArgs(com.fasterxml.jackson.databind.JsonNode modifiedArgs)
      Sets the modified tool arguments.
      Parameters:
      modifiedArgs - the modified arguments
      Returns:
      this instance for method chaining

    • getAdditionalContext

      public String getAdditionalContext()
      Gets additional context to provide to the model.
      Returns:
      the additional context

    • setAdditionalContext

      public PreToolUseHookOutput setAdditionalContext(String additionalContext)
      Sets additional context to provide to the model.
      Parameters:
      additionalContext - the additional context
      Returns:
      this instance for method chaining

    • getSuppressOutput

      public Boolean getSuppressOutput()
      Returns whether to suppress output.
      Returns:
      true to suppress output

    • setSuppressOutput

      public PreToolUseHookOutput setSuppressOutput(Boolean suppressOutput)
      Sets whether to suppress output.
      Parameters:
      suppressOutput - true to suppress output
      Returns:
      this instance for method chaining