class PulpFileClient::DistributionsFileApi
Attributes
Public Class Methods
# File lib/pulp_file_client/api/distributions_file_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Create a file distribution Trigger an asynchronous create task @param file_file_distribution [FileFileDistribution] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]
# File lib/pulp_file_client/api/distributions_file_api.rb, line 27 def create(file_file_distribution, opts = {}) data, _status_code, _headers = create_with_http_info(file_file_distribution, opts) data end
Create a file distribution Trigger an asynchronous create task @param file_file_distribution [FileFileDistribution] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
# File lib/pulp_file_client/api/distributions_file_api.rb, line 37 def create_with_http_info(file_file_distribution, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistributionsFileApi.create ...' end # verify the required parameter 'file_file_distribution' is set if @api_client.config.client_side_validation && file_file_distribution.nil? fail ArgumentError, "Missing the required parameter 'file_file_distribution' when calling DistributionsFileApi.create" end # resource path local_var_path = '/pulp/api/v3/distributions/file/file/' # 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(file_file_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: DistributionsFileApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a file distribution Trigger an asynchronous delete task @param file_file_distribution_href [String] @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 [String] :name name @option opts [String] :name__in name__in @option opts [String] :ordering Which field to use when ordering the results. @return [AsyncOperationResponse]
# File lib/pulp_file_client/api/distributions_file_api.rb, line 98 def delete(file_file_distribution_href, opts = {}) data, _status_code, _headers = delete_with_http_info(file_file_distribution_href, opts) data end
Delete a file distribution Trigger an asynchronous delete task @param file_file_distribution_href [String] @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 [String] :name name @option opts [String] :name__in name__in @option opts [String] :ordering Which field to use when ordering the results. @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
# File lib/pulp_file_client/api/distributions_file_api.rb, line 115 def delete_with_http_info(file_file_distribution_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistributionsFileApi.delete ...' end # verify the required parameter 'file_file_distribution_href' is set if @api_client.config.client_side_validation && file_file_distribution_href.nil? fail ArgumentError, "Missing the required parameter 'file_file_distribution_href' when calling DistributionsFileApi.delete" end # resource path local_var_path = '{file_file_distribution_href}'.sub('{' + 'file_file_distribution_href' + '}', CGI.escape(file_file_distribution_href.to_s).gsub('%2F', '/')) # 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[:'name'] = opts[:'name'] if !opts[:'name'].nil? query_params[:'name__in'] = opts[:'name__in'] if !opts[:'name__in'].nil? query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].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] || '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: DistributionsFileApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List file distributions
FileDistributions host File Publications which makes the metadata and the referenced File Content available to HTTP clients. Additionally, a FileDistribution with an associated FilePublication can be the target url of a File Remote , allowing another instance of Pulp to sync the content.
@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 [InlineResponse2001]
# File lib/pulp_file_client/api/distributions_file_api.rb, line 184 def list(opts = {}) data, _status_code, _headers = list_with_http_info(opts) data end
List file distributions
FileDistributions host File Publications which makes the metadata and the referenced File Content available to HTTP clients. Additionally, a FileDistribution with an associated FilePublication can be the target url of a File Remote , allowing another instance of Pulp to sync the content.
@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<(InlineResponse2001, Integer, Hash)>] InlineResponse2001 data, response status code and response headers
# File lib/pulp_file_client/api/distributions_file_api.rb, line 204 def list_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistributionsFileApi.list ...' end # resource path local_var_path = '/pulp/api/v3/distributions/file/file/' # 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] || 'InlineResponse2001' # 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: DistributionsFileApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update a file distribution Trigger an asynchronous partial update task @param file_file_distribution_href [String] @param patchedfile_file_distribution [PatchedfileFileDistribution] @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 [String] :name name @option opts [String] :name__in name__in @option opts [String] :ordering Which field to use when ordering the results. @return [AsyncOperationResponse]
# File lib/pulp_file_client/api/distributions_file_api.rb, line 271 def partial_update(file_file_distribution_href, patchedfile_file_distribution, opts = {}) data, _status_code, _headers = partial_update_with_http_info(file_file_distribution_href, patchedfile_file_distribution, opts) data end
Update a file distribution Trigger an asynchronous partial update task @param file_file_distribution_href [String] @param patchedfile_file_distribution [PatchedfileFileDistribution] @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 [String] :name name @option opts [String] :name__in name__in @option opts [String] :ordering Which field to use when ordering the results. @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
# File lib/pulp_file_client/api/distributions_file_api.rb, line 289 def partial_update_with_http_info(file_file_distribution_href, patchedfile_file_distribution, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistributionsFileApi.partial_update ...' end # verify the required parameter 'file_file_distribution_href' is set if @api_client.config.client_side_validation && file_file_distribution_href.nil? fail ArgumentError, "Missing the required parameter 'file_file_distribution_href' when calling DistributionsFileApi.partial_update" end # verify the required parameter 'patchedfile_file_distribution' is set if @api_client.config.client_side_validation && patchedfile_file_distribution.nil? fail ArgumentError, "Missing the required parameter 'patchedfile_file_distribution' when calling DistributionsFileApi.partial_update" end # resource path local_var_path = '{file_file_distribution_href}'.sub('{' + 'file_file_distribution_href' + '}', CGI.escape(file_file_distribution_href.to_s).gsub('%2F', '/')) # 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[:'name'] = opts[:'name'] if !opts[:'name'].nil? query_params[:'name__in'] = opts[:'name__in'] if !opts[:'name__in'].nil? query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil? # 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(patchedfile_file_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: DistributionsFileApi#partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Inspect a file distribution
FileDistributions host File Publications which makes the metadata and the referenced File Content available to HTTP clients. Additionally, a FileDistribution with an associated FilePublication can be the target url of a File Remote , allowing another instance of Pulp to sync the content.
@param file_file_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 [FileFileDistributionResponse]
# File lib/pulp_file_client/api/distributions_file_api.rb, line 356 def read(file_file_distribution_href, opts = {}) data, _status_code, _headers = read_with_http_info(file_file_distribution_href, opts) data end
Inspect a file distribution
FileDistributions host File Publications which makes the metadata and the referenced File Content available to HTTP clients. Additionally, a FileDistribution with an associated FilePublication can be the target url of a File Remote , allowing another instance of Pulp to sync the content.
@param file_file_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<(FileFileDistributionResponse, Integer, Hash)>] FileFileDistributionResponse data, response status code and response headers
# File lib/pulp_file_client/api/distributions_file_api.rb, line 368 def read_with_http_info(file_file_distribution_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistributionsFileApi.read ...' end # verify the required parameter 'file_file_distribution_href' is set if @api_client.config.client_side_validation && file_file_distribution_href.nil? fail ArgumentError, "Missing the required parameter 'file_file_distribution_href' when calling DistributionsFileApi.read" end # resource path local_var_path = '{file_file_distribution_href}'.sub('{' + 'file_file_distribution_href' + '}', CGI.escape(file_file_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] || 'FileFileDistributionResponse' # 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: DistributionsFileApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update a file distribution Trigger an asynchronous update task @param file_file_distribution_href [String] @param file_file_distribution [FileFileDistribution] @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 [String] :name name @option opts [String] :name__in name__in @option opts [String] :ordering Which field to use when ordering the results. @return [AsyncOperationResponse]
# File lib/pulp_file_client/api/distributions_file_api.rb, line 430 def update(file_file_distribution_href, file_file_distribution, opts = {}) data, _status_code, _headers = update_with_http_info(file_file_distribution_href, file_file_distribution, opts) data end
Update a file distribution Trigger an asynchronous update task @param file_file_distribution_href [String] @param file_file_distribution [FileFileDistribution] @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 [String] :name name @option opts [String] :name__in name__in @option opts [String] :ordering Which field to use when ordering the results. @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
# File lib/pulp_file_client/api/distributions_file_api.rb, line 448 def update_with_http_info(file_file_distribution_href, file_file_distribution, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistributionsFileApi.update ...' end # verify the required parameter 'file_file_distribution_href' is set if @api_client.config.client_side_validation && file_file_distribution_href.nil? fail ArgumentError, "Missing the required parameter 'file_file_distribution_href' when calling DistributionsFileApi.update" end # verify the required parameter 'file_file_distribution' is set if @api_client.config.client_side_validation && file_file_distribution.nil? fail ArgumentError, "Missing the required parameter 'file_file_distribution' when calling DistributionsFileApi.update" end # resource path local_var_path = '{file_file_distribution_href}'.sub('{' + 'file_file_distribution_href' + '}', CGI.escape(file_file_distribution_href.to_s).gsub('%2F', '/')) # 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[:'name'] = opts[:'name'] if !opts[:'name'].nil? query_params[:'name__in'] = opts[:'name__in'] if !opts[:'name__in'].nil? query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil? # 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(file_file_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: DistributionsFileApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end