Package software.amazon.awssdk.services.iot.model

Interface BehaviorCriteria.Builder

    • Method Detail

      • comparisonOperator

        BehaviorCriteria.Builder comparisonOperator​(String comparisonOperator)

        The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold). Valid operators include:

        • string-list: in-set and not-in-set

        • number-list: in-set and not-in-set

        • ip-address-list: in-cidr-set and not-in-cidr-set

        • number: less-than, less-than-equals, greater-than, and greater-than-equals

        Parameters:
        comparisonOperator - The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold). Valid operators include:

        • string-list: in-set and not-in-set

        • number-list: in-set and not-in-set

        • ip-address-list: in-cidr-set and not-in-cidr-set

        • number: less-than, less-than-equals, greater-than, and greater-than-equals

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ComparisonOperator, ComparisonOperator

      • comparisonOperator

        BehaviorCriteria.Builder comparisonOperator​(ComparisonOperator comparisonOperator)

        The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold). Valid operators include:

        • string-list: in-set and not-in-set

        • number-list: in-set and not-in-set

        • ip-address-list: in-cidr-set and not-in-cidr-set

        • number: less-than, less-than-equals, greater-than, and greater-than-equals

        Parameters:
        comparisonOperator - The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold). Valid operators include:

        • string-list: in-set and not-in-set

        • number-list: in-set and not-in-set

        • ip-address-list: in-cidr-set and not-in-cidr-set

        • number: less-than, less-than-equals, greater-than, and greater-than-equals

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ComparisonOperator, ComparisonOperator

      • value

        BehaviorCriteria.Builder value​(MetricValue value)

        The value to be compared with the metric.

        Parameters:
        value - The value to be compared with the metric.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • durationSeconds

        BehaviorCriteria.Builder durationSeconds​(Integer durationSeconds)

        Use this to specify the time duration over which the behavior is evaluated, for those criteria that have a time dimension (for example, NUM_MESSAGES_SENT). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank. Cannot be used with list-based metric datatypes.

        Parameters:
        durationSeconds - Use this to specify the time duration over which the behavior is evaluated, for those criteria that have a time dimension (for example, NUM_MESSAGES_SENT). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank. Cannot be used with list-based metric datatypes.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • consecutiveDatapointsToAlarm

        BehaviorCriteria.Builder consecutiveDatapointsToAlarm​(Integer consecutiveDatapointsToAlarm)

        If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.

        Parameters:
        consecutiveDatapointsToAlarm - If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • consecutiveDatapointsToClear

        BehaviorCriteria.Builder consecutiveDatapointsToClear​(Integer consecutiveDatapointsToClear)

        If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.

        Parameters:
        consecutiveDatapointsToClear - If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • statisticalThreshold

        BehaviorCriteria.Builder statisticalThreshold​(StatisticalThreshold statisticalThreshold)

        A statistical ranking (percentile)that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

        Parameters:
        statisticalThreshold - A statistical ranking (percentile)that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • mlDetectionConfig

        BehaviorCriteria.Builder mlDetectionConfig​(MachineLearningDetectionConfig mlDetectionConfig)

        The configuration of an ML Detect

        Parameters:
        mlDetectionConfig - The configuration of an ML Detect
        Returns:
        Returns a reference to this object so that method calls can be chained together.