Class: WhiteLabelMachineName::MerticUsageService

Inherits:
Object
  • Object
show all
Defined in:
lib/whitelabelmachinename-ruby-sdk/api/mertic_usage_service_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MerticUsageService

Returns a new instance of MerticUsageService.



24
25
26
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/mertic_usage_service_api.rb', line 24

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



22
23
24
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/mertic_usage_service_api.rb', line 22

def api_client
  @api_client
end

Instance Method Details

#calculate(space_id, start, _end, opts = {}) ⇒ Array<MetricUsage>

Calculate Calculates the consumed resources for the given space and time range.

Parameters:

  • space_id
  • start —

    The start date from which on the consumed units should be returned from.

  • _end —

    The end date to which the consumed units should be returned to. The end date is not included in the result.

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

    the optional parameters

Returns:



35
36
37
38
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/mertic_usage_service_api.rb', line 35

def calculate(space_id, start, _end, opts = {})
  data, _status_code, _headers = calculate_with_http_info(space_id, start, _end, opts)
  return data
end

#calculate_with_http_info(space_id, start, _end, opts = {}) ⇒ Array<(Array<MetricUsage>, Fixnum, Hash)>

Calculate Calculates the consumed resources for the given space and time range.

Parameters:

  • space_id
  • start —

    The start date from which on the consumed units should be returned from.

  • _end —

    The end date to which the consumed units should be returned to. The end date is not included in the result.

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

    the optional parameters

Returns:

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

    Array<MetricUsage> data, response status code and response headers



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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/mertic_usage_service_api.rb', line 47

def calculate_with_http_info(space_id, start, _end, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MerticUsageService.calculate ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling MerticUsageService.calculate" if space_id.nil?
  # verify the required parameter 'start' is set
  fail ArgumentError, "Missing the required parameter 'start' when calling MerticUsageService.calculate" if start.nil?
  # verify the required parameter '_end' is set
  fail ArgumentError, "Missing the required parameter '_end' when calling MerticUsageService.calculate" if _end.nil?
  # resource path
  local_var_path = "/mertic-usage/calculate".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'start'] = start
  query_params[:'end'] = _end

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['*/*']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<MetricUsage>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MerticUsageService#calculate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end