class PulpcoreClient::UpstreamPulpsApi

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

Create an upstream pulp API for configuring an upstream Pulp to replicate. This API is provided as a tech preview. @param upstream_pulp [UpstreamPulp] @param [Hash] opts the optional parameters @return [UpstreamPulpResponse]

# File lib/pulpcore_client/api/upstream_pulps_api.rb, line 27
def create(upstream_pulp, opts = {})
  data, _status_code, _headers = create_with_http_info(upstream_pulp, opts)
  data
end

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

Create an upstream pulp API for configuring an upstream Pulp to replicate. This API is provided as a tech preview. @param upstream_pulp [UpstreamPulp] @param [Hash] opts the optional parameters @return [Array<(UpstreamPulpResponse, Integer, Hash)>] UpstreamPulpResponse data, response status code and response headers

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

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

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

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

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

Delete an upstream pulp API for configuring an upstream Pulp to replicate. This API is provided as a tech preview. @param upstream_pulp_href [String] @param [Hash] opts the optional parameters @return [nil]

# File lib/pulpcore_client/api/upstream_pulps_api.rb, line 91
def delete(upstream_pulp_href, opts = {})
  delete_with_http_info(upstream_pulp_href, opts)
  nil
end

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

Delete an upstream pulp API for configuring an upstream Pulp to replicate. This API is provided as a tech preview. @param upstream_pulp_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/upstream_pulps_api.rb, line 101
def delete_with_http_info(upstream_pulp_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UpstreamPulpsApi.delete ...'
  end
  # verify the required parameter 'upstream_pulp_href' is set
  if @api_client.config.client_side_validation && upstream_pulp_href.nil?
    fail ArgumentError, "Missing the required parameter 'upstream_pulp_href' when calling UpstreamPulpsApi.delete"
  end
  # resource path
  local_var_path = '{upstream_pulp_href}'.sub('{' + 'upstream_pulp_href' + '}', CGI.escape(upstream_pulp_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: UpstreamPulpsApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

list(opts = {}) click to toggle source

List upstream pulps API for configuring an upstream Pulp to replicate. This API is provided as a tech preview. @param [Hash] opts the optional parameters @option opts [Integer] :limit Number of results to return per page. @option opts [Integer] :offset The initial index from which to return the results. @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 [PaginatedUpstreamPulpResponseList]

# File lib/pulpcore_client/api/upstream_pulps_api.rb, line 154
def list(opts = {})
  data, _status_code, _headers = list_with_http_info(opts)
  data
end

list_with_http_info(opts = {}) click to toggle source

List upstream pulps API for configuring an upstream Pulp to replicate. This API is provided as a tech preview. @param [Hash] opts the optional parameters @option opts [Integer] :limit Number of results to return per page. @option opts [Integer] :offset The initial index from which to return the results. @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<(PaginatedUpstreamPulpResponseList, Integer, Hash)>] PaginatedUpstreamPulpResponseList data, response status code and response headers

# File lib/pulpcore_client/api/upstream_pulps_api.rb, line 167
def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UpstreamPulpsApi.list ...'
  end
  # resource path
  local_var_path = '/pulp/api/v3/upstream-pulps/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].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] || 'PaginatedUpstreamPulpResponseList' 

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

partial_update(upstream_pulp_href, patched_upstream_pulp, opts = {}) click to toggle source

Update an upstream pulp API for configuring an upstream Pulp to replicate. This API is provided as a tech preview. @param upstream_pulp_href [String] @param patched_upstream_pulp [PatchedUpstreamPulp] @param [Hash] opts the optional parameters @return [UpstreamPulpResponse]

# File lib/pulpcore_client/api/upstream_pulps_api.rb, line 220
def partial_update(upstream_pulp_href, patched_upstream_pulp, opts = {})
  data, _status_code, _headers = partial_update_with_http_info(upstream_pulp_href, patched_upstream_pulp, opts)
  data
end

partial_update_with_http_info(upstream_pulp_href, patched_upstream_pulp, opts = {}) click to toggle source

Update an upstream pulp API for configuring an upstream Pulp to replicate. This API is provided as a tech preview. @param upstream_pulp_href [String] @param patched_upstream_pulp [PatchedUpstreamPulp] @param [Hash] opts the optional parameters @return [Array<(UpstreamPulpResponse, Integer, Hash)>] UpstreamPulpResponse data, response status code and response headers

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

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

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

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

Inspect an upstream pulp API for configuring an upstream Pulp to replicate. This API is provided as a tech preview. @param upstream_pulp_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 [UpstreamPulpResponse]

# File lib/pulpcore_client/api/upstream_pulps_api.rb, line 291
def read(upstream_pulp_href, opts = {})
  data, _status_code, _headers = read_with_http_info(upstream_pulp_href, opts)
  data
end

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

Inspect an upstream pulp API for configuring an upstream Pulp to replicate. This API is provided as a tech preview. @param upstream_pulp_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<(UpstreamPulpResponse, Integer, Hash)>] UpstreamPulpResponse data, response status code and response headers

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

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

replicate(upstream_pulp_href, opts = {}) click to toggle source

Replicate Trigger an asynchronous repository replication task group. This API is provided as a tech preview. @param upstream_pulp_href [String] @param [Hash] opts the optional parameters @return [TaskGroupOperationResponse]

# File lib/pulpcore_client/api/upstream_pulps_api.rb, line 357
def replicate(upstream_pulp_href, opts = {})
  data, _status_code, _headers = replicate_with_http_info(upstream_pulp_href, opts)
  data
end

replicate_with_http_info(upstream_pulp_href, opts = {}) click to toggle source

Replicate Trigger an asynchronous repository replication task group. This API is provided as a tech preview. @param upstream_pulp_href [String] @param [Hash] opts the optional parameters @return [Array<(TaskGroupOperationResponse, Integer, Hash)>] TaskGroupOperationResponse data, response status code and response headers

# File lib/pulpcore_client/api/upstream_pulps_api.rb, line 367
def replicate_with_http_info(upstream_pulp_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UpstreamPulpsApi.replicate ...'
  end
  # verify the required parameter 'upstream_pulp_href' is set
  if @api_client.config.client_side_validation && upstream_pulp_href.nil?
    fail ArgumentError, "Missing the required parameter 'upstream_pulp_href' when calling UpstreamPulpsApi.replicate"
  end
  # resource path
  local_var_path = '{upstream_pulp_href}replicate/'.sub('{' + 'upstream_pulp_href' + '}', CGI.escape(upstream_pulp_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] || 'TaskGroupOperationResponse' 

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

update(upstream_pulp_href, upstream_pulp, opts = {}) click to toggle source

Update an upstream pulp API for configuring an upstream Pulp to replicate. This API is provided as a tech preview. @param upstream_pulp_href [String] @param upstream_pulp [UpstreamPulp] @param [Hash] opts the optional parameters @return [UpstreamPulpResponse]

# File lib/pulpcore_client/api/upstream_pulps_api.rb, line 420
def update(upstream_pulp_href, upstream_pulp, opts = {})
  data, _status_code, _headers = update_with_http_info(upstream_pulp_href, upstream_pulp, opts)
  data
end

update_with_http_info(upstream_pulp_href, upstream_pulp, opts = {}) click to toggle source

Update an upstream pulp API for configuring an upstream Pulp to replicate. This API is provided as a tech preview. @param upstream_pulp_href [String] @param upstream_pulp [UpstreamPulp] @param [Hash] opts the optional parameters @return [Array<(UpstreamPulpResponse, Integer, Hash)>] UpstreamPulpResponse data, response status code and response headers

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

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

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

Attributes

Public Class Methods

Public Instance Methods