Class: Nodeum::TaskSchedulesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TaskSchedulesApi

Returns a new instance of TaskSchedulesApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_task_schedule(task_id, task_schedule_body, opts = {}) ⇒ TaskSchedule

Creates a new task schedule. Only one should be created. **API Key Scope**: task_schedules / create

Parameters:

  • task_id (String) —

    Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/nodeum_sdk/api/task_schedules_api.rb', line 28

def create_task_schedule(task_id, task_schedule_body, opts = {})
  data, _status_code, _headers = create_task_schedule_with_http_info(task_id, task_schedule_body, opts)
  data
end

#create_task_schedule_with_http_info(task_id, task_schedule_body, opts = {}) ⇒ Array<(TaskSchedule, Integer, Hash)>

Creates a new task schedule. Only one should be created. **API Key Scope**: task_schedules / create

Parameters:

  • task_id (String) —

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

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

    the optional parameters

Returns:

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

    TaskSchedule data, response status code and response headers



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
85
86
87
88
89
90
 
# File 'lib/nodeum_sdk/api/task_schedules_api.rb', line 39

def create_task_schedule_with_http_info(task_id, task_schedule_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaskSchedulesApi.create_task_schedule ...'
  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 TaskSchedulesApi.create_task_schedule"
  end
  # verify the required parameter 'task_schedule_body' is set
  if @api_client.config.client_side_validation && task_schedule_body.nil?
    fail ArgumentError, "Missing the required parameter 'task_schedule_body' when calling TaskSchedulesApi.create_task_schedule"
  end
  # resource path
  local_var_path = '/tasks/{task_id}/task_schedule'.sub('{' + 'task_id' + '}', CGI.escape(task_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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

  # 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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TaskSchedulesApi#create_task_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#destroy_task_schedule(task_id, opts = {}) ⇒ nil

Destroys the task schedule. **API Key Scope**: task_schedules / destroy

Parameters:

  • task_id (String) —

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

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

    the optional parameters

Returns:

  • (nil) 


97
98
99
100
 
# File 'lib/nodeum_sdk/api/task_schedules_api.rb', line 97

def destroy_task_schedule(task_id, opts = {})
  destroy_task_schedule_with_http_info(task_id, opts)
  nil
end

#destroy_task_schedule_with_http_info(task_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Destroys the task schedule. **API Key Scope**: task_schedules / destroy

Parameters:

  • task_id (String) —

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

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
149
150
 
# File 'lib/nodeum_sdk/api/task_schedules_api.rb', line 107

def destroy_task_schedule_with_http_info(task_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaskSchedulesApi.destroy_task_schedule ...'
  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 TaskSchedulesApi.destroy_task_schedule"
  end
  # resource path
  local_var_path = '/tasks/{task_id}/task_schedule'.sub('{' + 'task_id' + '}', CGI.escape(task_id.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[:body] 

  # return_type
  return_type = opts[:return_type] 

  # 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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TaskSchedulesApi#destroy_task_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#index_task_schedules(opts = {}) ⇒ TaskScheduleCollection

Lists all task schedules. **API Key Scope**: task_schedules / index

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :with_next (Boolean) —

    Display the next scheduled date, and information about missing executions. (default to true)

  • :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

  • :rrule (String) —

    Filter on RRule of schedule

  • :done (String) —

    Filter on done schedule

  • :task_id (String) —

    Filter on task id

Returns:



164
165
166
167
 
# File 'lib/nodeum_sdk/api/task_schedules_api.rb', line 164

def index_task_schedules(opts = {})
  data, _status_code, _headers = index_task_schedules_with_http_info(opts)
  data
end

#index_task_schedules_with_http_info(opts = {}) ⇒ Array<(TaskScheduleCollection, Integer, Hash)>

Lists all task schedules. **API Key Scope**: task_schedules / index

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :with_next (Boolean) —

    Display the next scheduled date, and information about missing executions.

  • :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

  • :rrule (String) —

    Filter on RRule of schedule

  • :done (String) —

    Filter on done schedule

  • :task_id (String) —

    Filter on task id

Returns:

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

    TaskScheduleCollection data, response status code and response headers



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
228
229
230
 
# File 'lib/nodeum_sdk/api/task_schedules_api.rb', line 181

def index_task_schedules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaskSchedulesApi.index_task_schedules ...'
  end
  # resource path
  local_var_path = '/task_schedules'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'with_next'] = opts[:'with_next'] if !opts[:'with_next'].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[:'rrule'] = opts[:'rrule'] if !opts[:'rrule'].nil?
  query_params[:'done'] = opts[:'done'] if !opts[:'done'].nil?
  query_params[:'task_id'] = opts[:'task_id'] if !opts[:'task_id'].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] || 'TaskScheduleCollection' 

  # 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: TaskSchedulesApi#index_task_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#show_task_schedule(task_id, opts = {}) ⇒ TaskSchedule

Displays the task schedule. **API Key Scope**: task_schedules / show

Parameters:

  • task_id (String) —

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

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

    the optional parameters

Returns:



237
238
239
240
 
# File 'lib/nodeum_sdk/api/task_schedules_api.rb', line 237

def show_task_schedule(task_id, opts = {})
  data, _status_code, _headers = show_task_schedule_with_http_info(task_id, opts)
  data
end

#show_task_schedule_with_http_info(task_id, opts = {}) ⇒ Array<(TaskSchedule, Integer, Hash)>

Displays the task schedule. **API Key Scope**: task_schedules / show

Parameters:

  • task_id (String) —

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

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

    the optional parameters

Returns:

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

    TaskSchedule data, response status code and response headers



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
 
# File 'lib/nodeum_sdk/api/task_schedules_api.rb', line 247

def show_task_schedule_with_http_info(task_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaskSchedulesApi.show_task_schedule ...'
  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 TaskSchedulesApi.show_task_schedule"
  end
  # resource path
  local_var_path = '/tasks/{task_id}/task_schedule'.sub('{' + 'task_id' + '}', CGI.escape(task_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] || 'TaskSchedule' 

  # 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: TaskSchedulesApi#show_task_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_task_schedule(task_id, task_schedule_body, opts = {}) ⇒ TaskSchedule

Updates the existing task schedule. **API Key Scope**: task_schedules / update

Parameters:

  • task_id (String) —

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

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

    the optional parameters

Returns:



300
301
302
303
 
# File 'lib/nodeum_sdk/api/task_schedules_api.rb', line 300

def update_task_schedule(task_id, task_schedule_body, opts = {})
  data, _status_code, _headers = update_task_schedule_with_http_info(task_id, task_schedule_body, opts)
  data
end

#update_task_schedule_with_http_info(task_id, task_schedule_body, opts = {}) ⇒ Array<(TaskSchedule, Integer, Hash)>

Updates the existing task schedule. **API Key Scope**: task_schedules / update

Parameters:

  • task_id (String) —

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

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

    the optional parameters

Returns:

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

    TaskSchedule data, response status code and response headers



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
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/nodeum_sdk/api/task_schedules_api.rb', line 311

def update_task_schedule_with_http_info(task_id, task_schedule_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaskSchedulesApi.update_task_schedule ...'
  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 TaskSchedulesApi.update_task_schedule"
  end
  # verify the required parameter 'task_schedule_body' is set
  if @api_client.config.client_side_validation && task_schedule_body.nil?
    fail ArgumentError, "Missing the required parameter 'task_schedule_body' when calling TaskSchedulesApi.update_task_schedule"
  end
  # resource path
  local_var_path = '/tasks/{task_id}/task_schedule'.sub('{' + 'task_id' + '}', CGI.escape(task_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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

  # 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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TaskSchedulesApi#update_task_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end