Class: PulpContainerClient::RepositoriesContainerApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pulp_container_client/api/repositories_container_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RepositoriesContainerApi

Returns a new instance of RepositoriesContainerApi.



19
20
21
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



17
18
19
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add(container_container_repository_href, recursive_manage, opts = {}) ⇒ AsyncOperationResponse

Add content Trigger an asynchronous task to recursively add container content.

Parameters:

  • container_container_repository_href (String)
  • recursive_manage (RecursiveManage)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



28
29
30
31
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 28

def add(container_container_repository_href, recursive_manage, opts = {})
  data, _status_code, _headers = add_with_http_info(container_container_repository_href, recursive_manage, opts)
  data
end

#add_role(container_container_repository_href, nested_role, opts = {}) ⇒ NestedRoleResponse

Add a role for this object to users/groups.

Parameters:

  • container_container_repository_href (String)
  • nested_role (NestedRole)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



97
98
99
100
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 97

def add_role(container_container_repository_href, nested_role, opts = {})
  data, _status_code, _headers = add_role_with_http_info(container_container_repository_href, nested_role, opts)
  data
end

#add_role_with_http_info(container_container_repository_href, nested_role, opts = {}) ⇒ Array<(NestedRoleResponse, Integer, Hash)>

Add a role for this object to users/groups.

Parameters:

  • container_container_repository_href (String)
  • nested_role (NestedRole)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(NestedRoleResponse, Integer, Hash)>)

    NestedRoleResponse data, response status code and response headers



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
153
154
155
156
157
158
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 107

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

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

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

#add_with_http_info(container_container_repository_href, recursive_manage, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Add content Trigger an asynchronous task to recursively add container content.

Parameters:

  • container_container_repository_href (String)
  • recursive_manage (RecursiveManage)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(AsyncOperationResponse, Integer, Hash)>)

    AsyncOperationResponse data, response status code and response headers



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
85
86
87
88
89
90
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 39

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

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

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

#build_image(container_container_repository_href, opts = {}) ⇒ AsyncOperationResponse

Build an Image Trigger an asynchronous task to build an OCI image from a Containerfile. A new repository version is created with the new image and tag. This API is tech preview in Pulp Container 1.1. Backwards compatibility when upgrading is not guaranteed.

Parameters:

  • container_container_repository_href (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :containerfile_artifact (String)

    Artifact representing the Containerfile that should be used to run podman-build.

  • :containerfile (File)

    An uploaded Containerfile that should be used to run podman-build.

  • :tag (String)

    A tag name for the new image being built. (default to ‘latest’)

  • :artifacts (Object)

    A JSON string where each key is an artifact href and the value is it&#39;s relative path (name) inside the /pulp_working_directory of the build container executing the Containerfile.

Returns:



169
170
171
172
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 169

def build_image(container_container_repository_href, opts = {})
  data, _status_code, _headers = build_image_with_http_info(container_container_repository_href, opts)
  data
end

#build_image_with_http_info(container_container_repository_href, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Build an Image Trigger an asynchronous task to build an OCI image from a Containerfile. A new repository version is created with the new image and tag. This API is tech preview in Pulp Container 1.1. Backwards compatibility when upgrading is not guaranteed.

Parameters:

  • container_container_repository_href (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :containerfile_artifact (String)

    Artifact representing the Containerfile that should be used to run podman-build.

  • :containerfile (File)

    An uploaded Containerfile that should be used to run podman-build.

  • :tag (String)

    A tag name for the new image being built.

  • :artifacts (Object)

    A JSON string where each key is an artifact href and the value is it&#39;s relative path (name) inside the /pulp_working_directory of the build container executing the Containerfile.

Returns:

  • (Array<(AsyncOperationResponse, Integer, Hash)>)

    AsyncOperationResponse 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
237
238
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 183

def build_image_with_http_info(container_container_repository_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesContainerApi.build_image ...'
  end
  # verify the required parameter 'container_container_repository_href' is set
  if @api_client.config.client_side_validation && container_container_repository_href.nil?
    fail ArgumentError, "Missing the required parameter 'container_container_repository_href' when calling RepositoriesContainerApi.build_image"
  end
  if @api_client.config.client_side_validation && !opts[:'tag'].nil? && opts[:'tag'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"tag"]" when calling RepositoriesContainerApi.build_image, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '{container_container_repository_href}build_image/'.sub('{' + 'container_container_repository_href' + '}', CGI.escape(container_container_repository_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(['multipart/form-data', 'application/x-www-form-urlencoded'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['containerfile_artifact'] = opts[:'containerfile_artifact'] if !opts[:'containerfile_artifact'].nil?
  form_params['containerfile'] = opts[:'containerfile'] if !opts[:'containerfile'].nil?
  form_params['tag'] = opts[:'tag'] if !opts[:'tag'].nil?
  form_params['artifacts'] = opts[:'artifacts'] if !opts[:'artifacts'].nil?

  # http body (model)
  post_body = opts[:body] 

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

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

#copy_manifests(container_container_repository_href, manifest_copy, opts = {}) ⇒ AsyncOperationResponse

Copy manifests Trigger an asynchronous task to copy manifests

Parameters:

  • container_container_repository_href (String)
  • manifest_copy (ManifestCopy)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



246
247
248
249
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 246

def copy_manifests(container_container_repository_href, manifest_copy, opts = {})
  data, _status_code, _headers = copy_manifests_with_http_info(container_container_repository_href, manifest_copy, opts)
  data
end

#copy_manifests_with_http_info(container_container_repository_href, manifest_copy, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Copy manifests Trigger an asynchronous task to copy manifests

Parameters:

  • container_container_repository_href (String)
  • manifest_copy (ManifestCopy)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(AsyncOperationResponse, Integer, Hash)>)

    AsyncOperationResponse data, response status code and response headers



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
307
308
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 257

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

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

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

#copy_tags(container_container_repository_href, tag_copy, opts = {}) ⇒ AsyncOperationResponse

Copy tags Trigger an asynchronous task to copy tags

Parameters:

  • container_container_repository_href (String)
  • tag_copy (TagCopy)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



316
317
318
319
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 316

def copy_tags(container_container_repository_href, tag_copy, opts = {})
  data, _status_code, _headers = copy_tags_with_http_info(container_container_repository_href, tag_copy, opts)
  data
end

#copy_tags_with_http_info(container_container_repository_href, tag_copy, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Copy tags Trigger an asynchronous task to copy tags

Parameters:

  • container_container_repository_href (String)
  • tag_copy (TagCopy)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(AsyncOperationResponse, Integer, Hash)>)

    AsyncOperationResponse 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
375
376
377
378
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 327

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

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

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

#create(container_container_repository, opts = {}) ⇒ ContainerContainerRepositoryResponse

Create a container repository ViewSet for container repo.

Parameters:

Returns:



385
386
387
388
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 385

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

#create_with_http_info(container_container_repository, opts = {}) ⇒ Array<(ContainerContainerRepositoryResponse, Integer, Hash)>

Create a container repository ViewSet for container repo.

Parameters:

Returns:



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
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 395

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

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

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

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

#delete(container_container_repository_href, opts = {}) ⇒ AsyncOperationResponse

Delete a container repository Trigger an asynchronous delete task

Parameters:

  • container_container_repository_href (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



449
450
451
452
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 449

def delete(container_container_repository_href, opts = {})
  data, _status_code, _headers = delete_with_http_info(container_container_repository_href, opts)
  data
end

#delete_with_http_info(container_container_repository_href, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Delete a container repository Trigger an asynchronous delete task

Parameters:

  • container_container_repository_href (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(AsyncOperationResponse, Integer, Hash)>)

    AsyncOperationResponse data, response status code and response headers



459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 459

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

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

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

#list(opts = {}) ⇒ PaginatedcontainerContainerRepositoryResponseList

List container repositorys ViewSet for container repo.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :name__startswith (String)

    Filter results where name starts with value

  • :offset (Integer)

    The initial index from which to return the results.

  • :ordering (Array<String>)

    Ordering

  • :pulp_label_select (String)

    Filter labels by search string

  • :remote (String)

    Foreign Key referenced by HREF

  • :retain_repo_versions (Integer)

    Filter results where retain_repo_versions matches value

  • :retain_repo_versions__gt (Integer)

    Filter results where retain_repo_versions is greater than value

  • :retain_repo_versions__gte (Integer)

    Filter results where retain_repo_versions is greater than or equal to value

  • :retain_repo_versions__isnull (Boolean)

    Filter results where retain_repo_versions has a null value

  • :retain_repo_versions__lt (Integer)

    Filter results where retain_repo_versions is less than value

  • :retain_repo_versions__lte (Integer)

    Filter results where retain_repo_versions is less than or equal to value

  • :retain_repo_versions__ne (Integer)

    Filter results where retain_repo_versions not equal to value

  • :retain_repo_versions__range (Array<Integer>)

    Filter results where retain_repo_versions is between two comma separated values

  • :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:



530
531
532
533
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 530

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

#list_roles(container_container_repository_href, opts = {}) ⇒ ObjectRolesResponse

List roles assigned to this object.

Parameters:

  • container_container_repository_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:



632
633
634
635
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 632

def list_roles(container_container_repository_href, opts = {})
  data, _status_code, _headers = list_roles_with_http_info(container_container_repository_href, opts)
  data
end

#list_roles_with_http_info(container_container_repository_href, opts = {}) ⇒ Array<(ObjectRolesResponse, Integer, Hash)>

List roles assigned to this object.

Parameters:

  • container_container_repository_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<(ObjectRolesResponse, Integer, Hash)>)

    ObjectRolesResponse data, response status code and response headers



643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 643

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

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

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

List container repositorys ViewSet for container repo.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :name__startswith (String)

    Filter results where name starts with value

  • :offset (Integer)

    The initial index from which to return the results.

  • :ordering (Array<String>)

    Ordering

  • :pulp_label_select (String)

    Filter labels by search string

  • :remote (String)

    Foreign Key referenced by HREF

  • :retain_repo_versions (Integer)

    Filter results where retain_repo_versions matches value

  • :retain_repo_versions__gt (Integer)

    Filter results where retain_repo_versions is greater than value

  • :retain_repo_versions__gte (Integer)

    Filter results where retain_repo_versions is greater than or equal to value

  • :retain_repo_versions__isnull (Boolean)

    Filter results where retain_repo_versions has a null value

  • :retain_repo_versions__lt (Integer)

    Filter results where retain_repo_versions is less than value

  • :retain_repo_versions__lte (Integer)

    Filter results where retain_repo_versions is less than or equal to value

  • :retain_repo_versions__ne (Integer)

    Filter results where retain_repo_versions not equal to value

  • :retain_repo_versions__range (Array<Integer>)

    Filter results where retain_repo_versions is between two comma separated values

  • :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:



559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 559

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesContainerApi.list ...'
  end
  allowable_values = ["-description", "-name", "-next_version", "-pk", "-pulp_created", "-pulp_id", "-pulp_labels", "-pulp_last_updated", "-pulp_type", "-retain_repo_versions", "-user_hidden", "description", "name", "next_version", "pk", "pulp_created", "pulp_id", "pulp_labels", "pulp_last_updated", "pulp_type", "retain_repo_versions", "user_hidden"]
  if @api_client.config.client_side_validation && opts[:'ordering'] && !opts[:'ordering'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"ordering\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/pulp/api/v3/repositories/container/container/'

  # query parameters
  query_params = opts[:query_params] || {}
  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__in'] = @api_client.build_collection_param(opts[:'name__in'], :csv) if !opts[:'name__in'].nil?
  query_params[:'name__startswith'] = opts[:'name__startswith'] if !opts[:'name__startswith'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'ordering'] = @api_client.build_collection_param(opts[:'ordering'], :csv) if !opts[:'ordering'].nil?
  query_params[:'pulp_label_select'] = opts[:'pulp_label_select'] if !opts[:'pulp_label_select'].nil?
  query_params[:'remote'] = opts[:'remote'] if !opts[:'remote'].nil?
  query_params[:'retain_repo_versions'] = opts[:'retain_repo_versions'] if !opts[:'retain_repo_versions'].nil?
  query_params[:'retain_repo_versions__gt'] = opts[:'retain_repo_versions__gt'] if !opts[:'retain_repo_versions__gt'].nil?
  query_params[:'retain_repo_versions__gte'] = opts[:'retain_repo_versions__gte'] if !opts[:'retain_repo_versions__gte'].nil?
  query_params[:'retain_repo_versions__isnull'] = opts[:'retain_repo_versions__isnull'] if !opts[:'retain_repo_versions__isnull'].nil?
  query_params[:'retain_repo_versions__lt'] = opts[:'retain_repo_versions__lt'] if !opts[:'retain_repo_versions__lt'].nil?
  query_params[:'retain_repo_versions__lte'] = opts[:'retain_repo_versions__lte'] if !opts[:'retain_repo_versions__lte'].nil?
  query_params[:'retain_repo_versions__ne'] = opts[:'retain_repo_versions__ne'] if !opts[:'retain_repo_versions__ne'].nil?
  query_params[:'retain_repo_versions__range'] = @api_client.build_collection_param(opts[:'retain_repo_versions__range'], :csv) if !opts[:'retain_repo_versions__range'].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] || 'PaginatedcontainerContainerRepositoryResponseList' 

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

#my_permissions(container_container_repository_href, opts = {}) ⇒ MyPermissionsResponse

List permissions available to the current user on this object.

Parameters:

  • container_container_repository_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:



698
699
700
701
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 698

def my_permissions(container_container_repository_href, opts = {})
  data, _status_code, _headers = my_permissions_with_http_info(container_container_repository_href, opts)
  data
end

#my_permissions_with_http_info(container_container_repository_href, opts = {}) ⇒ Array<(MyPermissionsResponse, Integer, Hash)>

List permissions available to the current user on this object.

Parameters:

  • container_container_repository_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<(MyPermissionsResponse, Integer, Hash)>)

    MyPermissionsResponse data, response status code and response headers



709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 709

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

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

#partial_update(container_container_repository_href, patchedcontainer_container_repository, opts = {}) ⇒ AsyncOperationResponse

Update a container repository Trigger an asynchronous partial update task

Parameters:

  • container_container_repository_href (String)
  • patchedcontainer_container_repository (PatchedcontainerContainerRepository)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



764
765
766
767
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 764

def partial_update(container_container_repository_href, patchedcontainer_container_repository, opts = {})
  data, _status_code, _headers = partial_update_with_http_info(container_container_repository_href, patchedcontainer_container_repository, opts)
  data
end

#partial_update_with_http_info(container_container_repository_href, patchedcontainer_container_repository, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Update a container repository Trigger an asynchronous partial update task

Parameters:

  • container_container_repository_href (String)
  • patchedcontainer_container_repository (PatchedcontainerContainerRepository)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(AsyncOperationResponse, Integer, Hash)>)

    AsyncOperationResponse data, response status code and response headers



775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 775

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

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

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

#read(container_container_repository_href, opts = {}) ⇒ ContainerContainerRepositoryResponse

Inspect a container repository ViewSet for container repo.

Parameters:

  • container_container_repository_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:



835
836
837
838
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 835

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

#read_with_http_info(container_container_repository_href, opts = {}) ⇒ Array<(ContainerContainerRepositoryResponse, Integer, Hash)>

Inspect a container repository ViewSet for container repo.

Parameters:

  • container_container_repository_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:



847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 847

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

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

#remove(container_container_repository_href, recursive_manage, opts = {}) ⇒ AsyncOperationResponse

Remove content Trigger an async task to recursively remove container content.

Parameters:

  • container_container_repository_href (String)
  • recursive_manage (RecursiveManage)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



902
903
904
905
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 902

def remove(container_container_repository_href, recursive_manage, opts = {})
  data, _status_code, _headers = remove_with_http_info(container_container_repository_href, recursive_manage, opts)
  data
end

#remove_role(container_container_repository_href, nested_role, opts = {}) ⇒ NestedRoleResponse

Remove a role for this object from users/groups.

Parameters:

  • container_container_repository_href (String)
  • nested_role (NestedRole)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



971
972
973
974
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 971

def remove_role(container_container_repository_href, nested_role, opts = {})
  data, _status_code, _headers = remove_role_with_http_info(container_container_repository_href, nested_role, opts)
  data
end

#remove_role_with_http_info(container_container_repository_href, nested_role, opts = {}) ⇒ Array<(NestedRoleResponse, Integer, Hash)>

Remove a role for this object from users/groups.

Parameters:

  • container_container_repository_href (String)
  • nested_role (NestedRole)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(NestedRoleResponse, Integer, Hash)>)

    NestedRoleResponse data, response status code and response headers



981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 981

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

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

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

#remove_with_http_info(container_container_repository_href, recursive_manage, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Remove content Trigger an async task to recursively remove container content.

Parameters:

  • container_container_repository_href (String)
  • recursive_manage (RecursiveManage)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(AsyncOperationResponse, Integer, Hash)>)

    AsyncOperationResponse data, response status code and response headers



913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 913

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

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

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

#sign(container_container_repository_href, repository_sign, opts = {}) ⇒ AsyncOperationResponse

Sign images in the repo Trigger an asynchronous task to sign content.

Parameters:

  • container_container_repository_href (String)
  • repository_sign (RepositorySign)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



1040
1041
1042
1043
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 1040

def sign(container_container_repository_href, repository_sign, opts = {})
  data, _status_code, _headers = sign_with_http_info(container_container_repository_href, repository_sign, opts)
  data
end

#sign_with_http_info(container_container_repository_href, repository_sign, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Sign images in the repo Trigger an asynchronous task to sign content.

Parameters:

  • container_container_repository_href (String)
  • repository_sign (RepositorySign)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(AsyncOperationResponse, Integer, Hash)>)

    AsyncOperationResponse data, response status code and response headers



1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 1051

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

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

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

#sync(container_container_repository_href, container_repository_sync_url, opts = {}) ⇒ AsyncOperationResponse

Sync from a remote Trigger an asynchronous task to sync content.

Parameters:

  • container_container_repository_href (String)
  • container_repository_sync_url (ContainerRepositorySyncURL)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



1110
1111
1112
1113
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 1110

def sync(container_container_repository_href, container_repository_sync_url, opts = {})
  data, _status_code, _headers = sync_with_http_info(container_container_repository_href, container_repository_sync_url, opts)
  data
end

#sync_with_http_info(container_container_repository_href, container_repository_sync_url, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Sync from a remote Trigger an asynchronous task to sync content.

Parameters:

  • container_container_repository_href (String)
  • container_repository_sync_url (ContainerRepositorySyncURL)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(AsyncOperationResponse, Integer, Hash)>)

    AsyncOperationResponse data, response status code and response headers



1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 1121

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

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

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

#tag(container_container_repository_href, tag_image, opts = {}) ⇒ AsyncOperationResponse

Create a Tag Trigger an asynchronous task to tag an image in the repository

Parameters:

  • container_container_repository_href (String)
  • tag_image (TagImage)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



1180
1181
1182
1183
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 1180

def tag(container_container_repository_href, tag_image, opts = {})
  data, _status_code, _headers = tag_with_http_info(container_container_repository_href, tag_image, opts)
  data
end

#tag_with_http_info(container_container_repository_href, tag_image, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Create a Tag Trigger an asynchronous task to tag an image in the repository

Parameters:

  • container_container_repository_href (String)
  • tag_image (TagImage)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(AsyncOperationResponse, Integer, Hash)>)

    AsyncOperationResponse data, response status code and response headers



1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 1191

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

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

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

#untag(container_container_repository_href, un_tag_image, opts = {}) ⇒ AsyncOperationResponse

Delete a tag Trigger an asynchronous task to untag an image in the repository

Parameters:

  • container_container_repository_href (String)
  • un_tag_image (UnTagImage)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



1250
1251
1252
1253
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 1250

def untag(container_container_repository_href, un_tag_image, opts = {})
  data, _status_code, _headers = untag_with_http_info(container_container_repository_href, un_tag_image, opts)
  data
end

#untag_with_http_info(container_container_repository_href, un_tag_image, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Delete a tag Trigger an asynchronous task to untag an image in the repository

Parameters:

  • container_container_repository_href (String)
  • un_tag_image (UnTagImage)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(AsyncOperationResponse, Integer, Hash)>)

    AsyncOperationResponse data, response status code and response headers



1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 1261

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

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

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

#update(container_container_repository_href, container_container_repository, opts = {}) ⇒ AsyncOperationResponse

Update a container repository Trigger an asynchronous update task

Parameters:

  • container_container_repository_href (String)
  • container_container_repository (ContainerContainerRepository)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



1320
1321
1322
1323
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 1320

def update(container_container_repository_href, container_container_repository, opts = {})
  data, _status_code, _headers = update_with_http_info(container_container_repository_href, container_container_repository, opts)
  data
end

#update_with_http_info(container_container_repository_href, container_container_repository, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Update a container repository Trigger an asynchronous update task

Parameters:

  • container_container_repository_href (String)
  • container_container_repository (ContainerContainerRepository)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(AsyncOperationResponse, Integer, Hash)>)

    AsyncOperationResponse data, response status code and response headers



1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 1331

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

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

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