Class: PulpcoreClient::StatusApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pulpcore_client/api/status_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ StatusApi 



19
20
21
 
# File 'lib/pulpcore_client/api/status_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/pulpcore_client/api/status_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#status_read(opts = {}) ⇒ StatusResponse

Inspect status of Pulp Returns status and app information about Pulp. Information includes: * version of pulpcore and loaded pulp plugins * known workers * known content apps * database connection status * redis connection status * disk usage information

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.



29
30
31
32
 
# File 'lib/pulpcore_client/api/status_api.rb', line 29

def status_read(opts = {})
  data, _status_code, _headers = status_read_with_http_info(opts)
  data
end

#status_read_with_http_info(opts = {}) ⇒ Array<(StatusResponse, Integer, Hash)>

Inspect status of Pulp Returns status and app information about Pulp. Information includes: * version of pulpcore and loaded pulp plugins * known workers * known content apps * database connection status * redis connection status * disk usage information

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/pulpcore_client/api/status_api.rb', line 41

def status_read_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusApi.status_read ...'
  end
  # resource path
  local_var_path = '/pulp/api/v3/status/'

  # 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']) unless header_params['Accept']
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'StatusResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"StatusApi.status_read",
    :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: StatusApi#status_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end