Class: PulpContainerClient::RepositoriesContainerPushApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RepositoriesContainerPushApi

Returns a new instance of RepositoriesContainerPushApi.



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

def api_client
  @api_client
end

Instance Method Details

#list(opts = {}) ⇒ PaginatedcontainerContainerPushRepositoryResponseList

List container push repositorys ViewSet for a container push repository. POST and DELETE are disallowed because a push repository is tightly coupled with a ContainerDistribution which handles it automatically. Created - during push operation, removed - with ContainerDistribution removal.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of results to return per page.

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

    Which field to use when ordering the results.

  • :pulp_label_select (String) —

    Filter labels by search string

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



37
38
39
40
 
# File 'lib/pulp_container_client/api/repositories_container_push_api.rb', line 37

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

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

List container push repositorys ViewSet for a container push repository. POST and DELETE are disallowed because a push repository is tightly coupled with a ContainerDistribution which handles it automatically. Created - during push operation, removed - with ContainerDistribution removal.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of results to return per page.

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

    Which field to use when ordering the results.

  • :pulp_label_select (String) —

    Filter labels by search string

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/pulp_container_client/api/repositories_container_push_api.rb', line 57

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

  # 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'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'pulp_label_select'] = opts[:'pulp_label_select'] if !opts[:'pulp_label_select'].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] || 'PaginatedcontainerContainerPushRepositoryResponseList' 

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

#read(container_container_push_repository_href, opts = {}) ⇒ ContainerContainerPushRepositoryResponse

Inspect a container push repository ViewSet for a container push repository. POST and DELETE are disallowed because a push repository is tightly coupled with a ContainerDistribution which handles it automatically. Created - during push operation, removed - with ContainerDistribution removal.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



118
119
120
121
 
# File 'lib/pulp_container_client/api/repositories_container_push_api.rb', line 118

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

#read_with_http_info(container_container_push_repository_href, opts = {}) ⇒ Array<(ContainerContainerPushRepositoryResponse, Integer, Hash)>

Inspect a container push repository ViewSet for a container push repository. POST and DELETE are disallowed because a push repository is tightly coupled with a ContainerDistribution which handles it automatically. Created - during push operation, removed - with ContainerDistribution removal.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/pulp_container_client/api/repositories_container_push_api.rb', line 130

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

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

#remove_image(container_container_push_repository_href, remove_image, opts = {}) ⇒ AsyncOperationResponse

Delete an image from a repository Trigger an asynchronous task to remove a manifest and all its associated data by a digest

Parameters:

  • container_container_push_repository_href (String)
  • remove_image (RemoveImage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



185
186
187
188
 
# File 'lib/pulp_container_client/api/repositories_container_push_api.rb', line 185

def remove_image(container_container_push_repository_href, remove_image, opts = {})
  data, _status_code, _headers = remove_image_with_http_info(container_container_push_repository_href, remove_image, opts)
  data
end

#remove_image_with_http_info(container_container_push_repository_href, remove_image, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Delete an image from a repository Trigger an asynchronous task to remove a manifest and all its associated data by a digest

Parameters:

  • container_container_push_repository_href (String)
  • remove_image (RemoveImage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    AsyncOperationResponse data, response status code and response headers



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
239
240
241
242
243
244
245
246
247
 
# File 'lib/pulp_container_client/api/repositories_container_push_api.rb', line 196

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

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

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

Parameters:

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

    the optional parameters

Returns:



255
256
257
258
 
# File 'lib/pulp_container_client/api/repositories_container_push_api.rb', line 255

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

#tag_with_http_info(container_container_push_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_push_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



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
309
310
311
312
313
314
315
316
317
 
# File 'lib/pulp_container_client/api/repositories_container_push_api.rb', line 266

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

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

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

Parameters:

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

    the optional parameters

Returns:



325
326
327
328
 
# File 'lib/pulp_container_client/api/repositories_container_push_api.rb', line 325

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

#untag_with_http_info(container_container_push_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_push_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



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
379
380
381
382
383
384
385
386
387
 
# File 'lib/pulp_container_client/api/repositories_container_push_api.rb', line 336

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