Class: SwaggerClient::PingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/harbor_swagger_client/api/ping_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PingApi 



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

def api_client
  @api_client
end

Instance Method Details

#ping_get(opts = {}) ⇒ String

Ping Harbor to check if it’s alive. This API simply replies a pong to indicate the process to handle API is up, disregarding the health status of dependent components.



26
27
28
29
 
# File 'lib/harbor_swagger_client/api/ping_api.rb', line 26

def ping_get(opts = {})
  data, _status_code, _headers = ping_get_with_http_info(opts)
  data
end

#ping_get_with_http_info(opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Ping Harbor to check if it&#39;s alive. This API simply replies a pong to indicate the process to handle API is up, disregarding the health status of dependent components.



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
 
# File 'lib/harbor_swagger_client/api/ping_api.rb', line 35

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basic']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PingApi#ping_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end