Module: Cyclid::Client::Job

Included in:
Tilapia
Defined in:
lib/cyclid/client/job.rb

Overview

Job related methods

Instance Method Summary collapse

Instance Method Details

#job_get(organization, jobid) ⇒ Hash

Get details of a job

Parameters:

  • organization (String) —

    Organization name.

  • jobid (Integer) —

    Job ID to retrieve. The ID must be a valid job for the organization.

Returns:

  • (Hash) —

    Decoded server response object.

See Also:



51
52
53
54
55
56
57
 
# File 'lib/cyclid/client/job.rb', line 51

def job_get(organization, jobid)
  uri = server_uri("/organizations/#{organization}/jobs/#{jobid}")
  res_data = api_get(uri)
  @logger.debug res_data

  return res_data
end

#job_log(organization, jobid) ⇒ Hash

Get a job log

Parameters:

  • organization (String) —

    Organization name.

  • jobid (Integer) —

    Job ID to retrieve. The ID must be a valid job for the organization.

Returns:

  • (Hash) —

    Decoded server response object.

See Also:



79
80
81
82
83
84
85
 
# File 'lib/cyclid/client/job.rb', line 79

def job_log(organization, jobid)
  uri = server_uri("/organizations/#{organization}/jobs/#{jobid}/log")
  res_data = api_get(uri)
  @logger.debug res_data

  return res_data
end

#job_status(organization, jobid) ⇒ Hash

Get a job status

Parameters:

  • organization (String) —

    Organization name.

  • jobid (Integer) —

    Job ID to retrieve. The ID must be a valid job for the organization.

Returns:

  • (Hash) —

    Decoded server response object.

See Also:



65
66
67
68
69
70
71
 
# File 'lib/cyclid/client/job.rb', line 65

def job_status(organization, jobid)
  uri = server_uri("/organizations/#{organization}/jobs/#{jobid}/status")
  res_data = api_get(uri)
  @logger.debug res_data

  return res_data
end

#job_submit(organization, job, type) ⇒ Hash

Submit a job

Examples:

Submit a job in JSON format

job = File.read('job.json')
job_submit('example', job, 'json')

Submit a job in YAML format

job = File.read('job.yml')
job_submit('example', job, 'yaml')

Parameters:

  • organization (String) —

    Organization name.

  • job (String) —

    Raw job data in either JSON or YAML

  • type (String) —

    Job data format; either ‘json’ or ‘yaml’

Returns:

  • (Hash) —

    Decoded server response object.



30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/cyclid/client/job.rb', line 30

def job_submit(organization, job, type)
  uri = server_uri("/organizations/#{organization}/jobs")
  case type
  when 'yaml'
    res_data = api_raw_post(uri, job, 'application/x-yaml')
  when 'json'
    res_data = api_raw_post(uri, job, 'application/json')
  else
    raise "Unknown job format #{type}"
  end
  @logger.debug res_data

  return res_data
end