Class: OpenapiClient::HealthApi

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/api/health_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ HealthApi

Returns a new instance of HealthApi.



19
20
21
 
# File 'lib/openapi_client/api/health_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/openapi_client/api/health_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#endpoint_health_get(opts = {}) ⇒ Array<EndpointHealth>

List endpoint health statuses

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



25
26
27
28
 
# File 'lib/openapi_client/api/health_api.rb', line 25

def endpoint_health_get(opts = {})
  data, _status_code, _headers = endpoint_health_get_with_http_info(opts)
  data
end

#endpoint_health_get_with_http_info(opts = {}) ⇒ Array<(Array<EndpointHealth>, Integer, Hash)>

List endpoint health statuses

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<EndpointHealth>, Integer, Hash)>) —

    Array<EndpointHealth> data, response status code and response headers



33
34
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
75
 
# File 'lib/openapi_client/api/health_api.rb', line 33

def endpoint_health_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: HealthApi.endpoint_health_get ...'
  end
  # resource path
  local_var_path = '/endpoint-health'

  # 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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<EndpointHealth>'

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

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

#endpoint_health_id_get(id, opts = {}) ⇒ EndpointHealth

Get specific endpoint health

Parameters:

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



81
82
83
84
 
# File 'lib/openapi_client/api/health_api.rb', line 81

def endpoint_health_id_get(id, opts = {})
  data, _status_code, _headers = endpoint_health_id_get_with_http_info(id, opts)
  data
end

#endpoint_health_id_get_with_http_info(id, opts = {}) ⇒ Array<(EndpointHealth, Integer, Hash)>

Get specific endpoint health

Parameters:

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EndpointHealth, Integer, Hash)>) —

    EndpointHealth data, response status code and response headers



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/openapi_client/api/health_api.rb', line 90

def endpoint_health_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: HealthApi.endpoint_health_id_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling HealthApi.endpoint_health_id_get"
  end
  # resource path
  local_var_path = '/endpoint-health/{id}'.sub('{id}', CGI.escape(id.to_s))

  # 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']) unless header_params['Accept']

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

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

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

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

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

#status_get(opts = {}) ⇒ SystemStatus

System status (public)

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



141
142
143
144
 
# File 'lib/openapi_client/api/health_api.rb', line 141

def status_get(opts = {})
  data, _status_code, _headers = status_get_with_http_info(opts)
  data
end

#status_get_with_http_info(opts = {}) ⇒ Array<(SystemStatus, Integer, Hash)>

System status (public)

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SystemStatus, Integer, Hash)>) —

    SystemStatus data, response status code and response headers



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/openapi_client/api/health_api.rb', line 149

def status_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: HealthApi.status_get ...'
  end
  # resource path
  local_var_path = '/status'

  # 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']) unless header_params['Accept']

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

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

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

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

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