Class: PulpcoreClient::TasksApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pulpcore_client/api/tasks_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TasksApi

Returns a new instance of TasksApi.



19
20
21
 
# File 'lib/pulpcore_client/api/tasks_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/pulpcore_client/api/tasks_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete(task_href, opts = {}) ⇒ nil

Delete a task

Parameters:

  • task_href (String) —

    URI of Task. e.g.: /pulp/api/v3/tasks/1/

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

    the optional parameters

Returns:

  • (nil) 


26
27
28
29
 
# File 'lib/pulpcore_client/api/tasks_api.rb', line 26

def delete(task_href, opts = {})
  delete_with_http_info(task_href, opts)
  nil
end

#delete_with_http_info(task_href, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a task

Parameters:

  • task_href (String) —

    URI of Task. e.g.: /pulp/api/v3/tasks/1/

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/pulpcore_client/api/tasks_api.rb', line 35

def delete_with_http_info(task_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TasksApi.delete ...'
  end
  # verify the required parameter 'task_href' is set
  if @api_client.config.client_side_validation && task_href.nil?
    fail ArgumentError, "Missing the required parameter 'task_href' when calling TasksApi.delete"
  end
  # resource path
  local_var_path = '{task_href}'.sub('{' + 'task_href' + '}', CGI.escape(task_href.to_s).gsub('%2F', '/'))

  # 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] || ['Basic']

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

#list(opts = {}) ⇒ InlineResponse2007

List tasks

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ordering (String) —

    Which field to use when ordering the results.

  • :name__contains (String) —

    Filter results where name contains value

  • :state (String)
  • :state__in (String) —

    Filter results where state is in a comma-separated list of values

  • :worker (String) —

    Foreign Key referenced by HREF

  • :worker__in (String) —

    Filter results where worker is in a comma-separated list of values

  • :started_at__lt (String) —

    Filter results where started_at is less than value

  • :started_at__lte (String) —

    Filter results where started_at is less than or equal to value

  • :started_at__gt (String) —

    Filter results where started_at is greater than value

  • :started_at__gte (String) —

    Filter results where started_at is greater than or equal to value

  • :started_at__range (String) —

    Filter results where started_at is between two comma separated values

  • :finished_at__lt (String) —

    Filter results where finished_at is less than value

  • :finished_at__lte (String) —

    Filter results where finished_at is less than or equal to value

  • :finished_at__gt (String) —

    Filter results where finished_at is greater than value

  • :finished_at__gte (String) —

    Filter results where finished_at is greater than or equal to value

  • :finished_at__range (String) —

    Filter results where finished_at is between two comma separated values

  • :parent_task (String) —

    Foreign Key referenced by HREF

  • :child_tasks (String) —

    Foreign Key referenced by HREF

  • :task_group (String) —

    Foreign Key referenced by HREF

  • :reserved_resources_record (String)
  • :created_resources (String)
  • :name (String)
  • :started_at (String) —

    ISO 8601 formatted dates are supported

  • :finished_at (String) —

    ISO 8601 formatted dates are supported

  • :limit (Integer) —

    Number of results to return per page.

  • :offset (Integer) —

    The initial index from which to return the results.

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



111
112
113
114
 
# File 'lib/pulpcore_client/api/tasks_api.rb', line 111

def list(opts = {})
  data, _status_code, _headers = list_with_http_info(opts)
  data
end

#list_with_http_info(opts = {}) ⇒ Array<(InlineResponse2007, Integer, Hash)>

List tasks

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ordering (String) —

    Which field to use when ordering the results.

  • :name__contains (String) —

    Filter results where name contains value

  • :state (String)
  • :state__in (String) —

    Filter results where state is in a comma-separated list of values

  • :worker (String) —

    Foreign Key referenced by HREF

  • :worker__in (String) —

    Filter results where worker is in a comma-separated list of values

  • :started_at__lt (String) —

    Filter results where started_at is less than value

  • :started_at__lte (String) —

    Filter results where started_at is less than or equal to value

  • :started_at__gt (String) —

    Filter results where started_at is greater than value

  • :started_at__gte (String) —

    Filter results where started_at is greater than or equal to value

  • :started_at__range (String) —

    Filter results where started_at is between two comma separated values

  • :finished_at__lt (String) —

    Filter results where finished_at is less than value

  • :finished_at__lte (String) —

    Filter results where finished_at is less than or equal to value

  • :finished_at__gt (String) —

    Filter results where finished_at is greater than value

  • :finished_at__gte (String) —

    Filter results where finished_at is greater than or equal to value

  • :finished_at__range (String) —

    Filter results where finished_at is between two comma separated values

  • :parent_task (String) —

    Foreign Key referenced by HREF

  • :child_tasks (String) —

    Foreign Key referenced by HREF

  • :task_group (String) —

    Foreign Key referenced by HREF

  • :reserved_resources_record (String)
  • :created_resources (String)
  • :name (String)
  • :started_at (String) —

    ISO 8601 formatted dates are supported

  • :finished_at (String) —

    ISO 8601 formatted dates are supported

  • :limit (Integer) —

    Number of results to return per page.

  • :offset (Integer) —

    The initial index from which to return the results.

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:

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

    InlineResponse2007 data, response status code and response headers



147
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
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/pulpcore_client/api/tasks_api.rb', line 147

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TasksApi.list ...'
  end
  # resource path
  local_var_path = '/pulp/api/v3/tasks/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'name__contains'] = opts[:'name__contains'] if !opts[:'name__contains'].nil?
  query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
  query_params[:'state__in'] = opts[:'state__in'] if !opts[:'state__in'].nil?
  query_params[:'worker'] = opts[:'worker'] if !opts[:'worker'].nil?
  query_params[:'worker__in'] = opts[:'worker__in'] if !opts[:'worker__in'].nil?
  query_params[:'started_at__lt'] = opts[:'started_at__lt'] if !opts[:'started_at__lt'].nil?
  query_params[:'started_at__lte'] = opts[:'started_at__lte'] if !opts[:'started_at__lte'].nil?
  query_params[:'started_at__gt'] = opts[:'started_at__gt'] if !opts[:'started_at__gt'].nil?
  query_params[:'started_at__gte'] = opts[:'started_at__gte'] if !opts[:'started_at__gte'].nil?
  query_params[:'started_at__range'] = opts[:'started_at__range'] if !opts[:'started_at__range'].nil?
  query_params[:'finished_at__lt'] = opts[:'finished_at__lt'] if !opts[:'finished_at__lt'].nil?
  query_params[:'finished_at__lte'] = opts[:'finished_at__lte'] if !opts[:'finished_at__lte'].nil?
  query_params[:'finished_at__gt'] = opts[:'finished_at__gt'] if !opts[:'finished_at__gt'].nil?
  query_params[:'finished_at__gte'] = opts[:'finished_at__gte'] if !opts[:'finished_at__gte'].nil?
  query_params[:'finished_at__range'] = opts[:'finished_at__range'] if !opts[:'finished_at__range'].nil?
  query_params[:'parent_task'] = opts[:'parent_task'] if !opts[:'parent_task'].nil?
  query_params[:'child_tasks'] = opts[:'child_tasks'] if !opts[:'child_tasks'].nil?
  query_params[:'task_group'] = opts[:'task_group'] if !opts[:'task_group'].nil?
  query_params[:'reserved_resources_record'] = opts[:'reserved_resources_record'] if !opts[:'reserved_resources_record'].nil?
  query_params[:'created_resources'] = opts[:'created_resources'] if !opts[:'created_resources'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'started_at'] = opts[:'started_at'] if !opts[:'started_at'].nil?
  query_params[:'finished_at'] = opts[:'finished_at'] if !opts[:'finished_at'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].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] || 'InlineResponse2007' 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic']

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

#read(task_href, opts = {}) ⇒ TaskRead

Inspect a task

Parameters:

  • task_href (String) —

    URI of Task. e.g.: /pulp/api/v3/tasks/1/

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



224
225
226
227
 
# File 'lib/pulpcore_client/api/tasks_api.rb', line 224

def read(task_href, opts = {})
  data, _status_code, _headers = read_with_http_info(task_href, opts)
  data
end

#read_with_http_info(task_href, opts = {}) ⇒ Array<(TaskRead, Integer, Hash)>

Inspect a task

Parameters:

  • task_href (String) —

    URI of Task. e.g.: /pulp/api/v3/tasks/1/

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:

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

    TaskRead data, response status code and response headers



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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/pulpcore_client/api/tasks_api.rb', line 235

def read_with_http_info(task_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TasksApi.read ...'
  end
  # verify the required parameter 'task_href' is set
  if @api_client.config.client_side_validation && task_href.nil?
    fail ArgumentError, "Missing the required parameter 'task_href' when calling TasksApi.read"
  end
  # resource path
  local_var_path = '{task_href}'.sub('{' + 'task_href' + '}', CGI.escape(task_href.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].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] || 'TaskRead' 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic']

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

#tasks_cancel(task_href, data, opts = {}) ⇒ Task

Cancel a task This operation cancels a task.

Parameters:

  • task_href (String) —

    URI of Task. e.g.: /pulp/api/v3/tasks/1/

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

    the optional parameters

Returns:



290
291
292
293
 
# File 'lib/pulpcore_client/api/tasks_api.rb', line 290

def tasks_cancel(task_href, data, opts = {})
  data, _status_code, _headers = tasks_cancel_with_http_info(task_href, data, opts)
  data
end

#tasks_cancel_with_http_info(task_href, data, opts = {}) ⇒ Array<(Task, Integer, Hash)>

Cancel a task This operation cancels a task.

Parameters:

  • task_href (String) —

    URI of Task. e.g.: /pulp/api/v3/tasks/1/

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

    the optional parameters

Returns:

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

    Task data, response status code and response headers



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
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/pulpcore_client/api/tasks_api.rb', line 301

def tasks_cancel_with_http_info(task_href, data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TasksApi.tasks_cancel ...'
  end
  # verify the required parameter 'task_href' is set
  if @api_client.config.client_side_validation && task_href.nil?
    fail ArgumentError, "Missing the required parameter 'task_href' when calling TasksApi.tasks_cancel"
  end
  # verify the required parameter 'data' is set
  if @api_client.config.client_side_validation && data.nil?
    fail ArgumentError, "Missing the required parameter 'data' when calling TasksApi.tasks_cancel"
  end
  # resource path
  local_var_path = '{task_href}'.sub('{' + 'task_href' + '}', CGI.escape(task_href.to_s).gsub('%2F', '/'))

  # 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(data) 

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

  # auth_names
  auth_names = opts[:auth_names] || ['Basic']

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