Class: CloudReactorAPIClient::WorkflowTaskInstancesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudreactor_api_client/api/workflow_task_instances_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WorkflowTaskInstancesApi

Returns a new instance of WorkflowTaskInstancesApi.



19
20
21
 
# File 'lib/cloudreactor_api_client/api/workflow_task_instances_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/cloudreactor_api_client/api/workflow_task_instances_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#workflow_task_instances_create(workflow_task_instance, opts = {}) ⇒ WorkflowTaskInstance

Parameters:

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

    the optional parameters

Returns:



25
26
27
28
 
# File 'lib/cloudreactor_api_client/api/workflow_task_instances_api.rb', line 25

def workflow_task_instances_create(workflow_task_instance, opts = {})
  data, _status_code, _headers = workflow_task_instances_create_with_http_info(workflow_task_instance, opts)
  data
end

#workflow_task_instances_create_with_http_info(workflow_task_instance, opts = {}) ⇒ Array<(WorkflowTaskInstance, Integer, Hash)>

Returns WorkflowTaskInstance data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(WorkflowTaskInstance, Integer, Hash)>) —

    WorkflowTaskInstance data, response status code and response headers



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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/cloudreactor_api_client/api/workflow_task_instances_api.rb', line 33

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

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(workflow_task_instance)

  # return_type
  return_type = opts[:debug_return_type] || 'WorkflowTaskInstance'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"WorkflowTaskInstancesApi.workflow_task_instances_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowTaskInstancesApi#workflow_task_instances_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


89
90
91
92
 
# File 'lib/cloudreactor_api_client/api/workflow_task_instances_api.rb', line 89

def workflow_task_instances_destroy(uuid, opts = {})
  workflow_task_instances_destroy_with_http_info(uuid, opts)
  nil
end

#workflow_task_instances_destroy_with_http_info(uuid, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Returns nil, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
135
136
137
138
139
140
141
 
# File 'lib/cloudreactor_api_client/api/workflow_task_instances_api.rb', line 97

def workflow_task_instances_destroy_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowTaskInstancesApi.workflow_task_instances_destroy ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling WorkflowTaskInstancesApi.workflow_task_instances_destroy"
  end
  # resource path
  local_var_path = '/workflow_task_instances/{uuid}/'.sub('{' + 'uuid' + '}', CGI.escape(uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"WorkflowTaskInstancesApi.workflow_task_instances_destroy",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowTaskInstancesApi#workflow_task_instances_destroy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_task_instances_list(opts = {}) ⇒ PaginatedWorkflowTaskInstanceList

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :description (String)
  • :limit (Integer) —

    Number of results to return per page.

  • :name (String)
  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (String) —

    Which field to use when ordering the results.

  • :search (String) —

    A search term.

  • :task__name (String)
  • :task__uuid (String)
  • :workflow__created_by_group__id (Integer)
  • :workflow__run_environment__uuid (String)
  • :workflow__uuid (String)

Returns:



156
157
158
159
 
# File 'lib/cloudreactor_api_client/api/workflow_task_instances_api.rb', line 156

def workflow_task_instances_list(opts = {})
  data, _status_code, _headers = workflow_task_instances_list_with_http_info(opts)
  data
end

#workflow_task_instances_list_with_http_info(opts = {}) ⇒ Array<(PaginatedWorkflowTaskInstanceList, Integer, Hash)>

Returns PaginatedWorkflowTaskInstanceList data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :description (String)
  • :limit (Integer) —

    Number of results to return per page.

  • :name (String)
  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (String) —

    Which field to use when ordering the results.

  • :search (String) —

    A search term.

  • :task__name (String)
  • :task__uuid (String)
  • :workflow__created_by_group__id (Integer)
  • :workflow__run_environment__uuid (String)
  • :workflow__uuid (String)

Returns:



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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/cloudreactor_api_client/api/workflow_task_instances_api.rb', line 174

def workflow_task_instances_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowTaskInstancesApi.workflow_task_instances_list ...'
  end
  # resource path
  local_var_path = '/workflow_task_instances/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'description'] = opts[:'description'] if !opts[:'description'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'task__name'] = opts[:'task__name'] if !opts[:'task__name'].nil?
  query_params[:'task__uuid'] = opts[:'task__uuid'] if !opts[:'task__uuid'].nil?
  query_params[:'workflow__created_by_group__id'] = opts[:'workflow__created_by_group__id'] if !opts[:'workflow__created_by_group__id'].nil?
  query_params[:'workflow__run_environment__uuid'] = opts[:'workflow__run_environment__uuid'] if !opts[:'workflow__run_environment__uuid'].nil?
  query_params[:'workflow__uuid'] = opts[:'workflow__uuid'] if !opts[:'workflow__uuid'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PaginatedWorkflowTaskInstanceList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"WorkflowTaskInstancesApi.workflow_task_instances_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowTaskInstancesApi#workflow_task_instances_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_task_instances_partial_update(uuid, opts = {}) ⇒ WorkflowTaskInstance

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



233
234
235
236
 
# File 'lib/cloudreactor_api_client/api/workflow_task_instances_api.rb', line 233

def workflow_task_instances_partial_update(uuid, opts = {})
  data, _status_code, _headers = workflow_task_instances_partial_update_with_http_info(uuid, opts)
  data
end

#workflow_task_instances_partial_update_with_http_info(uuid, opts = {}) ⇒ Array<(WorkflowTaskInstance, Integer, Hash)>

Returns WorkflowTaskInstance data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(WorkflowTaskInstance, Integer, Hash)>) —

    WorkflowTaskInstance data, response status code and response headers



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
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
 
# File 'lib/cloudreactor_api_client/api/workflow_task_instances_api.rb', line 242

def workflow_task_instances_partial_update_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowTaskInstancesApi.workflow_task_instances_partial_update ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling WorkflowTaskInstancesApi.workflow_task_instances_partial_update"
  end
  # resource path
  local_var_path = '/workflow_task_instances/{uuid}/'.sub('{' + 'uuid' + '}', CGI.escape(uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

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

  # return_type
  return_type = opts[:debug_return_type] || 'WorkflowTaskInstance'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"WorkflowTaskInstancesApi.workflow_task_instances_partial_update",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowTaskInstancesApi#workflow_task_instances_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_task_instances_retrieve(uuid, opts = {}) ⇒ WorkflowTaskInstance

Parameters:

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

    the optional parameters

Returns:



298
299
300
301
 
# File 'lib/cloudreactor_api_client/api/workflow_task_instances_api.rb', line 298

def workflow_task_instances_retrieve(uuid, opts = {})
  data, _status_code, _headers = workflow_task_instances_retrieve_with_http_info(uuid, opts)
  data
end

#workflow_task_instances_retrieve_with_http_info(uuid, opts = {}) ⇒ Array<(WorkflowTaskInstance, Integer, Hash)>

Returns WorkflowTaskInstance data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(WorkflowTaskInstance, Integer, Hash)>) —

    WorkflowTaskInstance data, response status code and response headers



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
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
 
# File 'lib/cloudreactor_api_client/api/workflow_task_instances_api.rb', line 306

def workflow_task_instances_retrieve_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowTaskInstancesApi.workflow_task_instances_retrieve ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling WorkflowTaskInstancesApi.workflow_task_instances_retrieve"
  end
  # resource path
  local_var_path = '/workflow_task_instances/{uuid}/'.sub('{' + 'uuid' + '}', CGI.escape(uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'WorkflowTaskInstance'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"WorkflowTaskInstancesApi.workflow_task_instances_retrieve",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowTaskInstancesApi#workflow_task_instances_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_task_instances_update(uuid, workflow_task_instance, opts = {}) ⇒ WorkflowTaskInstance

Parameters:

  • uuid (String)
  • workflow_task_instance (WorkflowTaskInstance)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



358
359
360
361
 
# File 'lib/cloudreactor_api_client/api/workflow_task_instances_api.rb', line 358

def workflow_task_instances_update(uuid, workflow_task_instance, opts = {})
  data, _status_code, _headers = workflow_task_instances_update_with_http_info(uuid, workflow_task_instance, opts)
  data
end

#workflow_task_instances_update_with_http_info(uuid, workflow_task_instance, opts = {}) ⇒ Array<(WorkflowTaskInstance, Integer, Hash)>

Returns WorkflowTaskInstance data, response status code and response headers.

Parameters:

  • uuid (String)
  • workflow_task_instance (WorkflowTaskInstance)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(WorkflowTaskInstance, Integer, Hash)>) —

    WorkflowTaskInstance data, response status code and response headers



367
368
369
370
371
372
373
374
375
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
 
# File 'lib/cloudreactor_api_client/api/workflow_task_instances_api.rb', line 367

def workflow_task_instances_update_with_http_info(uuid, workflow_task_instance, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowTaskInstancesApi.workflow_task_instances_update ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling WorkflowTaskInstancesApi.workflow_task_instances_update"
  end
  # verify the required parameter 'workflow_task_instance' is set
  if @api_client.config.client_side_validation && workflow_task_instance.nil?
    fail ArgumentError, "Missing the required parameter 'workflow_task_instance' when calling WorkflowTaskInstancesApi.workflow_task_instances_update"
  end
  # resource path
  local_var_path = '/workflow_task_instances/{uuid}/'.sub('{' + 'uuid' + '}', CGI.escape(uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(workflow_task_instance)

  # return_type
  return_type = opts[:debug_return_type] || 'WorkflowTaskInstance'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"WorkflowTaskInstancesApi.workflow_task_instances_update",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowTaskInstancesApi#workflow_task_instances_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end