class PulpContainerClient::RepositoriesContainerPushApi
Attributes
Public Class Methods
# File lib/pulp_container_client/api/repositories_container_push_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
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. @param [Hash] opts the optional parameters @option opts [Integer] :limit Number of results to return per page. @option opts [String] :name @option opts [String] :name__contains Filter results where name contains value @option opts [String] :name__icontains Filter results where name contains value @option opts [Array<String>] :name__in Filter results where name is in a comma-separated list of values @option opts [String] :name__startswith Filter results where name starts with value @option opts [Integer] :offset The initial index from which to return the results. @option opts [String] :ordering Which field to use when ordering the results. @option opts [String] :pulp_label_select Filter labels by search string @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [PaginatedcontainerContainerPushRepositoryResponseList]
# 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 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. @param [Hash] opts the optional parameters @option opts [Integer] :limit Number of results to return per page. @option opts [String] :name @option opts [String] :name__contains Filter results where name contains value @option opts [String] :name__icontains Filter results where name contains value @option opts [Array<String>] :name__in Filter results where name is in a comma-separated list of values @option opts [String] :name__startswith Filter results where name starts with value @option opts [Integer] :offset The initial index from which to return the results. @option opts [String] :ordering Which field to use when ordering the results. @option opts [String] :pulp_label_select Filter labels by search string @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [Array<(PaginatedcontainerContainerPushRepositoryResponseList
, Integer, Hash)>] PaginatedcontainerContainerPushRepositoryResponseList
data, response status code and response headers
# 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
Update a container push repository Trigger an asynchronous partial update task @param container_container_push_repository_href [String] @param patchedcontainer_container_push_repository [PatchedcontainerContainerPushRepository] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]
# File lib/pulp_container_client/api/repositories_container_push_api.rb, line 117 def partial_update(container_container_push_repository_href, patchedcontainer_container_push_repository, opts = {}) data, _status_code, _headers = partial_update_with_http_info(container_container_push_repository_href, patchedcontainer_container_push_repository, opts) data end
Update a container push repository Trigger an asynchronous partial update task @param container_container_push_repository_href [String] @param patchedcontainer_container_push_repository [PatchedcontainerContainerPushRepository] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse
, Integer, Hash)>] AsyncOperationResponse
data, response status code and response headers
# File lib/pulp_container_client/api/repositories_container_push_api.rb, line 128 def partial_update_with_http_info(container_container_push_repository_href, patchedcontainer_container_push_repository, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RepositoriesContainerPushApi.partial_update ...' 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.partial_update" end # verify the required parameter 'patchedcontainer_container_push_repository' is set if @api_client.config.client_side_validation && patchedcontainer_container_push_repository.nil? fail ArgumentError, "Missing the required parameter 'patchedcontainer_container_push_repository' when calling RepositoriesContainerPushApi.partial_update" 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] || {} # 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_push_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: RepositoriesContainerPushApi#partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
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. @param container_container_push_repository_href [String] @param [Hash] opts the optional parameters @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [ContainerContainerPushRepositoryResponse]
# File lib/pulp_container_client/api/repositories_container_push_api.rb, line 188 def read(container_container_push_repository_href, opts = {}) data, _status_code, _headers = read_with_http_info(container_container_push_repository_href, opts) data end
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. @param container_container_push_repository_href [String] @param [Hash] opts the optional parameters @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [Array<(ContainerContainerPushRepositoryResponse
, Integer, Hash)>] ContainerContainerPushRepositoryResponse
data, response status code and response headers
# File lib/pulp_container_client/api/repositories_container_push_api.rb, line 200 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
Delete an image from a repository Trigger an asynchronous task to remove a manifest and all its associated data by a digest @param container_container_push_repository_href [String] @param remove_image
[RemoveImage] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]
# File lib/pulp_container_client/api/repositories_container_push_api.rb, line 255 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
Delete an image from a repository Trigger an asynchronous task to remove a manifest and all its associated data by a digest @param container_container_push_repository_href [String] @param remove_image
[RemoveImage] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse
, Integer, Hash)>] AsyncOperationResponse
data, response status code and response headers
# File lib/pulp_container_client/api/repositories_container_push_api.rb, line 266 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
Create a Tag Trigger an asynchronous task to tag an image in the repository @param container_container_push_repository_href [String] @param tag_image [TagImage] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]
# File lib/pulp_container_client/api/repositories_container_push_api.rb, line 325 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
Create a Tag Trigger an asynchronous task to tag an image in the repository @param container_container_push_repository_href [String] @param tag_image [TagImage] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse
, Integer, Hash)>] AsyncOperationResponse
data, response status code and response headers
# File lib/pulp_container_client/api/repositories_container_push_api.rb, line 336 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
Delete a tag Trigger an asynchronous task to untag an image in the repository @param container_container_push_repository_href [String] @param un_tag_image [UnTagImage] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]
# File lib/pulp_container_client/api/repositories_container_push_api.rb, line 395 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
Delete a tag Trigger an asynchronous task to untag an image in the repository @param container_container_push_repository_href [String] @param un_tag_image [UnTagImage] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse
, Integer, Hash)>] AsyncOperationResponse
data, response status code and response headers
# File lib/pulp_container_client/api/repositories_container_push_api.rb, line 406 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
Update a container push repository Trigger an asynchronous update task @param container_container_push_repository_href [String] @param container_container_push_repository [ContainerContainerPushRepository] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]
# File lib/pulp_container_client/api/repositories_container_push_api.rb, line 465 def update(container_container_push_repository_href, container_container_push_repository, opts = {}) data, _status_code, _headers = update_with_http_info(container_container_push_repository_href, container_container_push_repository, opts) data end
Update a container push repository Trigger an asynchronous update task @param container_container_push_repository_href [String] @param container_container_push_repository [ContainerContainerPushRepository] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse
, Integer, Hash)>] AsyncOperationResponse
data, response status code and response headers
# File lib/pulp_container_client/api/repositories_container_push_api.rb, line 476 def update_with_http_info(container_container_push_repository_href, container_container_push_repository, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RepositoriesContainerPushApi.update ...' 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.update" end # verify the required parameter 'container_container_push_repository' is set if @api_client.config.client_side_validation && container_container_push_repository.nil? fail ArgumentError, "Missing the required parameter 'container_container_push_repository' when calling RepositoriesContainerPushApi.update" 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] || {} # 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_push_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: RepositoriesContainerPushApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end