class PulpcoreClient::WorkersApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

list(opts = {}) click to toggle source

List workers A customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. "Normal" Django Models and Master/Detail models are supported by the “register_with“ method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' endpoint_name (str): The name of the final path segment that should identify the ViewSet's collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the "parent_prefix" of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object's identity. schema (DefaultSchema): The schema class to use by default in a viewset. @param [Hash] opts the optional parameters @option opts [String] :last_heartbeat last_heartbeat @option opts [String] :last_heartbeat__gt last_heartbeat__gt @option opts [String] :last_heartbeat__gte last_heartbeat__gte @option opts [String] :last_heartbeat__lt last_heartbeat__lt @option opts [String] :last_heartbeat__lte last_heartbeat__lte @option opts [String] :last_heartbeat__range last_heartbeat__range @option opts [Integer] :limit Number of results to return per page. @option opts [String] :missing missing @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] :online online @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 [InlineResponse20014]

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

List workers A customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. "Normal&quot; Django Models and Master/Detail models are supported by the &#x60;&#x60;register_with&#x60;&#x60; method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to &#39;pk&#39; endpoint_name (str): The name of the final path segment that should identify the ViewSet&#39;s collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the "parent_prefix&quot; of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object&#39;s identity. schema (DefaultSchema): The schema class to use by default in a viewset. @param [Hash] opts the optional parameters @option opts [String] :last_heartbeat last_heartbeat @option opts [String] :last_heartbeat__gt last_heartbeat__gt @option opts [String] :last_heartbeat__gte last_heartbeat__gte @option opts [String] :last_heartbeat__lt last_heartbeat__lt @option opts [String] :last_heartbeat__lte last_heartbeat__lte @option opts [String] :last_heartbeat__range last_heartbeat__range @option opts [Integer] :limit Number of results to return per page. @option opts [String] :missing missing @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] :online online @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<(InlineResponse20014, Integer, Hash)>] InlineResponse20014 data, response status code and response headers

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'last_heartbeat'] = opts[:'last_heartbeat'] if !opts[:'last_heartbeat'].nil?
  query_params[:'last_heartbeat__gt'] = opts[:'last_heartbeat__gt'] if !opts[:'last_heartbeat__gt'].nil?
  query_params[:'last_heartbeat__gte'] = opts[:'last_heartbeat__gte'] if !opts[:'last_heartbeat__gte'].nil?
  query_params[:'last_heartbeat__lt'] = opts[:'last_heartbeat__lt'] if !opts[:'last_heartbeat__lt'].nil?
  query_params[:'last_heartbeat__lte'] = opts[:'last_heartbeat__lte'] if !opts[:'last_heartbeat__lte'].nil?
  query_params[:'last_heartbeat__range'] = opts[:'last_heartbeat__range'] if !opts[:'last_heartbeat__range'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'missing'] = opts[:'missing'] if !opts[:'missing'].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[:'online'] = opts[:'online'] if !opts[:'online'].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] || 'InlineResponse20014' 

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

Inspect a worker A customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. "Normal" Django Models and Master/Detail models are supported by the “register_with“ method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' endpoint_name (str): The name of the final path segment that should identify the ViewSet's collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the "parent_prefix" of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object's identity. schema (DefaultSchema): The schema class to use by default in a viewset. @param worker_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 [WorkerResponse]

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

Inspect a worker A customized named ModelViewSet that knows how to register itself with the Pulp API router. This viewset is discoverable by its name. "Normal&quot; Django Models and Master/Detail models are supported by the &#x60;&#x60;register_with&#x60;&#x60; method. Attributes: lookup_field (str): The name of the field by which an object should be looked up, in addition to any parent lookups if this ViewSet is nested. Defaults to &#39;pk&#39; endpoint_name (str): The name of the final path segment that should identify the ViewSet&#39;s collection endpoint. nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must correspond to the "parent_prefix&quot; of a router with rest_framework_nested.NestedMixin. None indicates this ViewSet should not be nested. parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs to django model filter expressions that can be used with the corresponding value from self.kwargs, used only by a nested ViewSet to filter based on the parent object&#39;s identity. schema (DefaultSchema): The schema class to use by default in a viewset. @param worker_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<(WorkerResponse, Integer, Hash)>] WorkerResponse data, response status code and response headers

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

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