Class: SmplkitGeneratedClient::App::MetricsApi

Inherits:

Object

Object
SmplkitGeneratedClient::App::MetricsApi

show all

Defined in:: lib/smplkit/_generated/app/lib/smplkit_app_client/api/metrics_api.rb

Instance Attribute Summary collapse

#api_client ⇒ Object

Returns the value of attribute api_client.

Instance Method Summary collapse

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

Bulk Ingest Metrics Ingest pre-aggregated metric data points.
#bulk_ingest_metrics_with_http_info(metric_bulk_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Bulk Ingest Metrics Ingest pre-aggregated metric data points.
#initialize(api_client = ApiClient.default) ⇒ MetricsApi constructor

A new instance of MetricsApi.
#list_metric_names(opts = {}) ⇒ MetricNamesResponse

List Metric Names Return distinct metric names recorded for the account, each with a representative unit.
#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.
#list_metric_rollups(filter_name, filter_rollup, opts = {}) ⇒ MetricRollupListResponse

List Metric Rollups Query aggregated metric rollups.
#list_metric_rollups_with_http_info(filter_name, filter_rollup, opts = {}) ⇒ Array<(MetricRollupListResponse, Integer, Hash)>

List Metric Rollups Query aggregated metric rollups.
#list_metrics(filter_name, opts = {}) ⇒ MetricListResponse

List Metrics Query raw metric rows with filtering by name, time range, and dimensions.
#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.

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)

# 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

# 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 `-` for descending order. Default: `name`. Allowed values: `name`, `-name`. (default to ‘name’)
:page_number (Integer) —

1-based page number to return. Optional; defaults to `1` when omitted. Must be `>= 1` — requests with a smaller value are rejected with a 400 error. (default to 1)
:page_size (Integer) —

Number of items per page. Optional; defaults to `1000` when omitted. Must be between `1` and `1000` inclusive — requests outside that range are rejected with a 400 error. (default to 1000)
:meta_total (Boolean) —

When `true`, the response's `meta.pagination` block includes `total` (the total number of matching items across all pages) and `total_pages`. Computing these requires an extra `COUNT` query, so omit (or pass `false`) when the totals are not needed. Defaults to `false`. (default to false)

Returns:

(MetricNamesResponse)

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

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)>`

Parameters:

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

the optional parameters

Options Hash (opts):

:sort (String) —

Field to sort by. Prefix with `-` for descending order. Default: `name`. Allowed values: `name`, `-name`. (default to ‘name’)
:page_number (Integer) —

1-based page number to return. Optional; defaults to `1` when omitted. Must be `>= 1` — requests with a smaller value are rejected with a 400 error. (default to 1)
:page_size (Integer) —

Number of items per page. Optional; defaults to `1000` when omitted. Must be between `1` and `1000` inclusive — requests outside that range are rejected with a 400 error. (default to 1000)
:meta_total (Boolean) —

When `true`, the response's `meta.pagination` block includes `total` (the total number of matching items across all pages) and `total_pages`. Computing these requires an extra `COUNT` query, so omit (or pass `false`) when the totals are not needed. Defaults to `false`. (default to false)

Returns:

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

MetricNamesResponse data, response status code and response headers

# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/metrics_api.rb', line 111

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?
  query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'meta[total]'] = opts[:'meta_total'] if !opts[:'meta_total'].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 `-` for descending order. Default: `bucket`. Allowed values: `bucket`, `-bucket`. (default to ‘bucket’)
:page_number (Integer) —

1-based page number to return. Optional; defaults to `1` when omitted. Must be `>= 1` — requests with a smaller value are rejected with a 400 error. (default to 1)
:page_size (Integer) —

Number of items per page. Optional; defaults to `1000` when omitted. Must be between `1` and `1000` inclusive — requests outside that range are rejected with a 400 error. (default to 1000)
:meta_total (Boolean) —

When `true`, the response's `meta.pagination` block includes `total` (the total number of matching items across all pages) and `total_pages`. Computing these requires an extra `COUNT` query, so omit (or pass `false`) when the totals are not needed. Defaults to `false`. (default to false)

Returns:

(MetricRollupListResponse)

# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/metrics_api.rb', line 174

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 `-` for descending order. Default: `bucket`. Allowed values: `bucket`, `-bucket`. (default to ‘bucket’)
:page_number (Integer) —

1-based page number to return. Optional; defaults to `1` when omitted. Must be `>= 1` — requests with a smaller value are rejected with a 400 error. (default to 1)
:page_size (Integer) —

Number of items per page. Optional; defaults to `1000` when omitted. Must be between `1` and `1000` inclusive — requests outside that range are rejected with a 400 error. (default to 1000)
:meta_total (Boolean) —

When `true`, the response's `meta.pagination` block includes `total` (the total number of matching items across all pages) and `total_pages`. Computing these requires an extra `COUNT` query, so omit (or pass `false`) when the totals are not needed. Defaults to `false`. (default to false)

Returns:

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

MetricRollupListResponse data, response status code and response headers

# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/metrics_api.rb', line 190

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?
  query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'meta[total]'] = opts[:'meta_total'] if !opts[:'meta_total'].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 `-` for descending order. Default: `-recorded_at`. Allowed values: `recorded_at`, `-recorded_at`, `value`, `-value`. (default to ‘-recorded_at’)
:page_number (Integer) —

1-based page number to return. Optional; defaults to `1` when omitted. Must be `>= 1` — requests with a smaller value are rejected with a 400 error. (default to 1)
:page_size (Integer) —

Number of items per page. Optional; defaults to `1000` when omitted. Must be between `1` and `1000` inclusive — requests outside that range are rejected with a 400 error. (default to 1000)
:meta_total (Boolean) —

When `true`, the response's `meta.pagination` block includes `total` (the total number of matching items across all pages) and `total_pages`. Computing these requires an extra `COUNT` query, so omit (or pass `false`) when the totals are not needed. Defaults to `false`. (default to false)

Returns:

(MetricListResponse)

# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/metrics_api.rb', line 263

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 `-` for descending order. Default: `-recorded_at`. Allowed values: `recorded_at`, `-recorded_at`, `value`, `-value`. (default to ‘-recorded_at’)
:page_number (Integer) —

1-based page number to return. Optional; defaults to `1` when omitted. Must be `>= 1` — requests with a smaller value are rejected with a 400 error. (default to 1)
:page_size (Integer) —

Number of items per page. Optional; defaults to `1000` when omitted. Must be between `1` and `1000` inclusive — requests outside that range are rejected with a 400 error. (default to 1000)
:meta_total (Boolean) —

When `true`, the response's `meta.pagination` block includes `total` (the total number of matching items across all pages) and `total_pages`. Computing these requires an extra `COUNT` query, so omit (or pass `false`) when the totals are not needed. Defaults to `false`. (default to false)

Returns:

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

MetricListResponse data, response status code and response headers

# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/metrics_api.rb', line 278

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?
  query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'meta[total]'] = opts[:'meta_total'] if !opts[:'meta_total'].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

Class: SmplkitGeneratedClient::App::MetricsApi

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MetricsApi

Instance Attribute Details

#api_client ⇒ Object

Instance Method Details

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

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

#list_metric_names(opts = {}) ⇒ MetricNamesResponse

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

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

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

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

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

#initialize(api_client = ApiClient.default) ⇒ `MetricsApi`

#api_client ⇒ `Object`

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

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

#list_metric_names(opts = {}) ⇒ `MetricNamesResponse`

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

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

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

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

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