Class SimpleMetricDataProviderBaseAbstract

Base class to help implement a MetricDataProvider that fetches one region and metric at a time. To support fetching multiple regions and metrics simultaneously, implement MetricDataProvider directly.

Hierarchy

Implements

Constructors

Properties

Methods

Constructors

Properties

id: string

A unique provider id to associate with the provider (e.g. "mock"). This ID can be used from a MetricDataReference in a metric to reference the data from this provider.

Methods

  • Method to be overridden by subclasses to fetch the specified MetricData.

    Returns

    The MetricData for the given metric and region.

    Parameters

    • region: Region

      The region to get data for.

    • metric: Metric

      The metric to get data for.

    • includeTimeseries: boolean

      Whether to get timeseries data.

    • metricCatalog: MetricCatalog

      The metric catalog using this data provider. The data provider can call back into the catalog if it needs to fetch dependent data.

    Returns Promise<MetricData<unknown>>

Generated using TypeDoc