BehaviorCriteria (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.iot.model.BehaviorCriteria

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<BehaviorCriteria.Builder,BehaviorCriteria>

@Generated(value="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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface BehaviorCriteria.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`BehaviorCriteria.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static BehaviorCriteria.Builder`	`builder()`
`ComparisonOperator`	`comparisonOperator()` The operator that relates the thing measured (`metric`) to the criteria (containing a `value` or `statisticalThreshold`).
`String`	`comparisonOperatorAsString()` The operator that relates the thing measured (`metric`) to the criteria (containing a `value` or `statisticalThreshold`).
`Integer`	`consecutiveDatapointsToAlarm()` If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs.
`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.
`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`).
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`MachineLearningDetectionConfig`	`mlDetectionConfig()` The configuration of an ML Detect
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends BehaviorCriteria.Builder>`	`serializableBuilderClass()`
`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.
`BehaviorCriteria.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`MetricValue`	`value()` The value to be compared with the `metric`.

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
  - 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
  - toBuilder
```
public BehaviorCriteria.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<BehaviorCriteria.Builder,BehaviorCriteria>
  - 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)
```
    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

Class BehaviorCriteria

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

comparisonOperator

comparisonOperatorAsString

value

durationSeconds

consecutiveDatapointsToAlarm

consecutiveDatapointsToClear

statisticalThreshold

mlDetectionConfig

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields