/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace IoTEventsData { namespace Model { /** *

Contains a summary of an alarm.

See Also:

AWS * API Reference

*/ class AlarmSummary { public: AWS_IOTEVENTSDATA_API AlarmSummary(); AWS_IOTEVENTSDATA_API AlarmSummary(Aws::Utils::Json::JsonView jsonValue); AWS_IOTEVENTSDATA_API AlarmSummary& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_IOTEVENTSDATA_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The name of the alarm model.

*/ inline const Aws::String& GetAlarmModelName() const{ return m_alarmModelName; } /** *

The name of the alarm model.

*/ inline bool AlarmModelNameHasBeenSet() const { return m_alarmModelNameHasBeenSet; } /** *

The name of the alarm model.

*/ inline void SetAlarmModelName(const Aws::String& value) { m_alarmModelNameHasBeenSet = true; m_alarmModelName = value; } /** *

The name of the alarm model.

*/ inline void SetAlarmModelName(Aws::String&& value) { m_alarmModelNameHasBeenSet = true; m_alarmModelName = std::move(value); } /** *

The name of the alarm model.

*/ inline void SetAlarmModelName(const char* value) { m_alarmModelNameHasBeenSet = true; m_alarmModelName.assign(value); } /** *

The name of the alarm model.

*/ inline AlarmSummary& WithAlarmModelName(const Aws::String& value) { SetAlarmModelName(value); return *this;} /** *

The name of the alarm model.

*/ inline AlarmSummary& WithAlarmModelName(Aws::String&& value) { SetAlarmModelName(std::move(value)); return *this;} /** *

The name of the alarm model.

*/ inline AlarmSummary& WithAlarmModelName(const char* value) { SetAlarmModelName(value); return *this;} /** *

The version of the alarm model.

*/ inline const Aws::String& GetAlarmModelVersion() const{ return m_alarmModelVersion; } /** *

The version of the alarm model.

*/ inline bool AlarmModelVersionHasBeenSet() const { return m_alarmModelVersionHasBeenSet; } /** *

The version of the alarm model.

*/ inline void SetAlarmModelVersion(const Aws::String& value) { m_alarmModelVersionHasBeenSet = true; m_alarmModelVersion = value; } /** *

The version of the alarm model.

*/ inline void SetAlarmModelVersion(Aws::String&& value) { m_alarmModelVersionHasBeenSet = true; m_alarmModelVersion = std::move(value); } /** *

The version of the alarm model.

*/ inline void SetAlarmModelVersion(const char* value) { m_alarmModelVersionHasBeenSet = true; m_alarmModelVersion.assign(value); } /** *

The version of the alarm model.

*/ inline AlarmSummary& WithAlarmModelVersion(const Aws::String& value) { SetAlarmModelVersion(value); return *this;} /** *

The version of the alarm model.

*/ inline AlarmSummary& WithAlarmModelVersion(Aws::String&& value) { SetAlarmModelVersion(std::move(value)); return *this;} /** *

The version of the alarm model.

*/ inline AlarmSummary& WithAlarmModelVersion(const char* value) { SetAlarmModelVersion(value); return *this;} /** *

The value of the key used as a filter to select only the alarms associated * with the key.

*/ inline const Aws::String& GetKeyValue() const{ return m_keyValue; } /** *

The value of the key used as a filter to select only the alarms associated * with the key.

*/ inline bool KeyValueHasBeenSet() const { return m_keyValueHasBeenSet; } /** *

The value of the key used as a filter to select only the alarms associated * with the key.

*/ inline void SetKeyValue(const Aws::String& value) { m_keyValueHasBeenSet = true; m_keyValue = value; } /** *

The value of the key used as a filter to select only the alarms associated * with the key.

*/ inline void SetKeyValue(Aws::String&& value) { m_keyValueHasBeenSet = true; m_keyValue = std::move(value); } /** *

The value of the key used as a filter to select only the alarms associated * with the key.

*/ inline void SetKeyValue(const char* value) { m_keyValueHasBeenSet = true; m_keyValue.assign(value); } /** *

The value of the key used as a filter to select only the alarms associated * with the key.

*/ inline AlarmSummary& WithKeyValue(const Aws::String& value) { SetKeyValue(value); return *this;} /** *

The value of the key used as a filter to select only the alarms associated * with the key.

*/ inline AlarmSummary& WithKeyValue(Aws::String&& value) { SetKeyValue(std::move(value)); return *this;} /** *

The value of the key used as a filter to select only the alarms associated * with the key.

*/ inline AlarmSummary& WithKeyValue(const char* value) { SetKeyValue(value); return *this;} /** *

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.

*/ inline const AlarmStateName& GetStateName() const{ return m_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.

*/ inline bool StateNameHasBeenSet() const { return m_stateNameHasBeenSet; } /** *

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.

*/ inline void SetStateName(const AlarmStateName& value) { m_stateNameHasBeenSet = true; m_stateName = value; } /** *

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.

*/ inline void SetStateName(AlarmStateName&& value) { m_stateNameHasBeenSet = true; m_stateName = std::move(value); } /** *

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.

*/ inline AlarmSummary& WithStateName(const AlarmStateName& value) { SetStateName(value); return *this;} /** *

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.

*/ inline AlarmSummary& WithStateName(AlarmStateName&& value) { SetStateName(std::move(value)); return *this;} /** *

The time the alarm was created, in the Unix epoch format.

*/ inline const Aws::Utils::DateTime& GetCreationTime() const{ return m_creationTime; } /** *

The time the alarm was created, in the Unix epoch format.

*/ inline bool CreationTimeHasBeenSet() const { return m_creationTimeHasBeenSet; } /** *

The time the alarm was created, in the Unix epoch format.

*/ inline void SetCreationTime(const Aws::Utils::DateTime& value) { m_creationTimeHasBeenSet = true; m_creationTime = value; } /** *

The time the alarm was created, in the Unix epoch format.

*/ inline void SetCreationTime(Aws::Utils::DateTime&& value) { m_creationTimeHasBeenSet = true; m_creationTime = std::move(value); } /** *

The time the alarm was created, in the Unix epoch format.

*/ inline AlarmSummary& WithCreationTime(const Aws::Utils::DateTime& value) { SetCreationTime(value); return *this;} /** *

The time the alarm was created, in the Unix epoch format.

*/ inline AlarmSummary& WithCreationTime(Aws::Utils::DateTime&& value) { SetCreationTime(std::move(value)); return *this;} /** *

The time the alarm was last updated, in the Unix epoch format.

*/ inline const Aws::Utils::DateTime& GetLastUpdateTime() const{ return m_lastUpdateTime; } /** *

The time the alarm was last updated, in the Unix epoch format.

*/ inline bool LastUpdateTimeHasBeenSet() const { return m_lastUpdateTimeHasBeenSet; } /** *

The time the alarm was last updated, in the Unix epoch format.

*/ inline void SetLastUpdateTime(const Aws::Utils::DateTime& value) { m_lastUpdateTimeHasBeenSet = true; m_lastUpdateTime = value; } /** *

The time the alarm was last updated, in the Unix epoch format.

*/ inline void SetLastUpdateTime(Aws::Utils::DateTime&& value) { m_lastUpdateTimeHasBeenSet = true; m_lastUpdateTime = std::move(value); } /** *

The time the alarm was last updated, in the Unix epoch format.

*/ inline AlarmSummary& WithLastUpdateTime(const Aws::Utils::DateTime& value) { SetLastUpdateTime(value); return *this;} /** *

The time the alarm was last updated, in the Unix epoch format.

*/ inline AlarmSummary& WithLastUpdateTime(Aws::Utils::DateTime&& value) { SetLastUpdateTime(std::move(value)); return *this;} private: Aws::String m_alarmModelName; bool m_alarmModelNameHasBeenSet = false; Aws::String m_alarmModelVersion; bool m_alarmModelVersionHasBeenSet = false; Aws::String m_keyValue; bool m_keyValueHasBeenSet = false; AlarmStateName m_stateName; bool m_stateNameHasBeenSet = false; Aws::Utils::DateTime m_creationTime; bool m_creationTimeHasBeenSet = false; Aws::Utils::DateTime m_lastUpdateTime; bool m_lastUpdateTimeHasBeenSet = false; }; } // namespace Model } // namespace IoTEventsData } // namespace Aws