software.amazon.awssdk.services.iot.model

Class BehaviorCriteria

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

Method Summary

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 which 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()
List<SdkField<?>>	sdkFields()
static Class<? extends BehaviorCriteria.Builder>	serializableBuilderClass()
StatisticalThreshold	statisticalThreshold() A statistical ranking (percentile) which 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 ComparisonOperator comparisonOperator()

The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold).

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

See Also:

ComparisonOperator

comparisonOperatorAsString

public String comparisonOperatorAsString()

The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold).

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

See Also:

ComparisonOperator

value

public MetricValue value()

The value to be compared with the metric.

Returns:

The value to be compared with the metric.

durationSeconds

public Integer durationSeconds()

Use this to specify the time duration over which the behavior is evaluated, for those criteria which 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.

Returns:

Use this to specify the time duration over which the behavior is evaluated, for those criteria which 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.

consecutiveDatapointsToAlarm

public 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 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 StatisticalThreshold statisticalThreshold()

A statistical ranking (percentile) which 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) which indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo