Class HooksDiscoverRequest

java.lang.Object
com.github.copilot.generated.rpc.HooksDiscoverRequest

@CopilotExperimental @Generated("copilot-sdk-codegen") public final class HooksDiscoverRequest extends Object
Optional project paths and host-exclusion behavior for server-scoped hook discovery.

Required inputs are constructor arguments. Optional inputs have fluent setters.

Since:
1.0.0
  • Constructor Details

    • HooksDiscoverRequest

      public HooksDiscoverRequest()
      Creates a request with its required inputs.
  • Method Details

    • getProjectPaths

      public List<String> getProjectPaths()
      Returns the projectPaths property.
      Returns:
      Optional project directory paths whose trusted repository and project-expanded plugin hooks should be discovered. When omitted or empty, user, managed-policy, and globally enabled installed or explicit plugin hooks are returned without project expansion.
    • getExcludeHostHooks

      public Boolean getExcludeHostHooks()
      Returns the excludeHostHooks property.
      Returns:
      When true, omit host-owned user and plugin hook rows and their diagnostics. Managed-policy hooks and trusted repository hooks remain visible, and host disabledHooks still contribute to each remaining row's effective enabled state. This filters sources rather than simulating a host with no settings.
    • getHookDirectories

      public List<String> getHookDirectories()
      Returns the hookDirectories property.
      Returns:
      Explicit discovery-only file-hook roots, separate from callback hooks and filesystem grants. Available without ambient discovery or repository file-hook enablement, subject to managed/hook disables. Relative paths resolve against the request's effective working directory when supplied. Null and omission are equivalent; an empty array contributes no explicit roots.
    • setProjectPaths

      public HooksDiscoverRequest setProjectPaths(List<String> value)
      Sets the projectPaths property.
      Parameters:
      value - Optional project directory paths whose trusted repository and project-expanded plugin hooks should be discovered. When omitted or empty, user, managed-policy, and globally enabled installed or explicit plugin hooks are returned without project expansion.
      Returns:
      this request
    • setExcludeHostHooks

      public HooksDiscoverRequest setExcludeHostHooks(Boolean value)
      Sets the excludeHostHooks property.
      Parameters:
      value - When true, omit host-owned user and plugin hook rows and their diagnostics. Managed-policy hooks and trusted repository hooks remain visible, and host disabledHooks still contribute to each remaining row's effective enabled state. This filters sources rather than simulating a host with no settings.
      Returns:
      this request
    • setHookDirectories

      public HooksDiscoverRequest setHookDirectories(List<String> value)
      Sets the hookDirectories property.
      Parameters:
      value - Explicit discovery-only file-hook roots, separate from callback hooks and filesystem grants. Available without ambient discovery or repository file-hook enablement, subject to managed/hook disables. Relative paths resolve against the request's effective working directory when supplied. Null and omission are equivalent; an empty array contributes no explicit roots.
      Returns:
      this request