Package software.amazon.awssdk.services.iot.model

Class Behavior

java.lang.Object

software.amazon.awssdk.services.iot.model.Behavior

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Behavior.Builder,Behavior>

@Generated("software.amazon.awssdk:codegen")
public final class Behavior
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Behavior.Builder,Behavior>

A Device Defender security profile behavior.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Behavior.Builder

Method Summary

Modifier and Type	Method	Description
static Behavior.Builder	builder()
BehaviorCriteria	criteria()	The criteria that determine if a device is behaving normally in regard to the metric.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	exportMetric()	Value indicates exporting metrics related to the behavior when it is true.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	metric()	What is measured by the behavior.
MetricDimension	metricDimension()	The dimension for a metric in your behavior.
String	name()	The name you've given to the behavior.
List<SdkField<?>>	sdkFields()
static Class<? extends Behavior.Builder>	serializableBuilderClass()
Boolean	suppressAlerts()	Suppresses alerts.
Behavior.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

name

public final String name()

The name you've given to the behavior.

Returns:

The name you've given to the behavior.

metric

public final String metric()

What is measured by the behavior.

Returns:

What is measured by the behavior.

metricDimension

public final MetricDimension metricDimension()

The dimension for a metric in your behavior. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric to only MQTT topics where the name matches the pattern specified in the dimension. This can't be used with custom metrics.

Returns:

The dimension for a metric in your behavior. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric to only MQTT topics where the name matches the pattern specified in the dimension. This can't be used with custom metrics.

criteria

public final BehaviorCriteria criteria()

The criteria that determine if a device is behaving normally in regard to the metric.

In the IoT console, you can choose to be sent an alert through Amazon SNS when IoT Device Defender detects that a device is behaving anomalously.

Returns:

The criteria that determine if a device is behaving normally in regard to the metric.

In the IoT console, you can choose to be sent an alert through Amazon SNS when IoT Device Defender detects that a device is behaving anomalously.

suppressAlerts

public final Boolean suppressAlerts()

Suppresses alerts.

Returns:

Suppresses alerts.

exportMetric

public final Boolean exportMetric()

Value indicates exporting metrics related to the behavior when it is true.

Returns:

Value indicates exporting metrics related to the behavior when it is true.

toBuilder

public Behavior.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Behavior.Builder,Behavior>

builder

public static Behavior.Builder builder()

serializableBuilderClass

public static Class<? extends Behavior.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