AWS SDK for C++  1.8.182
AWS SDK for C++
Public Member Functions | List of all members
Aws::IoT::Model::TopicRuleDestinationSummary Class Reference

#include <TopicRuleDestinationSummary.h>

Public Member Functions

 TopicRuleDestinationSummary ()
 
 TopicRuleDestinationSummary (Aws::Utils::Json::JsonView jsonValue)
 
TopicRuleDestinationSummaryoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetArn () const
 
bool ArnHasBeenSet () const
 
void SetArn (const Aws::String &value)
 
void SetArn (Aws::String &&value)
 
void SetArn (const char *value)
 
TopicRuleDestinationSummaryWithArn (const Aws::String &value)
 
TopicRuleDestinationSummaryWithArn (Aws::String &&value)
 
TopicRuleDestinationSummaryWithArn (const char *value)
 
const TopicRuleDestinationStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const TopicRuleDestinationStatus &value)
 
void SetStatus (TopicRuleDestinationStatus &&value)
 
TopicRuleDestinationSummaryWithStatus (const TopicRuleDestinationStatus &value)
 
TopicRuleDestinationSummaryWithStatus (TopicRuleDestinationStatus &&value)
 
const Aws::Utils::DateTimeGetCreatedAt () const
 
bool CreatedAtHasBeenSet () const
 
void SetCreatedAt (const Aws::Utils::DateTime &value)
 
void SetCreatedAt (Aws::Utils::DateTime &&value)
 
TopicRuleDestinationSummaryWithCreatedAt (const Aws::Utils::DateTime &value)
 
TopicRuleDestinationSummaryWithCreatedAt (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetLastUpdatedAt () const
 
bool LastUpdatedAtHasBeenSet () const
 
void SetLastUpdatedAt (const Aws::Utils::DateTime &value)
 
void SetLastUpdatedAt (Aws::Utils::DateTime &&value)
 
TopicRuleDestinationSummaryWithLastUpdatedAt (const Aws::Utils::DateTime &value)
 
TopicRuleDestinationSummaryWithLastUpdatedAt (Aws::Utils::DateTime &&value)
 
const Aws::StringGetStatusReason () const
 
bool StatusReasonHasBeenSet () const
 
void SetStatusReason (const Aws::String &value)
 
void SetStatusReason (Aws::String &&value)
 
void SetStatusReason (const char *value)
 
TopicRuleDestinationSummaryWithStatusReason (const Aws::String &value)
 
TopicRuleDestinationSummaryWithStatusReason (Aws::String &&value)
 
TopicRuleDestinationSummaryWithStatusReason (const char *value)
 
const HttpUrlDestinationSummaryGetHttpUrlSummary () const
 
bool HttpUrlSummaryHasBeenSet () const
 
void SetHttpUrlSummary (const HttpUrlDestinationSummary &value)
 
void SetHttpUrlSummary (HttpUrlDestinationSummary &&value)
 
TopicRuleDestinationSummaryWithHttpUrlSummary (const HttpUrlDestinationSummary &value)
 
TopicRuleDestinationSummaryWithHttpUrlSummary (HttpUrlDestinationSummary &&value)
 
const VpcDestinationSummaryGetVpcDestinationSummary () const
 
bool VpcDestinationSummaryHasBeenSet () const
 
void SetVpcDestinationSummary (const VpcDestinationSummary &value)
 
void SetVpcDestinationSummary (VpcDestinationSummary &&value)
 
TopicRuleDestinationSummaryWithVpcDestinationSummary (const VpcDestinationSummary &value)
 
TopicRuleDestinationSummaryWithVpcDestinationSummary (VpcDestinationSummary &&value)
 

Detailed Description

Information about the topic rule destination.

See Also:

AWS API Reference

Definition at line 35 of file TopicRuleDestinationSummary.h.

Constructor & Destructor Documentation

◆ TopicRuleDestinationSummary() [1/2]

Aws::IoT::Model::TopicRuleDestinationSummary::TopicRuleDestinationSummary ( )

◆ TopicRuleDestinationSummary() [2/2]

Aws::IoT::Model::TopicRuleDestinationSummary::TopicRuleDestinationSummary ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ArnHasBeenSet()

bool Aws::IoT::Model::TopicRuleDestinationSummary::ArnHasBeenSet ( ) const
inline

The topic rule destination ARN.

Definition at line 52 of file TopicRuleDestinationSummary.h.

◆ CreatedAtHasBeenSet()

bool Aws::IoT::Model::TopicRuleDestinationSummary::CreatedAtHasBeenSet ( ) const
inline

The date and time when the topic rule destination was created.

Definition at line 226 of file TopicRuleDestinationSummary.h.

◆ GetArn()

const Aws::String& Aws::IoT::Model::TopicRuleDestinationSummary::GetArn ( ) const
inline

The topic rule destination ARN.

Definition at line 47 of file TopicRuleDestinationSummary.h.

◆ GetCreatedAt()

const Aws::Utils::DateTime& Aws::IoT::Model::TopicRuleDestinationSummary::GetCreatedAt ( ) const
inline

The date and time when the topic rule destination was created.

Definition at line 221 of file TopicRuleDestinationSummary.h.

◆ GetHttpUrlSummary()

const HttpUrlDestinationSummary& Aws::IoT::Model::TopicRuleDestinationSummary::GetHttpUrlSummary ( ) const
inline

Information about the HTTP URL.

Definition at line 324 of file TopicRuleDestinationSummary.h.

◆ GetLastUpdatedAt()

const Aws::Utils::DateTime& Aws::IoT::Model::TopicRuleDestinationSummary::GetLastUpdatedAt ( ) const
inline

The date and time when the topic rule destination was last updated.

Definition at line 252 of file TopicRuleDestinationSummary.h.

◆ GetStatus()

const TopicRuleDestinationStatus& Aws::IoT::Model::TopicRuleDestinationSummary::GetStatus ( ) const
inline

The status of the topic rule destination. Valid values are:

IN_PROGRESS

A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

ENABLED

Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.

DISABLED

Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.

ERROR

Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

Definition at line 105 of file TopicRuleDestinationSummary.h.

◆ GetStatusReason()

const Aws::String& Aws::IoT::Model::TopicRuleDestinationSummary::GetStatusReason ( ) const
inline

The reason the topic rule destination is in the current status.

Definition at line 283 of file TopicRuleDestinationSummary.h.

◆ GetVpcDestinationSummary()

const VpcDestinationSummary& Aws::IoT::Model::TopicRuleDestinationSummary::GetVpcDestinationSummary ( ) const
inline

Information about the virtual private cloud (VPC) connection.

Definition at line 355 of file TopicRuleDestinationSummary.h.

◆ HttpUrlSummaryHasBeenSet()

bool Aws::IoT::Model::TopicRuleDestinationSummary::HttpUrlSummaryHasBeenSet ( ) const
inline

Information about the HTTP URL.

Definition at line 329 of file TopicRuleDestinationSummary.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::IoT::Model::TopicRuleDestinationSummary::Jsonize ( ) const

◆ LastUpdatedAtHasBeenSet()

bool Aws::IoT::Model::TopicRuleDestinationSummary::LastUpdatedAtHasBeenSet ( ) const
inline

The date and time when the topic rule destination was last updated.

Definition at line 257 of file TopicRuleDestinationSummary.h.

◆ operator=()

TopicRuleDestinationSummary& Aws::IoT::Model::TopicRuleDestinationSummary::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetArn() [1/3]

void Aws::IoT::Model::TopicRuleDestinationSummary::SetArn ( Aws::String &&  value)
inline

The topic rule destination ARN.

Definition at line 62 of file TopicRuleDestinationSummary.h.

◆ SetArn() [2/3]

void Aws::IoT::Model::TopicRuleDestinationSummary::SetArn ( const Aws::String value)
inline

The topic rule destination ARN.

Definition at line 57 of file TopicRuleDestinationSummary.h.

◆ SetArn() [3/3]

void Aws::IoT::Model::TopicRuleDestinationSummary::SetArn ( const char *  value)
inline

The topic rule destination ARN.

Definition at line 67 of file TopicRuleDestinationSummary.h.

◆ SetCreatedAt() [1/2]

void Aws::IoT::Model::TopicRuleDestinationSummary::SetCreatedAt ( Aws::Utils::DateTime &&  value)
inline

The date and time when the topic rule destination was created.

Definition at line 236 of file TopicRuleDestinationSummary.h.

◆ SetCreatedAt() [2/2]

void Aws::IoT::Model::TopicRuleDestinationSummary::SetCreatedAt ( const Aws::Utils::DateTime value)
inline

The date and time when the topic rule destination was created.

Definition at line 231 of file TopicRuleDestinationSummary.h.

◆ SetHttpUrlSummary() [1/2]

void Aws::IoT::Model::TopicRuleDestinationSummary::SetHttpUrlSummary ( const HttpUrlDestinationSummary value)
inline

Information about the HTTP URL.

Definition at line 334 of file TopicRuleDestinationSummary.h.

◆ SetHttpUrlSummary() [2/2]

void Aws::IoT::Model::TopicRuleDestinationSummary::SetHttpUrlSummary ( HttpUrlDestinationSummary &&  value)
inline

Information about the HTTP URL.

Definition at line 339 of file TopicRuleDestinationSummary.h.

◆ SetLastUpdatedAt() [1/2]

void Aws::IoT::Model::TopicRuleDestinationSummary::SetLastUpdatedAt ( Aws::Utils::DateTime &&  value)
inline

The date and time when the topic rule destination was last updated.

Definition at line 267 of file TopicRuleDestinationSummary.h.

◆ SetLastUpdatedAt() [2/2]

void Aws::IoT::Model::TopicRuleDestinationSummary::SetLastUpdatedAt ( const Aws::Utils::DateTime value)
inline

The date and time when the topic rule destination was last updated.

Definition at line 262 of file TopicRuleDestinationSummary.h.

◆ SetStatus() [1/2]

void Aws::IoT::Model::TopicRuleDestinationSummary::SetStatus ( const TopicRuleDestinationStatus value)
inline

The status of the topic rule destination. Valid values are:

IN_PROGRESS

A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

ENABLED

Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.

DISABLED

Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.

ERROR

Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

Definition at line 149 of file TopicRuleDestinationSummary.h.

◆ SetStatus() [2/2]

void Aws::IoT::Model::TopicRuleDestinationSummary::SetStatus ( TopicRuleDestinationStatus &&  value)
inline

The status of the topic rule destination. Valid values are:

IN_PROGRESS

A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

ENABLED

Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.

DISABLED

Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.

ERROR

Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

Definition at line 171 of file TopicRuleDestinationSummary.h.

◆ SetStatusReason() [1/3]

void Aws::IoT::Model::TopicRuleDestinationSummary::SetStatusReason ( Aws::String &&  value)
inline

The reason the topic rule destination is in the current status.

Definition at line 298 of file TopicRuleDestinationSummary.h.

◆ SetStatusReason() [2/3]

void Aws::IoT::Model::TopicRuleDestinationSummary::SetStatusReason ( const Aws::String value)
inline

The reason the topic rule destination is in the current status.

Definition at line 293 of file TopicRuleDestinationSummary.h.

◆ SetStatusReason() [3/3]

void Aws::IoT::Model::TopicRuleDestinationSummary::SetStatusReason ( const char *  value)
inline

The reason the topic rule destination is in the current status.

Definition at line 303 of file TopicRuleDestinationSummary.h.

◆ SetVpcDestinationSummary() [1/2]

void Aws::IoT::Model::TopicRuleDestinationSummary::SetVpcDestinationSummary ( const VpcDestinationSummary value)
inline

Information about the virtual private cloud (VPC) connection.

Definition at line 365 of file TopicRuleDestinationSummary.h.

◆ SetVpcDestinationSummary() [2/2]

void Aws::IoT::Model::TopicRuleDestinationSummary::SetVpcDestinationSummary ( VpcDestinationSummary &&  value)
inline

Information about the virtual private cloud (VPC) connection.

Definition at line 370 of file TopicRuleDestinationSummary.h.

◆ StatusHasBeenSet()

bool Aws::IoT::Model::TopicRuleDestinationSummary::StatusHasBeenSet ( ) const
inline

The status of the topic rule destination. Valid values are:

IN_PROGRESS

A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

ENABLED

Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.

DISABLED

Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.

ERROR

Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

Definition at line 127 of file TopicRuleDestinationSummary.h.

◆ StatusReasonHasBeenSet()

bool Aws::IoT::Model::TopicRuleDestinationSummary::StatusReasonHasBeenSet ( ) const
inline

The reason the topic rule destination is in the current status.

Definition at line 288 of file TopicRuleDestinationSummary.h.

◆ VpcDestinationSummaryHasBeenSet()

bool Aws::IoT::Model::TopicRuleDestinationSummary::VpcDestinationSummaryHasBeenSet ( ) const
inline

Information about the virtual private cloud (VPC) connection.

Definition at line 360 of file TopicRuleDestinationSummary.h.

◆ WithArn() [1/3]

TopicRuleDestinationSummary& Aws::IoT::Model::TopicRuleDestinationSummary::WithArn ( Aws::String &&  value)
inline

The topic rule destination ARN.

Definition at line 77 of file TopicRuleDestinationSummary.h.

◆ WithArn() [2/3]

TopicRuleDestinationSummary& Aws::IoT::Model::TopicRuleDestinationSummary::WithArn ( const Aws::String value)
inline

The topic rule destination ARN.

Definition at line 72 of file TopicRuleDestinationSummary.h.

◆ WithArn() [3/3]

TopicRuleDestinationSummary& Aws::IoT::Model::TopicRuleDestinationSummary::WithArn ( const char *  value)
inline

The topic rule destination ARN.

Definition at line 82 of file TopicRuleDestinationSummary.h.

◆ WithCreatedAt() [1/2]

TopicRuleDestinationSummary& Aws::IoT::Model::TopicRuleDestinationSummary::WithCreatedAt ( Aws::Utils::DateTime &&  value)
inline

The date and time when the topic rule destination was created.

Definition at line 246 of file TopicRuleDestinationSummary.h.

◆ WithCreatedAt() [2/2]

TopicRuleDestinationSummary& Aws::IoT::Model::TopicRuleDestinationSummary::WithCreatedAt ( const Aws::Utils::DateTime value)
inline

The date and time when the topic rule destination was created.

Definition at line 241 of file TopicRuleDestinationSummary.h.

◆ WithHttpUrlSummary() [1/2]

TopicRuleDestinationSummary& Aws::IoT::Model::TopicRuleDestinationSummary::WithHttpUrlSummary ( const HttpUrlDestinationSummary value)
inline

Information about the HTTP URL.

Definition at line 344 of file TopicRuleDestinationSummary.h.

◆ WithHttpUrlSummary() [2/2]

TopicRuleDestinationSummary& Aws::IoT::Model::TopicRuleDestinationSummary::WithHttpUrlSummary ( HttpUrlDestinationSummary &&  value)
inline

Information about the HTTP URL.

Definition at line 349 of file TopicRuleDestinationSummary.h.

◆ WithLastUpdatedAt() [1/2]

TopicRuleDestinationSummary& Aws::IoT::Model::TopicRuleDestinationSummary::WithLastUpdatedAt ( Aws::Utils::DateTime &&  value)
inline

The date and time when the topic rule destination was last updated.

Definition at line 277 of file TopicRuleDestinationSummary.h.

◆ WithLastUpdatedAt() [2/2]

TopicRuleDestinationSummary& Aws::IoT::Model::TopicRuleDestinationSummary::WithLastUpdatedAt ( const Aws::Utils::DateTime value)
inline

The date and time when the topic rule destination was last updated.

Definition at line 272 of file TopicRuleDestinationSummary.h.

◆ WithStatus() [1/2]

TopicRuleDestinationSummary& Aws::IoT::Model::TopicRuleDestinationSummary::WithStatus ( const TopicRuleDestinationStatus value)
inline

The status of the topic rule destination. Valid values are:

IN_PROGRESS

A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

ENABLED

Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.

DISABLED

Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.

ERROR

Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

Definition at line 193 of file TopicRuleDestinationSummary.h.

◆ WithStatus() [2/2]

TopicRuleDestinationSummary& Aws::IoT::Model::TopicRuleDestinationSummary::WithStatus ( TopicRuleDestinationStatus &&  value)
inline

The status of the topic rule destination. Valid values are:

IN_PROGRESS

A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

ENABLED

Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.

DISABLED

Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.

ERROR

Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

Definition at line 215 of file TopicRuleDestinationSummary.h.

◆ WithStatusReason() [1/3]

TopicRuleDestinationSummary& Aws::IoT::Model::TopicRuleDestinationSummary::WithStatusReason ( Aws::String &&  value)
inline

The reason the topic rule destination is in the current status.

Definition at line 313 of file TopicRuleDestinationSummary.h.

◆ WithStatusReason() [2/3]

TopicRuleDestinationSummary& Aws::IoT::Model::TopicRuleDestinationSummary::WithStatusReason ( const Aws::String value)
inline

The reason the topic rule destination is in the current status.

Definition at line 308 of file TopicRuleDestinationSummary.h.

◆ WithStatusReason() [3/3]

TopicRuleDestinationSummary& Aws::IoT::Model::TopicRuleDestinationSummary::WithStatusReason ( const char *  value)
inline

The reason the topic rule destination is in the current status.

Definition at line 318 of file TopicRuleDestinationSummary.h.

◆ WithVpcDestinationSummary() [1/2]

TopicRuleDestinationSummary& Aws::IoT::Model::TopicRuleDestinationSummary::WithVpcDestinationSummary ( const VpcDestinationSummary value)
inline

Information about the virtual private cloud (VPC) connection.

Definition at line 375 of file TopicRuleDestinationSummary.h.

◆ WithVpcDestinationSummary() [2/2]

TopicRuleDestinationSummary& Aws::IoT::Model::TopicRuleDestinationSummary::WithVpcDestinationSummary ( VpcDestinationSummary &&  value)
inline

Information about the virtual private cloud (VPC) connection.

Definition at line 380 of file TopicRuleDestinationSummary.h.


The documentation for this class was generated from the following file: