class Vantage::PingApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

ping(opts = {}) click to toggle source

This is a health check endpoint that can be used to determine Vantage API healthiness. It will return 200 if everything is running smoothly. @param [Hash] opts the optional parameters @return [Object]

# 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 = {}) click to toggle source

This is a health check endpoint that can be used to determine Vantage API healthiness. It will return 200 if everything is running smoothly. @param [Hash] opts the optional parameters @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers

# 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