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:

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Behavior.Builder,Behavior>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.