software.amazon.awssdk.services.iotsitewise.model

Class Metric

java.lang.Object

software.amazon.awssdk.services.iotsitewise.model.Metric

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Metric.Builder,Metric>

@Generated(value="software.amazon.awssdk:codegen")
public final class Metric
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Metric.Builder,Metric>

Contains an asset metric property. With metrics, you can calculate aggregate functions, such as an average, maximum, or minimum, as specified through an expression. A metric maps several values to a single value (such as a sum).

The maximum number of dependent/cascading variables used in any one metric calculation is 10. Therefore, a root metric can have up to 10 cascading metrics in its computational dependency tree. Additionally, a metric can only have a data type of DOUBLE and consume properties with data types of INTEGER or DOUBLE.

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Metric.Builder

Method Summary

Modifier and Type	Method and Description
static Metric.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	expression() The mathematical expression that defines the metric aggregation function.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasVariables() Returns true if the Variables property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<SdkField<?>>	sdkFields()
static Class<? extends Metric.Builder>	serializableBuilderClass()
Metric.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<ExpressionVariable>	variables() The list of variables used in the expression.
MetricWindow	window() The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

expression

public final 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 AWS IoT SiteWise User Guide.

Returns:

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 AWS IoT SiteWise User Guide.

hasVariables

public final boolean hasVariables()

Returns true if the Variables property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

variables

public final List<ExpressionVariable> variables()

The list of variables used in the expression.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasVariables() to see if a value was sent in this field.

Returns:

The list of variables used in the expression.

window

public final MetricWindow window()

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

Returns:

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

toBuilder

public Metric.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Metric.Builder,Metric>

builder

public static Metric.Builder builder()

serializableBuilderClass

public static Class<? extends Metric.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo