Package com.atlassian.bitbucket.hook.script

Interface HookScriptConfig

public interface HookScriptConfig
Configures a HookScript to run for a given scope, and defines the triggers for which it should be invoked.

A single script can be configured multiple times for different scopes. In such cases, the configuration for the most specific scope supersedes less specific ones. For example, if a script is configured at both project and repository level, the repository-level configuration overrides and replaces the project-level config for that repository; the two are not merged.

When a script is configured for a given scope, it is invoked according to its type. Configuration cannot override type. If a given script implements a pre-style hook, it can only be run as a PreRepositoryHook. Configuration only controls what scopes a script is run for, and for which triggers.

Since:
6.2

  • Method Details

    • getScope

      @Nonnull Scope getScope()
      Returns:
      the scope for which the script is configured

    • getScript

      @Nonnull HookScript getScript()
      Returns:
      the configured script

    • getTriggerIds

      @Nonnull Set<String> getTriggerIds()
      Returns:
      a set of trigger IDs for which the script should be invoked, with an empty denoting all triggers