BehaviorCriteria (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BehaviorCriteria
extends Object
implements Serializable, Cloneable, StructuredPojo

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
`BehaviorCriteria`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getComparisonOperator()` The operator that relates the thing measured (`metric`) to the criteria (containing a `value` or `statisticalThreshold`).
`Integer`	`getConsecutiveDatapointsToAlarm()` If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs.
`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.
`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`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setComparisonOperator(String comparisonOperator)` The operator that relates the thing measured (`metric`) to the criteria (containing a `value` or `statisticalThreshold`).
`void`	`setConsecutiveDatapointsToAlarm(Integer consecutiveDatapointsToAlarm)` If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs.
`void`	`setConsecutiveDatapointsToClear(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(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`.
`String`	`toString()` Returns a string representation of this object.
`BehaviorCriteria`	`withComparisonOperator(ComparisonOperator comparisonOperator)` The operator that relates the thing measured (`metric`) to the criteria (containing a `value` or `statisticalThreshold`).
`BehaviorCriteria`	`withComparisonOperator(String comparisonOperator)` The operator that relates the thing measured (`metric`) to the criteria (containing a `value` or `statisticalThreshold`).
`BehaviorCriteria`	`withConsecutiveDatapointsToAlarm(Integer consecutiveDatapointsToAlarm)` If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs.
`BehaviorCriteria`	`withConsecutiveDatapointsToClear(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(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
  - setComparisonOperator
```
public void setComparisonOperator(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
    See Also:
    
    ComparisonOperator
  - getComparisonOperator
```
public 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
    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
  - withComparisonOperator
```
public BehaviorCriteria withComparisonOperator(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
  - 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
    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
  - setValue
```
public void setValue(MetricValue value)
```
    The value to be compared with the metric.
    
    Parameters:
    
    value - The value to be compared with the metric.
  - getValue
```
public MetricValue getValue()
```
    The value to be compared with the metric.
    
    Returns:
    
    The value to be compared with the metric.
  - withValue
```
public BehaviorCriteria withValue(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.
  - setDurationSeconds
```
public void setDurationSeconds(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.
  - getDurationSeconds
```
public 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.
  - withDurationSeconds
```
public BehaviorCriteria withDurationSeconds(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.
  - setConsecutiveDatapointsToAlarm
```
public void setConsecutiveDatapointsToAlarm(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.
  - getConsecutiveDatapointsToAlarm
```
public 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.
    
    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.
  - withConsecutiveDatapointsToAlarm
```
public BehaviorCriteria withConsecutiveDatapointsToAlarm(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.
  - setConsecutiveDatapointsToClear
```
public void setConsecutiveDatapointsToClear(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.
  - getConsecutiveDatapointsToClear
```
public 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.
    
    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.
  - withConsecutiveDatapointsToClear
```
public BehaviorCriteria withConsecutiveDatapointsToClear(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.
  - 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.
  - 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.
  - 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.
    
    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.
  - setMlDetectionConfig
```
public void setMlDetectionConfig(MachineLearningDetectionConfig mlDetectionConfig)
```
    The configuration of an ML Detect
    
    Parameters:
    
    mlDetectionConfig - The configuration of an ML Detect
  - getMlDetectionConfig
```
public MachineLearningDetectionConfig getMlDetectionConfig()
```
    The configuration of an ML Detect
    
    Returns:
    
    The configuration of an ML Detect
  - withMlDetectionConfig
```
public BehaviorCriteria withMlDetectionConfig(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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public BehaviorCriteria clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.773

Class BehaviorCriteria

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BehaviorCriteria

Method Detail

setComparisonOperator

getComparisonOperator

withComparisonOperator

withComparisonOperator

setValue

getValue

withValue

setDurationSeconds

getDurationSeconds

withDurationSeconds

setConsecutiveDatapointsToAlarm

getConsecutiveDatapointsToAlarm

withConsecutiveDatapointsToAlarm

setConsecutiveDatapointsToClear

getConsecutiveDatapointsToClear

withConsecutiveDatapointsToClear

setStatisticalThreshold

getStatisticalThreshold

withStatisticalThreshold

setMlDetectionConfig

getMlDetectionConfig

withMlDetectionConfig

toString

equals

hashCode

clone

marshall