Class BehaviorCriteria

java.lang.Object
software.amazon.awssdk.services.iot.model.BehaviorCriteria
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<BehaviorCriteria.Builder,BehaviorCriteria>
@Generated("software.amazon.awssdk:codegen") public final class BehaviorCriteria extends Object implements SdkPojo, Serializable, ToCopyableBuilder<BehaviorCriteria.Builder,BehaviorCriteria>

The criteria by which the behavior is determined to be normal.

See Also:

  • Method Details

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

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

    • 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

    • toBuilder

      public BehaviorCriteria.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<BehaviorCriteria.Builder,BehaviorCriteria>
      Returns:
      a builder for type T

    • builder

      public static BehaviorCriteria.Builder builder()

    • serializableBuilderClass

      public static Class<? extends BehaviorCriteria.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.