Class: PulpcoreClient::TaskGroupsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TaskGroupsApi

Returns a new instance of TaskGroupsApi.



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

def api_client
  @api_client
end

Instance Method Details

#list(opts = {}) ⇒ PaginatedTaskGroupResponseList

List task groups

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of results to return per page.

  • :offset (Integer) —

    The initial index from which to return the results.

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



29
30
31
32
 
# File 'lib/pulpcore_client/api/task_groups_api.rb', line 29

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

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

List task groups

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of results to return per page.

  • :offset (Integer) —

    The initial index from which to return the results.

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



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

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[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) 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] || 'PaginatedTaskGroupResponseList' 

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

#read(task_group_href, opts = {}) ⇒ TaskGroupResponse

Inspect a task group

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



94
95
96
97
 
# File 'lib/pulpcore_client/api/task_groups_api.rb', line 94

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

#read_with_http_info(task_group_href, opts = {}) ⇒ Array<(TaskGroupResponse, Integer, Hash)>

Inspect a task group

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:

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

    TaskGroupResponse data, response status code and response headers



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
149
150
151
152
 
# File 'lib/pulpcore_client/api/task_groups_api.rb', line 105

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'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) 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] || 'TaskGroupResponse' 

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

#task_groups_cancel(task_group_href, patched_task_cancel, opts = {}) ⇒ TaskGroupResponse

Cancel a task group This operation cancels a task group.

Parameters:

  • task_group_href (String)
  • patched_task_cancel (PatchedTaskCancel)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



160
161
162
163
 
# File 'lib/pulpcore_client/api/task_groups_api.rb', line 160

def task_groups_cancel(task_group_href, patched_task_cancel, opts = {})
  data, _status_code, _headers = task_groups_cancel_with_http_info(task_group_href, patched_task_cancel, opts)
  data
end

#task_groups_cancel_with_http_info(task_group_href, patched_task_cancel, opts = {}) ⇒ Array<(TaskGroupResponse, Integer, Hash)>

Cancel a task group This operation cancels a task group.

Parameters:

  • task_group_href (String)
  • patched_task_cancel (PatchedTaskCancel)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    TaskGroupResponse data, response status code and response headers



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
217
218
219
220
221
222
 
# File 'lib/pulpcore_client/api/task_groups_api.rb', line 171

def task_groups_cancel_with_http_info(task_group_href, patched_task_cancel, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaskGroupsApi.task_groups_cancel ...'
  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.task_groups_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 TaskGroupsApi.task_groups_cancel"
  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] || {}

  # 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] || 'TaskGroupResponse' 

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