Job.js

  1. const Resource = require('./Resource');
  3. /** @namespace jobs */
  4. class Job extends Resource {
  5.   constructor(httpClient) {
  6.     super(httpClient);
  7.     this.baseURL = '/jobs';
  8.     this.operations = ['list', 'get', 'create', 'delete', 'terminate'];
  9.   }
  11.   /** List jobs<br>
  12.    * see: {@link https://qarnot.com/documentation/api/#api-Jobs-List_Jobs}
  13.    * @function
  14.    * @name list
  15.    * @memberof jobs
  16.    * @example <caption>Usage</caption>
  17.    * const jobs = await Qarnot.jobs.list();
  18.    * console.log(jobs);
  19.    * @example <caption>Output</caption>
  20.    * [
  21.    *   {
  22.    *    "name": "my job",
  23.    *    "creationDate": "2014-12-24T15:10:54.8659210Z",
  24.    *    "lastModified": "2014-12-24T15:10:54.8659210Z",
  25.    *    "uuid": "52c10b2d-0687-41e1-985e-7279f6dd543a",
  26.    *    "state": 'Active',
  27.    *    "poolUuid": "6307bccd-a886-4b6d-8223-66c9024dd94c",
  28.    *    "useDependencies": true,
  29.    *    "maxWallTime": "1.03:16:50.5000000"
  30.    *   }
  31.    * ]
  32.    * @returns {Promise<Object[]>}
  33.    */
  35.   /** Get information of the specified job<br>
  36.    * see: {@link https://qarnot.com/documentation/api/#api-Jobs-Job_Information}
  37.    * @function
  38.    * @name get
  39.    * @memberof jobs
  40.    * @param uuid {String} uuid of the job
  41.    * @example <caption>Usage</caption>
  42.    * const job = await Qarnot.jobs.get('52c10b2d-0687-41e1-985e-7279f6dd543a');
  43.    * console.log(job);
  44.    * @example <caption>Output</caption>
  45.    * {
  46.    *    "name": "my job",
  47.    *    "creationDate": "2014-12-24T15:10:54.8659210Z",
  48.    *    "lastModified": "2014-12-24T15:10:54.8659210Z",
  49.    *    "uuid": "52c10b2d-0687-41e1-985e-7279f6dd543a",
  50.    *    "state": 'Active',
  51.    *    "poolUuid": "6307bccd-a886-4b6d-8223-66c9024dd94c",
  52.    *    "useDependencies": true,
  53.    *    "maxWallTime": "1.03:16:50.5000000"
  54.    * }
  55.    * @returns {Promise<Object>}
  56.    */
  58.   /** List tasks in the specified job<br>
  59.    * see: {@link https://qarnot.com/documentation/api/#api-Jobs-List_job_s_Tasks}
  60.    * @function
  61.    * @name get
  62.    * @memberof jobs
  63.    * @param uuid {String} uuid of the job
  64.    * @example <caption>Usage</caption>
  65.    * const tasks = await Qarnot.jobs.getTasks('52c10b2d-0687-41e1-985e-7279f6dd543a');
  66.    * console.log(tasks);
  67.    * @example <caption>Output</caption>
  68.    * [
  69.    *   {
  70.    *     "name": "my blend",
  71.    *     "profile": "blender",
  72.    *     "instanceCount": 4,
  73.    *     "snapshotWhitelist": "white.*",
  74.    *     "snapshotBlacklist": "black.*",
  75.    *     "resourceBuckets": [
  76.    *       "my-input-bucket"
  77.    *     ],
  78.    *     "resultBucket": "my-output-bucket",
  79.    *     "state": "Success",
  80.    *     "status": {
  81.    *       "downloadProgress": 100.0,
  82.    *       "executionProgress": 0.0,
  83.    *       "uploadProgress": 0.0,
  84.    *       "instanceCount": 6,
  85.    *       "downloadTime": "00:00:00",
  86.    *       "downloadTimeSec": 0.0,
  87.    *       "environmentTime": "00:00:00",
  88.    *       "environmentTimeSec": 0.0,
  89.    *       "executionTime": "00:00:00",
  90.    *       "executionTimeSec": 0,
  91.    *       "uploadTime": "00:00:00",
  92.    *       "uploadTimeSec" : 0.0,
  93.    *       "succeededRange": "",
  94.    *       "executedRange": "",
  95.    *       "failedRange": "",
  96.    *       "runningInstancesInfo": {
  97.    *         "perRunningInstanceInfo": [
  98.    *           {
  99.    *             "phase": "environment",
  100.    *             "instanceId": 2467,
  101.    *             "maxFrequencyGHz": 0.0,
  102.    *             "currentFrequencyGHz": 0.0,
  103.    *             "cpuUsage": 0.0,
  104.    *             "MaxMemoryMB": 0,
  105.    *             "CurrentMemoryMB": 0,
  106.    *             "networkInKbps": 0.0,
  107.    *             "networkOutKbps": 0.0,
  108.    *             "progress": 0.0,
  109.    *             "executionTimeSec": 0,
  110.    *             "executionTimeGHz": 0.0,
  111.    *             "cpuModel": "",
  112.    *             "activeForwards": [],
  113.    *             "memoryUsage": 0.0
  114.    *           }
  115.    *         ],
  116.    *         "timestamp": "0001-01-01T00:00:00",
  117.    *         "averageFrequencyGHz": 0.0,
  118.    *         "maxFrequencyGHz": 0.0,
  119.    *         "minFrequencyGHz": 0.0,
  120.    *         "averageMaxFrequencyGHz": 0.0,
  121.    *         "averageCpuUsage": 0.0,
  122.    *         "clusterPowerIndicator": 1.0,
  123.    *         "averageMemoryOccupation": 0.0,
  124.    *         "averageNetworkInKbps": 0.0,
  125.    *         "averageNetworkOutKbps": 0.0,
  126.    *         "totalNetworkInKbps": 0.0,
  127.    *         "totalNetworkOutKbps": 0.0
  128.    *       }
  129.    *     },
  130.    *     "snapshotInterval": 0,
  131.    *     "resultsCount":1,
  132.    *     "constants": [
  133.    *       {
  134.    *         "key": "BLEND_FILE",
  135.    *         "value": "final2.blend"
  136.    *       }
  137.    *     ],
  138.    *     "creationDate": "2014-12-24T15:10:54.8659210Z",
  139.    *     "uuid": "52c10b2d-0687-41e1-985e-7279f6dd543a"
  140.    *   }
  141.    * ]
  142.    * @returns {Promise<Object>}
  143.    */
  144.   getTasks(uuid) {
  145.     return this.httpClient.executeHttp('GET', `${this.baseURL}/${uuid}/tasks`, null);
  146.   }
  148.   /** Create a new job<br>
  149.    * see: {@link https://qarnot.com/documentation/api/#api-Jobs-Create_job}
  150.    * @function
  151.    * @name create
  152.    * @memberof jobs
  153.    * @example <caption>Usage</caption>
  154.    * const job = await Qarnot.jobs.create({
  155.    *    "name": "my job",
  156.    *    "poolUuid": "6307bccd-a886-4b6d-8223-66c9024dd94c",
  157.    *    "useDependencies": true,
  158.    *    "maxWallTime": "1.03:16:50.5000000"
  159.    *  });
  160.    * console.log(job)
  161.    * @example <caption>Output</caption>
  162.    * { uuid: 'bb43b1cb-c03f-4417-9210-a265de8995e9' }
  163.    * @returns {Promise<Object>}
  164.    */
  166.   /** Delete a job<br>
  167.    * see: {@link https://qarnot.com/documentation/api/#api-Jobs-Delete_Job}
  168.    * @function
  169.    * @name delete
  170.    * @memberof jobs
  171.    * @example <caption>Usage</caption>
  172.    * await Qarnot.jobs.delete('bb43b1cb-c03f-4417-9210-a265de8995e9');
  173.    * @returns {Promise}
  174.    */
  176.   /** Terminate a job<br>
  177.    * see: {@link https://qarnot.com/documentation/api/#api-Jobs-Terminate_Job}
  178.    * @function
  179.    * @name terminate
  180.    * @memberof jobs
  181.    * @example <caption>Usage</caption>
  182.    * await Qarnot.jobs.terminate('bb43b1cb-c03f-4417-9210-a265de8995e9');
  183.    * @returns {Promise}
  184.    */
  185.   terminate(uuid) {
  186.     return this.httpClient.executeHttp('POST', `${this.baseURL}/${uuid}/terminate`, null);
  187.   }
  189.   /** Get a paginate number of user's jobs list<br>
  190.    * see: {@link https://qarnot.com/documentation/api/#api-Jobs-Paginate_Jobs_List}
  191.    * @function
  192.    * @name paginate
  193.    * @memberof jobs
  194.    * @example <caption>Usage</caption>
  195.    * const pagination = await Qarnot.jobs.paginate();
  196.    * console.log(pagination);
  197.    * @example <caption>Output</caption>
  198.    * [
  199.    *    {
  200.    *       data:
  201.    *       [
  202.    *           {
  203.    *             "Connection": null,
  204.    *             "Uuid": "8c97b929-cb3b-4b5e-b630-2a94a1c6b77a",
  205.    *             "Name": "job_0",
  206.    *             "Shortname": "shortname",
  207.    *             "PoolUuid": "00000000-0000-0000-0000-000000000000",
  208.    *             "State": "Completed",
  209.    *             "PreviousState": "Terminating",
  210.    *             "StateTransitionTime": "2020-07-07T16:17:49Z",
  211.    *             "PreviousStateTransitionTime": "2020-07-07T16:17:49Z",
  212.    *             "CreationDate": "2020-07-07T16:15:05Z",
  213.    *             "LastModified": "2020-07-07T16:17:49Z",
  214.    *             "UseDependencies": false,
  215.    *             "MaximumWallTime": "00:00:00",
  216.    *             "Pool": null
  217.    *           }
  218.    *       ],
  219.    *       count: 1,
  220.    *       isTruncated: true,
  221.    *       nextToken: '5ed67ba6d1f1b90d3aff497b'
  222.    *    }
  223.    * ]
  224.    * @returns {Promise<Object[]>}
  225.    */
  226.   paginate(maximumResults = 20, nextToken = null, filter = null, orderBy = null, orderType = null) {
  227.     const pageBody = {
  228.       Token: nextToken,
  229.       Filter: filter,
  230.       MaximumResults: maximumResults,
  231.       OrderBy: orderBy,
  232.       OrderType: orderType,
  233.     };
  234.     return this.httpClient.executeHttp('POST', `${this.baseURL}/paginate`, pageBody);
  235.   }
  236. }
  238. module.exports = Job;