class PulpDebClient::DistributionsAptApi

create(deb_apt_distribution, opts = {}) click to toggle source

Create an apt distribution Trigger an asynchronous create task @param deb_apt_distribution [DebAptDistribution] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulp_deb_client/api/distributions_apt_api.rb, line 27
def create(deb_apt_distribution, opts = {})
  data, _status_code, _headers = create_with_http_info(deb_apt_distribution, opts)
  data
end

create_with_http_info(deb_apt_distribution, opts = {}) click to toggle source

Create an apt distribution Trigger an asynchronous create task @param deb_apt_distribution [DebAptDistribution] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers

# File lib/pulp_deb_client/api/distributions_apt_api.rb, line 37
def create_with_http_info(deb_apt_distribution, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DistributionsAptApi.create ...'
  end
  # verify the required parameter 'deb_apt_distribution' is set
  if @api_client.config.client_side_validation && deb_apt_distribution.nil?
    fail ArgumentError, "Missing the required parameter 'deb_apt_distribution' when calling DistributionsAptApi.create"
  end
  # resource path
  local_var_path = '/pulp/api/v3/distributions/deb/apt/'

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

delete(deb_apt_distribution_href, opts = {}) click to toggle source

Delete an apt distribution Trigger an asynchronous delete task @param deb_apt_distribution_href [String] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulp_deb_client/api/distributions_apt_api.rb, line 91
def delete(deb_apt_distribution_href, opts = {})
  data, _status_code, _headers = delete_with_http_info(deb_apt_distribution_href, opts)
  data
end

delete_with_http_info(deb_apt_distribution_href, opts = {}) click to toggle source

Delete an apt distribution Trigger an asynchronous delete task @param deb_apt_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_deb_client/api/distributions_apt_api.rb, line 101
def delete_with_http_info(deb_apt_distribution_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DistributionsAptApi.delete ...'
  end
  # verify the required parameter 'deb_apt_distribution_href' is set
  if @api_client.config.client_side_validation && deb_apt_distribution_href.nil?
    fail ArgumentError, "Missing the required parameter 'deb_apt_distribution_href' when calling DistributionsAptApi.delete"
  end
  # resource path
  local_var_path = '{deb_apt_distribution_href}'.sub('{' + 'deb_apt_distribution_href' + '}', CGI.escape(deb_apt_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: DistributionsAptApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

list(opts = {}) click to toggle source

List apt distributions An AptDistribution is just an AptPublication made available via the content app. Creating an AptDistribution is a comparatively quick action. This way Pulp users may take as much time as is needed to prepare a VerbatimPublication or AptPublication, and then control the exact moment when that publication is made available. @param [Hash] opts the optional parameters @option opts [String] :base_path Filter results where base_path matches value @option opts [String] :base_path__contains Filter results where base_path contains value @option opts [String] :base_path__icontains Filter results where base_path contains value @option opts [Array<String>] :base_path__in Filter results where base_path is in a comma-separated list of values @option opts [Integer] :limit Number of results to return per page. @option opts [String] :name Filter results where name matches value @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 [Array<String>] :ordering Ordering @option opts [String] :pulp_label_select Filter labels by search string @option opts [String] :repository Filter results where repository matches value @option opts [Array<String>] :repository__in Filter results where repository is in a comma-separated list of values @option opts [String] :with_content Filter distributions based on the content served by them @option opts [Array<String>] :fields A list of fields to include in the response. @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response. @return [PaginateddebAptDistributionResponseList]

# File lib/pulp_deb_client/api/distributions_apt_api.rb, line 170
def list(opts = {})
  data, _status_code, _headers = list_with_http_info(opts)
  data
end

list_with_http_info(opts = {}) click to toggle source

List apt distributions An AptDistribution is just an AptPublication made available via the content app. Creating an AptDistribution is a comparatively quick action. This way Pulp users may take as much time as is needed to prepare a VerbatimPublication or AptPublication, and then control the exact moment when that publication is made available. @param [Hash] opts the optional parameters @option opts [String] :base_path Filter results where base_path matches value @option opts [String] :base_path__contains Filter results where base_path contains value @option opts [String] :base_path__icontains Filter results where base_path contains value @option opts [Array<String>] :base_path__in Filter results where base_path is in a comma-separated list of values @option opts [Integer] :limit Number of results to return per page. @option opts [String] :name Filter results where name matches value @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 [Array<String>] :ordering Ordering @option opts [String] :pulp_label_select Filter labels by search string @option opts [String] :repository Filter results where repository matches value @option opts [Array<String>] :repository__in Filter results where repository is in a comma-separated list of values @option opts [String] :with_content Filter distributions based on the content served by them @option opts [Array<String>] :fields A list of fields to include in the response. @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response. @return [Array<(PaginateddebAptDistributionResponseList, Integer, Hash)>] PaginateddebAptDistributionResponseList data, response status code and response headers

# File lib/pulp_deb_client/api/distributions_apt_api.rb, line 197
def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DistributionsAptApi.list ...'
  end
  allowable_values = ["-base_path", "-name", "-pk", "-pulp_created", "-pulp_id", "-pulp_labels", "-pulp_last_updated", "-pulp_type", "base_path", "name", "pk", "pulp_created", "pulp_id", "pulp_labels", "pulp_last_updated", "pulp_type"]
  if @api_client.config.client_side_validation && opts[:'ordering'] && !opts[:'ordering'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"ordering\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/pulp/api/v3/distributions/deb/apt/'

  # 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'] = @api_client.build_collection_param(opts[:'base_path__in'], :csv) 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__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'] = @api_client.build_collection_param(opts[:'ordering'], :csv) if !opts[:'ordering'].nil?
  query_params[:'pulp_label_select'] = opts[:'pulp_label_select'] if !opts[:'pulp_label_select'].nil?
  query_params[:'repository'] = opts[:'repository'] if !opts[:'repository'].nil?
  query_params[:'repository__in'] = @api_client.build_collection_param(opts[:'repository__in'], :csv) if !opts[:'repository__in'].nil?
  query_params[:'with_content'] = opts[:'with_content'] if !opts[:'with_content'].nil?
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) 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] || 'PaginateddebAptDistributionResponseList' 

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

partial_update(deb_apt_distribution_href, patcheddeb_apt_distribution, opts = {}) click to toggle source

Update an apt distribution Trigger an asynchronous partial update task @param deb_apt_distribution_href [String] @param patcheddeb_apt_distribution [PatcheddebAptDistribution] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulp_deb_client/api/distributions_apt_api.rb, line 268
def partial_update(deb_apt_distribution_href, patcheddeb_apt_distribution, opts = {})
  data, _status_code, _headers = partial_update_with_http_info(deb_apt_distribution_href, patcheddeb_apt_distribution, opts)
  data
end

partial_update_with_http_info(deb_apt_distribution_href, patcheddeb_apt_distribution, opts = {}) click to toggle source

Update an apt distribution Trigger an asynchronous partial update task @param deb_apt_distribution_href [String] @param patcheddeb_apt_distribution [PatcheddebAptDistribution] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers

# File lib/pulp_deb_client/api/distributions_apt_api.rb, line 279
def partial_update_with_http_info(deb_apt_distribution_href, patcheddeb_apt_distribution, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DistributionsAptApi.partial_update ...'
  end
  # verify the required parameter 'deb_apt_distribution_href' is set
  if @api_client.config.client_side_validation && deb_apt_distribution_href.nil?
    fail ArgumentError, "Missing the required parameter 'deb_apt_distribution_href' when calling DistributionsAptApi.partial_update"
  end
  # verify the required parameter 'patcheddeb_apt_distribution' is set
  if @api_client.config.client_side_validation && patcheddeb_apt_distribution.nil?
    fail ArgumentError, "Missing the required parameter 'patcheddeb_apt_distribution' when calling DistributionsAptApi.partial_update"
  end
  # resource path
  local_var_path = '{deb_apt_distribution_href}'.sub('{' + 'deb_apt_distribution_href' + '}', CGI.escape(deb_apt_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(patcheddeb_apt_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: DistributionsAptApi#partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

read(deb_apt_distribution_href, opts = {}) click to toggle source

Inspect an apt distribution An AptDistribution is just an AptPublication made available via the content app. Creating an AptDistribution is a comparatively quick action. This way Pulp users may take as much time as is needed to prepare a VerbatimPublication or AptPublication, and then control the exact moment when that publication is made available. @param deb_apt_distribution_href [String] @param [Hash] opts the optional parameters @option opts [Array<String>] :fields A list of fields to include in the response. @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response. @return [DebAptDistributionResponse]

# File lib/pulp_deb_client/api/distributions_apt_api.rb, line 339
def read(deb_apt_distribution_href, opts = {})
  data, _status_code, _headers = read_with_http_info(deb_apt_distribution_href, opts)
  data
end

read_with_http_info(deb_apt_distribution_href, opts = {}) click to toggle source

Inspect an apt distribution An AptDistribution is just an AptPublication made available via the content app. Creating an AptDistribution is a comparatively quick action. This way Pulp users may take as much time as is needed to prepare a VerbatimPublication or AptPublication, and then control the exact moment when that publication is made available. @param deb_apt_distribution_href [String] @param [Hash] opts the optional parameters @option opts [Array<String>] :fields A list of fields to include in the response. @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response. @return [Array<(DebAptDistributionResponse, Integer, Hash)>] DebAptDistributionResponse data, response status code and response headers

# File lib/pulp_deb_client/api/distributions_apt_api.rb, line 351
def read_with_http_info(deb_apt_distribution_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DistributionsAptApi.read ...'
  end
  # verify the required parameter 'deb_apt_distribution_href' is set
  if @api_client.config.client_side_validation && deb_apt_distribution_href.nil?
    fail ArgumentError, "Missing the required parameter 'deb_apt_distribution_href' when calling DistributionsAptApi.read"
  end
  # resource path
  local_var_path = '{deb_apt_distribution_href}'.sub('{' + 'deb_apt_distribution_href' + '}', CGI.escape(deb_apt_distribution_href.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) 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] || 'DebAptDistributionResponse' 

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

update(deb_apt_distribution_href, deb_apt_distribution, opts = {}) click to toggle source

Update an apt distribution Trigger an asynchronous update task @param deb_apt_distribution_href [String] @param deb_apt_distribution [DebAptDistribution] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulp_deb_client/api/distributions_apt_api.rb, line 406
def update(deb_apt_distribution_href, deb_apt_distribution, opts = {})
  data, _status_code, _headers = update_with_http_info(deb_apt_distribution_href, deb_apt_distribution, opts)
  data
end

update_with_http_info(deb_apt_distribution_href, deb_apt_distribution, opts = {}) click to toggle source

Update an apt distribution Trigger an asynchronous update task @param deb_apt_distribution_href [String] @param deb_apt_distribution [DebAptDistribution] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers

# File lib/pulp_deb_client/api/distributions_apt_api.rb, line 417
def update_with_http_info(deb_apt_distribution_href, deb_apt_distribution, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DistributionsAptApi.update ...'
  end
  # verify the required parameter 'deb_apt_distribution_href' is set
  if @api_client.config.client_side_validation && deb_apt_distribution_href.nil?
    fail ArgumentError, "Missing the required parameter 'deb_apt_distribution_href' when calling DistributionsAptApi.update"
  end
  # verify the required parameter 'deb_apt_distribution' is set
  if @api_client.config.client_side_validation && deb_apt_distribution.nil?
    fail ArgumentError, "Missing the required parameter 'deb_apt_distribution' when calling DistributionsAptApi.update"
  end
  # resource path
  local_var_path = '{deb_apt_distribution_href}'.sub('{' + 'deb_apt_distribution_href' + '}', CGI.escape(deb_apt_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(deb_apt_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: DistributionsAptApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

Attributes

Public Class Methods

Public Instance Methods