Package io.jpostman.annotations

Annotation Type JPostman.Runner

    • Element Detail

      • id

        String id
        Optional annotation id used by dependsOn = "#id".
        Returns:
        annotation id
        Default:
        ""

      • tags

        String[] tags
        Tags used to select this runner.
        Returns:
        tags
        Default:
        {}

      • namespace

        String namespace
        Runner namespace.
        Returns:
        namespace
        Default:
        ""

      • folder

        String[] folder
        Collection folder path from the collection root to the target folder.

        Each value represents one folder level. An empty value selects requests from the collection root. 

         folder = "Products"
 folder = { "level1", "level2", "level3" }
        Returns:
        folder path levels from parent to child
        Default:
        {""}

      • include

        String[] include
        Request names to include.
        Returns:
        included request names
        Default:
        {}

      • exclude

        String[] exclude
        Request names to exclude.
        Returns:
        excluded request names
        Default:
        {}

      • rules

        String[] rules
        Rules section names.
        Returns:
        rule names
        Default:
        {}

      • filter

        String[] filter
        Fields to keep in the context.
        Returns:
        filter fields
        Default:
        {}

      • dependsOn

        String[] dependsOn
        Dependency method names.

        For runner launcher methods, a single runner dependency such as dependsOn = "#testRunner" can reuse the referenced runner body with this annotation's tags when this runner does not define its own folder, include/exclude, executor, rules, filter, data, asserts, verify, or lifecycle settings.

        Returns:
        dependency method names
        Default:
        {}

      • verify

        int verify
        Expected HTTP status code for every request executed by this runner. Response and call dependencies inherit this value only while the runner is active. Standalone response and call test methods remain separate executions.
        Returns:
        expected HTTP status code, -1 to use the context default, 0 to pass without status verification, or 1 to mark the completed test skipped
        Default:
        -1

      • executor

        String executor
        Selects a named JPostman.Executor by method name or "#id". Leave empty to use the single executor or the executor without an id.
        Returns:
        executor selector, or empty string for automatic/default selection
        Default:
        ""

      • debug

        String debug
        Local JPostman debug override.

        Use debug to inherit the context debug setting. Use none to suppress output, error for the full failure trace, request for prepared-request diagnostics, response for received-response diagnostics, info for runtime annotation information, or all for all local diagnostics. Request, response, info, and all are printed after annotation execution for both passing and failing executions. The local error mode is different: it is printed only for failures and is deferred until after the JPostman report execution details.

        Returns:
        local debug setting
        Default:
        "debug"

      • lifecycle

        boolean lifecycle
        Enables request/response runner lifecycle callbacks.

        The default false invokes the runner method body once after all selected collection requests reach runner completion, including aggregate HTTP/verification failures. Blank-request @JPostman.Request dependencies still apply per selected request. Set this to true to keep dependencies as one-time runner setup and invoke the runner body after each attempted HTTP request (including completed failed responses), with the before-request phase additionally enabled for fluent runner rules used by jpostman.runner().start(...), jpostman.runner().request(...), or jpostman.runner().response(...).

        Returns:
        true to enable before-request and response lifecycle callbacks
        Default:
        false

      • data

        String data
        Data section name.
        Returns:
        data section
        Default:
        ""

      • asserts

        String[] asserts
        Assertion section names.
        Returns:
        assertion sections
        Default:
        {}

      • enabled

        boolean enabled
        Returns:
        true to run this runner even when context skipAll is enabled
        Default:
        false

      • skip

        boolean skip
        Returns:
        true to skip this runner/test execution
        Default:
        false