This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-iot/include/aws/iot/model/UpdateTopicRuleDestinationRequest.h

221 lines
12 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/iot/IoT_EXPORTS.h>
#include <aws/iot/IoTRequest.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/iot/model/TopicRuleDestinationStatus.h>
#include <utility>
namespace Aws
{
namespace IoT
{
namespace Model
{
/**
*/
class AWS_IOT_API UpdateTopicRuleDestinationRequest : public IoTRequest
{
public:
UpdateTopicRuleDestinationRequest();
// 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 "UpdateTopicRuleDestination"; }
Aws::String SerializePayload() const override;
/**
* <p>The ARN of the topic rule destination.</p>
*/
inline const Aws::String& GetArn() const{ return m_arn; }
/**
* <p>The ARN of the topic rule destination.</p>
*/
inline bool ArnHasBeenSet() const { return m_arnHasBeenSet; }
/**
* <p>The ARN of the topic rule destination.</p>
*/
inline void SetArn(const Aws::String& value) { m_arnHasBeenSet = true; m_arn = value; }
/**
* <p>The ARN of the topic rule destination.</p>
*/
inline void SetArn(Aws::String&& value) { m_arnHasBeenSet = true; m_arn = std::move(value); }
/**
* <p>The ARN of the topic rule destination.</p>
*/
inline void SetArn(const char* value) { m_arnHasBeenSet = true; m_arn.assign(value); }
/**
* <p>The ARN of the topic rule destination.</p>
*/
inline UpdateTopicRuleDestinationRequest& WithArn(const Aws::String& value) { SetArn(value); return *this;}
/**
* <p>The ARN of the topic rule destination.</p>
*/
inline UpdateTopicRuleDestinationRequest& WithArn(Aws::String&& value) { SetArn(std::move(value)); return *this;}
/**
* <p>The ARN of the topic rule destination.</p>
*/
inline UpdateTopicRuleDestinationRequest& WithArn(const char* value) { SetArn(value); return *this;}
/**
* <p>The status of the topic rule destination. Valid values are:</p> <dl>
* <dt>IN_PROGRESS</dt> <dd> <p>A topic rule destination was created but has not
* been confirmed. You can set <code>status</code> to <code>IN_PROGRESS</code> by
* calling <code>UpdateTopicRuleDestination</code>. Calling
* <code>UpdateTopicRuleDestination</code> causes a new confirmation challenge to
* be sent to your confirmation endpoint.</p> </dd> <dt>ENABLED</dt> <dd>
* <p>Confirmation was completed, and traffic to this destination is allowed. You
* can set <code>status</code> to <code>DISABLED</code> by calling
* <code>UpdateTopicRuleDestination</code>.</p> </dd> <dt>DISABLED</dt> <dd>
* <p>Confirmation was completed, and traffic to this destination is not allowed.
* You can set <code>status</code> to <code>ENABLED</code> by calling
* <code>UpdateTopicRuleDestination</code>.</p> </dd> <dt>ERROR</dt> <dd>
* <p>Confirmation could not be completed, for example if the confirmation timed
* out. You can call <code>GetTopicRuleDestination</code> for details about the
* error. You can set <code>status</code> to <code>IN_PROGRESS</code> by calling
* <code>UpdateTopicRuleDestination</code>. Calling
* <code>UpdateTopicRuleDestination</code> causes a new confirmation challenge to
* be sent to your confirmation endpoint.</p> </dd> </dl>
*/
inline const TopicRuleDestinationStatus& GetStatus() const{ return m_status; }
/**
* <p>The status of the topic rule destination. Valid values are:</p> <dl>
* <dt>IN_PROGRESS</dt> <dd> <p>A topic rule destination was created but has not
* been confirmed. You can set <code>status</code> to <code>IN_PROGRESS</code> by
* calling <code>UpdateTopicRuleDestination</code>. Calling
* <code>UpdateTopicRuleDestination</code> causes a new confirmation challenge to
* be sent to your confirmation endpoint.</p> </dd> <dt>ENABLED</dt> <dd>
* <p>Confirmation was completed, and traffic to this destination is allowed. You
* can set <code>status</code> to <code>DISABLED</code> by calling
* <code>UpdateTopicRuleDestination</code>.</p> </dd> <dt>DISABLED</dt> <dd>
* <p>Confirmation was completed, and traffic to this destination is not allowed.
* You can set <code>status</code> to <code>ENABLED</code> by calling
* <code>UpdateTopicRuleDestination</code>.</p> </dd> <dt>ERROR</dt> <dd>
* <p>Confirmation could not be completed, for example if the confirmation timed
* out. You can call <code>GetTopicRuleDestination</code> for details about the
* error. You can set <code>status</code> to <code>IN_PROGRESS</code> by calling
* <code>UpdateTopicRuleDestination</code>. Calling
* <code>UpdateTopicRuleDestination</code> causes a new confirmation challenge to
* be sent to your confirmation endpoint.</p> </dd> </dl>
*/
inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; }
/**
* <p>The status of the topic rule destination. Valid values are:</p> <dl>
* <dt>IN_PROGRESS</dt> <dd> <p>A topic rule destination was created but has not
* been confirmed. You can set <code>status</code> to <code>IN_PROGRESS</code> by
* calling <code>UpdateTopicRuleDestination</code>. Calling
* <code>UpdateTopicRuleDestination</code> causes a new confirmation challenge to
* be sent to your confirmation endpoint.</p> </dd> <dt>ENABLED</dt> <dd>
* <p>Confirmation was completed, and traffic to this destination is allowed. You
* can set <code>status</code> to <code>DISABLED</code> by calling
* <code>UpdateTopicRuleDestination</code>.</p> </dd> <dt>DISABLED</dt> <dd>
* <p>Confirmation was completed, and traffic to this destination is not allowed.
* You can set <code>status</code> to <code>ENABLED</code> by calling
* <code>UpdateTopicRuleDestination</code>.</p> </dd> <dt>ERROR</dt> <dd>
* <p>Confirmation could not be completed, for example if the confirmation timed
* out. You can call <code>GetTopicRuleDestination</code> for details about the
* error. You can set <code>status</code> to <code>IN_PROGRESS</code> by calling
* <code>UpdateTopicRuleDestination</code>. Calling
* <code>UpdateTopicRuleDestination</code> causes a new confirmation challenge to
* be sent to your confirmation endpoint.</p> </dd> </dl>
*/
inline void SetStatus(const TopicRuleDestinationStatus& value) { m_statusHasBeenSet = true; m_status = value; }
/**
* <p>The status of the topic rule destination. Valid values are:</p> <dl>
* <dt>IN_PROGRESS</dt> <dd> <p>A topic rule destination was created but has not
* been confirmed. You can set <code>status</code> to <code>IN_PROGRESS</code> by
* calling <code>UpdateTopicRuleDestination</code>. Calling
* <code>UpdateTopicRuleDestination</code> causes a new confirmation challenge to
* be sent to your confirmation endpoint.</p> </dd> <dt>ENABLED</dt> <dd>
* <p>Confirmation was completed, and traffic to this destination is allowed. You
* can set <code>status</code> to <code>DISABLED</code> by calling
* <code>UpdateTopicRuleDestination</code>.</p> </dd> <dt>DISABLED</dt> <dd>
* <p>Confirmation was completed, and traffic to this destination is not allowed.
* You can set <code>status</code> to <code>ENABLED</code> by calling
* <code>UpdateTopicRuleDestination</code>.</p> </dd> <dt>ERROR</dt> <dd>
* <p>Confirmation could not be completed, for example if the confirmation timed
* out. You can call <code>GetTopicRuleDestination</code> for details about the
* error. You can set <code>status</code> to <code>IN_PROGRESS</code> by calling
* <code>UpdateTopicRuleDestination</code>. Calling
* <code>UpdateTopicRuleDestination</code> causes a new confirmation challenge to
* be sent to your confirmation endpoint.</p> </dd> </dl>
*/
inline void SetStatus(TopicRuleDestinationStatus&& value) { m_statusHasBeenSet = true; m_status = std::move(value); }
/**
* <p>The status of the topic rule destination. Valid values are:</p> <dl>
* <dt>IN_PROGRESS</dt> <dd> <p>A topic rule destination was created but has not
* been confirmed. You can set <code>status</code> to <code>IN_PROGRESS</code> by
* calling <code>UpdateTopicRuleDestination</code>. Calling
* <code>UpdateTopicRuleDestination</code> causes a new confirmation challenge to
* be sent to your confirmation endpoint.</p> </dd> <dt>ENABLED</dt> <dd>
* <p>Confirmation was completed, and traffic to this destination is allowed. You
* can set <code>status</code> to <code>DISABLED</code> by calling
* <code>UpdateTopicRuleDestination</code>.</p> </dd> <dt>DISABLED</dt> <dd>
* <p>Confirmation was completed, and traffic to this destination is not allowed.
* You can set <code>status</code> to <code>ENABLED</code> by calling
* <code>UpdateTopicRuleDestination</code>.</p> </dd> <dt>ERROR</dt> <dd>
* <p>Confirmation could not be completed, for example if the confirmation timed
* out. You can call <code>GetTopicRuleDestination</code> for details about the
* error. You can set <code>status</code> to <code>IN_PROGRESS</code> by calling
* <code>UpdateTopicRuleDestination</code>. Calling
* <code>UpdateTopicRuleDestination</code> causes a new confirmation challenge to
* be sent to your confirmation endpoint.</p> </dd> </dl>
*/
inline UpdateTopicRuleDestinationRequest& WithStatus(const TopicRuleDestinationStatus& value) { SetStatus(value); return *this;}
/**
* <p>The status of the topic rule destination. Valid values are:</p> <dl>
* <dt>IN_PROGRESS</dt> <dd> <p>A topic rule destination was created but has not
* been confirmed. You can set <code>status</code> to <code>IN_PROGRESS</code> by
* calling <code>UpdateTopicRuleDestination</code>. Calling
* <code>UpdateTopicRuleDestination</code> causes a new confirmation challenge to
* be sent to your confirmation endpoint.</p> </dd> <dt>ENABLED</dt> <dd>
* <p>Confirmation was completed, and traffic to this destination is allowed. You
* can set <code>status</code> to <code>DISABLED</code> by calling
* <code>UpdateTopicRuleDestination</code>.</p> </dd> <dt>DISABLED</dt> <dd>
* <p>Confirmation was completed, and traffic to this destination is not allowed.
* You can set <code>status</code> to <code>ENABLED</code> by calling
* <code>UpdateTopicRuleDestination</code>.</p> </dd> <dt>ERROR</dt> <dd>
* <p>Confirmation could not be completed, for example if the confirmation timed
* out. You can call <code>GetTopicRuleDestination</code> for details about the
* error. You can set <code>status</code> to <code>IN_PROGRESS</code> by calling
* <code>UpdateTopicRuleDestination</code>. Calling
* <code>UpdateTopicRuleDestination</code> causes a new confirmation challenge to
* be sent to your confirmation endpoint.</p> </dd> </dl>
*/
inline UpdateTopicRuleDestinationRequest& WithStatus(TopicRuleDestinationStatus&& value) { SetStatus(std::move(value)); return *this;}
private:
Aws::String m_arn;
bool m_arnHasBeenSet;
TopicRuleDestinationStatus m_status;
bool m_statusHasBeenSet;
};
} // namespace Model
} // namespace IoT
} // namespace Aws