AlarmState (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ioteventsdata.model.AlarmState

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AlarmState
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains information about the current state of the alarm.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AlarmState()

Constructors
Constructor and Description
`AlarmState()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AlarmState`	`clone()`
`boolean`	`equals(Object obj)`
`CustomerAction`	`getCustomerAction()` Contains information about the action that you can take to respond to the alarm.
`RuleEvaluation`	`getRuleEvaluation()` Information needed to evaluate data.
`String`	`getStateName()` The name of the alarm state.
`SystemEvent`	`getSystemEvent()` Contains information about alarm state changes.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCustomerAction(CustomerAction customerAction)` Contains information about the action that you can take to respond to the alarm.
`void`	`setRuleEvaluation(RuleEvaluation ruleEvaluation)` Information needed to evaluate data.
`void`	`setStateName(String stateName)` The name of the alarm state.
`void`	`setSystemEvent(SystemEvent systemEvent)` Contains information about alarm state changes.
`String`	`toString()` Returns a string representation of this object.
`AlarmState`	`withCustomerAction(CustomerAction customerAction)` Contains information about the action that you can take to respond to the alarm.
`AlarmState`	`withRuleEvaluation(RuleEvaluation ruleEvaluation)` Information needed to evaluate data.
`AlarmState`	`withStateName(AlarmStateName stateName)` The name of the alarm state.
`AlarmState`	`withStateName(String stateName)` The name of the alarm state.
`AlarmState`	`withSystemEvent(SystemEvent systemEvent)` Contains information about alarm state changes.

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

- Constructor Detail
  - AlarmState
```
public AlarmState()
```
- Method Detail
  - setStateName
```
public void setStateName(String stateName)
```
    The name of the alarm state. The state name can be one of the following values:
    - DISABLED - When the alarm is in the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state.
    - NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data.
    - ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.
    - ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm.
    - SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state.
    - LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL state, you must acknowledge the alarm.
    Parameters:
    stateName - The name of the alarm state. The state name can be one of the following values:
    
    DISABLED - When the alarm is in the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state.
    
    NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data.
    
    ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.
    
    ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm.
    
    SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state.
    
    LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL state, you must acknowledge the alarm.
    See Also:
    
    AlarmStateName
  - getStateName
```
public String getStateName()
```
    The name of the alarm state. The state name can be one of the following values:
    - DISABLED - When the alarm is in the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state.
    - NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data.
    - ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.
    - ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm.
    - SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state.
    - LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL state, you must acknowledge the alarm.
    Returns:
    The name of the alarm state. The state name can be one of the following values:
    
    DISABLED - When the alarm is in the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state.
    
    NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data.
    
    ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.
    
    ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm.
    
    SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state.
    
    LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL state, you must acknowledge the alarm.
    See Also:
    
    AlarmStateName
  - withStateName
```
public AlarmState withStateName(String stateName)
```
    The name of the alarm state. The state name can be one of the following values:
    - DISABLED - When the alarm is in the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state.
    - NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data.
    - ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.
    - ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm.
    - SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state.
    - LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL state, you must acknowledge the alarm.
    Parameters:
    stateName - The name of the alarm state. The state name can be one of the following values:
    
    DISABLED - When the alarm is in the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state.
    
    NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data.
    
    ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.
    
    ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm.
    
    SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state.
    
    LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL state, you must acknowledge the alarm.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AlarmStateName
  - withStateName
```
public AlarmState withStateName(AlarmStateName stateName)
```
    The name of the alarm state. The state name can be one of the following values:
    - DISABLED - When the alarm is in the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state.
    - NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data.
    - ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.
    - ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm.
    - SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state.
    - LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL state, you must acknowledge the alarm.
    Parameters:
    stateName - The name of the alarm state. The state name can be one of the following values:
    
    DISABLED - When the alarm is in the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state.
    
    NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data.
    
    ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.
    
    ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm.
    
    SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state.
    
    LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL state, you must acknowledge the alarm.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AlarmStateName
  - setRuleEvaluation
```
public void setRuleEvaluation(RuleEvaluation ruleEvaluation)
```
    Information needed to evaluate data.
    
    Parameters:
    
    ruleEvaluation - Information needed to evaluate data.
  - getRuleEvaluation
```
public RuleEvaluation getRuleEvaluation()
```
    Information needed to evaluate data.
    
    Returns:
    
    Information needed to evaluate data.
  - withRuleEvaluation
```
public AlarmState withRuleEvaluation(RuleEvaluation ruleEvaluation)
```
    Information needed to evaluate data.
    
    Parameters:
    
    ruleEvaluation - Information needed to evaluate data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCustomerAction
```
public void setCustomerAction(CustomerAction customerAction)
```
    Contains information about the action that you can take to respond to the alarm.
    
    Parameters:
    
    customerAction - Contains information about the action that you can take to respond to the alarm.
  - getCustomerAction
```
public CustomerAction getCustomerAction()
```
    Contains information about the action that you can take to respond to the alarm.
    
    Returns:
    
    Contains information about the action that you can take to respond to the alarm.
  - withCustomerAction
```
public AlarmState withCustomerAction(CustomerAction customerAction)
```
    Contains information about the action that you can take to respond to the alarm.
    
    Parameters:
    
    customerAction - Contains information about the action that you can take to respond to the alarm.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSystemEvent
```
public void setSystemEvent(SystemEvent systemEvent)
```
    Contains information about alarm state changes.
    
    Parameters:
    
    systemEvent - Contains information about alarm state changes.
  - getSystemEvent
```
public SystemEvent getSystemEvent()
```
    Contains information about alarm state changes.
    
    Returns:
    
    Contains information about alarm state changes.
  - withSystemEvent
```
public AlarmState withSystemEvent(SystemEvent systemEvent)
```
    Contains information about alarm state changes.
    
    Parameters:
    
    systemEvent - Contains information about alarm state changes.
    
    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 AlarmState 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.780

Class AlarmState

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AlarmState

Method Detail

setStateName

getStateName

withStateName

withStateName

setRuleEvaluation

getRuleEvaluation

withRuleEvaluation

setCustomerAction

getCustomerAction

withCustomerAction

setSystemEvent

getSystemEvent

withSystemEvent

toString

equals

hashCode

clone

marshall