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

Class BehaviorCriteria

    • Method Detail

      • comparisonOperator

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

        If the service returns an enum value that is not available in the current SDK version, comparisonOperator will return ComparisonOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from comparisonOperatorAsString().

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

        See Also:
        ComparisonOperator

      • comparisonOperatorAsString

        public final String comparisonOperatorAsString()

        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

        If the service returns an enum value that is not available in the current SDK version, comparisonOperator will return ComparisonOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from comparisonOperatorAsString().

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

        See Also:
        ComparisonOperator

      • value

        public final MetricValue value()

        The value to be compared with the metric.

        Returns:
        The value to be compared with the metric.

      • durationSeconds

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

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

      • consecutiveDatapointsToAlarm

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

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

      • consecutiveDatapointsToClear

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

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

      • statisticalThreshold

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

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

      • mlDetectionConfig

        public final MachineLearningDetectionConfig mlDetectionConfig()

        The configuration of an ML Detect

        Returns:
        The configuration of an ML Detect

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