class PulpContainerClient::DistributionsContainerApi
Attributes
Public Class Methods
# File lib/pulp_container_client/api/distributions_container_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Create a container distribution Trigger an asynchronous create task @param container_container_distribution [ContainerContainerDistribution] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]
# File lib/pulp_container_client/api/distributions_container_api.rb, line 27 def create(container_container_distribution, opts = {}) data, _status_code, _headers = create_with_http_info(container_container_distribution, opts) data end
Create a container distribution Trigger an asynchronous create task @param container_container_distribution [ContainerContainerDistribution] @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/distributions_container_api.rb, line 37 def create_with_http_info(container_container_distribution, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistributionsContainerApi.create ...' end # verify the required parameter 'container_container_distribution' is set if @api_client.config.client_side_validation && container_container_distribution.nil? fail ArgumentError, "Missing the required parameter 'container_container_distribution' when calling DistributionsContainerApi.create" end # resource path local_var_path = '/pulp/api/v3/distributions/container/container/' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(container_container_distribution) # 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: DistributionsContainerApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a container distribution Trigger an asynchronous delete task @param container_container_distribution_href [String] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]
# File lib/pulp_container_client/api/distributions_container_api.rb, line 91 def delete(container_container_distribution_href, opts = {}) data, _status_code, _headers = delete_with_http_info(container_container_distribution_href, opts) data end
Delete a container distribution Trigger an asynchronous delete task @param container_container_distribution_href [String] @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/distributions_container_api.rb, line 101 def delete_with_http_info(container_container_distribution_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistributionsContainerApi.delete ...' end # verify the required parameter 'container_container_distribution_href' is set if @api_client.config.client_side_validation && container_container_distribution_href.nil? fail ArgumentError, "Missing the required parameter 'container_container_distribution_href' when calling DistributionsContainerApi.delete" end # resource path local_var_path = '{container_container_distribution_href}'.sub('{' + 'container_container_distribution_href' + '}', CGI.escape(container_container_distribution_href.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'AsyncOperationResponse' # auth_names auth_names = opts[:auth_names] || ['basicAuth'] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: DistributionsContainerApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List container distributions The Container Distribution will serve the latest version of a Repository if “repository“ is specified. The Container Distribution will serve a specific repository version if “repository_version“. Note that *either* “repository“ or “repository_version“ can be set on a Container Distribution, but not both. @param [Hash] opts the optional parameters @option opts [String] :base_path base_path @option opts [String] :base_path__contains base_path__contains @option opts [String] :base_path__icontains base_path__icontains @option opts [String] :base_path__in base_path__in @option opts [Integer] :limit Number of results to return per page. @option opts [String] :name name @option opts [String] :name__in name__in @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] :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 [InlineResponse2004]
# File lib/pulp_container_client/api/distributions_container_api.rb, line 163 def list(opts = {}) data, _status_code, _headers = list_with_http_info(opts) data end
List container distributions The Container Distribution will serve the latest version of a Repository if ``repository`` is specified. The Container Distribution will serve a specific repository version if ``repository_version``. Note that *either* ``repository`` or ``repository_version`` can be set on a Container Distribution, but not both. @param [Hash] opts the optional parameters @option opts [String] :base_path base_path @option opts [String] :base_path__contains base_path__contains @option opts [String] :base_path__icontains base_path__icontains @option opts [String] :base_path__in base_path__in @option opts [Integer] :limit Number of results to return per page. @option opts [String] :name name @option opts [String] :name__in name__in @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] :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<(InlineResponse2004, Integer, Hash)>] InlineResponse2004 data, response status code and response headers
# File lib/pulp_container_client/api/distributions_container_api.rb, line 183 def list_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistributionsContainerApi.list ...' end # resource path local_var_path = '/pulp/api/v3/distributions/container/container/' # query parameters query_params = opts[:query_params] || {} query_params[:'base_path'] = opts[:'base_path'] if !opts[:'base_path'].nil? query_params[:'base_path__contains'] = opts[:'base_path__contains'] if !opts[:'base_path__contains'].nil? query_params[:'base_path__icontains'] = opts[:'base_path__icontains'] if !opts[:'base_path__icontains'].nil? query_params[:'base_path__in'] = opts[:'base_path__in'] if !opts[:'base_path__in'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil? query_params[:'name__in'] = opts[:'name__in'] if !opts[:'name__in'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil? query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil? query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse2004' # 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: DistributionsContainerApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update a container distribution Trigger an asynchronous partial update task @param container_container_distribution_href [String] @param patchedcontainer_container_distribution [PatchedcontainerContainerDistribution] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]
# File lib/pulp_container_client/api/distributions_container_api.rb, line 243 def partial_update(container_container_distribution_href, patchedcontainer_container_distribution, opts = {}) data, _status_code, _headers = partial_update_with_http_info(container_container_distribution_href, patchedcontainer_container_distribution, opts) data end
Update a container distribution Trigger an asynchronous partial update task @param container_container_distribution_href [String] @param patchedcontainer_container_distribution [PatchedcontainerContainerDistribution] @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/distributions_container_api.rb, line 254 def partial_update_with_http_info(container_container_distribution_href, patchedcontainer_container_distribution, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistributionsContainerApi.partial_update ...' end # verify the required parameter 'container_container_distribution_href' is set if @api_client.config.client_side_validation && container_container_distribution_href.nil? fail ArgumentError, "Missing the required parameter 'container_container_distribution_href' when calling DistributionsContainerApi.partial_update" end # verify the required parameter 'patchedcontainer_container_distribution' is set if @api_client.config.client_side_validation && patchedcontainer_container_distribution.nil? fail ArgumentError, "Missing the required parameter 'patchedcontainer_container_distribution' when calling DistributionsContainerApi.partial_update" end # resource path local_var_path = '{container_container_distribution_href}'.sub('{' + 'container_container_distribution_href' + '}', CGI.escape(container_container_distribution_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_distribution) # 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: DistributionsContainerApi#partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Inspect a container distribution The Container Distribution will serve the latest version of a Repository if “repository“ is specified. The Container Distribution will serve a specific repository version if “repository_version“. Note that *either* “repository“ or “repository_version“ can be set on a Container Distribution, but not both. @param container_container_distribution_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 [ContainerContainerDistributionResponse]
# File lib/pulp_container_client/api/distributions_container_api.rb, line 314 def read(container_container_distribution_href, opts = {}) data, _status_code, _headers = read_with_http_info(container_container_distribution_href, opts) data end
Inspect a container distribution The Container Distribution will serve the latest version of a Repository if ``repository`` is specified. The Container Distribution will serve a specific repository version if ``repository_version``. Note that *either* ``repository`` or ``repository_version`` can be set on a Container Distribution, but not both. @param container_container_distribution_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<(ContainerContainerDistributionResponse, Integer, Hash)>] ContainerContainerDistributionResponse data, response status code and response headers
# File lib/pulp_container_client/api/distributions_container_api.rb, line 326 def read_with_http_info(container_container_distribution_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistributionsContainerApi.read ...' end # verify the required parameter 'container_container_distribution_href' is set if @api_client.config.client_side_validation && container_container_distribution_href.nil? fail ArgumentError, "Missing the required parameter 'container_container_distribution_href' when calling DistributionsContainerApi.read" end # resource path local_var_path = '{container_container_distribution_href}'.sub('{' + 'container_container_distribution_href' + '}', CGI.escape(container_container_distribution_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] || 'ContainerContainerDistributionResponse' # 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: DistributionsContainerApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update a container distribution Trigger an asynchronous update task @param container_container_distribution_href [String] @param container_container_distribution [ContainerContainerDistribution] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]
# File lib/pulp_container_client/api/distributions_container_api.rb, line 381 def update(container_container_distribution_href, container_container_distribution, opts = {}) data, _status_code, _headers = update_with_http_info(container_container_distribution_href, container_container_distribution, opts) data end
Update a container distribution Trigger an asynchronous update task @param container_container_distribution_href [String] @param container_container_distribution [ContainerContainerDistribution] @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/distributions_container_api.rb, line 392 def update_with_http_info(container_container_distribution_href, container_container_distribution, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistributionsContainerApi.update ...' end # verify the required parameter 'container_container_distribution_href' is set if @api_client.config.client_side_validation && container_container_distribution_href.nil? fail ArgumentError, "Missing the required parameter 'container_container_distribution_href' when calling DistributionsContainerApi.update" end # verify the required parameter 'container_container_distribution' is set if @api_client.config.client_side_validation && container_container_distribution.nil? fail ArgumentError, "Missing the required parameter 'container_container_distribution' when calling DistributionsContainerApi.update" end # resource path local_var_path = '{container_container_distribution_href}'.sub('{' + 'container_container_distribution_href' + '}', CGI.escape(container_container_distribution_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_distribution) # 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: DistributionsContainerApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end