Package software.amazon.awscdk.services.stepfunctions

Interface TaskMetricsConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

TaskMetricsConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-27T16:51:05.972Z")
@Stability(Stable)
public interface TaskMetricsConfig
extends software.amazon.jsii.JsiiSerializable

Task Metrics.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.stepfunctions.*;
 Object metricDimensions;
 TaskMetricsConfig taskMetricsConfig = TaskMetricsConfig.builder()
         .metricDimensions(Map.of(
                 "metricDimensionsKey", metricDimensions))
         .metricPrefixPlural("metricPrefixPlural")
         .metricPrefixSingular("metricPrefixSingular")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	TaskMetricsConfig.Builder	A builder for TaskMetricsConfig
static final class	TaskMetricsConfig.Jsii$Proxy	An implementation for TaskMetricsConfig

Method Summary

Modifier and Type	Method	Description
static TaskMetricsConfig.Builder	builder()
default Map<String,Object>	getMetricDimensions()	The dimensions to attach to metrics.
default String	getMetricPrefixPlural()	Prefix for plural metric names of activity actions.
default String	getMetricPrefixSingular()	Prefix for singular metric names of activity actions.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMetricDimensions

@Stability(Stable)
@Nullable
default Map<String,Object> getMetricDimensions()

The dimensions to attach to metrics.

Default: - No metrics

getMetricPrefixPlural

@Stability(Stable)
@Nullable
default String getMetricPrefixPlural()

Prefix for plural metric names of activity actions.

Default: - No such metrics

getMetricPrefixSingular

@Stability(Stable)
@Nullable
default String getMetricPrefixSingular()

Prefix for singular metric names of activity actions.

Default: - No such metrics

builder

@Stability(Stable)
static TaskMetricsConfig.Builder builder()

Returns:

a TaskMetricsConfig.Builder of TaskMetricsConfig