/**
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0.
 */

#pragma once
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/core/utils/memory/stl/AWSVector.h>
#include <aws/monitoring/CloudWatchRequest.h>
#include <aws/monitoring/CloudWatch_EXPORTS.h>
#include <aws/monitoring/model/AlarmType.h>
#include <aws/monitoring/model/StateValue.h>

#include <utility>

namespace Aws {
namespace CloudWatch {
namespace Model {

/**
 */
class DescribeAlarmsRequest : public CloudWatchRequest {
 public:
  AWS_CLOUDWATCH_API DescribeAlarmsRequest() = default;

  // 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 "DescribeAlarms"; }

  AWS_CLOUDWATCH_API Aws::String SerializePayload() const override;

  AWS_CLOUDWATCH_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;

  ///@{
  /**
   * <p>The names of the alarms to retrieve information about.</p>
   */
  inline const Aws::Vector<Aws::String>& GetAlarmNames() const { return m_alarmNames; }
  inline bool AlarmNamesHasBeenSet() const { return m_alarmNamesHasBeenSet; }
  template <typename AlarmNamesT = Aws::Vector<Aws::String>>
  void SetAlarmNames(AlarmNamesT&& value) {
    m_alarmNamesHasBeenSet = true;
    m_alarmNames = std::forward<AlarmNamesT>(value);
  }
  template <typename AlarmNamesT = Aws::Vector<Aws::String>>
  DescribeAlarmsRequest& WithAlarmNames(AlarmNamesT&& value) {
    SetAlarmNames(std::forward<AlarmNamesT>(value));
    return *this;
  }
  template <typename AlarmNamesT = Aws::String>
  DescribeAlarmsRequest& AddAlarmNames(AlarmNamesT&& value) {
    m_alarmNamesHasBeenSet = true;
    m_alarmNames.emplace_back(std::forward<AlarmNamesT>(value));
    return *this;
  }
  ///@}

  ///@{
  /**
   * <p>An alarm name prefix. If you specify this parameter, you receive information
   * about all alarms that have names that start with this prefix.</p> <p>If this
   * parameter is specified, you cannot specify <code>AlarmNames</code>.</p>
   */
  inline const Aws::String& GetAlarmNamePrefix() const { return m_alarmNamePrefix; }
  inline bool AlarmNamePrefixHasBeenSet() const { return m_alarmNamePrefixHasBeenSet; }
  template <typename AlarmNamePrefixT = Aws::String>
  void SetAlarmNamePrefix(AlarmNamePrefixT&& value) {
    m_alarmNamePrefixHasBeenSet = true;
    m_alarmNamePrefix = std::forward<AlarmNamePrefixT>(value);
  }
  template <typename AlarmNamePrefixT = Aws::String>
  DescribeAlarmsRequest& WithAlarmNamePrefix(AlarmNamePrefixT&& value) {
    SetAlarmNamePrefix(std::forward<AlarmNamePrefixT>(value));
    return *this;
  }
  ///@}

  ///@{
  /**
   * <p>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, even if composite alarms exist in the account.</p> <p>For example, if
   * you omit this parameter or specify <code>MetricAlarms</code>, the operation
   * returns only a list of metric alarms. It does not return any composite alarms,
   * even if composite alarms exist in the account.</p> <p>If you specify
   * <code>CompositeAlarms</code>, the operation returns only a list of composite
   * alarms, and does not return any metric alarms.</p>
   */
  inline const Aws::Vector<AlarmType>& GetAlarmTypes() const { return m_alarmTypes; }
  inline bool AlarmTypesHasBeenSet() const { return m_alarmTypesHasBeenSet; }
  template <typename AlarmTypesT = Aws::Vector<AlarmType>>
  void SetAlarmTypes(AlarmTypesT&& value) {
    m_alarmTypesHasBeenSet = true;
    m_alarmTypes = std::forward<AlarmTypesT>(value);
  }
  template <typename AlarmTypesT = Aws::Vector<AlarmType>>
  DescribeAlarmsRequest& WithAlarmTypes(AlarmTypesT&& value) {
    SetAlarmTypes(std::forward<AlarmTypesT>(value));
    return *this;
  }
  inline DescribeAlarmsRequest& AddAlarmTypes(AlarmType value) {
    m_alarmTypesHasBeenSet = true;
    m_alarmTypes.push_back(value);
    return *this;
  }
  ///@}

  ///@{
  /**
   * <p>If you use this parameter and specify the name of a composite alarm, the
   * operation returns information about the "children" alarms of the alarm you
   * specify. These are the metric alarms and composite alarms referenced in the
   * <code>AlarmRule</code> field of the composite alarm that you specify in
   * <code>ChildrenOfAlarmName</code>. Information about the composite alarm that you
   * name in <code>ChildrenOfAlarmName</code> is not returned.</p> <p>If you specify
   * <code>ChildrenOfAlarmName</code>, you cannot specify any other parameters in the
   * request except for <code>MaxRecords</code> and <code>NextToken</code>. If you do
   * so, you receive a validation error.</p>  <p>Only the <code>Alarm
   * Name</code>, <code>ARN</code>, <code>StateValue</code>
   * (OK/ALARM/INSUFFICIENT_DATA), and <code>StateUpdatedTimestamp</code> information
   * are returned by this operation when you use this parameter. To get complete
   * information about these alarms, perform another <code>DescribeAlarms</code>
   * operation and specify the parent alarm names in the <code>AlarmNames</code>
   * parameter.</p>
   */
  inline const Aws::String& GetChildrenOfAlarmName() const { return m_childrenOfAlarmName; }
  inline bool ChildrenOfAlarmNameHasBeenSet() const { return m_childrenOfAlarmNameHasBeenSet; }
  template <typename ChildrenOfAlarmNameT = Aws::String>
  void SetChildrenOfAlarmName(ChildrenOfAlarmNameT&& value) {
    m_childrenOfAlarmNameHasBeenSet = true;
    m_childrenOfAlarmName = std::forward<ChildrenOfAlarmNameT>(value);
  }
  template <typename ChildrenOfAlarmNameT = Aws::String>
  DescribeAlarmsRequest& WithChildrenOfAlarmName(ChildrenOfAlarmNameT&& value) {
    SetChildrenOfAlarmName(std::forward<ChildrenOfAlarmNameT>(value));
    return *this;
  }
  ///@}

  ///@{
  /**
   * <p>If you use this parameter and specify the name of a metric or composite
   * alarm, the operation returns information about the "parent" alarms of the alarm
   * you specify. These are the composite alarms that have <code>AlarmRule</code>
   * parameters that reference the alarm named in <code>ParentsOfAlarmName</code>.
   * Information about the alarm that you specify in <code>ParentsOfAlarmName</code>
   * is not returned.</p> <p>If you specify <code>ParentsOfAlarmName</code>, you
   * cannot specify any other parameters in the request except for
   * <code>MaxRecords</code> and <code>NextToken</code>. If you do so, you receive a
   * validation error.</p>  <p>Only the Alarm Name and ARN are returned by this
   * operation when you use this parameter. To get complete information about these
   * alarms, perform another <code>DescribeAlarms</code> operation and specify the
   * parent alarm names in the <code>AlarmNames</code> parameter.</p>
   */
  inline const Aws::String& GetParentsOfAlarmName() const { return m_parentsOfAlarmName; }
  inline bool ParentsOfAlarmNameHasBeenSet() const { return m_parentsOfAlarmNameHasBeenSet; }
  template <typename ParentsOfAlarmNameT = Aws::String>
  void SetParentsOfAlarmName(ParentsOfAlarmNameT&& value) {
    m_parentsOfAlarmNameHasBeenSet = true;
    m_parentsOfAlarmName = std::forward<ParentsOfAlarmNameT>(value);
  }
  template <typename ParentsOfAlarmNameT = Aws::String>
  DescribeAlarmsRequest& WithParentsOfAlarmName(ParentsOfAlarmNameT&& value) {
    SetParentsOfAlarmName(std::forward<ParentsOfAlarmNameT>(value));
    return *this;
  }
  ///@}

  ///@{
  /**
   * <p>Specify this parameter to receive information only about alarms that are
   * currently in the state that you specify.</p>
   */
  inline StateValue GetStateValue() const { return m_stateValue; }
  inline bool StateValueHasBeenSet() const { return m_stateValueHasBeenSet; }
  inline void SetStateValue(StateValue value) {
    m_stateValueHasBeenSet = true;
    m_stateValue = value;
  }
  inline DescribeAlarmsRequest& WithStateValue(StateValue value) {
    SetStateValue(value);
    return *this;
  }
  ///@}

  ///@{
  /**
   * <p>Use this parameter to filter the results of the operation to only those
   * alarms that use a certain alarm action. For example, you could specify the ARN
   * of an SNS topic to find all alarms that send notifications to that topic.</p>
   */
  inline const Aws::String& GetActionPrefix() const { return m_actionPrefix; }
  inline bool ActionPrefixHasBeenSet() const { return m_actionPrefixHasBeenSet; }
  template <typename ActionPrefixT = Aws::String>
  void SetActionPrefix(ActionPrefixT&& value) {
    m_actionPrefixHasBeenSet = true;
    m_actionPrefix = std::forward<ActionPrefixT>(value);
  }
  template <typename ActionPrefixT = Aws::String>
  DescribeAlarmsRequest& WithActionPrefix(ActionPrefixT&& value) {
    SetActionPrefix(std::forward<ActionPrefixT>(value));
    return *this;
  }
  ///@}

  ///@{
  /**
   * <p>The maximum number of alarm descriptions to retrieve.</p>
   */
  inline int GetMaxRecords() const { return m_maxRecords; }
  inline bool MaxRecordsHasBeenSet() const { return m_maxRecordsHasBeenSet; }
  inline void SetMaxRecords(int value) {
    m_maxRecordsHasBeenSet = true;
    m_maxRecords = value;
  }
  inline DescribeAlarmsRequest& WithMaxRecords(int value) {
    SetMaxRecords(value);
    return *this;
  }
  ///@}

  ///@{
  /**
   * <p>The token returned by a previous call to indicate that there is more data
   * available.</p>
   */
  inline const Aws::String& GetNextToken() const { return m_nextToken; }
  inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
  template <typename NextTokenT = Aws::String>
  void SetNextToken(NextTokenT&& value) {
    m_nextTokenHasBeenSet = true;
    m_nextToken = std::forward<NextTokenT>(value);
  }
  template <typename NextTokenT = Aws::String>
  DescribeAlarmsRequest& WithNextToken(NextTokenT&& value) {
    SetNextToken(std::forward<NextTokenT>(value));
    return *this;
  }
  ///@}
 private:
  Aws::Vector<Aws::String> m_alarmNames;

  Aws::String m_alarmNamePrefix;

  Aws::Vector<AlarmType> m_alarmTypes;

  Aws::String m_childrenOfAlarmName;

  Aws::String m_parentsOfAlarmName;

  StateValue m_stateValue{StateValue::NOT_SET};

  Aws::String m_actionPrefix;

  int m_maxRecords{0};

  Aws::String m_nextToken;
  bool m_alarmNamesHasBeenSet = false;
  bool m_alarmNamePrefixHasBeenSet = false;
  bool m_alarmTypesHasBeenSet = false;
  bool m_childrenOfAlarmNameHasBeenSet = false;
  bool m_parentsOfAlarmNameHasBeenSet = false;
  bool m_stateValueHasBeenSet = false;
  bool m_actionPrefixHasBeenSet = false;
  bool m_maxRecordsHasBeenSet = false;
  bool m_nextTokenHasBeenSet = false;
};

}  // namespace Model
}  // namespace CloudWatch
}  // namespace Aws