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_client ⇒ Object

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_repository_href, data, opts = {}) ⇒ AsyncOperationResponse

Trigger an asynchronous task to recursively add container content.

Parameters:

  • container_repository_href (String) —

    URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/

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

    the optional parameters

Returns:



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

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

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

Trigger an asynchronous task to recursively add container content.

Parameters:

  • container_repository_href (String) —

    URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/

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

    the optional parameters

Returns:

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

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

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

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(data) 

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

  # auth_names
  auth_names = opts[:auth_names] || ['Basic']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(: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

#copy_manifests(container_repository_href, data, opts = {}) ⇒ AsyncOperationResponse

Trigger an asynchronous task to copy manifests

Parameters:

  • container_repository_href (String) —

    URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/

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

    the optional parameters

Returns:



95
96
97
98
 
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 95

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

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

Trigger an asynchronous task to copy manifests

Parameters:

  • container_repository_href (String) —

    URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/

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

    the optional parameters

Returns:

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

    AsyncOperationResponse data, response status code and response headers



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 105

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

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(data) 

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

  # auth_names
  auth_names = opts[:auth_names] || ['Basic']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(: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_repository_href, data, opts = {}) ⇒ AsyncOperationResponse

Trigger an asynchronous task to copy tags

Parameters:

  • container_repository_href (String) —

    URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/

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

    the optional parameters

Returns:



163
164
165
166
 
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 163

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

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

Trigger an asynchronous task to copy tags

Parameters:

  • container_repository_href (String) —

    URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/

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

    the optional parameters

Returns:

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

    AsyncOperationResponse data, response status code and response headers



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 173

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

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(data) 

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

  # auth_names
  auth_names = opts[:auth_names] || ['Basic']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(: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(data, opts = {}) ⇒ ContainerContainerRepository

Create a container repository ViewSet for container repo.

Parameters:

Returns:



231
232
233
234
 
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 231

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

#create_with_http_info(data, opts = {}) ⇒ Array<(ContainerContainerRepository, Integer, Hash)>

Create a container repository ViewSet for container repo.

Parameters:

Returns:



241
242
243
244
245
246
247
248
249
250
251
252
253
254
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
 
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 241

def create_with_http_info(data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesContainerApi.create ...'
  end
  # verify the required parameter 'data' is set
  if @api_client.config.client_side_validation && data.nil?
    fail ArgumentError, "Missing the required parameter 'data' 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'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(data) 

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

  # auth_names
  auth_names = opts[:auth_names] || ['Basic']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(: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_repository_href, opts = {}) ⇒ AsyncOperationResponse

Delete a container repository Trigger an asynchronous task to delete a repository.

Parameters:

  • container_repository_href (String) —

    URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/

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

    the optional parameters

Returns:



295
296
297
298
 
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 295

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

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

Delete a container repository Trigger an asynchronous task to delete a repository.

Parameters:

  • container_repository_href (String) —

    URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/

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

    the optional parameters

Returns:

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

    AsyncOperationResponse data, response status code and response headers



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 305

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

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(: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 = {}) ⇒ InlineResponse2005

List container repositorys ViewSet for container repo.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String)
  • :name__in (String) —

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

  • :limit (Integer) —

    Number of results to return per page.

  • :offset (Integer) —

    The initial index from which to return 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:



362
363
364
365
 
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 362

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

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

List container repositorys ViewSet for container repo.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String)
  • :name__in (String) —

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

  • :limit (Integer) —

    Number of results to return per page.

  • :offset (Integer) —

    The initial index from which to return 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<(InlineResponse2005, Integer, Hash)>) —

    InlineResponse2005 data, response status code and response headers



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
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
 
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 377

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'name__in'] = opts[:'name__in'] if !opts[:'name__in'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

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

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

  # auth_names
  auth_names = opts[:auth_names] || ['Basic']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RepositoriesContainerApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#partial_update(container_repository_href, data, opts = {}) ⇒ ContainerContainerRepository

Partially update a container repository ViewSet for container repo.

Parameters:

  • container_repository_href (String) —

    URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/

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

    the optional parameters

Returns:



432
433
434
435
 
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 432

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

#partial_update_with_http_info(container_repository_href, data, opts = {}) ⇒ Array<(ContainerContainerRepository, Integer, Hash)>

Partially update a container repository ViewSet for container repo.

Parameters:

  • container_repository_href (String) —

    URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/

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

    the optional parameters

Returns:



443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
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
 
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 443

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

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(data) 

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

  # auth_names
  auth_names = opts[:auth_names] || ['Basic']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(: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_repository_href, opts = {}) ⇒ ContainerContainerRepository

Inspect a container repository ViewSet for container repo.

Parameters:

  • container_repository_href (String) —

    URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/

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



503
504
505
506
 
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 503

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

#read_with_http_info(container_repository_href, opts = {}) ⇒ Array<(ContainerContainerRepository, Integer, Hash)>

Inspect a container repository ViewSet for container repo.

Parameters:

  • container_repository_href (String) —

    URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/

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



515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 515

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

  # auth_names
  auth_names = opts[:auth_names] || ['Basic']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RepositoriesContainerApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#remove(container_repository_href, data, opts = {}) ⇒ AsyncOperationResponse

Trigger an async task to recursively remove container content.

Parameters:

  • container_repository_href (String) —

    URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/

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

    the optional parameters

Returns:



569
570
571
572
 
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 569

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

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

Trigger an async task to recursively remove container content.

Parameters:

  • container_repository_href (String) —

    URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/

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

    the optional parameters

Returns:

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

    AsyncOperationResponse data, response status code and response headers



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
625
626
627
628
629
630
 
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 579

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

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(data) 

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

  # auth_names
  auth_names = opts[:auth_names] || ['Basic']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(: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

#sync(container_repository_href, data, opts = {}) ⇒ AsyncOperationResponse

Trigger an asynchronous task to sync content.

Parameters:

  • container_repository_href (String) —

    URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/

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

    the optional parameters

Returns:



637
638
639
640
 
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 637

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

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

Trigger an asynchronous task to sync content.

Parameters:

  • container_repository_href (String) —

    URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/

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

    the optional parameters

Returns:

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

    AsyncOperationResponse data, response status code and response headers



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
691
692
693
694
695
696
697
698
 
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 647

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

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(data) 

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

  # auth_names
  auth_names = opts[:auth_names] || ['Basic']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(: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_repository_href, data, opts = {}) ⇒ AsyncOperationResponse

Trigger an asynchronous task to tag an image in the repository

Parameters:

  • container_repository_href (String) —

    URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/

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

    the optional parameters

Returns:



705
706
707
708
 
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 705

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

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

Trigger an asynchronous task to tag an image in the repository

Parameters:

  • container_repository_href (String) —

    URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/

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

    the optional parameters

Returns:

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

    AsyncOperationResponse data, response status code and response headers



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
757
758
759
760
761
762
763
764
765
766
 
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 715

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

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(data) 

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

  # auth_names
  auth_names = opts[:auth_names] || ['Basic']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(: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_repository_href, data, opts = {}) ⇒ AsyncOperationResponse

Trigger an asynchronous task to untag an image in the repository

Parameters:

  • container_repository_href (String) —

    URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/

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

    the optional parameters

Returns:



773
774
775
776
 
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 773

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

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

Trigger an asynchronous task to untag an image in the repository

Parameters:

  • container_repository_href (String) —

    URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/

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

    the optional parameters

Returns:

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

    AsyncOperationResponse data, response status code and response headers



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
827
828
829
830
831
832
833
834
 
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 783

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

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(data) 

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

  # auth_names
  auth_names = opts[:auth_names] || ['Basic']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(: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_repository_href, data, opts = {}) ⇒ AsyncOperationResponse

Update a container repository Trigger an asynchronous task to update a repository.

Parameters:

  • container_repository_href (String) —

    URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/

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

    the optional parameters

Returns:



842
843
844
845
 
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 842

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

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

Update a container repository Trigger an asynchronous task to update a repository.

Parameters:

  • container_repository_href (String) —

    URI of Container Repository. e.g.: /pulp/api/v3/repositories/container/container/1/

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

    the optional parameters

Returns:

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

    AsyncOperationResponse data, response status code and response headers



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
895
896
897
898
899
900
901
902
903
904
 
# File 'lib/pulp_container_client/api/repositories_container_api.rb', line 853

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

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(data) 

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

  # auth_names
  auth_names = opts[:auth_names] || ['Basic']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(: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