Class: Nodeum::TaskExecutionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/nodeum_sdk/api/task_executions_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TaskExecutionsApi

Returns a new instance of TaskExecutionsApi.



19
20
21
 
# File 'lib/nodeum_sdk/api/task_executions_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/nodeum_sdk/api/task_executions_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#index_task_executions(opts = {}) ⇒ TaskExecutionCollection

Lists all task executions. **API Key Scope**: task_executions / index

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The number of items to display for pagination.

  • :offset (Integer) —

    The number of items to skip for pagination.

  • :sort_by (Array<String>) —

    Sort results by attribute. Can sort on multiple attributes, separated by &#x60;|&#x60;. Order direction can be suffixing the attribute by either &#x60;:asc&#x60; (default) or &#x60;:desc&#x60;.

  • :complete_list (Boolean) —

    If &#x60;false&#x60;, only includes the last correct execution of a task. (default to true)

  • :id (String) —

    Filter on id

  • :task_id (String) —

    Filter on task id

  • :name (String) —

    Filter on name

  • :workflow_type (String) —

    Filter on task workflow type

  • :workflow_action (String) —

    Filter on task workflow action

  • :source_type (String) —

    Filter on task source type

  • :destination_type (String) —

    Filter on task destination type

  • :status (String) —

    Filter on status

  • :log_time (String) —

    Filter on log time

  • :job_started (String) —

    Filter on job started

  • :job_finished (String) —

    Filter on job finished

  • :creation_date (String) —

    Filter on creation date

  • :modification_date (String) —

    Filter on modification date

  • :to_process_size (String) —

    Filter on to process size

  • :processed_size (String) —

    Filter on processed size

  • :to_process_files (String) —

    Filter on to process files

  • :processed_files (String) —

    Filter on processed files

  • :finalized_files (String) —

    Filter on finalized files

  • :estimation_time (String) —

    Filter on estimation time

  • :bandwidth (String) —

    Filter on bandwidth

Returns:



50
51
52
53
 
# File 'lib/nodeum_sdk/api/task_executions_api.rb', line 50

def index_task_executions(opts = {})
  data, _status_code, _headers = index_task_executions_with_http_info(opts)
  data
end

#index_task_executions_by_task(opts = {}) ⇒ TaskExecutionCollection

Lists all task executions. **API Key Scope**: task_executions / index

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :task_id (String) —

    Filter on task id

  • :limit (Integer) —

    The number of items to display for pagination.

  • :offset (Integer) —

    The number of items to skip for pagination.

  • :sort_by (Array<String>) —

    Sort results by attribute. Can sort on multiple attributes, separated by &#x60;|&#x60;. Order direction can be suffixing the attribute by either &#x60;:asc&#x60; (default) or &#x60;:desc&#x60;.

  • :id (String) —

    Filter on id

  • :name (String) —

    Filter on name

  • :workflow_type (String) —

    Filter on task workflow type

  • :workflow_action (String) —

    Filter on task workflow action

  • :source_type (String) —

    Filter on task source type

  • :destination_type (String) —

    Filter on task destination type

  • :status (String) —

    Filter on status

  • :log_time (String) —

    Filter on log time

  • :job_started (String) —

    Filter on job started

  • :job_finished (String) —

    Filter on job finished

  • :to_process_size (String) —

    Filter on to process size

  • :processed_size (String) —

    Filter on processed size

  • :to_process_files (String) —

    Filter on to process files

  • :processed_files (String) —

    Filter on processed files

  • :finalized_files (String) —

    Filter on finalized files

  • :estimation_time (String) —

    Filter on estimation time

  • :bandwidth (String) —

    Filter on bandwidth

Returns:



175
176
177
178
 
# File 'lib/nodeum_sdk/api/task_executions_api.rb', line 175

def index_task_executions_by_task(opts = {})
  data, _status_code, _headers = index_task_executions_by_task_with_http_info(opts)
  data
end

#index_task_executions_by_task_with_http_info(opts = {}) ⇒ Array<(TaskExecutionCollection, Integer, Hash)>

Lists all task executions. **API Key Scope**: task_executions / index

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :task_id (String) —

    Filter on task id

  • :limit (Integer) —

    The number of items to display for pagination.

  • :offset (Integer) —

    The number of items to skip for pagination.

  • :sort_by (Array<String>) —

    Sort results by attribute. Can sort on multiple attributes, separated by &#x60;|&#x60;. Order direction can be suffixing the attribute by either &#x60;:asc&#x60; (default) or &#x60;:desc&#x60;.

  • :id (String) —

    Filter on id

  • :name (String) —

    Filter on name

  • :workflow_type (String) —

    Filter on task workflow type

  • :workflow_action (String) —

    Filter on task workflow action

  • :source_type (String) —

    Filter on task source type

  • :destination_type (String) —

    Filter on task destination type

  • :status (String) —

    Filter on status

  • :log_time (String) —

    Filter on log time

  • :job_started (String) —

    Filter on job started

  • :job_finished (String) —

    Filter on job finished

  • :to_process_size (String) —

    Filter on to process size

  • :processed_size (String) —

    Filter on processed size

  • :to_process_files (String) —

    Filter on to process files

  • :processed_files (String) —

    Filter on processed files

  • :finalized_files (String) —

    Filter on finalized files

  • :estimation_time (String) —

    Filter on estimation time

  • :bandwidth (String) —

    Filter on bandwidth

Returns:

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

    TaskExecutionCollection data, response status code and response headers



205
206
207
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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/nodeum_sdk/api/task_executions_api.rb', line 205

def index_task_executions_by_task_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaskExecutionsApi.index_task_executions_by_task ...'
  end
  # resource path
  local_var_path = '/tasks/{task_id}/task_executions'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'task_id'] = opts[:'task_id'] if !opts[:'task_id'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'sort_by'] = @api_client.build_collection_param(opts[:'sort_by'], :pipe) if !opts[:'sort_by'].nil?
  query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'workflow_type'] = opts[:'workflow_type'] if !opts[:'workflow_type'].nil?
  query_params[:'workflow_action'] = opts[:'workflow_action'] if !opts[:'workflow_action'].nil?
  query_params[:'source_type'] = opts[:'source_type'] if !opts[:'source_type'].nil?
  query_params[:'destination_type'] = opts[:'destination_type'] if !opts[:'destination_type'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'log_time'] = opts[:'log_time'] if !opts[:'log_time'].nil?
  query_params[:'job_started'] = opts[:'job_started'] if !opts[:'job_started'].nil?
  query_params[:'job_finished'] = opts[:'job_finished'] if !opts[:'job_finished'].nil?
  query_params[:'to_process_size'] = opts[:'to_process_size'] if !opts[:'to_process_size'].nil?
  query_params[:'processed_size'] = opts[:'processed_size'] if !opts[:'processed_size'].nil?
  query_params[:'to_process_files'] = opts[:'to_process_files'] if !opts[:'to_process_files'].nil?
  query_params[:'processed_files'] = opts[:'processed_files'] if !opts[:'processed_files'].nil?
  query_params[:'finalized_files'] = opts[:'finalized_files'] if !opts[:'finalized_files'].nil?
  query_params[:'estimation_time'] = opts[:'estimation_time'] if !opts[:'estimation_time'].nil?
  query_params[:'bandwidth'] = opts[:'bandwidth'] if !opts[:'bandwidth'].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[:body] 

  # return_type
  return_type = opts[:return_type] || 'TaskExecutionCollection' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :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: TaskExecutionsApi#index_task_executions_by_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#index_task_executions_with_http_info(opts = {}) ⇒ Array<(TaskExecutionCollection, Integer, Hash)>

Lists all task executions. **API Key Scope**: task_executions / index

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The number of items to display for pagination.

  • :offset (Integer) —

    The number of items to skip for pagination.

  • :sort_by (Array<String>) —

    Sort results by attribute. Can sort on multiple attributes, separated by &#x60;|&#x60;. Order direction can be suffixing the attribute by either &#x60;:asc&#x60; (default) or &#x60;:desc&#x60;.

  • :complete_list (Boolean) —

    If &#x60;false&#x60;, only includes the last correct execution of a task.

  • :id (String) —

    Filter on id

  • :task_id (String) —

    Filter on task id

  • :name (String) —

    Filter on name

  • :workflow_type (String) —

    Filter on task workflow type

  • :workflow_action (String) —

    Filter on task workflow action

  • :source_type (String) —

    Filter on task source type

  • :destination_type (String) —

    Filter on task destination type

  • :status (String) —

    Filter on status

  • :log_time (String) —

    Filter on log time

  • :job_started (String) —

    Filter on job started

  • :job_finished (String) —

    Filter on job finished

  • :creation_date (String) —

    Filter on creation date

  • :modification_date (String) —

    Filter on modification date

  • :to_process_size (String) —

    Filter on to process size

  • :processed_size (String) —

    Filter on processed size

  • :to_process_files (String) —

    Filter on to process files

  • :processed_files (String) —

    Filter on processed files

  • :finalized_files (String) —

    Filter on finalized files

  • :estimation_time (String) —

    Filter on estimation time

  • :bandwidth (String) —

    Filter on bandwidth

Returns:

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

    TaskExecutionCollection data, response status code and response headers



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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/nodeum_sdk/api/task_executions_api.rb', line 83

def index_task_executions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaskExecutionsApi.index_task_executions ...'
  end
  # resource path
  local_var_path = '/task_executions'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'sort_by'] = @api_client.build_collection_param(opts[:'sort_by'], :pipe) if !opts[:'sort_by'].nil?
  query_params[:'complete_list'] = opts[:'complete_list'] if !opts[:'complete_list'].nil?
  query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'task_id'] = opts[:'task_id'] if !opts[:'task_id'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'workflow_type'] = opts[:'workflow_type'] if !opts[:'workflow_type'].nil?
  query_params[:'workflow_action'] = opts[:'workflow_action'] if !opts[:'workflow_action'].nil?
  query_params[:'source_type'] = opts[:'source_type'] if !opts[:'source_type'].nil?
  query_params[:'destination_type'] = opts[:'destination_type'] if !opts[:'destination_type'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'log_time'] = opts[:'log_time'] if !opts[:'log_time'].nil?
  query_params[:'job_started'] = opts[:'job_started'] if !opts[:'job_started'].nil?
  query_params[:'job_finished'] = opts[:'job_finished'] if !opts[:'job_finished'].nil?
  query_params[:'creation_date'] = opts[:'creation_date'] if !opts[:'creation_date'].nil?
  query_params[:'modification_date'] = opts[:'modification_date'] if !opts[:'modification_date'].nil?
  query_params[:'to_process_size'] = opts[:'to_process_size'] if !opts[:'to_process_size'].nil?
  query_params[:'processed_size'] = opts[:'processed_size'] if !opts[:'processed_size'].nil?
  query_params[:'to_process_files'] = opts[:'to_process_files'] if !opts[:'to_process_files'].nil?
  query_params[:'processed_files'] = opts[:'processed_files'] if !opts[:'processed_files'].nil?
  query_params[:'finalized_files'] = opts[:'finalized_files'] if !opts[:'finalized_files'].nil?
  query_params[:'estimation_time'] = opts[:'estimation_time'] if !opts[:'estimation_time'].nil?
  query_params[:'bandwidth'] = opts[:'bandwidth'] if !opts[:'bandwidth'].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[:body] 

  # return_type
  return_type = opts[:return_type] || 'TaskExecutionCollection' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :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: TaskExecutionsApi#index_task_executions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#show_task_execution(task_execution_id, opts = {}) ⇒ TaskExecution

Displays a specific task execution. **API Key Scope**: task_executions / show

Parameters:

  • task_execution_id (String) —

    Numeric ID of task execution.

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

    the optional parameters

Returns:



274
275
276
277
 
# File 'lib/nodeum_sdk/api/task_executions_api.rb', line 274

def show_task_execution(task_execution_id, opts = {})
  data, _status_code, _headers = show_task_execution_with_http_info(task_execution_id, opts)
  data
end

#show_task_execution_by_task(task_id, task_execution_id, opts = {}) ⇒ TaskExecution

Displays a specific task execution. **API Key Scope**: task_executions / show

Parameters:

  • task_id (String) —

    Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID.

  • task_execution_id (String) —

    Numeric ID of task execution.

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

    the optional parameters

Returns:



337
338
339
340
 
# File 'lib/nodeum_sdk/api/task_executions_api.rb', line 337

def show_task_execution_by_task(task_id, task_execution_id, opts = {})
  data, _status_code, _headers = show_task_execution_by_task_with_http_info(task_id, task_execution_id, opts)
  data
end

#show_task_execution_by_task_with_http_info(task_id, task_execution_id, opts = {}) ⇒ Array<(TaskExecution, Integer, Hash)>

Displays a specific task execution. **API Key Scope**: task_executions / show

Parameters:

  • task_id (String) —

    Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID.

  • task_execution_id (String) —

    Numeric ID of task execution.

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

    the optional parameters

Returns:

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

    TaskExecution data, response status code and response headers



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
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
 
# File 'lib/nodeum_sdk/api/task_executions_api.rb', line 348

def show_task_execution_by_task_with_http_info(task_id, task_execution_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaskExecutionsApi.show_task_execution_by_task ...'
  end
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_id' when calling TaskExecutionsApi.show_task_execution_by_task"
  end
  # verify the required parameter 'task_execution_id' is set
  if @api_client.config.client_side_validation && task_execution_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_execution_id' when calling TaskExecutionsApi.show_task_execution_by_task"
  end
  # resource path
  local_var_path = '/tasks/{task_id}/task_executions/{task_execution_id}'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s)).sub('{' + 'task_execution_id' + '}', CGI.escape(task_execution_id.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[:body] 

  # return_type
  return_type = opts[:return_type] || 'TaskExecution' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :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: TaskExecutionsApi#show_task_execution_by_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#show_task_execution_with_http_info(task_execution_id, opts = {}) ⇒ Array<(TaskExecution, Integer, Hash)>

Displays a specific task execution. **API Key Scope**: task_executions / show

Parameters:

  • task_execution_id (String) —

    Numeric ID of task execution.

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

    the optional parameters

Returns:

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

    TaskExecution data, response status code and response headers



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
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/nodeum_sdk/api/task_executions_api.rb', line 284

def show_task_execution_with_http_info(task_execution_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaskExecutionsApi.show_task_execution ...'
  end
  # verify the required parameter 'task_execution_id' is set
  if @api_client.config.client_side_validation && task_execution_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_execution_id' when calling TaskExecutionsApi.show_task_execution"
  end
  # resource path
  local_var_path = '/task_executions/{task_execution_id}'.sub('{' + 'task_execution_id' + '}', CGI.escape(task_execution_id.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[:body] 

  # return_type
  return_type = opts[:return_type] || 'TaskExecution' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  new_options = opts.merge(
    :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: TaskExecutionsApi#show_task_execution\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end