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

#include <AssociateTargetsWithJobRequest.h>

+ Inheritance diagram for Aws::IoT::Model::AssociateTargetsWithJobRequest:

Public Member Functions

 AssociateTargetsWithJobRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
const Aws::Vector< Aws::String > & GetTargets () const
 
bool TargetsHasBeenSet () const
 
void SetTargets (const Aws::Vector< Aws::String > &value)
 
void SetTargets (Aws::Vector< Aws::String > &&value)
 
AssociateTargetsWithJobRequestWithTargets (const Aws::Vector< Aws::String > &value)
 
AssociateTargetsWithJobRequestWithTargets (Aws::Vector< Aws::String > &&value)
 
AssociateTargetsWithJobRequestAddTargets (const Aws::String &value)
 
AssociateTargetsWithJobRequestAddTargets (Aws::String &&value)
 
AssociateTargetsWithJobRequestAddTargets (const char *value)
 
const Aws::StringGetJobId () const
 
bool JobIdHasBeenSet () const
 
void SetJobId (const Aws::String &value)
 
void SetJobId (Aws::String &&value)
 
void SetJobId (const char *value)
 
AssociateTargetsWithJobRequestWithJobId (const Aws::String &value)
 
AssociateTargetsWithJobRequestWithJobId (Aws::String &&value)
 
AssociateTargetsWithJobRequestWithJobId (const char *value)
 
const Aws::StringGetComment () const
 
bool CommentHasBeenSet () const
 
void SetComment (const Aws::String &value)
 
void SetComment (Aws::String &&value)
 
void SetComment (const char *value)
 
AssociateTargetsWithJobRequestWithComment (const Aws::String &value)
 
AssociateTargetsWithJobRequestWithComment (Aws::String &&value)
 
AssociateTargetsWithJobRequestWithComment (const char *value)
 
const Aws::StringGetNamespaceId () const
 
bool NamespaceIdHasBeenSet () const
 
void SetNamespaceId (const Aws::String &value)
 
void SetNamespaceId (Aws::String &&value)
 
void SetNamespaceId (const char *value)
 
AssociateTargetsWithJobRequestWithNamespaceId (const Aws::String &value)
 
AssociateTargetsWithJobRequestWithNamespaceId (Aws::String &&value)
 
AssociateTargetsWithJobRequestWithNamespaceId (const char *value)
 
- Public Member Functions inherited from Aws::IoT::IoTRequest
virtual ~IoTRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::IoT::IoTRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 26 of file AssociateTargetsWithJobRequest.h.

Constructor & Destructor Documentation

◆ AssociateTargetsWithJobRequest()

Aws::IoT::Model::AssociateTargetsWithJobRequest::AssociateTargetsWithJobRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

void Aws::IoT::Model::AssociateTargetsWithJobRequest::AddQueryStringParameters ( Aws::Http::URI uri) const
overridevirtual

Do nothing virtual, override this to add query strings to the request

Reimplemented from Aws::AmazonWebServiceRequest.

◆ AddTargets() [1/3]

AssociateTargetsWithJobRequest& Aws::IoT::Model::AssociateTargetsWithJobRequest::AddTargets ( Aws::String &&  value)
inline

A list of thing group ARNs that define the targets of the job.

Definition at line 80 of file AssociateTargetsWithJobRequest.h.

◆ AddTargets() [2/3]

AssociateTargetsWithJobRequest& Aws::IoT::Model::AssociateTargetsWithJobRequest::AddTargets ( const Aws::String value)
inline

A list of thing group ARNs that define the targets of the job.

Definition at line 75 of file AssociateTargetsWithJobRequest.h.

◆ AddTargets() [3/3]

AssociateTargetsWithJobRequest& Aws::IoT::Model::AssociateTargetsWithJobRequest::AddTargets ( const char *  value)
inline

A list of thing group ARNs that define the targets of the job.

Definition at line 85 of file AssociateTargetsWithJobRequest.h.

◆ CommentHasBeenSet()

bool Aws::IoT::Model::AssociateTargetsWithJobRequest::CommentHasBeenSet ( ) const
inline

An optional comment string describing why the job was associated with the targets.

Definition at line 139 of file AssociateTargetsWithJobRequest.h.

◆ GetComment()

const Aws::String& Aws::IoT::Model::AssociateTargetsWithJobRequest::GetComment ( ) const
inline

An optional comment string describing why the job was associated with the targets.

Definition at line 133 of file AssociateTargetsWithJobRequest.h.

◆ GetJobId()

const Aws::String& Aws::IoT::Model::AssociateTargetsWithJobRequest::GetJobId ( ) const
inline

The unique identifier you assigned to this job when it was created.

Definition at line 91 of file AssociateTargetsWithJobRequest.h.

◆ GetNamespaceId()

const Aws::String& Aws::IoT::Model::AssociateTargetsWithJobRequest::GetNamespaceId ( ) const
inline

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 187 of file AssociateTargetsWithJobRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::IoT::Model::AssociateTargetsWithJobRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file AssociateTargetsWithJobRequest.h.

◆ GetTargets()

const Aws::Vector<Aws::String>& Aws::IoT::Model::AssociateTargetsWithJobRequest::GetTargets ( ) const
inline

A list of thing group ARNs that define the targets of the job.

Definition at line 45 of file AssociateTargetsWithJobRequest.h.

◆ JobIdHasBeenSet()

bool Aws::IoT::Model::AssociateTargetsWithJobRequest::JobIdHasBeenSet ( ) const
inline

The unique identifier you assigned to this job when it was created.

Definition at line 96 of file AssociateTargetsWithJobRequest.h.

◆ NamespaceIdHasBeenSet()

bool Aws::IoT::Model::AssociateTargetsWithJobRequest::NamespaceIdHasBeenSet ( ) const
inline

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 198 of file AssociateTargetsWithJobRequest.h.

◆ SerializePayload()

Aws::String Aws::IoT::Model::AssociateTargetsWithJobRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetComment() [1/3]

void Aws::IoT::Model::AssociateTargetsWithJobRequest::SetComment ( Aws::String &&  value)
inline

An optional comment string describing why the job was associated with the targets.

Definition at line 151 of file AssociateTargetsWithJobRequest.h.

◆ SetComment() [2/3]

void Aws::IoT::Model::AssociateTargetsWithJobRequest::SetComment ( const Aws::String value)
inline

An optional comment string describing why the job was associated with the targets.

Definition at line 145 of file AssociateTargetsWithJobRequest.h.

◆ SetComment() [3/3]

void Aws::IoT::Model::AssociateTargetsWithJobRequest::SetComment ( const char *  value)
inline

An optional comment string describing why the job was associated with the targets.

Definition at line 157 of file AssociateTargetsWithJobRequest.h.

◆ SetJobId() [1/3]

void Aws::IoT::Model::AssociateTargetsWithJobRequest::SetJobId ( Aws::String &&  value)
inline

The unique identifier you assigned to this job when it was created.

Definition at line 106 of file AssociateTargetsWithJobRequest.h.

◆ SetJobId() [2/3]

void Aws::IoT::Model::AssociateTargetsWithJobRequest::SetJobId ( const Aws::String value)
inline

The unique identifier you assigned to this job when it was created.

Definition at line 101 of file AssociateTargetsWithJobRequest.h.

◆ SetJobId() [3/3]

void Aws::IoT::Model::AssociateTargetsWithJobRequest::SetJobId ( const char *  value)
inline

The unique identifier you assigned to this job when it was created.

Definition at line 111 of file AssociateTargetsWithJobRequest.h.

◆ SetNamespaceId() [1/3]

void Aws::IoT::Model::AssociateTargetsWithJobRequest::SetNamespaceId ( Aws::String &&  value)
inline

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 220 of file AssociateTargetsWithJobRequest.h.

◆ SetNamespaceId() [2/3]

void Aws::IoT::Model::AssociateTargetsWithJobRequest::SetNamespaceId ( const Aws::String value)
inline

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 209 of file AssociateTargetsWithJobRequest.h.

◆ SetNamespaceId() [3/3]

void Aws::IoT::Model::AssociateTargetsWithJobRequest::SetNamespaceId ( const char *  value)
inline

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 231 of file AssociateTargetsWithJobRequest.h.

◆ SetTargets() [1/2]

void Aws::IoT::Model::AssociateTargetsWithJobRequest::SetTargets ( Aws::Vector< Aws::String > &&  value)
inline

A list of thing group ARNs that define the targets of the job.

Definition at line 60 of file AssociateTargetsWithJobRequest.h.

◆ SetTargets() [2/2]

void Aws::IoT::Model::AssociateTargetsWithJobRequest::SetTargets ( const Aws::Vector< Aws::String > &  value)
inline

A list of thing group ARNs that define the targets of the job.

Definition at line 55 of file AssociateTargetsWithJobRequest.h.

◆ TargetsHasBeenSet()

bool Aws::IoT::Model::AssociateTargetsWithJobRequest::TargetsHasBeenSet ( ) const
inline

A list of thing group ARNs that define the targets of the job.

Definition at line 50 of file AssociateTargetsWithJobRequest.h.

◆ WithComment() [1/3]

AssociateTargetsWithJobRequest& Aws::IoT::Model::AssociateTargetsWithJobRequest::WithComment ( Aws::String &&  value)
inline

An optional comment string describing why the job was associated with the targets.

Definition at line 169 of file AssociateTargetsWithJobRequest.h.

◆ WithComment() [2/3]

AssociateTargetsWithJobRequest& Aws::IoT::Model::AssociateTargetsWithJobRequest::WithComment ( const Aws::String value)
inline

An optional comment string describing why the job was associated with the targets.

Definition at line 163 of file AssociateTargetsWithJobRequest.h.

◆ WithComment() [3/3]

AssociateTargetsWithJobRequest& Aws::IoT::Model::AssociateTargetsWithJobRequest::WithComment ( const char *  value)
inline

An optional comment string describing why the job was associated with the targets.

Definition at line 175 of file AssociateTargetsWithJobRequest.h.

◆ WithJobId() [1/3]

AssociateTargetsWithJobRequest& Aws::IoT::Model::AssociateTargetsWithJobRequest::WithJobId ( Aws::String &&  value)
inline

The unique identifier you assigned to this job when it was created.

Definition at line 121 of file AssociateTargetsWithJobRequest.h.

◆ WithJobId() [2/3]

AssociateTargetsWithJobRequest& Aws::IoT::Model::AssociateTargetsWithJobRequest::WithJobId ( const Aws::String value)
inline

The unique identifier you assigned to this job when it was created.

Definition at line 116 of file AssociateTargetsWithJobRequest.h.

◆ WithJobId() [3/3]

AssociateTargetsWithJobRequest& Aws::IoT::Model::AssociateTargetsWithJobRequest::WithJobId ( const char *  value)
inline

The unique identifier you assigned to this job when it was created.

Definition at line 126 of file AssociateTargetsWithJobRequest.h.

◆ WithNamespaceId() [1/3]

AssociateTargetsWithJobRequest& Aws::IoT::Model::AssociateTargetsWithJobRequest::WithNamespaceId ( Aws::String &&  value)
inline

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 253 of file AssociateTargetsWithJobRequest.h.

◆ WithNamespaceId() [2/3]

AssociateTargetsWithJobRequest& Aws::IoT::Model::AssociateTargetsWithJobRequest::WithNamespaceId ( const Aws::String value)
inline

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 242 of file AssociateTargetsWithJobRequest.h.

◆ WithNamespaceId() [3/3]

AssociateTargetsWithJobRequest& Aws::IoT::Model::AssociateTargetsWithJobRequest::WithNamespaceId ( const char *  value)
inline

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Definition at line 264 of file AssociateTargetsWithJobRequest.h.

◆ WithTargets() [1/2]

AssociateTargetsWithJobRequest& Aws::IoT::Model::AssociateTargetsWithJobRequest::WithTargets ( Aws::Vector< Aws::String > &&  value)
inline

A list of thing group ARNs that define the targets of the job.

Definition at line 70 of file AssociateTargetsWithJobRequest.h.

◆ WithTargets() [2/2]

AssociateTargetsWithJobRequest& Aws::IoT::Model::AssociateTargetsWithJobRequest::WithTargets ( const Aws::Vector< Aws::String > &  value)
inline

A list of thing group ARNs that define the targets of the job.

Definition at line 65 of file AssociateTargetsWithJobRequest.h.


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