Class: SmplkitGeneratedClient::App::MetricsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/smplkit/_generated/app/lib/smplkit_app_client/api/metrics_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MetricsApi

Returns a new instance of MetricsApi.



19
20
21
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/metrics_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/smplkit/_generated/app/lib/smplkit_app_client/api/metrics_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#bulk_ingest_metrics(metric_bulk_request, opts = {}) ⇒ nil

Bulk Ingest Metrics Ingest pre-aggregated metric data points. Returns 202 Accepted with no response body.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/metrics_api.rb', line 27

def bulk_ingest_metrics(metric_bulk_request, opts = {})
  bulk_ingest_metrics_with_http_info(metric_bulk_request, opts)
  nil
end

#bulk_ingest_metrics_with_http_info(metric_bulk_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Bulk Ingest Metrics Ingest pre-aggregated metric data points. Returns 202 Accepted with no response body.

Parameters:

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

    the optional parameters

Returns:

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

    nil, 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
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/metrics_api.rb', line 37

def bulk_ingest_metrics_with_http_info(metric_bulk_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetricsApi.bulk_ingest_metrics ...'
  end
  # verify the required parameter 'metric_bulk_request' is set
  if @api_client.config.client_side_validation && metric_bulk_request.nil?
    fail ArgumentError, "Missing the required parameter 'metric_bulk_request' when calling MetricsApi.bulk_ingest_metrics"
  end
  # resource path
  local_var_path = '/api/v1/metrics/bulk'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(metric_bulk_request)

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"MetricsApi.bulk_ingest_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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MetricsApi#bulk_ingest_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_metric_names(opts = {}) ⇒ MetricNamesResponse

List Metric Names Return distinct metric names recorded for the account, each with a representative unit. Plain-JSON response (not JSON:API) — this is metadata for discovery, not a metric resource. Default sort is ‘name` ascending.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :sort (String) —

    Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;name&#x60;. Allowed values: &#x60;name&#x60;, &#x60;-name&#x60;. (default to ‘name’)

Returns:



95
96
97
98
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/metrics_api.rb', line 95

def list_metric_names(opts = {})
  data, _status_code, _headers = list_metric_names_with_http_info(opts)
  data
end

#list_metric_names_with_http_info(opts = {}) ⇒ Array<(MetricNamesResponse, Integer, Hash)>

List Metric Names Return distinct metric names recorded for the account, each with a representative unit. Plain-JSON response (not JSON:API) — this is metadata for discovery, not a metric resource. Default sort is &#x60;name&#x60; ascending.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :sort (String) —

    Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;name&#x60;. Allowed values: &#x60;name&#x60;, &#x60;-name&#x60;. (default to ‘name’)

Returns:

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

    MetricNamesResponse data, response status code and response headers



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
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
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/metrics_api.rb', line 105

def list_metric_names_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetricsApi.list_metric_names ...'
  end
  allowable_values = ["name", "-name"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v1/metric_names'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MetricsApi.list_metric_names",
    :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: MetricsApi#list_metric_names\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_metric_rollups(filter_name, filter_rollup, opts = {}) ⇒ MetricRollupListResponse

List Metric Rollups Query aggregated metric rollups. Requires filter for the aggregation interval.

Parameters:

  • filter_name (String)
  • filter_rollup (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_recorded_at (String)
  • :sort (String) —

    Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;bucket&#x60;. Allowed values: &#x60;bucket&#x60;, &#x60;-bucket&#x60;. (default to ‘bucket’)

Returns:



162
163
164
165
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/metrics_api.rb', line 162

def list_metric_rollups(filter_name, filter_rollup, opts = {})
  data, _status_code, _headers = list_metric_rollups_with_http_info(filter_name, filter_rollup, opts)
  data
end

#list_metric_rollups_with_http_info(filter_name, filter_rollup, opts = {}) ⇒ Array<(MetricRollupListResponse, Integer, Hash)>

List Metric Rollups Query aggregated metric rollups. Requires filter for the aggregation interval.

Parameters:

  • filter_name (String)
  • filter_rollup (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_recorded_at (String)
  • :sort (String) —

    Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;bucket&#x60;. Allowed values: &#x60;bucket&#x60;, &#x60;-bucket&#x60;. (default to ‘bucket’)

Returns:

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

    MetricRollupListResponse data, response status code and response headers



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/metrics_api.rb', line 175

def list_metric_rollups_with_http_info(filter_name, filter_rollup, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetricsApi.list_metric_rollups ...'
  end
  # verify the required parameter 'filter_name' is set
  if @api_client.config.client_side_validation && filter_name.nil?
    fail ArgumentError, "Missing the required parameter 'filter_name' when calling MetricsApi.list_metric_rollups"
  end
  # verify the required parameter 'filter_rollup' is set
  if @api_client.config.client_side_validation && filter_rollup.nil?
    fail ArgumentError, "Missing the required parameter 'filter_rollup' when calling MetricsApi.list_metric_rollups"
  end
  allowable_values = ["bucket", "-bucket"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v1/metric_rollups'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[name]'] = filter_name
  query_params[:'filter[rollup]'] = filter_rollup
  query_params[:'filter[recorded_at]'] = opts[:'filter_recorded_at'] if !opts[:'filter_recorded_at'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MetricsApi.list_metric_rollups",
    :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: MetricsApi#list_metric_rollups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_metrics(filter_name, opts = {}) ⇒ MetricListResponse

List Metrics Query raw metric rows with filtering by name, time range, and dimensions.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter_recorded_at (String)
  • :sort (String) —

    Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;-recorded_at&#x60;. Allowed values: &#x60;recorded_at&#x60;, &#x60;-recorded_at&#x60;, &#x60;value&#x60;, &#x60;-value&#x60;. (default to ‘-recorded_at’)

Returns:



242
243
244
245
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/metrics_api.rb', line 242

def list_metrics(filter_name, opts = {})
  data, _status_code, _headers = list_metrics_with_http_info(filter_name, opts)
  data
end

#list_metrics_with_http_info(filter_name, opts = {}) ⇒ Array<(MetricListResponse, Integer, Hash)>

List Metrics Query raw metric rows with filtering by name, time range, and dimensions.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter_recorded_at (String)
  • :sort (String) —

    Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;-recorded_at&#x60;. Allowed values: &#x60;recorded_at&#x60;, &#x60;-recorded_at&#x60;, &#x60;value&#x60;, &#x60;-value&#x60;. (default to ‘-recorded_at’)

Returns:

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

    MetricListResponse data, response status code and response headers



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/metrics_api.rb', line 254

def list_metrics_with_http_info(filter_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetricsApi.list_metrics ...'
  end
  # verify the required parameter 'filter_name' is set
  if @api_client.config.client_side_validation && filter_name.nil?
    fail ArgumentError, "Missing the required parameter 'filter_name' when calling MetricsApi.list_metrics"
  end
  allowable_values = ["recorded_at", "-recorded_at", "value", "-value"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v1/metrics'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[name]'] = filter_name
  query_params[:'filter[recorded_at]'] = opts[:'filter_recorded_at'] if !opts[:'filter_recorded_at'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"MetricsApi.list_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: MetricsApi#list_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end