Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsQueryResult

Package version

Metrics, including additional information like cost, the resourceRegion, etc...

Hierarchy

  • MetricsQueryResult

Index

Properties

Optional cost

cost: undefined | number

The integer value representing the cost of the query, for data case.

Optional granularity

granularity: undefined | string

The interval (window size) for which the metric data was returned in. This may be adjusted in the future and returned back from what was originally requested. This is not present if a metadata request was made.

metrics

metrics: Metric[]

the value of the collection.

Optional namespace

namespace: undefined | string

The namespace of the metrics been queried

Optional resourceRegion

resourceRegion: undefined | string

The region of the resource been queried for metrics.

timespan

timespan: TimeInterval

The timespan for which the data was retrieved. Its value consists of two datetimes concatenated, separated by '/'. This may be adjusted in the future and returned back from what was originally requested.

Methods

getMetricByName

  • getMetricByName(metricName: string): Metric | undefined

Generated using TypeDoc