class PulpcoreClient::TasksApi
Attributes
Public Class Methods
# File lib/pulpcore_client/api/tasks_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Delete a task A customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. "Normal" Django Models and Master/Detail models are supported by the “register_with“ method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' endpoint_name (str): The name of the final path segment that should identify the ViewSet's collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the "parent_prefix" of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object's identity. schema (DefaultSchema): The schema class to use by default in a viewset. @param task_href [String] @param [Hash] opts the optional parameters @return [nil]
# File lib/pulpcore_client/api/tasks_api.rb, line 27 def delete(task_href, opts = {}) delete_with_http_info(task_href, opts) nil end
Delete a task A customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. "Normal" Django Models and Master/Detail models are supported by the ``register_with`` method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' endpoint_name (str): The name of the final path segment that should identify the ViewSet's collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the "parent_prefix" of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object's identity. schema (DefaultSchema): The schema class to use by default in a viewset. @param task_href [String] @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
# File lib/pulpcore_client/api/tasks_api.rb, line 37 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] || ['basicAuth'] 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 tasks A customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. "Normal" Django Models and Master/Detail models are supported by the “register_with“ method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' endpoint_name (str): The name of the final path segment that should identify the ViewSet's collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the "parent_prefix" of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object's identity. schema (DefaultSchema): The schema class to use by default in a viewset. @param [Hash] opts the optional parameters @option opts [String] :child_tasks child_tasks @option opts [String] :created_resources created_resources @option opts [String] :finished_at finished_at @option opts [String] :finished_at__gt finished_at__gt @option opts [String] :finished_at__gte finished_at__gte @option opts [String] :finished_at__lt finished_at__lt @option opts [String] :finished_at__lte finished_at__lte @option opts [String] :finished_at__range finished_at__range @option opts [Integer] :limit Number of results to return per page. @option opts [String] :name name @option opts [String] :name__contains name__contains @option opts [Integer] :offset The initial index from which to return the results. @option opts [String] :ordering Which field to use when ordering the results. @option opts [String] :parent_task parent_task @option opts [String] :reserved_resources_record reserved_resources_record @option opts [String] :started_at started_at @option opts [String] :started_at__gt started_at__gt @option opts [String] :started_at__gte started_at__gte @option opts [String] :started_at__lt started_at__lt @option opts [String] :started_at__lte started_at__lte @option opts [String] :started_at__range started_at__range @option opts [String] :state state @option opts [String] :state__in state__in @option opts [String] :task_group task_group @option opts [String] :worker worker @option opts [String] :worker__in worker__in @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [PaginatedTaskResponseList]
# File lib/pulpcore_client/api/tasks_api.rb, line 114 def list(opts = {}) data, _status_code, _headers = list_with_http_info(opts) data end
List tasks A customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. "Normal" Django Models and Master/Detail models are supported by the ``register_with`` method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' endpoint_name (str): The name of the final path segment that should identify the ViewSet's collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the "parent_prefix" of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object's identity. schema (DefaultSchema): The schema class to use by default in a viewset. @param [Hash] opts the optional parameters @option opts [String] :child_tasks child_tasks @option opts [String] :created_resources created_resources @option opts [String] :finished_at finished_at @option opts [String] :finished_at__gt finished_at__gt @option opts [String] :finished_at__gte finished_at__gte @option opts [String] :finished_at__lt finished_at__lt @option opts [String] :finished_at__lte finished_at__lte @option opts [String] :finished_at__range finished_at__range @option opts [Integer] :limit Number of results to return per page. @option opts [String] :name name @option opts [String] :name__contains name__contains @option opts [Integer] :offset The initial index from which to return the results. @option opts [String] :ordering Which field to use when ordering the results. @option opts [String] :parent_task parent_task @option opts [String] :reserved_resources_record reserved_resources_record @option opts [String] :started_at started_at @option opts [String] :started_at__gt started_at__gt @option opts [String] :started_at__gte started_at__gte @option opts [String] :started_at__lt started_at__lt @option opts [String] :started_at__lte started_at__lte @option opts [String] :started_at__range started_at__range @option opts [String] :state state @option opts [String] :state__in state__in @option opts [String] :task_group task_group @option opts [String] :worker worker @option opts [String] :worker__in worker__in @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [Array<(PaginatedTaskResponseList, Integer, Hash)>] PaginatedTaskResponseList data, response status code and response headers
# File lib/pulpcore_client/api/tasks_api.rb, line 151 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[:'child_tasks'] = opts[:'child_tasks'] if !opts[:'child_tasks'].nil? query_params[:'created_resources'] = opts[:'created_resources'] if !opts[:'created_resources'].nil? query_params[:'finished_at'] = opts[:'finished_at'] if !opts[:'finished_at'].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__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__range'] = opts[:'finished_at__range'] if !opts[:'finished_at__range'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil? query_params[:'name__contains'] = opts[:'name__contains'] if !opts[:'name__contains'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil? query_params[:'parent_task'] = opts[:'parent_task'] if !opts[:'parent_task'].nil? query_params[:'reserved_resources_record'] = opts[:'reserved_resources_record'] if !opts[:'reserved_resources_record'].nil? query_params[:'started_at'] = opts[:'started_at'] if !opts[:'started_at'].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__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__range'] = opts[:'started_at__range'] if !opts[:'started_at__range'].nil? query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil? query_params[:'state__in'] = opts[:'state__in'] if !opts[:'state__in'].nil? query_params[:'task_group'] = opts[:'task_group'] if !opts[:'task_group'].nil? query_params[:'worker'] = opts[:'worker'] if !opts[:'worker'].nil? query_params[:'worker__in'] = opts[:'worker__in'] if !opts[:'worker__in'].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] || 'PaginatedTaskResponseList' # auth_names auth_names = opts[:auth_names] || ['basicAuth'] 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
Inspect a task A customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. "Normal" Django Models and Master/Detail models are supported by the “register_with“ method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' endpoint_name (str): The name of the final path segment that should identify the ViewSet's collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the "parent_prefix" of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object's identity. schema (DefaultSchema): The schema class to use by default in a viewset. @param task_href [String] @param [Hash] opts the optional parameters @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [TaskResponse]
# File lib/pulpcore_client/api/tasks_api.rb, line 229 def read(task_href, opts = {}) data, _status_code, _headers = read_with_http_info(task_href, opts) data end
Inspect a task A customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. "Normal" Django Models and Master/Detail models are supported by the ``register_with`` method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' endpoint_name (str): The name of the final path segment that should identify the ViewSet's collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the "parent_prefix" of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object's identity. schema (DefaultSchema): The schema class to use by default in a viewset. @param task_href [String] @param [Hash] opts the optional parameters @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [Array<(TaskResponse, Integer, Hash)>] TaskResponse data, response status code and response headers
# File lib/pulpcore_client/api/tasks_api.rb, line 241 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] || 'TaskResponse' # auth_names auth_names = opts[:auth_names] || ['basicAuth'] 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
Cancel a task This operation cancels a task. @param task_href [String] @param patched_task_cancel [PatchedTaskCancel] @param [Hash] opts the optional parameters @return [TaskResponse]
# File lib/pulpcore_client/api/tasks_api.rb, line 296 def tasks_cancel(task_href, patched_task_cancel, opts = {}) data, _status_code, _headers = tasks_cancel_with_http_info(task_href, patched_task_cancel, opts) data end
Cancel a task This operation cancels a task. @param task_href [String] @param patched_task_cancel [PatchedTaskCancel] @param [Hash] opts the optional parameters @return [Array<(TaskResponse, Integer, Hash)>] TaskResponse data, response status code and response headers
# File lib/pulpcore_client/api/tasks_api.rb, line 307 def tasks_cancel_with_http_info(task_href, patched_task_cancel, 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 'patched_task_cancel' is set if @api_client.config.client_side_validation && patched_task_cancel.nil? fail ArgumentError, "Missing the required parameter 'patched_task_cancel' 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', 'application/x-www-form-urlencoded', 'multipart/form-data']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(patched_task_cancel) # return_type return_type = opts[:return_type] || 'TaskResponse' # auth_names auth_names = opts[:auth_names] || ['basicAuth'] 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