Class: Fastly::BillingUsageMetricsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/api/billing_usage_metrics_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BillingUsageMetricsApi

Returns a new instance of BillingUsageMetricsApi.



17
18
19
 
# File 'lib/fastly/api/billing_usage_metrics_api.rb', line 17

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/fastly/api/billing_usage_metrics_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#get_service_level_usage(opts = {}) ⇒ Serviceusagemetrics

Retrieve service-level usage metrics for services with non-zero usage units. Returns product usage, broken down by service.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :product_id (String) —

    The product identifier for the metrics returned (e.g., `cdn_usage`). This should be used along with `usage_type_name`.

  • :service (String) —

    The service identifier for the metrics being requested.

  • :usage_type_name (String) —

    The usage type name for the metrics returned (e.g., `North America Requests`). This should be used along with `product_id`.

  • :start_month (String)
  • :end_month (String)
  • :limit (String) —

    Number of results per page. The maximum is 10000. (default to ‘1000’)

  • :cursor (String) —

    Cursor value from the `next_cursor` field of a previous response, used to retrieve the next page. To request the first page, this should be empty.

Returns:



30
31
32
33
 
# File 'lib/fastly/api/billing_usage_metrics_api.rb', line 30

def get_service_level_usage(opts = {})
  data, _status_code, _headers = get_service_level_usage_with_http_info(opts)
  data
end

#get_service_level_usage_with_http_info(opts = {}) ⇒ Array<(Serviceusagemetrics, Integer, Hash)>

Retrieve service-level usage metrics for services with non-zero usage units. Returns product usage, broken down by service.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :product_id (String) —

    The product identifier for the metrics returned (e.g., &#x60;cdn_usage&#x60;). This should be used along with &#x60;usage_type_name&#x60;.

  • :service (String) —

    The service identifier for the metrics being requested.

  • :usage_type_name (String) —

    The usage type name for the metrics returned (e.g., &#x60;North America Requests&#x60;). This should be used along with &#x60;product_id&#x60;.

  • :start_month (String)
  • :end_month (String)
  • :limit (String) —

    Number of results per page. The maximum is 10000. (default to ‘1000’)

  • :cursor (String) —

    Cursor value from the &#x60;next_cursor&#x60; field of a previous response, used to retrieve the next page. To request the first page, this should be empty.

Returns:

  • (Array<(Serviceusagemetrics, Integer, Hash)>) —

    Serviceusagemetrics data, response status code and response headers



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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/fastly/api/billing_usage_metrics_api.rb', line 45

def get_service_level_usage_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillingUsageMetricsApi.get_service_level_usage ...'
  end
  # unbox the parameters from the hash
  pattern = Regexp.new(/^[0-9]{4}-[0-9]{2}$/)
  if @api_client.config.client_side_validation && !opts[:'start_month'].nil? && opts[:'start_month'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"start_month\"]' when calling BillingUsageMetricsApi.get_service_level_usage, must conform to the pattern #{pattern}."
  end

  pattern = Regexp.new(/^[0-9]{4}-[0-9]{2}$/)
  if @api_client.config.client_side_validation && !opts[:'end_month'].nil? && opts[:'end_month'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"end_month\"]' when calling BillingUsageMetricsApi.get_service_level_usage, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/billing/v3/service-usage-metrics'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'product_id'] = opts[:'product_id'] if !opts[:'product_id'].nil?
  query_params[:'service'] = opts[:'service'] if !opts[:'service'].nil?
  query_params[:'usage_type_name'] = opts[:'usage_type_name'] if !opts[:'usage_type_name'].nil?
  query_params[:'start_month'] = opts[:'start_month'] if !opts[:'start_month'].nil?
  query_params[:'end_month'] = opts[:'end_month'] if !opts[:'end_month'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Serviceusagemetrics'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"BillingUsageMetricsApi.get_service_level_usage",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingUsageMetricsApi#get_service_level_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_usage_metrics(opts = {}) ⇒ Usagemetric

Get monthly usage metrics Returns monthly usage metrics for customer by product.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :start_month (String) — default: required
  • :end_month (String) — default: required

Returns:



112
113
114
115
 
# File 'lib/fastly/api/billing_usage_metrics_api.rb', line 112

def get_usage_metrics(opts = {})
  data, _status_code, _headers = get_usage_metrics_with_http_info(opts)
  data
end

#get_usage_metrics_with_http_info(opts = {}) ⇒ Array<(Usagemetric, Integer, Hash)>

Get monthly usage metrics Returns monthly usage metrics for customer by product.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :start_month (String) — default: required
  • :end_month (String) — default: required

Returns:

  • (Array<(Usagemetric, Integer, Hash)>) —

    Usagemetric data, response status code and response headers



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/fastly/api/billing_usage_metrics_api.rb', line 122

def get_usage_metrics_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillingUsageMetricsApi.get_usage_metrics ...'
  end
  # unbox the parameters from the hash
  start_month = opts[:'start_month']
  end_month = opts[:'end_month']
  # verify the required parameter 'start_month' is set
  if @api_client.config.client_side_validation && start_month.nil?
    fail ArgumentError, "Missing the required parameter 'start_month' when calling BillingUsageMetricsApi.get_usage_metrics"
  end
  pattern = Regexp.new(/^[0-9]{4}-[0-9]{2}$/)
  if @api_client.config.client_side_validation && start_month !~ pattern
    fail ArgumentError, "invalid value for 'start_month' when calling BillingUsageMetricsApi.get_usage_metrics, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'end_month' is set
  if @api_client.config.client_side_validation && end_month.nil?
    fail ArgumentError, "Missing the required parameter 'end_month' when calling BillingUsageMetricsApi.get_usage_metrics"
  end
  pattern = Regexp.new(/^[0-9]{4}-[0-9]{2}$/)
  if @api_client.config.client_side_validation && end_month !~ pattern
    fail ArgumentError, "invalid value for 'end_month' when calling BillingUsageMetricsApi.get_usage_metrics, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/billing/v3/usage-metrics'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'start_month'] = start_month
  query_params[:'end_month'] = end_month

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Usagemetric'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"BillingUsageMetricsApi.get_usage_metrics",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingUsageMetricsApi#get_usage_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end