nodes/generated

Interface JenkinsNodeParameters

Source
interface JenkinsNodeParameters {
    job?: string;
    limit?: number;
    newJob?: string;
    operation?:
        | "create"
        | "getAll"
        | "copy"
        | "trigger"
        | "triggerParams"
        | "cancelQuietDown"
        | "quietDown"
        | "restart"
        | "safeRestart"
        | "safeExit"
        | "exit";
    param?: { params: { name?: string; value?: string }[] };
    reason?: string;
    resource?: "job" | "instance" | "build";
    returnAll?: boolean;
    xml?: string;
}

Properties§

§readonly job?: string

Name of the job. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getJobs"}

§readonly limit?: number

Max number of results to return Default: 50 Type options: {"minValue":1}

§readonly newJob?: string

Name of the new Jenkins job

§readonly operation?:
    | "create"
    | "getAll"
    | "copy"
    | "trigger"
    | "triggerParams"
    | "cancelQuietDown"
    | "quietDown"
    | "restart"
    | "safeRestart"
    | "safeExit"
    | "exit"

Possible operations Default: "trigger"

§readonly param?: { ... }

Parameters for Jenkins job Default: {} Type options: {"multipleValues":true}

§readonly reason?: string

Freeform reason for quiet down mode

§readonly resource?: "job" | "instance" | "build"

Default: "job"

§readonly returnAll?: boolean

Whether to return all results or only up to a given limit

§readonly xml?: string

XML of Jenkins config