class VSphereAutomation::Appliance::HealthApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/vsphere-automation-appliance/api/health_api.rb, line 16
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

messages(item, opts = {}) click to toggle source

Get health messages. @param item ID of the data item @param [Hash] opts the optional parameters @return [ApplianceHealthMessagesResult|VapiStdErrorsErrorError|VapiStdErrorsNotFoundError|]

# File lib/vsphere-automation-appliance/api/health_api.rb, line 23
def messages(item, opts = {})
  data, _status_code, _headers = messages_with_http_info(item, opts)
  data
end
messages_with_http_info(item, opts = {}) click to toggle source

Get health messages. @api private @param item ID of the data item @param [Hash] opts the optional parameters @return [Array<(ApplianceHealthMessagesResult|VapiStdErrorsErrorError|VapiStdErrorsNotFoundError|, Fixnum, Hash)>] data, response status code and response headers

# File lib/vsphere-automation-appliance/api/health_api.rb, line 33
def messages_with_http_info(item, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: HealthApi.messages ...'
  end
  # verify the required parameter 'item' is set
  if @api_client.config.client_side_validation && item.nil?
    fail ArgumentError, "Missing the required parameter 'item' when calling HealthApi.messages"
  end
  # resource path
  local_var_path = '/appliance/health/{item}/messages'.sub('{' + 'item' + '}', item.to_s)

  # 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 = ['api_key']
  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 => {
      '200' => 'Appliance::ApplianceHealthMessagesResult',
      '400' => 'Appliance::VapiStdErrorsErrorError',
      '404' => 'Appliance::VapiStdErrorsNotFoundError',
    })
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HealthApi#messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end