class PulpcoreClient::TaskGroupsApi
Attributes
Public Class Methods
# File lib/pulpcore_client/api/task_groups_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
List task groups @param [Hash] opts the optional parameters @option opts [String] :ordering Which field to use when ordering the results. @option opts [Integer] :limit Number of results to return per page. @option opts [Integer] :offset The initial index from which to return the results. @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 [InlineResponse2006]
# File lib/pulpcore_client/api/task_groups_api.rb, line 30 def list(opts = {}) data, _status_code, _headers = list_with_http_info(opts) data end
List task groups @param [Hash] opts the optional parameters @option opts [String] :ordering Which field to use when ordering the results. @option opts [Integer] :limit Number of results to return per page. @option opts [Integer] :offset The initial index from which to return the results. @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<(InlineResponse2006, Integer, Hash)>] InlineResponse2006 data, response status code and response headers
# File lib/pulpcore_client/api/task_groups_api.rb, line 43 def list_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TaskGroupsApi.list ...' end # resource path local_var_path = '/pulp/api/v3/task-groups/' # query parameters query_params = opts[:query_params] || {} query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].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] || 'InlineResponse2006' # 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: TaskGroupsApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Inspect a task group @param task_group_href [String] URI of Task Group. e.g.: /pulp/api/v3/task-groups/1/ @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 [TaskGroupRead]
# File lib/pulpcore_client/api/task_groups_api.rb, line 97 def read(task_group_href, opts = {}) data, _status_code, _headers = read_with_http_info(task_group_href, opts) data end
Inspect a task group @param task_group_href [String] URI of Task Group. e.g.: /pulp/api/v3/task-groups/1/ @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<(TaskGroupRead, Integer, Hash)>] TaskGroupRead data, response status code and response headers
# File lib/pulpcore_client/api/task_groups_api.rb, line 108 def read_with_http_info(task_group_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TaskGroupsApi.read ...' end # verify the required parameter 'task_group_href' is set if @api_client.config.client_side_validation && task_group_href.nil? fail ArgumentError, "Missing the required parameter 'task_group_href' when calling TaskGroupsApi.read" end # resource path local_var_path = '{task_group_href}'.sub('{' + 'task_group_href' + '}', CGI.escape(task_group_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] || 'TaskGroupRead' # 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: TaskGroupsApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end