Module: Buildkit::Client::Jobs

Included in:
Buildkit::Client
Defined in:
lib/buildkit/client/jobs.rb

Overview

Methods for the Jobs API

See Also:

Instance Method Summary collapse

Instance Method Details

#job_env(org, pipeline, build, job, options = {}) ⇒ Array<Sawyer::Resource>

Get a job’s environment variables

Examples:

Buildkit.job_env('my-great-org', 'great-pipeline', 123, 'my-job-id')

Parameters:

  • org (String) —

    Organization slug.

  • pipeline (String) —

    Pipeline slug.

  • build (Integer) —

    Build number.

  • job (String) —

    Job id.

Returns:

  • (Array<Sawyer::Resource>) —

    Hashes representing Buildkite job env.

See Also:



33
34
35
 
# File 'lib/buildkit/client/jobs.rb', line 33

def job_env(org, pipeline, build, job, options = {})
  get("/v2/organizations/#{org}/pipelines/#{pipeline}/builds/#{build}/jobs/#{job}/env", options)
end

#job_log(org, pipeline, build, job, options = {}) ⇒ Sawyer::Resource

Get a job’s log output

Examples:

Buildkit.job_log('my-great-org', 'great-pipeline', 123, 'my-job-id')

Parameters:

  • org (String) —

    Organization slug.

  • pipeline (String) —

    Pipeline slug.

  • build (Integer) —

    Build number.

  • job (String) —

    Job id.

Returns:

  • (Sawyer::Resource) —

    Hash representing the Buildkit job log output.

See Also:



47
48
49
 
# File 'lib/buildkit/client/jobs.rb', line 47

def job_log(org, pipeline, build, job, options = {})
  get("/v2/organizations/#{org}/pipelines/#{pipeline}/builds/#{build}/jobs/#{job}/log", options)
end

#retry_job(org, pipeline, build, job, options = {}) ⇒ Array<Sawyer::Resource>

Retry a job

Examples:

Buildkit.retry_job('my-great-org', 'great-pipeline', 123, 'my-job-id')

Parameters:

  • org (String) —

    Organization slug.

  • pipeline (String) —

    Pipeline slug.

  • build (Integer) —

    Build number.

  • job (String) —

    Job id.

Returns:

  • (Array<Sawyer::Resource>) —

    Hashes representing Buildkite job.

See Also:



19
20
21
 
# File 'lib/buildkit/client/jobs.rb', line 19

def retry_job(org, pipeline, build, job, options = {})
  put("/v2/organizations/#{org}/pipelines/#{pipeline}/builds/#{build}/jobs/#{job}/retry", options)
end