Class: ForemanApi::Resources::Report

Inherits:
Base
  • Object
show all
Defined in:
lib/foreman_api/resources/report.rb

Constant Summary

Constants inherited from Base

Base::API_VERSION

Instance Attribute Summary

Attributes inherited from Base

#client, #config, #logger

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#http_call, #initialize, method_doc, #perform_call, #validate_params!, validation_hash

Constructor Details

This class inherits a constructor from ForemanApi::Base

Class Method Details

.doc ⇒ Object 



4
5
6
 
# File 'lib/foreman_api/resources/report.rb', line 4

def self.doc
  @doc ||= ForemanApi.doc['resources']["reports"]
end

Instance Method Details

#create(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

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

    a hash of params to be passed to the service

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

    additional http headers

Options Hash (params):

  • report (Hash, nil) —

    allowed keys are:

    • host [String] hostname or certname

    • logs [Array, nil] optional array of log hashes

    • metrics [Hash] hash of report metrics, can be just {}

    • reported_at [String] utc time of report

    • status [Hash] hash of status type totals

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



40
41
42
 
# File 'lib/foreman_api/resources/report.rb', line 40

def create(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

#destroy(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

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

    a hash of params to be passed to the service

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

    additional http headers

Options Hash (params):

  • id (String)

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



49
50
51
 
# File 'lib/foreman_api/resources/report.rb', line 49

def destroy(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

#index(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

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

    a hash of params to be passed to the service

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

    additional http headers

Options Hash (params):

  • order (String) —

    sort results

  • page (String) —

    paginate results

  • per_page (String) —

    number of entries per request

  • search (String) —

    filter results

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



16
17
18
 
# File 'lib/foreman_api/resources/report.rb', line 16

def index(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

#last(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

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

    a hash of params to be passed to the service

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

    additional http headers

Options Hash (params):

  • id (String)
  • host_id (Object) —

    Part of /api/hosts/:host_id/reports/last path

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



59
60
61
 
# File 'lib/foreman_api/resources/report.rb', line 59

def last(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

#show(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

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

    a hash of params to be passed to the service

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

    additional http headers

Options Hash (params):

  • id (String)

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



25
26
27
 
# File 'lib/foreman_api/resources/report.rb', line 25

def show(params = {}, headers = {})
  perform_call(__method__, params, headers)
end