Interface MetricConfig

All Superinterfaces:
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:36.877Z") @Stability(Stable) public interface MetricConfig extends
Properties of a rendered metric.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 Metric metric;
 Object renderingProperties;
 Object value;
 MetricConfig metricConfig = MetricConfig.builder()
                         "usingMetricsKey", metric))
                 // the properties below are optional
                 // the properties below are optional
                 "renderingPropertiesKey", renderingProperties))
  • Method Details

    • getMathExpression

      @Stability(Stable) @Nullable default MetricExpressionConfig getMathExpression()
      In case the metric is a math expression, the details of the math expression.

      Default: - None

    • getMetricStat

      @Stability(Stable) @Nullable default MetricStatConfig getMetricStat()
      In case the metric represents a query, the details of the query.

      Default: - None

    • getRenderingProperties

      @Stability(Stable) @Nullable default Map<String,Object> getRenderingProperties()
      Additional properties which will be rendered if the metric is used in a dashboard.

      Examples are 'label' and 'color', but any key in here will be added to dashboard graphs.

      Default: - None

    • builder

      @Stability(Stable) static MetricConfig.Builder builder()
      a MetricConfig.Builder of MetricConfig