Package software.amazon.awssdk.services.iotsitewise.model

Interface Metric.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Metric.Builder,Metric>, SdkBuilder<Metric.Builder,Metric>, SdkPojo

Enclosing class:

Metric

public static interface Metric.Builder
extends SdkPojo, CopyableBuilder<Metric.Builder,Metric>

Method Summary

Modifier and Type	Method	Description
Metric.Builder	expression(String expression)	The mathematical expression that defines the metric aggregation function.
default Metric.Builder	processingConfig(Consumer<MetricProcessingConfig.Builder> processingConfig)	The processing configuration for the given metric property.
Metric.Builder	processingConfig(MetricProcessingConfig processingConfig)	The processing configuration for the given metric property.
Metric.Builder	variables(Collection<ExpressionVariable> variables)	The list of variables used in the expression.
Metric.Builder	variables(Consumer<ExpressionVariable.Builder>... variables)	The list of variables used in the expression.
Metric.Builder	variables(ExpressionVariable... variables)	The list of variables used in the expression.
default Metric.Builder	window(Consumer<MetricWindow.Builder> window)	The window (time interval) over which IoT SiteWise computes the metric's aggregation expression.
Metric.Builder	window(MetricWindow window)	The window (time interval) over which IoT SiteWise computes the metric's aggregation expression.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

expression

Metric.Builder expression(String expression)

The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

For more information, see Quotas in the IoT SiteWise User Guide.

Parameters:

expression - The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

For more information, see Quotas in the IoT SiteWise User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

variables

Metric.Builder variables(Collection<ExpressionVariable> variables)

The list of variables used in the expression.

Parameters:

variables - The list of variables used in the expression.

Returns:

Returns a reference to this object so that method calls can be chained together.

variables

Metric.Builder variables(ExpressionVariable... variables)

The list of variables used in the expression.

Parameters:

variables - The list of variables used in the expression.

Returns:

Returns a reference to this object so that method calls can be chained together.

variables

Metric.Builder variables(Consumer<ExpressionVariable.Builder>... variables)

The list of variables used in the expression.

This is a convenience method that creates an instance of the ExpressionVariable.Builder avoiding the need to create one manually via ExpressionVariable.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #variables(List).

Parameters:

variables - a consumer that will call methods on ExpressionVariable.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#variables(java.util.Collection)

window

Metric.Builder window(MetricWindow window)

The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per window.

Parameters:

window - The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per window.

Returns:

Returns a reference to this object so that method calls can be chained together.

window

default Metric.Builder window(Consumer<MetricWindow.Builder> window)

The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per window.

This is a convenience method that creates an instance of the MetricWindow.Builder avoiding the need to create one manually via MetricWindow.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to window(MetricWindow).

Parameters:

window - a consumer that will call methods on MetricWindow.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

window(MetricWindow)

processingConfig

Metric.Builder processingConfig(MetricProcessingConfig processingConfig)

The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.

Parameters:

processingConfig - The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.

Returns:

Returns a reference to this object so that method calls can be chained together.

processingConfig

default Metric.Builder processingConfig(Consumer<MetricProcessingConfig.Builder> processingConfig)

The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.

This is a convenience method that creates an instance of the MetricProcessingConfig.Builder avoiding the need to create one manually via MetricProcessingConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to processingConfig(MetricProcessingConfig).

Parameters:

processingConfig - a consumer that will call methods on MetricProcessingConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

processingConfig(MetricProcessingConfig)