/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include namespace Aws { namespace CloudWatch { namespace Model { /** */ class DescribeAlarmHistoryRequest : public CloudWatchRequest { public: AWS_CLOUDWATCH_API DescribeAlarmHistoryRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "DescribeAlarmHistory"; } AWS_CLOUDWATCH_API Aws::String SerializePayload() const override; protected: AWS_CLOUDWATCH_API void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

The name of the alarm.

*/ inline const Aws::String& GetAlarmName() const{ return m_alarmName; } /** *

The name of the alarm.

*/ inline bool AlarmNameHasBeenSet() const { return m_alarmNameHasBeenSet; } /** *

The name of the alarm.

*/ inline void SetAlarmName(const Aws::String& value) { m_alarmNameHasBeenSet = true; m_alarmName = value; } /** *

The name of the alarm.

*/ inline void SetAlarmName(Aws::String&& value) { m_alarmNameHasBeenSet = true; m_alarmName = std::move(value); } /** *

The name of the alarm.

*/ inline void SetAlarmName(const char* value) { m_alarmNameHasBeenSet = true; m_alarmName.assign(value); } /** *

The name of the alarm.

*/ inline DescribeAlarmHistoryRequest& WithAlarmName(const Aws::String& value) { SetAlarmName(value); return *this;} /** *

The name of the alarm.

*/ inline DescribeAlarmHistoryRequest& WithAlarmName(Aws::String&& value) { SetAlarmName(std::move(value)); return *this;} /** *

The name of the alarm.

*/ inline DescribeAlarmHistoryRequest& WithAlarmName(const char* value) { SetAlarmName(value); return *this;} /** *

Use this parameter to specify whether you want the operation to return metric * alarms or composite alarms. If you omit this parameter, only metric alarms are * returned.

*/ inline const Aws::Vector& GetAlarmTypes() const{ return m_alarmTypes; } /** *

Use this parameter to specify whether you want the operation to return metric * alarms or composite alarms. If you omit this parameter, only metric alarms are * returned.

*/ inline bool AlarmTypesHasBeenSet() const { return m_alarmTypesHasBeenSet; } /** *

Use this parameter to specify whether you want the operation to return metric * alarms or composite alarms. If you omit this parameter, only metric alarms are * returned.

*/ inline void SetAlarmTypes(const Aws::Vector& value) { m_alarmTypesHasBeenSet = true; m_alarmTypes = value; } /** *

Use this parameter to specify whether you want the operation to return metric * alarms or composite alarms. If you omit this parameter, only metric alarms are * returned.

*/ inline void SetAlarmTypes(Aws::Vector&& value) { m_alarmTypesHasBeenSet = true; m_alarmTypes = std::move(value); } /** *

Use this parameter to specify whether you want the operation to return metric * alarms or composite alarms. If you omit this parameter, only metric alarms are * returned.

*/ inline DescribeAlarmHistoryRequest& WithAlarmTypes(const Aws::Vector& value) { SetAlarmTypes(value); return *this;} /** *

Use this parameter to specify whether you want the operation to return metric * alarms or composite alarms. If you omit this parameter, only metric alarms are * returned.

*/ inline DescribeAlarmHistoryRequest& WithAlarmTypes(Aws::Vector&& value) { SetAlarmTypes(std::move(value)); return *this;} /** *

Use this parameter to specify whether you want the operation to return metric * alarms or composite alarms. If you omit this parameter, only metric alarms are * returned.

*/ inline DescribeAlarmHistoryRequest& AddAlarmTypes(const AlarmType& value) { m_alarmTypesHasBeenSet = true; m_alarmTypes.push_back(value); return *this; } /** *

Use this parameter to specify whether you want the operation to return metric * alarms or composite alarms. If you omit this parameter, only metric alarms are * returned.

*/ inline DescribeAlarmHistoryRequest& AddAlarmTypes(AlarmType&& value) { m_alarmTypesHasBeenSet = true; m_alarmTypes.push_back(std::move(value)); return *this; } /** *

The type of alarm histories to retrieve.

*/ inline const HistoryItemType& GetHistoryItemType() const{ return m_historyItemType; } /** *

The type of alarm histories to retrieve.

*/ inline bool HistoryItemTypeHasBeenSet() const { return m_historyItemTypeHasBeenSet; } /** *

The type of alarm histories to retrieve.

*/ inline void SetHistoryItemType(const HistoryItemType& value) { m_historyItemTypeHasBeenSet = true; m_historyItemType = value; } /** *

The type of alarm histories to retrieve.

*/ inline void SetHistoryItemType(HistoryItemType&& value) { m_historyItemTypeHasBeenSet = true; m_historyItemType = std::move(value); } /** *

The type of alarm histories to retrieve.

*/ inline DescribeAlarmHistoryRequest& WithHistoryItemType(const HistoryItemType& value) { SetHistoryItemType(value); return *this;} /** *

The type of alarm histories to retrieve.

*/ inline DescribeAlarmHistoryRequest& WithHistoryItemType(HistoryItemType&& value) { SetHistoryItemType(std::move(value)); return *this;} /** *

The starting date to retrieve alarm history.

*/ inline const Aws::Utils::DateTime& GetStartDate() const{ return m_startDate; } /** *

The starting date to retrieve alarm history.

*/ inline bool StartDateHasBeenSet() const { return m_startDateHasBeenSet; } /** *

The starting date to retrieve alarm history.

*/ inline void SetStartDate(const Aws::Utils::DateTime& value) { m_startDateHasBeenSet = true; m_startDate = value; } /** *

The starting date to retrieve alarm history.

*/ inline void SetStartDate(Aws::Utils::DateTime&& value) { m_startDateHasBeenSet = true; m_startDate = std::move(value); } /** *

The starting date to retrieve alarm history.

*/ inline DescribeAlarmHistoryRequest& WithStartDate(const Aws::Utils::DateTime& value) { SetStartDate(value); return *this;} /** *

The starting date to retrieve alarm history.

*/ inline DescribeAlarmHistoryRequest& WithStartDate(Aws::Utils::DateTime&& value) { SetStartDate(std::move(value)); return *this;} /** *

The ending date to retrieve alarm history.

*/ inline const Aws::Utils::DateTime& GetEndDate() const{ return m_endDate; } /** *

The ending date to retrieve alarm history.

*/ inline bool EndDateHasBeenSet() const { return m_endDateHasBeenSet; } /** *

The ending date to retrieve alarm history.

*/ inline void SetEndDate(const Aws::Utils::DateTime& value) { m_endDateHasBeenSet = true; m_endDate = value; } /** *

The ending date to retrieve alarm history.

*/ inline void SetEndDate(Aws::Utils::DateTime&& value) { m_endDateHasBeenSet = true; m_endDate = std::move(value); } /** *

The ending date to retrieve alarm history.

*/ inline DescribeAlarmHistoryRequest& WithEndDate(const Aws::Utils::DateTime& value) { SetEndDate(value); return *this;} /** *

The ending date to retrieve alarm history.

*/ inline DescribeAlarmHistoryRequest& WithEndDate(Aws::Utils::DateTime&& value) { SetEndDate(std::move(value)); return *this;} /** *

The maximum number of alarm history records to retrieve.

*/ inline int GetMaxRecords() const{ return m_maxRecords; } /** *

The maximum number of alarm history records to retrieve.

*/ inline bool MaxRecordsHasBeenSet() const { return m_maxRecordsHasBeenSet; } /** *

The maximum number of alarm history records to retrieve.

*/ inline void SetMaxRecords(int value) { m_maxRecordsHasBeenSet = true; m_maxRecords = value; } /** *

The maximum number of alarm history records to retrieve.

*/ inline DescribeAlarmHistoryRequest& WithMaxRecords(int value) { SetMaxRecords(value); return *this;} /** *

The token returned by a previous call to indicate that there is more data * available.

*/ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

The token returned by a previous call to indicate that there is more data * available.

*/ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

The token returned by a previous call to indicate that there is more data * available.

*/ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

The token returned by a previous call to indicate that there is more data * available.

*/ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

The token returned by a previous call to indicate that there is more data * available.

*/ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

The token returned by a previous call to indicate that there is more data * available.

*/ inline DescribeAlarmHistoryRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

The token returned by a previous call to indicate that there is more data * available.

*/ inline DescribeAlarmHistoryRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

The token returned by a previous call to indicate that there is more data * available.

*/ inline DescribeAlarmHistoryRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** *

Specified whether to return the newest or oldest alarm history first. Specify * TimestampDescending to have the newest event history returned * first, and specify TimestampAscending to have the oldest history * returned first.

*/ inline const ScanBy& GetScanBy() const{ return m_scanBy; } /** *

Specified whether to return the newest or oldest alarm history first. Specify * TimestampDescending to have the newest event history returned * first, and specify TimestampAscending to have the oldest history * returned first.

*/ inline bool ScanByHasBeenSet() const { return m_scanByHasBeenSet; } /** *

Specified whether to return the newest or oldest alarm history first. Specify * TimestampDescending to have the newest event history returned * first, and specify TimestampAscending to have the oldest history * returned first.

*/ inline void SetScanBy(const ScanBy& value) { m_scanByHasBeenSet = true; m_scanBy = value; } /** *

Specified whether to return the newest or oldest alarm history first. Specify * TimestampDescending to have the newest event history returned * first, and specify TimestampAscending to have the oldest history * returned first.

*/ inline void SetScanBy(ScanBy&& value) { m_scanByHasBeenSet = true; m_scanBy = std::move(value); } /** *

Specified whether to return the newest or oldest alarm history first. Specify * TimestampDescending to have the newest event history returned * first, and specify TimestampAscending to have the oldest history * returned first.

*/ inline DescribeAlarmHistoryRequest& WithScanBy(const ScanBy& value) { SetScanBy(value); return *this;} /** *

Specified whether to return the newest or oldest alarm history first. Specify * TimestampDescending to have the newest event history returned * first, and specify TimestampAscending to have the oldest history * returned first.

*/ inline DescribeAlarmHistoryRequest& WithScanBy(ScanBy&& value) { SetScanBy(std::move(value)); return *this;} private: Aws::String m_alarmName; bool m_alarmNameHasBeenSet = false; Aws::Vector m_alarmTypes; bool m_alarmTypesHasBeenSet = false; HistoryItemType m_historyItemType; bool m_historyItemTypeHasBeenSet = false; Aws::Utils::DateTime m_startDate; bool m_startDateHasBeenSet = false; Aws::Utils::DateTime m_endDate; bool m_endDateHasBeenSet = false; int m_maxRecords; bool m_maxRecordsHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; ScanBy m_scanBy; bool m_scanByHasBeenSet = false; }; } // namespace Model } // namespace CloudWatch } // namespace Aws