Class MetricsQueryMetadata

Object containing all metric names returned and their associated metadata.

Hierarchy

  • MetricsQueryMetadata

Constructors

constructor

Properties

additionalProperties? aggr? displayName? end? expression? interval? length? metric? pointlist? queryIndex? scope? start? tagSet? unit?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional aggr

aggr?: string

Aggregation type.

Optional displayName

displayName?: string

Display name of the metric.

Optional end

end?: number

End of the time window, milliseconds since Unix epoch.

Optional expression

expression?: string

Metric expression.

Optional interval

interval?: number

Number of milliseconds between data samples.

Optional length

length?: number

Number of data samples.

Optional metric

metric?: string

Metric name.

Optional pointlist

pointlist?: [number, number][]

List of points of the timeseries in milliseconds.

Optional queryIndex

queryIndex?: number

The index of the series' query within the request.

Optional scope

scope?: string

Metric scope, comma separated list of tags.

Optional start

start?: number

Start of the time window, milliseconds since Unix epoch.

Optional tagSet

tagSet?: string[]

Unique tags identifying this series.

Optional unit

unit?: [MetricsQueryUnit, MetricsQueryUnit]

Detailed information about the metric unit. The first element describes the "primary unit" (for example, bytes in bytes per second). The second element describes the "per unit" (for example, second in bytes per second). If the second element is not present, the API returns null.

Settings

Member Visibility

Theme

Generated using TypeDoc