class PulpcoreClient::ExportersPulpApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/pulpcore_client/api/exporters_pulp_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

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

Create a pulp exporter ViewSet for viewing PulpExporters. @param pulp_exporter [PulpExporter] @param [Hash] opts the optional parameters @return [PulpExporterResponse]

# File lib/pulpcore_client/api/exporters_pulp_api.rb, line 27
def create(pulp_exporter, opts = {})
  data, _status_code, _headers = create_with_http_info(pulp_exporter, opts)
  data
end
create_with_http_info(pulp_exporter, opts = {}) click to toggle source

Create a pulp exporter ViewSet for viewing PulpExporters. @param pulp_exporter [PulpExporter] @param [Hash] opts the optional parameters @return [Array<(PulpExporterResponse, Integer, Hash)>] PulpExporterResponse data, response status code and response headers

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

  # 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(pulp_exporter) 

  # return_type
  return_type = opts[:return_type] || 'PulpExporterResponse' 

  # 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: ExportersPulpApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete(pulp_exporter_href, opts = {}) click to toggle source

Delete a pulp exporter ViewSet for viewing PulpExporters. @param pulp_exporter_href [String] @param [Hash] opts the optional parameters @return [nil]

# File lib/pulpcore_client/api/exporters_pulp_api.rb, line 91
def delete(pulp_exporter_href, opts = {})
  delete_with_http_info(pulp_exporter_href, opts)
  nil
end
delete_with_http_info(pulp_exporter_href, opts = {}) click to toggle source

Delete a pulp exporter ViewSet for viewing PulpExporters. @param pulp_exporter_href [String] @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

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

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # 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: ExportersPulpApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list(opts = {}) click to toggle source

List pulp exporters ViewSet for viewing PulpExporters. @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] :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 [PaginatedPulpExporterResponseList]

# File lib/pulpcore_client/api/exporters_pulp_api.rb, line 160
def list(opts = {})
  data, _status_code, _headers = list_with_http_info(opts)
  data
end
list_with_http_info(opts = {}) click to toggle source

List pulp exporters ViewSet for viewing PulpExporters. @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] :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<(PaginatedPulpExporterResponseList, Integer, Hash)>] PaginatedPulpExporterResponseList data, response status code and response headers

# File lib/pulpcore_client/api/exporters_pulp_api.rb, line 179
def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ExportersPulpApi.list ...'
  end
  # resource path
  local_var_path = '/pulp/api/v3/exporters/core/pulp/'

  # 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[:'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] || 'PaginatedPulpExporterResponseList' 

  # 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: ExportersPulpApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
partial_update(pulp_exporter_href, patched_pulp_exporter, opts = {}) click to toggle source

Update a pulp exporter ViewSet for viewing PulpExporters. @param pulp_exporter_href [String] @param patched_pulp_exporter [PatchedPulpExporter] @param [Hash] opts the optional parameters @return [PulpExporterResponse]

# File lib/pulpcore_client/api/exporters_pulp_api.rb, line 238
def partial_update(pulp_exporter_href, patched_pulp_exporter, opts = {})
  data, _status_code, _headers = partial_update_with_http_info(pulp_exporter_href, patched_pulp_exporter, opts)
  data
end
partial_update_with_http_info(pulp_exporter_href, patched_pulp_exporter, opts = {}) click to toggle source

Update a pulp exporter ViewSet for viewing PulpExporters. @param pulp_exporter_href [String] @param patched_pulp_exporter [PatchedPulpExporter] @param [Hash] opts the optional parameters @return [Array<(PulpExporterResponse, Integer, Hash)>] PulpExporterResponse data, response status code and response headers

# File lib/pulpcore_client/api/exporters_pulp_api.rb, line 249
def partial_update_with_http_info(pulp_exporter_href, patched_pulp_exporter, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ExportersPulpApi.partial_update ...'
  end
  # verify the required parameter 'pulp_exporter_href' is set
  if @api_client.config.client_side_validation && pulp_exporter_href.nil?
    fail ArgumentError, "Missing the required parameter 'pulp_exporter_href' when calling ExportersPulpApi.partial_update"
  end
  # verify the required parameter 'patched_pulp_exporter' is set
  if @api_client.config.client_side_validation && patched_pulp_exporter.nil?
    fail ArgumentError, "Missing the required parameter 'patched_pulp_exporter' when calling ExportersPulpApi.partial_update"
  end
  # resource path
  local_var_path = '{pulp_exporter_href}'.sub('{' + 'pulp_exporter_href' + '}', CGI.escape(pulp_exporter_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(patched_pulp_exporter) 

  # return_type
  return_type = opts[:return_type] || 'PulpExporterResponse' 

  # 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: ExportersPulpApi#partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
read(pulp_exporter_href, opts = {}) click to toggle source

Inspect a pulp exporter ViewSet for viewing PulpExporters. @param pulp_exporter_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 [PulpExporterResponse]

# File lib/pulpcore_client/api/exporters_pulp_api.rb, line 309
def read(pulp_exporter_href, opts = {})
  data, _status_code, _headers = read_with_http_info(pulp_exporter_href, opts)
  data
end
read_with_http_info(pulp_exporter_href, opts = {}) click to toggle source

Inspect a pulp exporter ViewSet for viewing PulpExporters. @param pulp_exporter_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<(PulpExporterResponse, Integer, Hash)>] PulpExporterResponse data, response status code and response headers

# File lib/pulpcore_client/api/exporters_pulp_api.rb, line 321
def read_with_http_info(pulp_exporter_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ExportersPulpApi.read ...'
  end
  # verify the required parameter 'pulp_exporter_href' is set
  if @api_client.config.client_side_validation && pulp_exporter_href.nil?
    fail ArgumentError, "Missing the required parameter 'pulp_exporter_href' when calling ExportersPulpApi.read"
  end
  # resource path
  local_var_path = '{pulp_exporter_href}'.sub('{' + 'pulp_exporter_href' + '}', CGI.escape(pulp_exporter_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] || 'PulpExporterResponse' 

  # 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: ExportersPulpApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update(pulp_exporter_href, pulp_exporter, opts = {}) click to toggle source

Update a pulp exporter ViewSet for viewing PulpExporters. @param pulp_exporter_href [String] @param pulp_exporter [PulpExporter] @param [Hash] opts the optional parameters @return [PulpExporterResponse]

# File lib/pulpcore_client/api/exporters_pulp_api.rb, line 376
def update(pulp_exporter_href, pulp_exporter, opts = {})
  data, _status_code, _headers = update_with_http_info(pulp_exporter_href, pulp_exporter, opts)
  data
end
update_with_http_info(pulp_exporter_href, pulp_exporter, opts = {}) click to toggle source

Update a pulp exporter ViewSet for viewing PulpExporters. @param pulp_exporter_href [String] @param pulp_exporter [PulpExporter] @param [Hash] opts the optional parameters @return [Array<(PulpExporterResponse, Integer, Hash)>] PulpExporterResponse data, response status code and response headers

# File lib/pulpcore_client/api/exporters_pulp_api.rb, line 387
def update_with_http_info(pulp_exporter_href, pulp_exporter, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ExportersPulpApi.update ...'
  end
  # verify the required parameter 'pulp_exporter_href' is set
  if @api_client.config.client_side_validation && pulp_exporter_href.nil?
    fail ArgumentError, "Missing the required parameter 'pulp_exporter_href' when calling ExportersPulpApi.update"
  end
  # verify the required parameter 'pulp_exporter' is set
  if @api_client.config.client_side_validation && pulp_exporter.nil?
    fail ArgumentError, "Missing the required parameter 'pulp_exporter' when calling ExportersPulpApi.update"
  end
  # resource path
  local_var_path = '{pulp_exporter_href}'.sub('{' + 'pulp_exporter_href' + '}', CGI.escape(pulp_exporter_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(pulp_exporter) 

  # return_type
  return_type = opts[:return_type] || 'PulpExporterResponse' 

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