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

Class Metric

  • All Implemented Interfaces:
    Serializable, SdkPojo, ToCopyableBuilder<Metric.Builder,​Metric>
    @Generated("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 IoT SiteWise User Guide.

    See Also:
    Serialized Form

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

      • hasVariables

        public final boolean hasVariables()
        For responses, this returns true if the service returned a value for the Variables property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • 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.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVariables() method.

        Returns:
        The list of variables used in the expression.

      • window

        public final MetricWindow window()

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

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

      • processingConfig

        public final 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.

        Returns:
        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.

      • 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

      • 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)