Class: PulpcoreClient::GroupsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ GroupsApi

Returns a new instance of GroupsApi.



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

def api_client
  @api_client
end

Instance Method Details

#create(group, opts = {}) ⇒ GroupResponse

Create a group ViewSet for Group. NOTE: This API endpoint is in "tech preview" and subject to change

Parameters:

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/pulpcore_client/api/groups_api.rb', line 27

def create(group, opts = {})
  data, _status_code, _headers = create_with_http_info(group, opts)
  data
end

#create_with_http_info(group, opts = {}) ⇒ Array<(GroupResponse, Integer, Hash)>

Create a group ViewSet for Group. NOTE: This API endpoint is in &quot;tech preview&quot; and subject to change

Parameters:

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

    the optional parameters

Returns:

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

    GroupResponse data, response status code and response headers



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
79
80
81
82
83
84
 
# File 'lib/pulpcore_client/api/groups_api.rb', line 37

def create_with_http_info(group, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.create ...'
  end
  # verify the required parameter 'group' is set
  if @api_client.config.client_side_validation && group.nil?
    fail ArgumentError, "Missing the required parameter 'group' when calling GroupsApi.create"
  end
  # resource path
  local_var_path = '/pulp/api/v3/groups/'

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

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

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

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

Delete a group ViewSet for Group. NOTE: This API endpoint is in "tech preview" and subject to change

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


91
92
93
94
 
# File 'lib/pulpcore_client/api/groups_api.rb', line 91

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

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

Delete a group ViewSet for Group. NOTE: This API endpoint is in &quot;tech preview&quot; and subject to change

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



101
102
103
104
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
 
# File 'lib/pulpcore_client/api/groups_api.rb', line 101

def delete_with_http_info(auth_group_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.delete ...'
  end
  # verify the required parameter 'auth_group_href' is set
  if @api_client.config.client_side_validation && auth_group_href.nil?
    fail ArgumentError, "Missing the required parameter 'auth_group_href' when calling GroupsApi.delete"
  end
  # resource path
  local_var_path = '{auth_group_href}'.sub('{' + 'auth_group_href' + '}', CGI.escape(auth_group_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: GroupsApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(opts = {}) ⇒ PaginatedGroupResponseList

List groups ViewSet for Group. NOTE: This API endpoint is in "tech preview" and subject to change

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (Integer) —

    Filter results where id matches value

  • :id__in (Array<Integer>) —

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

  • :limit (Integer) —

    Number of results to return per page.

  • :name (String) —

    Filter results where name matches value

  • :name__contains (String) —

    Filter results where name contains value

  • :name__icontains (String) —

    Filter results where name contains value

  • :name__iexact (String) —

    Filter results where name matches value

  • :name__in (Array<String>) —

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

  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (String) —

    Which field to use when ordering 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:



162
163
164
165
 
# File 'lib/pulpcore_client/api/groups_api.rb', line 162

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

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

List groups ViewSet for Group. NOTE: This API endpoint is in &quot;tech preview&quot; and subject to change

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (Integer) —

    Filter results where id matches value

  • :id__in (Array<Integer>) —

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

  • :limit (Integer) —

    Number of results to return per page.

  • :name (String) —

    Filter results where name matches value

  • :name__contains (String) —

    Filter results where name contains value

  • :name__icontains (String) —

    Filter results where name contains value

  • :name__iexact (String) —

    Filter results where name matches value

  • :name__in (Array<String>) —

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

  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (String) —

    Which field to use when ordering 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<(PaginatedGroupResponseList, Integer, Hash)>) —

    PaginatedGroupResponseList data, response status code and response headers



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
231
232
233
234
235
236
 
# File 'lib/pulpcore_client/api/groups_api.rb', line 183

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'id__in'] = @api_client.build_collection_param(opts[:'id__in'], :csv) if !opts[:'id__in'].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[:'name__icontains'] = opts[:'name__icontains'] if !opts[:'name__icontains'].nil?
  query_params[:'name__iexact'] = opts[:'name__iexact'] if !opts[:'name__iexact'].nil?
  query_params[:'name__in'] = @api_client.build_collection_param(opts[:'name__in'], :csv) if !opts[:'name__in'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].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] || 'PaginatedGroupResponseList' 

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

#partial_update(auth_group_href, patched_group, opts = {}) ⇒ GroupResponse

Update a group ViewSet for Group. NOTE: This API endpoint is in "tech preview" and subject to change

Parameters:

  • auth_group_href (String)
  • patched_group (PatchedGroup)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



244
245
246
247
 
# File 'lib/pulpcore_client/api/groups_api.rb', line 244

def partial_update(auth_group_href, patched_group, opts = {})
  data, _status_code, _headers = partial_update_with_http_info(auth_group_href, patched_group, opts)
  data
end

#partial_update_with_http_info(auth_group_href, patched_group, opts = {}) ⇒ Array<(GroupResponse, Integer, Hash)>

Update a group ViewSet for Group. NOTE: This API endpoint is in &quot;tech preview&quot; and subject to change

Parameters:

  • auth_group_href (String)
  • patched_group (PatchedGroup)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    GroupResponse data, response status code and response headers



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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/pulpcore_client/api/groups_api.rb', line 255

def partial_update_with_http_info(auth_group_href, patched_group, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.partial_update ...'
  end
  # verify the required parameter 'auth_group_href' is set
  if @api_client.config.client_side_validation && auth_group_href.nil?
    fail ArgumentError, "Missing the required parameter 'auth_group_href' when calling GroupsApi.partial_update"
  end
  # verify the required parameter 'patched_group' is set
  if @api_client.config.client_side_validation && patched_group.nil?
    fail ArgumentError, "Missing the required parameter 'patched_group' when calling GroupsApi.partial_update"
  end
  # resource path
  local_var_path = '{auth_group_href}'.sub('{' + 'auth_group_href' + '}', CGI.escape(auth_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_group) 

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

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

#read(auth_group_href, opts = {}) ⇒ GroupResponse

Inspect a group ViewSet for Group. NOTE: This API endpoint is in "tech preview" and subject to change

Parameters:

  • auth_group_href (String)
  • 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:



315
316
317
318
 
# File 'lib/pulpcore_client/api/groups_api.rb', line 315

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

#read_with_http_info(auth_group_href, opts = {}) ⇒ Array<(GroupResponse, Integer, Hash)>

Inspect a group ViewSet for Group. NOTE: This API endpoint is in &quot;tech preview&quot; and subject to change

Parameters:

  • auth_group_href (String)
  • 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<(GroupResponse, Integer, Hash)>) —

    GroupResponse data, response status code and response headers



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
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/pulpcore_client/api/groups_api.rb', line 327

def read_with_http_info(auth_group_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.read ...'
  end
  # verify the required parameter 'auth_group_href' is set
  if @api_client.config.client_side_validation && auth_group_href.nil?
    fail ArgumentError, "Missing the required parameter 'auth_group_href' when calling GroupsApi.read"
  end
  # resource path
  local_var_path = '{auth_group_href}'.sub('{' + 'auth_group_href' + '}', CGI.escape(auth_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] || 'GroupResponse' 

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

#update(auth_group_href, group, opts = {}) ⇒ GroupResponse

Update a group ViewSet for Group. NOTE: This API endpoint is in "tech preview" and subject to change

Parameters:

  • auth_group_href (String)
  • group (Group)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



382
383
384
385
 
# File 'lib/pulpcore_client/api/groups_api.rb', line 382

def update(auth_group_href, group, opts = {})
  data, _status_code, _headers = update_with_http_info(auth_group_href, group, opts)
  data
end

#update_with_http_info(auth_group_href, group, opts = {}) ⇒ Array<(GroupResponse, Integer, Hash)>

Update a group ViewSet for Group. NOTE: This API endpoint is in &quot;tech preview&quot; and subject to change

Parameters:

  • auth_group_href (String)
  • group (Group)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    GroupResponse data, response status code and response headers



393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/pulpcore_client/api/groups_api.rb', line 393

def update_with_http_info(auth_group_href, group, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.update ...'
  end
  # verify the required parameter 'auth_group_href' is set
  if @api_client.config.client_side_validation && auth_group_href.nil?
    fail ArgumentError, "Missing the required parameter 'auth_group_href' when calling GroupsApi.update"
  end
  # verify the required parameter 'group' is set
  if @api_client.config.client_side_validation && group.nil?
    fail ArgumentError, "Missing the required parameter 'group' when calling GroupsApi.update"
  end
  # resource path
  local_var_path = '{auth_group_href}'.sub('{' + 'auth_group_href' + '}', CGI.escape(auth_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(group) 

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

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