Behavior (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

A Device Defender security profile behavior.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

Behavior()

Constructors
Constructor and Description
`Behavior()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Behavior`	`clone()`
`boolean`	`equals(Object obj)`
`BehaviorCriteria`	`getCriteria()` The criteria that determine if a device is behaving normally in regard to the `metric`.
`Boolean`	`getExportMetric()` Value indicates exporting metrics related to the behavior when it is true.
`String`	`getMetric()` What is measured by the behavior.
`MetricDimension`	`getMetricDimension()` The dimension for a metric in your behavior.
`String`	`getName()` The name you've given to the behavior.
`Boolean`	`getSuppressAlerts()` Suppresses alerts.
`int`	`hashCode()`
`Boolean`	`isExportMetric()` Value indicates exporting metrics related to the behavior when it is true.
`Boolean`	`isSuppressAlerts()` Suppresses alerts.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCriteria(BehaviorCriteria criteria)` The criteria that determine if a device is behaving normally in regard to the `metric`.
`void`	`setExportMetric(Boolean exportMetric)` Value indicates exporting metrics related to the behavior when it is true.
`void`	`setMetric(String metric)` What is measured by the behavior.
`void`	`setMetricDimension(MetricDimension metricDimension)` The dimension for a metric in your behavior.
`void`	`setName(String name)` The name you've given to the behavior.
`void`	`setSuppressAlerts(Boolean suppressAlerts)` Suppresses alerts.
`String`	`toString()` Returns a string representation of this object.
`Behavior`	`withCriteria(BehaviorCriteria criteria)` The criteria that determine if a device is behaving normally in regard to the `metric`.
`Behavior`	`withExportMetric(Boolean exportMetric)` Value indicates exporting metrics related to the behavior when it is true.
`Behavior`	`withMetric(String metric)` What is measured by the behavior.
`Behavior`	`withMetricDimension(MetricDimension metricDimension)` The dimension for a metric in your behavior.
`Behavior`	`withName(String name)` The name you've given to the behavior.
`Behavior`	`withSuppressAlerts(Boolean suppressAlerts)` Suppresses alerts.

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

- Constructor Detail
  - Behavior
```
public Behavior()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name you've given to the behavior.
    
    Parameters:
    
    name - The name you've given to the behavior.
  - getName
```
public String getName()
```
    The name you've given to the behavior.
    
    Returns:
    
    The name you've given to the behavior.
  - withName
```
public Behavior withName(String name)
```
    The name you've given to the behavior.
    
    Parameters:
    
    name - The name you've given to the behavior.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetric
```
public void setMetric(String metric)
```
    What is measured by the behavior.
    
    Parameters:
    
    metric - What is measured by the behavior.
  - getMetric
```
public String getMetric()
```
    What is measured by the behavior.
    
    Returns:
    
    What is measured by the behavior.
  - withMetric
```
public Behavior withMetric(String metric)
```
    What is measured by the behavior.
    
    Parameters:
    
    metric - What is measured by the behavior.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetricDimension
```
public void setMetricDimension(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.
    
    Parameters:
    
    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.
  - getMetricDimension
```
public MetricDimension getMetricDimension()
```
    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.
  - withMetricDimension
```
public Behavior withMetricDimension(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCriteria
```
public void setCriteria(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.
    
    Parameters:
    
    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.
  - getCriteria
```
public BehaviorCriteria getCriteria()
```
    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.
  - withCriteria
```
public Behavior withCriteria(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSuppressAlerts
```
public void setSuppressAlerts(Boolean suppressAlerts)
```
    Suppresses alerts.
    
    Parameters:
    
    suppressAlerts - Suppresses alerts.
  - getSuppressAlerts
```
public Boolean getSuppressAlerts()
```
    Suppresses alerts.
    
    Returns:
    
    Suppresses alerts.
  - withSuppressAlerts
```
public Behavior withSuppressAlerts(Boolean suppressAlerts)
```
    Suppresses alerts.
    
    Parameters:
    
    suppressAlerts - Suppresses alerts.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isSuppressAlerts
```
public Boolean isSuppressAlerts()
```
    Suppresses alerts.
    
    Returns:
    
    Suppresses alerts.
  - setExportMetric
```
public void setExportMetric(Boolean exportMetric)
```
    Value indicates exporting metrics related to the behavior when it is true.
    
    Parameters:
    
    exportMetric - Value indicates exporting metrics related to the behavior when it is true.
  - getExportMetric
```
public Boolean getExportMetric()
```
    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.
  - withExportMetric
```
public Behavior withExportMetric(Boolean exportMetric)
```
    Value indicates exporting metrics related to the behavior when it is true.
    
    Parameters:
    
    exportMetric - Value indicates exporting metrics related to the behavior when it is true.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isExportMetric
```
public Boolean isExportMetric()
```
    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.
  - 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 Behavior 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 Behavior

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Behavior

Method Detail

setName

getName

withName

setMetric

getMetric

withMetric

setMetricDimension

getMetricDimension

withMetricDimension

setCriteria

getCriteria

withCriteria

setSuppressAlerts

getSuppressAlerts

withSuppressAlerts

isSuppressAlerts

setExportMetric

getExportMetric

withExportMetric

isExportMetric

toString

equals

hashCode

clone

marshall