Class: Harbor2Client::PingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/harbor2_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/harbor2_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/harbor2_client/api/ping_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_ping(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.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

Returns:

  • (String) 


27
28
29
30
 
# File 'lib/harbor2_client/api/ping_api.rb', line 27

def get_ping(opts = {})
  data, _status_code, _headers = get_ping_with_http_info(opts)
  data
end

#get_ping_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.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

Returns:

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

    String data, response status code and response headers



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
76
 
# File 'lib/harbor2_client/api/ping_api.rb', line 37

def get_ping_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PingApi.get_ping ...'
  end
  if @api_client.config.client_side_validation && !opts[:'x_request_id'].nil? && opts[:'x_request_id'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"x_request_id"]" when calling PingApi.get_ping, the character length must be great than or equal to 1.'
  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'])
  header_params[:'X-Request-Id'] = opts[:'x_request_id'] if !opts[:'x_request_id'].nil?

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