Class: PulpcoreClient::LivezApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LivezApi 



19
20
21
 
# File 'lib/pulpcore_client/api/livez_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/livez_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#livez_read(opts = {}) ⇒ nil

Inspect liveness of Pulp’s REST API. Returns 200 OK when API is alive.



26
27
28
29
 
# File 'lib/pulpcore_client/api/livez_api.rb', line 26

def livez_read(opts = {})
  livez_read_with_http_info(opts)
  nil
end

#livez_read_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Inspect liveness of Pulp&#39;s REST API. Returns 200 OK when API is alive.



35
36
37
38
39
40
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
 
# File 'lib/pulpcore_client/api/livez_api.rb', line 35

def livez_read_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LivezApi.livez_read ...'
  end
  # resource path
  local_var_path = '/pulp/api/v3/livez/'

  # 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] || []

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