AlarmSummary (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Contains a summary of an alarm.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AlarmSummary()

Constructors
Constructor and Description
`AlarmSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AlarmSummary`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAlarmModelName()` The name of the alarm model.
`String`	`getAlarmModelVersion()` The version of the alarm model.
`Date`	`getCreationTime()` The time the alarm was created, in the Unix epoch format.
`String`	`getKeyValue()` The value of the key used as a filter to select only the alarms associated with the key.
`Date`	`getLastUpdateTime()` The time the alarm was last updated, in the Unix epoch format.
`String`	`getStateName()` The name of the alarm state.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAlarmModelName(String alarmModelName)` The name of the alarm model.
`void`	`setAlarmModelVersion(String alarmModelVersion)` The version of the alarm model.
`void`	`setCreationTime(Date creationTime)` The time the alarm was created, in the Unix epoch format.
`void`	`setKeyValue(String keyValue)` The value of the key used as a filter to select only the alarms associated with the key.
`void`	`setLastUpdateTime(Date lastUpdateTime)` The time the alarm was last updated, in the Unix epoch format.
`void`	`setStateName(String stateName)` The name of the alarm state.
`String`	`toString()` Returns a string representation of this object.
`AlarmSummary`	`withAlarmModelName(String alarmModelName)` The name of the alarm model.
`AlarmSummary`	`withAlarmModelVersion(String alarmModelVersion)` The version of the alarm model.
`AlarmSummary`	`withCreationTime(Date creationTime)` The time the alarm was created, in the Unix epoch format.
`AlarmSummary`	`withKeyValue(String keyValue)` The value of the key used as a filter to select only the alarms associated with the key.
`AlarmSummary`	`withLastUpdateTime(Date lastUpdateTime)` The time the alarm was last updated, in the Unix epoch format.
`AlarmSummary`	`withStateName(AlarmStateName stateName)` The name of the alarm state.
`AlarmSummary`	`withStateName(String stateName)` The name of the alarm state.

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

- Constructor Detail
  - AlarmSummary
```
public AlarmSummary()
```
- Method Detail
  - setAlarmModelName
```
public void setAlarmModelName(String alarmModelName)
```
    The name of the alarm model.
    
    Parameters:
    
    alarmModelName - The name of the alarm model.
  - getAlarmModelName
```
public String getAlarmModelName()
```
    The name of the alarm model.
    
    Returns:
    
    The name of the alarm model.
  - withAlarmModelName
```
public AlarmSummary withAlarmModelName(String alarmModelName)
```
    The name of the alarm model.
    
    Parameters:
    
    alarmModelName - The name of the alarm model.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAlarmModelVersion
```
public void setAlarmModelVersion(String alarmModelVersion)
```
    The version of the alarm model.
    
    Parameters:
    
    alarmModelVersion - The version of the alarm model.
  - getAlarmModelVersion
```
public String getAlarmModelVersion()
```
    The version of the alarm model.
    
    Returns:
    
    The version of the alarm model.
  - withAlarmModelVersion
```
public AlarmSummary withAlarmModelVersion(String alarmModelVersion)
```
    The version of the alarm model.
    
    Parameters:
    
    alarmModelVersion - The version of the alarm model.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKeyValue
```
public void setKeyValue(String keyValue)
```
    The value of the key used as a filter to select only the alarms associated with the key.
    
    Parameters:
    
    keyValue - The value of the key used as a filter to select only the alarms associated with the key.
  - getKeyValue
```
public String getKeyValue()
```
    The value of the key used as a filter to select only the alarms associated with the key.
    
    Returns:
    
    The value of the key used as a filter to select only the alarms associated with the key.
  - withKeyValue
```
public AlarmSummary withKeyValue(String keyValue)
```
    The value of the key used as a filter to select only the alarms associated with the key.
    
    Parameters:
    
    keyValue - The value of the key used as a filter to select only the alarms associated with the key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 AlarmSummary 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 AlarmSummary 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
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    The time the alarm was created, in the Unix epoch format.
    
    Parameters:
    
    creationTime - The time the alarm was created, in the Unix epoch format.
  - getCreationTime
```
public Date getCreationTime()
```
    The time the alarm was created, in the Unix epoch format.
    
    Returns:
    
    The time the alarm was created, in the Unix epoch format.
  - withCreationTime
```
public AlarmSummary withCreationTime(Date creationTime)
```
    The time the alarm was created, in the Unix epoch format.
    
    Parameters:
    
    creationTime - The time the alarm was created, in the Unix epoch format.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdateTime
```
public void setLastUpdateTime(Date lastUpdateTime)
```
    The time the alarm was last updated, in the Unix epoch format.
    
    Parameters:
    
    lastUpdateTime - The time the alarm was last updated, in the Unix epoch format.
  - getLastUpdateTime
```
public Date getLastUpdateTime()
```
    The time the alarm was last updated, in the Unix epoch format.
    
    Returns:
    
    The time the alarm was last updated, in the Unix epoch format.
  - withLastUpdateTime
```
public AlarmSummary withLastUpdateTime(Date lastUpdateTime)
```
    The time the alarm was last updated, in the Unix epoch format.
    
    Parameters:
    
    lastUpdateTime - The time the alarm was last updated, in the Unix epoch format.
    
    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 AlarmSummary 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.779

Class AlarmSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AlarmSummary

Method Detail

setAlarmModelName

getAlarmModelName

withAlarmModelName

setAlarmModelVersion

getAlarmModelVersion

withAlarmModelVersion

setKeyValue

getKeyValue

withKeyValue

setStateName

getStateName

withStateName

withStateName

setCreationTime

getCreationTime

withCreationTime

setLastUpdateTime

getLastUpdateTime

withLastUpdateTime

toString

equals

hashCode

clone

marshall