BehaviorCriteria (AWS SDK for Android

java.lang.Object
- com.amazonaws.services.iot.model.BehaviorCriteria

All Implemented Interfaces:

java.io.Serializable
```
public class BehaviorCriteria
extends java.lang.Object
implements java.io.Serializable
```
The criteria by which the behavior is determined to be normal.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

BehaviorCriteria()

Constructors
Constructor and Description
`BehaviorCriteria()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getComparisonOperator()` The operator that relates the thing measured (`metric`) to the criteria (containing a `value` or `statisticalThreshold`).
`java.lang.Integer`	`getConsecutiveDatapointsToAlarm()` If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs.
`java.lang.Integer`	`getConsecutiveDatapointsToClear()` 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.
`java.lang.Integer`	`getDurationSeconds()` 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`).
`MachineLearningDetectionConfig`	`getMlDetectionConfig()` The configuration of an ML Detect
`StatisticalThreshold`	`getStatisticalThreshold()` 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.
`MetricValue`	`getValue()` The value to be compared with the `metric`.
`int`	`hashCode()`
`void`	`setComparisonOperator(ComparisonOperator comparisonOperator)` The operator that relates the thing measured (`metric`) to the criteria (containing a `value` or `statisticalThreshold`).
`void`	`setComparisonOperator(java.lang.String comparisonOperator)` The operator that relates the thing measured (`metric`) to the criteria (containing a `value` or `statisticalThreshold`).
`void`	`setConsecutiveDatapointsToAlarm(java.lang.Integer consecutiveDatapointsToAlarm)` If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs.
`void`	`setConsecutiveDatapointsToClear(java.lang.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.
`void`	`setDurationSeconds(java.lang.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`).
`void`	`setMlDetectionConfig(MachineLearningDetectionConfig mlDetectionConfig)` The configuration of an ML Detect
`void`	`setStatisticalThreshold(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.
`void`	`setValue(MetricValue value)` The value to be compared with the `metric`.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`BehaviorCriteria`	`withComparisonOperator(ComparisonOperator comparisonOperator)` The operator that relates the thing measured (`metric`) to the criteria (containing a `value` or `statisticalThreshold`).
`BehaviorCriteria`	`withComparisonOperator(java.lang.String comparisonOperator)` The operator that relates the thing measured (`metric`) to the criteria (containing a `value` or `statisticalThreshold`).
`BehaviorCriteria`	`withConsecutiveDatapointsToAlarm(java.lang.Integer consecutiveDatapointsToAlarm)` If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs.
`BehaviorCriteria`	`withConsecutiveDatapointsToClear(java.lang.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.
`BehaviorCriteria`	`withDurationSeconds(java.lang.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`).
`BehaviorCriteria`	`withMlDetectionConfig(MachineLearningDetectionConfig mlDetectionConfig)` The configuration of an ML Detect
`BehaviorCriteria`	`withStatisticalThreshold(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`	`withValue(MetricValue value)` The value to be compared with the `metric`.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BehaviorCriteria
```
public BehaviorCriteria()
```
- Method Detail
  - getComparisonOperator
```
public java.lang.String getComparisonOperator()
```
    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
    Constraints:
    Allowed Values: less-than, less-than-equals, greater-than, greater-than-equals, in-cidr-set, not-in-cidr-set, in-port-set, not-in-port-set, in-set, not-in-set
    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
  - setComparisonOperator
```
public void setComparisonOperator(java.lang.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
    Constraints:
    Allowed Values: less-than, less-than-equals, greater-than, greater-than-equals, in-cidr-set, not-in-cidr-set, in-port-set, not-in-port-set, in-set, not-in-set
    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
    See Also:
    
    ComparisonOperator
  - withComparisonOperator
```
public BehaviorCriteria withComparisonOperator(java.lang.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
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: less-than, less-than-equals, greater-than, greater-than-equals, in-cidr-set, not-in-cidr-set, in-port-set, not-in-port-set, in-set, not-in-set
    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:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    ComparisonOperator
  - setComparisonOperator
```
public void setComparisonOperator(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
    Constraints:
    Allowed Values: less-than, less-than-equals, greater-than, greater-than-equals, in-cidr-set, not-in-cidr-set, in-port-set, not-in-port-set, in-set, not-in-set
    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
    See Also:
    
    ComparisonOperator
  - withComparisonOperator
```
public BehaviorCriteria withComparisonOperator(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
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: less-than, less-than-equals, greater-than, greater-than-equals, in-cidr-set, not-in-cidr-set, in-port-set, not-in-port-set, in-set, not-in-set
    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:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    ComparisonOperator
  - getValue
```
public MetricValue getValue()
```
    The value to be compared with the metric.
    
    Returns:
    
    The value to be compared with the metric.
  - setValue
```
public void setValue(MetricValue value)
```
    The value to be compared with the metric.
    
    Parameters:
    
    value -
    The value to be compared with the metric.
  - withValue
```
public BehaviorCriteria withValue(MetricValue value)
```
    The value to be compared with the metric.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    value -
    The value to be compared with the metric.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getDurationSeconds
```
public java.lang.Integer getDurationSeconds()
```
    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.
  - setDurationSeconds
```
public void setDurationSeconds(java.lang.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.
  - withDurationSeconds
```
public BehaviorCriteria withDurationSeconds(java.lang.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 a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getConsecutiveDatapointsToAlarm
```
public java.lang.Integer getConsecutiveDatapointsToAlarm()
```
    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.
    
    Constraints:
    Range: 1 - 10
    
    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.
  - setConsecutiveDatapointsToAlarm
```
public void setConsecutiveDatapointsToAlarm(java.lang.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.
    
    Constraints:
    Range: 1 - 10
    
    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.
  - withConsecutiveDatapointsToAlarm
```
public BehaviorCriteria withConsecutiveDatapointsToAlarm(java.lang.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 a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 1 - 10
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getConsecutiveDatapointsToClear
```
public java.lang.Integer getConsecutiveDatapointsToClear()
```
    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.
    
    Constraints:
    Range: 1 - 10
    
    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.
  - setConsecutiveDatapointsToClear
```
public void setConsecutiveDatapointsToClear(java.lang.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.
    
    Constraints:
    Range: 1 - 10
    
    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.
  - withConsecutiveDatapointsToClear
```
public BehaviorCriteria withConsecutiveDatapointsToClear(java.lang.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 a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 1 - 10
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getStatisticalThreshold
```
public StatisticalThreshold getStatisticalThreshold()
```
    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.
  - setStatisticalThreshold
```
public void setStatisticalThreshold(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.
  - withStatisticalThreshold
```
public BehaviorCriteria withStatisticalThreshold(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 reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getMlDetectionConfig
```
public MachineLearningDetectionConfig getMlDetectionConfig()
```
    The configuration of an ML Detect
    
    Returns:
    
    The configuration of an ML Detect
  - setMlDetectionConfig
```
public void setMlDetectionConfig(MachineLearningDetectionConfig mlDetectionConfig)
```
    The configuration of an ML Detect
    
    Parameters:
    
    mlDetectionConfig -
    The configuration of an ML Detect
  - withMlDetectionConfig
```
public BehaviorCriteria withMlDetectionConfig(MachineLearningDetectionConfig mlDetectionConfig)
```
    The configuration of an ML Detect
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    mlDetectionConfig -
    The configuration of an ML Detect
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class BehaviorCriteria

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BehaviorCriteria

Method Detail

getComparisonOperator

setComparisonOperator

withComparisonOperator

setComparisonOperator

withComparisonOperator

getValue

setValue

withValue

getDurationSeconds

setDurationSeconds

withDurationSeconds

getConsecutiveDatapointsToAlarm

setConsecutiveDatapointsToAlarm

withConsecutiveDatapointsToAlarm

getConsecutiveDatapointsToClear

setConsecutiveDatapointsToClear

withConsecutiveDatapointsToClear

getStatisticalThreshold

setStatisticalThreshold

withStatisticalThreshold

getMlDetectionConfig

setMlDetectionConfig

withMlDetectionConfig

toString

hashCode

equals