Class: Allq::ActionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/allq_rest/api/actions_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ActionsApi

Returns a new instance of ActionsApi.



19
20
21
 
# File 'lib/allq_rest/api/actions_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/allq_rest/api/actions_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#bury_put(job_id, opts = {}) ⇒ BasicResponse

Bury Bury Job

Parameters:

  • job_id —

    Job ID

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/allq_rest/api/actions_api.rb', line 27

def bury_put(job_id, opts = {})
  data, _status_code, _headers = bury_put_with_http_info(job_id, opts)
  data
end

#bury_put_with_http_info(job_id, opts = {}) ⇒ Array<(BasicResponse, Fixnum, Hash)>

Bury Bury Job

Parameters:

  • job_id —

    Job ID

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

    the optional parameters

Returns:

  • (Array<(BasicResponse, Fixnum, Hash)>) —

    BasicResponse data, response status code and response headers



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
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/allq_rest/api/actions_api.rb', line 37

def bury_put_with_http_info(job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActionsApi.bury_put ...'
  end
  # verify the required parameter 'job_id' is set
  if @api_client.config.client_side_validation && job_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_id' when calling ActionsApi.bury_put"
  end
  # resource path
  local_var_path = '/bury'

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BasicResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ActionsApi#bury_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#job_delete(job_id, opts = {}) ⇒ BasicResponse

Delete Finished Job

Parameters:

  • job_id —

    Job ID

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

    the optional parameters

Options Hash (opts):

  • :tube (String) —

    Name of Tube (For deleting &quot;ready&quot; objects)

Returns:



83
84
85
86
 
# File 'lib/allq_rest/api/actions_api.rb', line 83

def job_delete(job_id, opts = {})
  data, _status_code, _headers = job_delete_with_http_info(job_id, opts)
  data
end

#job_delete_with_http_info(job_id, opts = {}) ⇒ Array<(BasicResponse, Fixnum, Hash)>

Delete Finished Job

Parameters:

  • job_id —

    Job ID

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

    the optional parameters

Options Hash (opts):

  • :tube (String) —

    Name of Tube (For deleting &quot;ready&quot; objects)

Returns:

  • (Array<(BasicResponse, Fixnum, Hash)>) —

    BasicResponse data, response status code and response headers



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
130
131
132
133
134
 
# File 'lib/allq_rest/api/actions_api.rb', line 94

def job_delete_with_http_info(job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActionsApi.job_delete ...'
  end
  # verify the required parameter 'job_id' is set
  if @api_client.config.client_side_validation && job_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_id' when calling ActionsApi.job_delete"
  end
  # resource path
  local_var_path = '/job'

  # query parameters
  query_params = {}
  query_params[:'job_id'] = job_id
  query_params[:'tube'] = opts[:'tube'] if !opts[:'tube'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BasicResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ActionsApi#job_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#job_get(tube, opts = {}) ⇒ JobResponse

Job Get job from queue

Parameters:

  • tube —

    Name of tube

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

    the optional parameters

Options Hash (opts):

  • :delete (String) —

    Delete on get

Returns:



141
142
143
144
 
# File 'lib/allq_rest/api/actions_api.rb', line 141

def job_get(tube, opts = {})
  data, _status_code, _headers = job_get_with_http_info(tube, opts)
  data
end

#job_get_with_http_info(tube, opts = {}) ⇒ Array<(JobResponse, Fixnum, Hash)>

Job Get job from queue

Parameters:

  • tube —

    Name of tube

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

    the optional parameters

Options Hash (opts):

  • :delete (String) —

    Delete on get

Returns:

  • (Array<(JobResponse, Fixnum, Hash)>) —

    JobResponse data, response status code and response headers



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
 
# File 'lib/allq_rest/api/actions_api.rb', line 152

def job_get_with_http_info(tube, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActionsApi.job_get ...'
  end
  # verify the required parameter 'tube' is set
  if @api_client.config.client_side_validation && tube.nil?
    fail ArgumentError, "Missing the required parameter 'tube' when calling ActionsApi.job_get"
  end
  # resource path
  local_var_path = '/job'

  # query parameters
  query_params = {}
  query_params[:'tube'] = tube
  query_params[:'delete'] = opts[:'delete'] if !opts[:'delete'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'JobResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ActionsApi#job_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#job_post(new_job, opts = {}) ⇒ JobRef

Job Put job into queue

Parameters:

  • new_job —

    New Job Object

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

    the optional parameters

Returns:



198
199
200
201
 
# File 'lib/allq_rest/api/actions_api.rb', line 198

def job_post(new_job, opts = {})
  data, _status_code, _headers = job_post_with_http_info(new_job, opts)
  data
end

#job_post_with_http_info(new_job, opts = {}) ⇒ Array<(JobRef, Fixnum, Hash)>

Job Put job into queue

Parameters:

  • new_job —

    New Job Object

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

    the optional parameters

Returns:

  • (Array<(JobRef, Fixnum, Hash)>) —

    JobRef data, response status code and response headers



208
209
210
211
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
 
# File 'lib/allq_rest/api/actions_api.rb', line 208

def job_post_with_http_info(new_job, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActionsApi.job_post ...'
  end
  # verify the required parameter 'new_job' is set
  if @api_client.config.client_side_validation && new_job.nil?
    fail ArgumentError, "Missing the required parameter 'new_job' when calling ActionsApi.job_post"
  end
  # resource path
  local_var_path = '/job'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(new_job)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'JobRef')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ActionsApi#job_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#multiple_job_get(tube, count, opts = {}) ⇒ MultipleJobResponse

Multiple Job Get multiple jobs from queue

Parameters:

  • tube —

    Name of tube

  • count —

    Max number of reults

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

    the optional parameters

Options Hash (opts):

  • :delete (String) —

    Delete on get

Returns:



255
256
257
258
 
# File 'lib/allq_rest/api/actions_api.rb', line 255

def multiple_job_get(tube, count, opts = {})
  data, _status_code, _headers = multiple_job_get_with_http_info(tube, count, opts)
  data
end

#multiple_job_get_with_http_info(tube, count, opts = {}) ⇒ Array<(MultipleJobResponse, Fixnum, Hash)>

Multiple Job Get multiple jobs from queue

Parameters:

  • tube —

    Name of tube

  • count —

    Max number of reults

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

    the optional parameters

Options Hash (opts):

  • :delete (String) —

    Delete on get

Returns:

  • (Array<(MultipleJobResponse, Fixnum, Hash)>) —

    MultipleJobResponse data, response status code and response headers



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
 
# File 'lib/allq_rest/api/actions_api.rb', line 267

def multiple_job_get_with_http_info(tube, count, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActionsApi.multiple_job_get ...'
  end
  # verify the required parameter 'tube' is set
  if @api_client.config.client_side_validation && tube.nil?
    fail ArgumentError, "Missing the required parameter 'tube' when calling ActionsApi.multiple_job_get"
  end
  # verify the required parameter 'count' is set
  if @api_client.config.client_side_validation && count.nil?
    fail ArgumentError, "Missing the required parameter 'count' when calling ActionsApi.multiple_job_get"
  end
  # resource path
  local_var_path = '/multiple_job'

  # query parameters
  query_params = {}
  query_params[:'tube'] = tube
  query_params[:'count'] = count
  query_params[:'delete'] = opts[:'delete'] if !opts[:'delete'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'MultipleJobResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ActionsApi#multiple_job_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#parent_job_post(new_parent_job, opts = {}) ⇒ JobRef

Parent Job Create a parent job

Parameters:

  • new_parent_job —

    New Parent Job Data

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

    the optional parameters

Returns:



320
321
322
323
 
# File 'lib/allq_rest/api/actions_api.rb', line 320

def parent_job_post(new_parent_job, opts = {})
  data, _status_code, _headers = parent_job_post_with_http_info(new_parent_job, opts)
  data
end

#parent_job_post_with_http_info(new_parent_job, opts = {}) ⇒ Array<(JobRef, Fixnum, Hash)>

Parent Job Create a parent job

Parameters:

  • new_parent_job —

    New Parent Job Data

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

    the optional parameters

Returns:

  • (Array<(JobRef, Fixnum, Hash)>) —

    JobRef data, response status code and response headers



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/allq_rest/api/actions_api.rb', line 330

def parent_job_post_with_http_info(new_parent_job, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActionsApi.parent_job_post ...'
  end
  # verify the required parameter 'new_parent_job' is set
  if @api_client.config.client_side_validation && new_parent_job.nil?
    fail ArgumentError, "Missing the required parameter 'new_parent_job' when calling ActionsApi.parent_job_post"
  end
  # resource path
  local_var_path = '/parent_job'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(new_parent_job)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'JobRef')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ActionsApi#parent_job_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#peek_get(tube, opts = {}) ⇒ JobResponse

Peek Peek at next job

Parameters:

  • tube —

    Tube name

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

    the optional parameters

Options Hash (opts):

  • :buried (String) —

    Look in buried (default to false)

Returns:



375
376
377
378
 
# File 'lib/allq_rest/api/actions_api.rb', line 375

def peek_get(tube, opts = {})
  data, _status_code, _headers = peek_get_with_http_info(tube, opts)
  data
end

#peek_get_with_http_info(tube, opts = {}) ⇒ Array<(JobResponse, Fixnum, Hash)>

Peek Peek at next job

Parameters:

  • tube —

    Tube name

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

    the optional parameters

Options Hash (opts):

  • :buried (String) —

    Look in buried

Returns:

  • (Array<(JobResponse, Fixnum, Hash)>) —

    JobResponse data, response status code and response headers



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
425
426
 
# File 'lib/allq_rest/api/actions_api.rb', line 386

def peek_get_with_http_info(tube, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActionsApi.peek_get ...'
  end
  # verify the required parameter 'tube' is set
  if @api_client.config.client_side_validation && tube.nil?
    fail ArgumentError, "Missing the required parameter 'tube' when calling ActionsApi.peek_get"
  end
  # resource path
  local_var_path = '/peek'

  # query parameters
  query_params = {}
  query_params[:'tube'] = tube
  query_params[:'buried'] = opts[:'buried'] if !opts[:'buried'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'JobResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ActionsApi#peek_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#release_put(job_id, opts = {}) ⇒ BasicResponse

Release Releases job back into queue

Parameters:

  • job_id —

    Job ID

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

    the optional parameters

Returns:



432
433
434
435
 
# File 'lib/allq_rest/api/actions_api.rb', line 432

def release_put(job_id, opts = {})
  data, _status_code, _headers = release_put_with_http_info(job_id, opts)
  data
end

#release_put_with_http_info(job_id, opts = {}) ⇒ Array<(BasicResponse, Fixnum, Hash)>

Release Releases job back into queue

Parameters:

  • job_id —

    Job ID

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

    the optional parameters

Returns:

  • (Array<(BasicResponse, Fixnum, Hash)>) —

    BasicResponse data, response status code and response headers



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
476
477
478
479
480
481
 
# File 'lib/allq_rest/api/actions_api.rb', line 442

def release_put_with_http_info(job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActionsApi.release_put ...'
  end
  # verify the required parameter 'job_id' is set
  if @api_client.config.client_side_validation && job_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_id' when calling ActionsApi.release_put"
  end
  # resource path
  local_var_path = '/release'

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BasicResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ActionsApi#release_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_children_started_put(job_id, opts = {}) ⇒ BasicResponse

Set Children Started When a parent job doesn’t know how many children are going to be added, this is the event that sets the final children count on the parent_job, allowing it to run when the children are done.

Parameters:

  • job_id —

    Job ID

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

    the optional parameters

Returns:



487
488
489
490
 
# File 'lib/allq_rest/api/actions_api.rb', line 487

def set_children_started_put(job_id, opts = {})
  data, _status_code, _headers = set_children_started_put_with_http_info(job_id, opts)
  data
end

#set_children_started_put_with_http_info(job_id, opts = {}) ⇒ Array<(BasicResponse, Fixnum, Hash)>

Set Children Started When a parent job doesn&#39;t know how many children are going to be added, this is the event that sets the final children count on the parent_job, allowing it to run when the children are done.

Parameters:

  • job_id —

    Job ID

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

    the optional parameters

Returns:

  • (Array<(BasicResponse, Fixnum, Hash)>) —

    BasicResponse data, response status code and response headers



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
531
532
533
534
535
536
 
# File 'lib/allq_rest/api/actions_api.rb', line 497

def set_children_started_put_with_http_info(job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActionsApi.set_children_started_put ...'
  end
  # verify the required parameter 'job_id' is set
  if @api_client.config.client_side_validation && job_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_id' when calling ActionsApi.set_children_started_put"
  end
  # resource path
  local_var_path = '/set_children_started'

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BasicResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ActionsApi#set_children_started_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#throttle_post(throttle, opts = {}) ⇒ TubeRef

Throttle Creates a throttle on a tube

Parameters:

  • throttle —

    Throttle info

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

    the optional parameters

Returns:



542
543
544
545
 
# File 'lib/allq_rest/api/actions_api.rb', line 542

def throttle_post(throttle, opts = {})
  data, _status_code, _headers = throttle_post_with_http_info(throttle, opts)
  data
end

#throttle_post_with_http_info(throttle, opts = {}) ⇒ Array<(TubeRef, Fixnum, Hash)>

Throttle Creates a throttle on a tube

Parameters:

  • throttle —

    Throttle info

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

    the optional parameters

Returns:

  • (Array<(TubeRef, Fixnum, Hash)>) —

    TubeRef data, response status code and response headers



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
586
587
588
589
590
 
# File 'lib/allq_rest/api/actions_api.rb', line 552

def throttle_post_with_http_info(throttle, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActionsApi.throttle_post ...'
  end
  # verify the required parameter 'throttle' is set
  if @api_client.config.client_side_validation && throttle.nil?
    fail ArgumentError, "Missing the required parameter 'throttle' when calling ActionsApi.throttle_post"
  end
  # resource path
  local_var_path = '/throttle'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(throttle)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TubeRef')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ActionsApi#throttle_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#touch_put(job_id, opts = {}) ⇒ BasicResponse

Touch Touch job

Parameters:

  • job_id —

    Job ID

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

    the optional parameters

Returns:



596
597
598
599
 
# File 'lib/allq_rest/api/actions_api.rb', line 596

def touch_put(job_id, opts = {})
  data, _status_code, _headers = touch_put_with_http_info(job_id, opts)
  data
end

#touch_put_with_http_info(job_id, opts = {}) ⇒ Array<(BasicResponse, Fixnum, Hash)>

Touch Touch job

Parameters:

  • job_id —

    Job ID

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

    the optional parameters

Returns:

  • (Array<(BasicResponse, Fixnum, Hash)>) —

    BasicResponse data, response status code and response headers



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
645
 
# File 'lib/allq_rest/api/actions_api.rb', line 606

def touch_put_with_http_info(job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActionsApi.touch_put ...'
  end
  # verify the required parameter 'job_id' is set
  if @api_client.config.client_side_validation && job_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_id' when calling ActionsApi.touch_put"
  end
  # resource path
  local_var_path = '/touch'

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BasicResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ActionsApi#touch_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#tube_delete(tube, opts = {}) ⇒ BasicResponse

Clear Tube Delete all contents of tube

Parameters:

  • tube —

    Tube Name

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

    the optional parameters

Returns:



651
652
653
654
 
# File 'lib/allq_rest/api/actions_api.rb', line 651

def tube_delete(tube, opts = {})
  data, _status_code, _headers = tube_delete_with_http_info(tube, opts)
  data
end

#tube_delete_with_http_info(tube, opts = {}) ⇒ Array<(BasicResponse, Fixnum, Hash)>

Clear Tube Delete all contents of tube

Parameters:

  • tube —

    Tube Name

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

    the optional parameters

Returns:

  • (Array<(BasicResponse, Fixnum, Hash)>) —

    BasicResponse data, response status code and response headers



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
699
700
 
# File 'lib/allq_rest/api/actions_api.rb', line 661

def tube_delete_with_http_info(tube, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActionsApi.tube_delete ...'
  end
  # verify the required parameter 'tube' is set
  if @api_client.config.client_side_validation && tube.nil?
    fail ArgumentError, "Missing the required parameter 'tube' when calling ActionsApi.tube_delete"
  end
  # resource path
  local_var_path = '/tube'

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BasicResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ActionsApi#tube_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end