Class: Apcera::JobsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/apcera/api/jobs_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = nil) ⇒ JobsApi

Returns a new instance of JobsApi.



7
8
9
 
# File 'lib/apcera/api/jobs_api.rb', line 7

def initialize(api_client = nil)
  @api_client = api_client || Configuration.api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



5
6
7
 
# File 'lib/apcera/api/jobs_api.rb', line 5

def api_client
  @api_client
end

Instance Method Details

#bindings_post(binding, opts = {}) ⇒ Binding

Creates a new binding between a job and a service, or between two jobs (a job link).

Parameters:

  • binding —

    An object that defines the properties of the new binding.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/apcera/api/jobs_api.rb', line 17

def bindings_post(binding, opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: JobsApi#bindings_post ..."
  end
  
  
  # verify the required parameter 'binding' is set
  fail "Missing the required parameter 'binding' when calling bindings_post" if binding.nil?
  
  # resource path
  path = "/bindings".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(binding)
  

  auth_names = ['authorization']
  result = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Binding')
  if Configuration.debugging
    Configuration.logger.debug "API called: JobsApi#bindings_post. Result: #{result.inspect}"
  end
  return result
end

#docker_job_check(job, opts = {}) ⇒ nil

Checks a Docker job before creation to see if it will be allowed by docker.allow policy. Checks a Docker job before creation to see if it will be allowed by [docker.allow policy](docs.apcera.com/policy/examples/docker/#docker-image-whitelisting).

Parameters:

  • job —

    The job object to check.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/apcera/api/jobs_api.rb', line 322

def docker_job_check(job, opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: JobsApi#docker_job_check ..."
  end
  
  
  # verify the required parameter 'job' is set
  fail "Missing the required parameter 'job' when calling docker_job_check" if job.nil?
  
  # resource path
  path = "/jobs/docker-job-check".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(job)
  

  auth_names = ['authorization']
  @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if Configuration.debugging
    Configuration.logger.debug "API called: JobsApi#docker_job_check"
  end
  return nil
end

#docker_jobs_post(job, opts = {}) ⇒ CreateDockerJobResponse

Creates a new job from a Docker image. Downloads a Docker image from a registry and creates a job to run it.

Parameters:

  • job —

    Docker job object.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/apcera/api/jobs_api.rb', line 267

def docker_jobs_post(job, opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: JobsApi#docker_jobs_post ..."
  end
  
  
  # verify the required parameter 'job' is set
  fail "Missing the required parameter 'job' when calling docker_jobs_post" if job.nil?
  
  # resource path
  path = "/jobs/docker".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(job)
  

  auth_names = ['authorization']
  result = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CreateDockerJobResponse')
  if Configuration.debugging
    Configuration.logger.debug "API called: JobsApi#docker_jobs_post. Result: #{result.inspect}"
  end
  return result
end

#job_uuid_instances_instance_uuid_snapshot_post(uuid, instance_uuid, pkg_fqn, opts = {}) ⇒ nil

Creates a snapshot of a instance of a job. Issues a snapshot request to the specified job instance.

Parameters:

  • uuid —

    UUID of the job to be snapshotted.

  • instance_uuid —

    UUID of the instance to be snapshotted.

  • pkg_fqn —

    FQN of snapshot package to return.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :directory (String) —

    Directory of a given job/capsule to snapshot.

  • :authorization (String)

Returns:

  • (nil) 


75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/apcera/api/jobs_api.rb', line 75

def job_uuid_instances_instance_uuid_snapshot_post(uuid, instance_uuid, pkg_fqn, opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: JobsApi#job_uuid_instances_instance_uuid_snapshot_post ..."
  end
  
  
  # verify the required parameter 'uuid' is set
  fail "Missing the required parameter 'uuid' when calling job_uuid_instances_instance_uuid_snapshot_post" if uuid.nil?
  
  # verify the required parameter 'instance_uuid' is set
  fail "Missing the required parameter 'instance_uuid' when calling job_uuid_instances_instance_uuid_snapshot_post" if instance_uuid.nil?
  
  # verify the required parameter 'pkg_fqn' is set
  fail "Missing the required parameter 'pkg_fqn' when calling job_uuid_instances_instance_uuid_snapshot_post" if pkg_fqn.nil?
  
  # resource path
  path = "/job/{uuid}/instances/{instance_uuid}/snapshot".sub('{format}','json').sub('{' + 'uuid' + '}', uuid.to_s).sub('{' + 'instance_uuid' + '}', instance_uuid.to_s)

  # query parameters
  query_params = {}
  query_params[:'pkgFQN'] = pkg_fqn
  query_params[:'directory'] = opts[:'directory'] if opts[:'directory']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['authorization']
  @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if Configuration.debugging
    Configuration.logger.debug "API called: JobsApi#job_uuid_instances_instance_uuid_snapshot_post"
  end
  return nil
end

#jobs_get(opts = {}) ⇒ Array<Job>

List jobs. Returns a list of jobs, optionally filtered by one or more query parameters.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :authorization (String)
  • :tag (Array<String>) —

    List of tags. Only jobs with the specified tags are returned.

  • :ids (Array<String>) —

    List of job UUIDs. Only jobs with the specified UUIDs are returned.

  • :name (String) —

    Local name of job(s) to return.

  • :fqn (String) —

    FQN of job to return.

  • :match_partial_fqn (String) —

    If ‘true`, jobs that partially match the specified FQN are returned.

  • :package_id (String) —

    Return jobs that use the package specified by UUID.

  • :binding_fqn (String) —

    Filter jobs with a specific binding FQN.

  • :provider_fqn (String) —

    Return jobs bound to services on the specified provider.

  • :service_fqn (String) —

    Return jobs bound to the specified service.

  • :count (String) —

    Limits the number of jobs returned in the response. By default, all jobs are returned.

  • :page (String) —

    Specifies the number of the results page to fetch. By default, the first page of results is returned.

  • :health (String) —

    If ‘true`, the response includes health metrics for the job.

Returns:



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/apcera/api/jobs_api.rb', line 148

def jobs_get(opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: JobsApi#jobs_get ..."
  end
  
  
  # resource path
  path = "/jobs".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'tag'] = opts[:'tag'] if opts[:'tag']
  query_params[:'ids'] = opts[:'ids'] if opts[:'ids']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'fqn'] = opts[:'fqn'] if opts[:'fqn']
  query_params[:'matchPartialFQN'] = opts[:'match_partial_fqn'] if opts[:'match_partial_fqn']
  query_params[:'package_id'] = opts[:'package_id'] if opts[:'package_id']
  query_params[:'BindingFQN'] = opts[:'binding_fqn'] if opts[:'binding_fqn']
  query_params[:'ProviderFQN'] = opts[:'provider_fqn'] if opts[:'provider_fqn']
  query_params[:'ServiceFQN'] = opts[:'service_fqn'] if opts[:'service_fqn']
  query_params[:'count'] = opts[:'count'] if opts[:'count']
  query_params[:'page'] = opts[:'page'] if opts[:'page']
  query_params[:'health'] = opts[:'health'] if opts[:'health']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['authorization']
  result = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<Job>')
  if Configuration.debugging
    Configuration.logger.debug "API called: JobsApi#jobs_get. Result: #{result.inspect}"
  end
  return result
end

#jobs_health_get(ids, opts = {}) ⇒ JobHealth

Retrieves health information for a job with a specific UUID. If a job UUID is supplied that corresponds to a deleted or non-running job, or the user does not have &#39;permit read&#39; on the job that they requested health for, the health score will not be in the result.

Parameters:

  • ids —

    List of job UUIDs separated by commas.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/apcera/api/jobs_api.rb', line 376

def jobs_health_get(ids, opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: JobsApi#jobs_health_get ..."
  end
  
  
  # verify the required parameter 'ids' is set
  fail "Missing the required parameter 'ids' when calling jobs_health_get" if ids.nil?
  
  # resource path
  path = "/jobs/health".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'ids'] = ids

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['authorization']
  result = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'JobHealth')
  if Configuration.debugging
    Configuration.logger.debug "API called: JobsApi#jobs_health_get. Result: #{result.inspect}"
  end
  return result
end

#jobs_post(job, opts = {}) ⇒ Job

Creates a new job. Creates a new job from the Job object passed in the POST body. The only required property in the request object is ‘fqn` ([Fully Qualified Name](docs.apcera.com/reference/glossary/#fqn)).

Parameters:

  • job —

    An object that defines the properties of the new job.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/apcera/api/jobs_api.rb', line 212

def jobs_post(job, opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: JobsApi#jobs_post ..."
  end
  
  
  # verify the required parameter 'job' is set
  fail "Missing the required parameter 'job' when calling jobs_post" if job.nil?
  
  # resource path
  path = "/jobs".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(job)
  

  auth_names = ['authorization']
  result = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Job')
  if Configuration.debugging
    Configuration.logger.debug "API called: JobsApi#jobs_post. Result: #{result.inspect}"
  end
  return result
end

#jobs_routes_endpoint_get(endpoint, opts = {}) ⇒ Hash<String, Array<String>>

Returns a map of the specified endpoint to an array of job UUIDs that are assigned to the endpoint.

Parameters:

  • endpoint —

    Base64-encoded endpoint URL.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
 
# File 'lib/apcera/api/jobs_api.rb', line 483

def jobs_routes_endpoint_get(endpoint, opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: JobsApi#jobs_routes_endpoint_get ..."
  end
  
  
  # verify the required parameter 'endpoint' is set
  fail "Missing the required parameter 'endpoint' when calling jobs_routes_endpoint_get" if endpoint.nil?
  
  # resource path
  path = "/jobs/routes/{endpoint}".sub('{format}','json').sub('{' + 'endpoint' + '}', endpoint.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['authorization']
  result = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Hash<String, Array<String>>')
  if Configuration.debugging
    Configuration.logger.debug "API called: JobsApi#jobs_routes_endpoint_get. Result: #{result.inspect}"
  end
  return result
end

#jobs_routes_get(opts = {}) ⇒ Hash<String, Array<String>>

Returns a list of all route endpoints that each map to an array of job UUIDs assigned to the endpoint. Returns a list of job routes.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'lib/apcera/api/jobs_api.rb', line 431

def jobs_routes_get(opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: JobsApi#jobs_routes_get ..."
  end
  
  
  # resource path
  path = "/jobs/routes".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['authorization']
  result = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Hash<String, Array<String>>')
  if Configuration.debugging
    Configuration.logger.debug "API called: JobsApi#jobs_routes_get. Result: #{result.inspect}"
  end
  return result
end

#jobs_uuid_compliance_get(uuid, opts = {}) ⇒ nil

Checks the specified job for policy compliance. Checks the specified job for policy compliance. It checks job routes, bindings, resources, etc. for any violations according to current policy.

Parameters:

  • uuid —

    UUID of the job to check for compliance.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
 
# File 'lib/apcera/api/jobs_api.rb', line 706

def jobs_uuid_compliance_get(uuid, opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: JobsApi#jobs_uuid_compliance_get ..."
  end
  
  
  # verify the required parameter 'uuid' is set
  fail "Missing the required parameter 'uuid' when calling jobs_uuid_compliance_get" if uuid.nil?
  
  # resource path
  path = "/jobs/{uuid}/compliance".sub('{format}','json').sub('{' + 'uuid' + '}', uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['authorization']
  @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if Configuration.debugging
    Configuration.logger.debug "API called: JobsApi#jobs_uuid_compliance_get"
  end
  return nil
end

#jobs_uuid_delete(uuid, opts = {}) ⇒ nil

Deletes the specified job. Deletes the specified job.

Parameters:

  • uuid —

    UUID of the job to delete.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
 
# File 'lib/apcera/api/jobs_api.rb', line 652

def jobs_uuid_delete(uuid, opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: JobsApi#jobs_uuid_delete ..."
  end
  
  
  # verify the required parameter 'uuid' is set
  fail "Missing the required parameter 'uuid' when calling jobs_uuid_delete" if uuid.nil?
  
  # resource path
  path = "/jobs/{uuid}".sub('{format}','json').sub('{' + 'uuid' + '}', uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['authorization']
  @api_client.call_api(:DELETE, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if Configuration.debugging
    Configuration.logger.debug "API called: JobsApi#jobs_uuid_delete"
  end
  return nil
end

#jobs_uuid_files_path_get(uuid, path, opts = {}) ⇒ Array<FileListing>

Returns information about an instance&#39;s underlying file system. Returns information about an instance&#39;s underlying file system.

Parameters:

  • uuid —

    UUID of the job whose file system information should be retrieved.

  • path —

    The path to the root folder for which to generate the folder/file listing. For example, ‘/jobs/&lt;uuid&gt;/files/` returns a listing for the instance&#39;s root folder, and `/jobs/&lt;uuid&gt;/files/app` returns a list of the instance&#39;s `/app` folder.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
 
# File 'lib/apcera/api/jobs_api.rb', line 761

def jobs_uuid_files_path_get(uuid, path, opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: JobsApi#jobs_uuid_files_path_get ..."
  end
  
  
  # verify the required parameter 'uuid' is set
  fail "Missing the required parameter 'uuid' when calling jobs_uuid_files_path_get" if uuid.nil?
  
  # verify the required parameter 'path' is set
  fail "Missing the required parameter 'path' when calling jobs_uuid_files_path_get" if path.nil?
  
  # resource path
  path = "/jobs/{uuid}/files/{path}".sub('{format}','json').sub('{' + 'uuid' + '}', uuid.to_s).sub('{' + 'path' + '}', path.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['authorization']
  result = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<FileListing>')
  if Configuration.debugging
    Configuration.logger.debug "API called: JobsApi#jobs_uuid_files_path_get. Result: #{result.inspect}"
  end
  return result
end

#jobs_uuid_get(uuid, opts = {}) ⇒ Job

Returns details about the specified job. Returns details about the specified job.

Parameters:

  • uuid —

    UUID of the job to fetch.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
 
# File 'lib/apcera/api/jobs_api.rb', line 538

def jobs_uuid_get(uuid, opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: JobsApi#jobs_uuid_get ..."
  end
  
  
  # verify the required parameter 'uuid' is set
  fail "Missing the required parameter 'uuid' when calling jobs_uuid_get" if uuid.nil?
  
  # resource path
  path = "/jobs/{uuid}".sub('{format}','json').sub('{' + 'uuid' + '}', uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['authorization']
  result = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Job')
  if Configuration.debugging
    Configuration.logger.debug "API called: JobsApi#jobs_uuid_get. Result: #{result.inspect}"
  end
  return result
end

#jobs_uuid_instances_get(uuid, opts = {}) ⇒ nil

Returns instances from the health manager for a given job UUID. Returns instances from the health manager for a given job UUID.

Parameters:

  • uuid —

    UUID of the job.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
 
# File 'lib/apcera/api/jobs_api.rb', line 819

def jobs_uuid_instances_get(uuid, opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: JobsApi#jobs_uuid_instances_get ..."
  end
  
  
  # verify the required parameter 'uuid' is set
  fail "Missing the required parameter 'uuid' when calling jobs_uuid_instances_get" if uuid.nil?
  
  # resource path
  path = "/jobs/{uuid}/instances".sub('{format}','json').sub('{' + 'uuid' + '}', uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['authorization']
  @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if Configuration.debugging
    Configuration.logger.debug "API called: JobsApi#jobs_uuid_instances_get"
  end
  return nil
end

#jobs_uuid_instances_instance_uuid_delete(uuid, instance_uuid, opts = {}) ⇒ nil

Stop a given instance of a job. Issues a stop request to the specified job instance.

Parameters:

  • uuid —

    UUID of the job.

  • instance_uuid —

    UUID of the job instance to stop.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'lib/apcera/api/jobs_api.rb', line 874

def jobs_uuid_instances_instance_uuid_delete(uuid, instance_uuid, opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: JobsApi#jobs_uuid_instances_instance_uuid_delete ..."
  end
  
  
  # verify the required parameter 'uuid' is set
  fail "Missing the required parameter 'uuid' when calling jobs_uuid_instances_instance_uuid_delete" if uuid.nil?
  
  # verify the required parameter 'instance_uuid' is set
  fail "Missing the required parameter 'instance_uuid' when calling jobs_uuid_instances_instance_uuid_delete" if instance_uuid.nil?
  
  # resource path
  path = "/jobs/{uuid}/instances/{instance_uuid}".sub('{format}','json').sub('{' + 'uuid' + '}', uuid.to_s).sub('{' + 'instance_uuid' + '}', instance_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['authorization']
  @api_client.call_api(:DELETE, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if Configuration.debugging
    Configuration.logger.debug "API called: JobsApi#jobs_uuid_instances_instance_uuid_delete"
  end
  return nil
end

#jobs_uuid_logs_drains_drain_uuid_delete(uuid, drain_uuid, opts = {}) ⇒ Drain

Deletes a log drain from a job. Deletes the specified log drain from the specified job.

Parameters:

  • uuid —

    UUID of the job with the log drain to delete.

  • drain_uuid —

    UUID of the log drain to delete.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
 
# File 'lib/apcera/api/jobs_api.rb', line 1098

def jobs_uuid_logs_drains_drain_uuid_delete(uuid, drain_uuid, opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: JobsApi#jobs_uuid_logs_drains_drain_uuid_delete ..."
  end
  
  
  # verify the required parameter 'uuid' is set
  fail "Missing the required parameter 'uuid' when calling jobs_uuid_logs_drains_drain_uuid_delete" if uuid.nil?
  
  # verify the required parameter 'drain_uuid' is set
  fail "Missing the required parameter 'drain_uuid' when calling jobs_uuid_logs_drains_drain_uuid_delete" if drain_uuid.nil?
  
  # resource path
  path = "/jobs/{uuid}/logs/drains/{drain_uuid}".sub('{format}','json').sub('{' + 'uuid' + '}', uuid.to_s).sub('{' + 'drain_uuid' + '}', drain_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['authorization']
  result = @api_client.call_api(:DELETE, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Drain')
  if Configuration.debugging
    Configuration.logger.debug "API called: JobsApi#jobs_uuid_logs_drains_drain_uuid_delete. Result: #{result.inspect}"
  end
  return result
end

#jobs_uuid_logs_drains_get(uuid, opts = {}) ⇒ Drain

Returns all log drains for the specified job. Returns all configured log drains for the specified job.

Parameters:

  • uuid —

    UUID of the job to retrieve log drains for.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
 
# File 'lib/apcera/api/jobs_api.rb', line 986

def jobs_uuid_logs_drains_get(uuid, opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: JobsApi#jobs_uuid_logs_drains_get ..."
  end
  
  
  # verify the required parameter 'uuid' is set
  fail "Missing the required parameter 'uuid' when calling jobs_uuid_logs_drains_get" if uuid.nil?
  
  # resource path
  path = "/jobs/{uuid}/logs/drains".sub('{format}','json').sub('{' + 'uuid' + '}', uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['authorization']
  result = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Drain')
  if Configuration.debugging
    Configuration.logger.debug "API called: JobsApi#jobs_uuid_logs_drains_get. Result: #{result.inspect}"
  end
  return result
end

#jobs_uuid_logs_drains_post(uuid, opts = {}) ⇒ Drain

Creates a log drain on the specified job. Creates a log drain on the specified job from the ‘drain` parameter in the request body.

Parameters:

  • uuid —

    UUID of the job.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :drain (Drain) —

    Drain object to add to job.

  • :authorization (String)

Returns:



1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
 
# File 'lib/apcera/api/jobs_api.rb', line 1042

def jobs_uuid_logs_drains_post(uuid, opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: JobsApi#jobs_uuid_logs_drains_post ..."
  end
  
  
  # verify the required parameter 'uuid' is set
  fail "Missing the required parameter 'uuid' when calling jobs_uuid_logs_drains_post" if uuid.nil?
  
  # resource path
  path = "/jobs/{uuid}/logs/drains".sub('{format}','json').sub('{' + 'uuid' + '}', uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'drain'])
  

  auth_names = ['authorization']
  result = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Drain')
  if Configuration.debugging
    Configuration.logger.debug "API called: JobsApi#jobs_uuid_logs_drains_post. Result: #{result.inspect}"
  end
  return result
end

#jobs_uuid_logs_get(uuid, opts = {}) ⇒ String

Returns logs for the specified job. Returns logs for the specified job.

Parameters:

  • uuid —

    UUID of the job to retrieve logs for.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
 
# File 'lib/apcera/api/jobs_api.rb', line 931

def jobs_uuid_logs_get(uuid, opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: JobsApi#jobs_uuid_logs_get ..."
  end
  
  
  # verify the required parameter 'uuid' is set
  fail "Missing the required parameter 'uuid' when calling jobs_uuid_logs_get" if uuid.nil?
  
  # resource path
  path = "/jobs/{uuid}/logs".sub('{format}','json').sub('{' + 'uuid' + '}', uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['authorization']
  result = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if Configuration.debugging
    Configuration.logger.debug "API called: JobsApi#jobs_uuid_logs_get. Result: #{result.inspect}"
  end
  return result
end

#jobs_uuid_put(uuid, job, opts = {}) ⇒ Job

Updates a job. Updates the specified job.

Parameters:

  • uuid —

    UUID of the job to update.

  • job —

    A JSON object describing the full job object to update, including new values for any properties to update on the job.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/apcera/api/jobs_api.rb', line 594

def jobs_uuid_put(uuid, job, opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: JobsApi#jobs_uuid_put ..."
  end
  
  
  # verify the required parameter 'uuid' is set
  fail "Missing the required parameter 'uuid' when calling jobs_uuid_put" if uuid.nil?
  
  # verify the required parameter 'job' is set
  fail "Missing the required parameter 'job' when calling jobs_uuid_put" if job.nil?
  
  # resource path
  path = "/jobs/{uuid}".sub('{format}','json').sub('{' + 'uuid' + '}', uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(job)
  

  auth_names = ['authorization']
  result = @api_client.call_api(:PUT, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Job')
  if Configuration.debugging
    Configuration.logger.debug "API called: JobsApi#jobs_uuid_put. Result: #{result.inspect}"
  end
  return result
end

#jobs_uuid_tunnel_get(uuid, opts = {}) ⇒ nil

Creates a bi-directional tunnel with the job/instance UUID specified. Creates a bi-directional tunnel with the job/instance UUID specified.

Parameters:

  • uuid —

    UUID of the job.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
 
# File 'lib/apcera/api/jobs_api.rb', line 1156

def jobs_uuid_tunnel_get(uuid, opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: JobsApi#jobs_uuid_tunnel_get ..."
  end
  
  
  # verify the required parameter 'uuid' is set
  fail "Missing the required parameter 'uuid' when calling jobs_uuid_tunnel_get" if uuid.nil?
  
  # resource path
  path = "/jobs/{uuid}/tunnel".sub('{format}','json').sub('{' + 'uuid' + '}', uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['authorization']
  @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if Configuration.debugging
    Configuration.logger.debug "API called: JobsApi#jobs_uuid_tunnel_get"
  end
  return nil
end

#jobs_uuid_tunnel_instance_id_get(uuid, instance_id, opts = {}) ⇒ nil

Creates a bi-directional tunnel with the job/instance UUID specified. Creates a bi-directional tunnel with the job/instance UUID specified.

Parameters:

  • uuid —

    UUID of the job.

  • instance_id —

    UUID of the job instance.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
 
# File 'lib/apcera/api/jobs_api.rb', line 1211

def jobs_uuid_tunnel_instance_id_get(uuid, instance_id, opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: JobsApi#jobs_uuid_tunnel_instance_id_get ..."
  end
  
  
  # verify the required parameter 'uuid' is set
  fail "Missing the required parameter 'uuid' when calling jobs_uuid_tunnel_instance_id_get" if uuid.nil?
  
  # verify the required parameter 'instance_id' is set
  fail "Missing the required parameter 'instance_id' when calling jobs_uuid_tunnel_instance_id_get" if instance_id.nil?
  
  # resource path
  path = "/jobs/{uuid}/tunnel/{instance_id}".sub('{format}','json').sub('{' + 'uuid' + '}', uuid.to_s).sub('{' + 'instance_id' + '}', instance_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['authorization']
  @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if Configuration.debugging
    Configuration.logger.debug "API called: JobsApi#jobs_uuid_tunnel_instance_id_get"
  end
  return nil
end

#tasks_uuid_get(uuid, opts = {}) ⇒ Task

Returns a list of task events for a given task. Returns the requested Task, which contains a list of task events. A client can poll this endpoint to check the status of a task. Optionally, a client can request a websocket connection over which tasks are streamed in real-time.

Parameters:

  • uuid —

    UUID of task.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :authorization (String)
  • :time (String) —

    If specified, only task events that occurred after the specified time are returned. If not specified, all task events are returned.

  • :upgrade (String) —

    Header required to upgrade connection to websocket. Value must be &#39;websocket&#39;.

  • :connection (String) —

    Header required to upgrade connection to websocket. Value must be &#39;Upgrade&#39;.

  • :sec_web_socket_key (String) —

    Header required to upgrade connection to websocket. Value is base64-encoded random bytes.

Returns:



1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
 
# File 'lib/apcera/api/jobs_api.rb', line 1272

def tasks_uuid_get(uuid, opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: JobsApi#tasks_uuid_get ..."
  end
  
  
  # verify the required parameter 'uuid' is set
  fail "Missing the required parameter 'uuid' when calling tasks_uuid_get" if uuid.nil?
  
  # resource path
  path = "/tasks/{uuid}".sub('{format}','json').sub('{' + 'uuid' + '}', uuid.to_s)

  # query parameters
  query_params = {}
  query_params[:'time'] = opts[:'time'] if opts[:'time']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']
  header_params[:'Upgrade'] = opts[:'upgrade'] if opts[:'upgrade']
  header_params[:'Connection'] = opts[:'connection'] if opts[:'connection']
  header_params[:'Sec-WebSocket-Key'] = opts[:'sec_web_socket_key'] if opts[:'sec_web_socket_key']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['authorization']
  result = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Task')
  if Configuration.debugging
    Configuration.logger.debug "API called: JobsApi#tasks_uuid_get. Result: #{result.inspect}"
  end
  return result
end

#unbind_post(job, opts = {}) ⇒ nil

Removes a service binding from a job. Removes a service binding from a job.

Parameters:

  • job —

    An object that specifies the job and service to unbind.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
 
# File 'lib/apcera/api/jobs_api.rb', line 1331

def unbind_post(job, opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: JobsApi#unbind_post ..."
  end
  
  
  # verify the required parameter 'job' is set
  fail "Missing the required parameter 'job' when calling unbind_post" if job.nil?
  
  # resource path
  path = "/unbind".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(job)
  

  auth_names = ['authorization']
  @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if Configuration.debugging
    Configuration.logger.debug "API called: JobsApi#unbind_post"
  end
  return nil
end

#unlink_post(job, opts = {}) ⇒ nil

Removes a link between two jobs. Removes a link between two jobs. The binding record is only removed from the ‘from_job` property of the request object.

Parameters:

  • job —

    An object that specifies the two jobs to link and the port to use on the target job.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
 
# File 'lib/apcera/api/jobs_api.rb', line 1385

def unlink_post(job, opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: JobsApi#unlink_post ..."
  end
  
  
  # verify the required parameter 'job' is set
  fail "Missing the required parameter 'job' when calling unlink_post" if job.nil?
  
  # resource path
  path = "/unlink".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(job)
  

  auth_names = ['authorization']
  @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if Configuration.debugging
    Configuration.logger.debug "API called: JobsApi#unlink_post"
  end
  return nil
end