Class: Vantage::PingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/vantage-client/api/ping_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PingApi

Returns a new instance of PingApi.



19
20
21
 
# File 'lib/vantage-client/api/ping_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/vantage-client/api/ping_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#ping(opts = {}) ⇒ Object

This is a health check endpoint that can be used to determine Vantage API healthiness. It will return a 200 success with the raw text of "pong" if everything is running smoothly.

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


25
26
27
28
 
# File 'lib/vantage-client/api/ping_api.rb', line 25

def ping(opts = {})
  data, _status_code, _headers = ping_with_http_info(opts)
  data
end

#ping_with_http_info(opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

This is a health check endpoint that can be used to determine Vantage API healthiness. It will return a 200 success with the raw text of &quot;pong&quot; if everything is running smoothly.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Object, Fixnum, Hash)>) —

    Object 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
 
# File 'lib/vantage-client/api/ping_api.rb', line 33

def ping_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PingApi.ping ...'
  end
  # resource path
  local_var_path = '/v1/ping'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PingApi#ping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end