jobs

Source:

Job.js, line 3

Methods

(static) create() → {Promise.<Object>}

Description:

Create a new job
see: https://qarnot.com/documentation/api/#api-Jobs-Create_job

Source:

Job.js, line 148

Examples

Usage

const job = await Qarnot.jobs.create({
   "name": "my job",
   "poolUuid": "6307bccd-a886-4b6d-8223-66c9024dd94c",
   "useDependencies": true,
   "maxWallTime": "1.03:16:50.5000000"
 });
console.log(job)

Output

{ uuid: 'bb43b1cb-c03f-4417-9210-a265de8995e9' }

Returns:

Type: Promise.<Object>

(static) delete() → {Promise}

Description:

Delete a job
see: https://qarnot.com/documentation/api/#api-Jobs-Delete_Job

Source:

Job.js, line 166

Example

Usage

await Qarnot.jobs.delete('bb43b1cb-c03f-4417-9210-a265de8995e9');

Returns:

Type: Promise

(static) get(uuid) → {Promise.<Object>}

Description:

Get information of the specified job
see: https://qarnot.com/documentation/api/#api-Jobs-Job_Information

Source:

Job.js, line 35

Examples

Usage

const job = await Qarnot.jobs.get('52c10b2d-0687-41e1-985e-7279f6dd543a');
console.log(job);

Output

{
   "name": "my job",
   "creationDate": "2014-12-24T15:10:54.8659210Z",
   "lastModified": "2014-12-24T15:10:54.8659210Z",
   "uuid": "52c10b2d-0687-41e1-985e-7279f6dd543a",
   "state": 'Active',
   "poolUuid": "6307bccd-a886-4b6d-8223-66c9024dd94c",
   "useDependencies": true,
   "maxWallTime": "1.03:16:50.5000000"
}

Parameters:

Name	Type	Description
`uuid`	String	uuid of the job

Returns:

Type: Promise.<Object>

(static) get(uuid) → {Promise.<Object>}

Description:

List tasks in the specified job
see: https://qarnot.com/documentation/api/#api-Jobs-List_job_s_Tasks

Source:

Job.js, line 58

Examples

Usage

const tasks = await Qarnot.jobs.getTasks('52c10b2d-0687-41e1-985e-7279f6dd543a');
console.log(tasks);

Output

[
  {
    "name": "my blend",
    "profile": "blender",
    "instanceCount": 4,
    "snapshotWhitelist": "white.*",
    "snapshotBlacklist": "black.*",
    "resourceBuckets": [
      "my-input-bucket"
    ],
    "resultBucket": "my-output-bucket",
    "state": "Success",
    "status": {
      "downloadProgress": 100.0,
      "executionProgress": 0.0,
      "uploadProgress": 0.0,
      "instanceCount": 6,
      "downloadTime": "00:00:00",
      "downloadTimeSec": 0.0,
      "environmentTime": "00:00:00",
      "environmentTimeSec": 0.0,
      "executionTime": "00:00:00",
      "executionTimeSec": 0,
      "uploadTime": "00:00:00",
      "uploadTimeSec" : 0.0,
      "succeededRange": "",
      "executedRange": "",
      "failedRange": "",
      "runningInstancesInfo": {
        "perRunningInstanceInfo": [
          {
            "phase": "environment",
            "instanceId": 2467,
            "maxFrequencyGHz": 0.0,
            "currentFrequencyGHz": 0.0,
            "cpuUsage": 0.0,
            "MaxMemoryMB": 0,
            "CurrentMemoryMB": 0,
            "networkInKbps": 0.0,
            "networkOutKbps": 0.0,
            "progress": 0.0,
            "executionTimeSec": 0,
            "executionTimeGHz": 0.0,
            "cpuModel": "",
            "activeForwards": [],
            "memoryUsage": 0.0
          }
        ],
        "timestamp": "0001-01-01T00:00:00",
        "averageFrequencyGHz": 0.0,
        "maxFrequencyGHz": 0.0,
        "minFrequencyGHz": 0.0,
        "averageMaxFrequencyGHz": 0.0,
        "averageCpuUsage": 0.0,
        "clusterPowerIndicator": 1.0,
        "averageMemoryOccupation": 0.0,
        "averageNetworkInKbps": 0.0,
        "averageNetworkOutKbps": 0.0,
        "totalNetworkInKbps": 0.0,
        "totalNetworkOutKbps": 0.0
      }
    },
    "snapshotInterval": 0,
    "resultsCount":1,
    "constants": [
      {
        "key": "BLEND_FILE",
        "value": "final2.blend"
      }
    ],
    "creationDate": "2014-12-24T15:10:54.8659210Z",
    "uuid": "52c10b2d-0687-41e1-985e-7279f6dd543a"
  }
]

Parameters:

Name	Type	Description
`uuid`	String	uuid of the job

Returns:

Type: Promise.<Object>

(static) list() → {Promise.<Array.<Object>>}

Description:

List jobs
see: https://qarnot.com/documentation/api/#api-Jobs-List_Jobs

Source:

Job.js, line 11

Examples

Usage

const jobs = await Qarnot.jobs.list();
console.log(jobs);

Output

[
  {
   "name": "my job",
   "creationDate": "2014-12-24T15:10:54.8659210Z",
   "lastModified": "2014-12-24T15:10:54.8659210Z",
   "uuid": "52c10b2d-0687-41e1-985e-7279f6dd543a",
   "state": 'Active',
   "poolUuid": "6307bccd-a886-4b6d-8223-66c9024dd94c",
   "useDependencies": true,
   "maxWallTime": "1.03:16:50.5000000"
  }
]

Returns:

Type: Promise.<Array.<Object>>

(static) paginate() → {Promise.<Array.<Object>>}

Description:

Get a paginate number of user's jobs list
see: https://qarnot.com/documentation/api/#api-Jobs-Paginate_Jobs_List

Source:

Job.js, line 189

Examples

Usage

const pagination = await Qarnot.jobs.paginate();
console.log(pagination);

Output

[
   {
      data:
      [
          {
            "Connection": null,
            "Uuid": "8c97b929-cb3b-4b5e-b630-2a94a1c6b77a",
            "Name": "job_0",
            "Shortname": "shortname",
            "PoolUuid": "00000000-0000-0000-0000-000000000000",
            "State": "Completed",
            "PreviousState": "Terminating",
            "StateTransitionTime": "2020-07-07T16:17:49Z",
            "PreviousStateTransitionTime": "2020-07-07T16:17:49Z",
            "CreationDate": "2020-07-07T16:15:05Z",
            "LastModified": "2020-07-07T16:17:49Z",
            "UseDependencies": false,
            "MaximumWallTime": "00:00:00",
            "Pool": null
          }
      ],
      count: 1,
      isTruncated: true,
      nextToken: '5ed67ba6d1f1b90d3aff497b'
   }
]

Returns:

Type: Promise.<Array.<Object>>

(static) terminate() → {Promise}

Description:

Terminate a job
see: https://qarnot.com/documentation/api/#api-Jobs-Terminate_Job

Source:

Job.js, line 176

Example

Usage

await Qarnot.jobs.terminate('bb43b1cb-c03f-4417-9210-a265de8995e9');

Returns:

Type: Promise