#include <DeleteOTAUpdateRequest.h>

Inheritance diagram for Aws::IoT::Model::DeleteOTAUpdateRequest:

Public Member Functions
	DeleteOTAUpdateRequest ()

virtual const char *	GetServiceRequestName () const override

Aws::String	SerializePayload () const override

void	AddQueryStringParameters (Aws::Http::URI &uri) const override

const Aws::String &	GetOtaUpdateId () const

bool	OtaUpdateIdHasBeenSet () const

void	SetOtaUpdateId (const Aws::String &value)

void	SetOtaUpdateId (Aws::String &&value)

void	SetOtaUpdateId (const char *value)

DeleteOTAUpdateRequest &	WithOtaUpdateId (const Aws::String &value)

DeleteOTAUpdateRequest &	WithOtaUpdateId (Aws::String &&value)

DeleteOTAUpdateRequest &	WithOtaUpdateId (const char *value)

bool	GetDeleteStream () const

bool	DeleteStreamHasBeenSet () const

void	SetDeleteStream (bool value)

DeleteOTAUpdateRequest &	WithDeleteStream (bool value)

bool	GetForceDeleteAWSJob () const

bool	ForceDeleteAWSJobHasBeenSet () const

void	SetForceDeleteAWSJob (bool value)

DeleteOTAUpdateRequest &	WithForceDeleteAWSJob (bool 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::IOStream >	GetBody () 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 RequestSignedHandler &	GetRequestSignedHandler () const

const Aws::IOStreamFactory &	GetResponseStreamFactory () 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::DataReceivedEventHandler &	GetDataReceivedEventHandler () const

virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const

virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const

virtual const RequestRetryHandler &	GetRequestRetryHandler () 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 25 of file DeleteOTAUpdateRequest.h.

Constructor & Destructor Documentation

◆ DeleteOTAUpdateRequest()

Aws::IoT::Model::DeleteOTAUpdateRequest::DeleteOTAUpdateRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

void Aws::IoT::Model::DeleteOTAUpdateRequest::AddQueryStringParameters ( Aws::Http::URI & uri ) const

overridevirtual

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

Reimplemented from Aws::AmazonWebServiceRequest.

◆ DeleteStreamHasBeenSet()

bool Aws::IoT::Model::DeleteOTAUpdateRequest::DeleteStreamHasBeenSet ( ) const

inline

When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted. Ignored if the stream specified in the OTAUpdate is supplied by the user.

Definition at line 94 of file DeleteOTAUpdateRequest.h.

◆ ForceDeleteAWSJobHasBeenSet()

bool Aws::IoT::Model::DeleteOTAUpdateRequest::ForceDeleteAWSJobHasBeenSet ( ) const

inline

When true, deletes the IoT job created by the OTAUpdate process even if it is "IN_PROGRESS". Otherwise, if the job is not in a terminal state ("COMPLETED" or "CANCELED") an exception will occur. The default is false.

Definition at line 123 of file DeleteOTAUpdateRequest.h.

◆ GetDeleteStream()

bool Aws::IoT::Model::DeleteOTAUpdateRequest::GetDeleteStream ( ) const

inline

When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted. Ignored if the stream specified in the OTAUpdate is supplied by the user.

Definition at line 87 of file DeleteOTAUpdateRequest.h.

◆ GetForceDeleteAWSJob()

bool Aws::IoT::Model::DeleteOTAUpdateRequest::GetForceDeleteAWSJob ( ) const

inline

When true, deletes the IoT job created by the OTAUpdate process even if it is "IN_PROGRESS". Otherwise, if the job is not in a terminal state ("COMPLETED" or "CANCELED") an exception will occur. The default is false.

Definition at line 116 of file DeleteOTAUpdateRequest.h.

◆ GetOtaUpdateId()

const Aws::String& Aws::IoT::Model::DeleteOTAUpdateRequest::GetOtaUpdateId ( ) const

inline

The ID of the OTA update to delete.

Definition at line 44 of file DeleteOTAUpdateRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::IoT::Model::DeleteOTAUpdateRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file DeleteOTAUpdateRequest.h.

◆ OtaUpdateIdHasBeenSet()

bool Aws::IoT::Model::DeleteOTAUpdateRequest::OtaUpdateIdHasBeenSet ( ) const

inline

The ID of the OTA update to delete.

Definition at line 49 of file DeleteOTAUpdateRequest.h.

◆ SerializePayload()

Aws::String Aws::IoT::Model::DeleteOTAUpdateRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDeleteStream()

void Aws::IoT::Model::DeleteOTAUpdateRequest::SetDeleteStream ( bool value )

inline

When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted. Ignored if the stream specified in the OTAUpdate is supplied by the user.

Definition at line 101 of file DeleteOTAUpdateRequest.h.

◆ SetForceDeleteAWSJob()

void Aws::IoT::Model::DeleteOTAUpdateRequest::SetForceDeleteAWSJob ( bool value )

inline

When true, deletes the IoT job created by the OTAUpdate process even if it is "IN_PROGRESS". Otherwise, if the job is not in a terminal state ("COMPLETED" or "CANCELED") an exception will occur. The default is false.

Definition at line 130 of file DeleteOTAUpdateRequest.h.

◆ SetOtaUpdateId() [1/3]

void Aws::IoT::Model::DeleteOTAUpdateRequest::SetOtaUpdateId ( Aws::String && value )

inline

The ID of the OTA update to delete.

Definition at line 59 of file DeleteOTAUpdateRequest.h.

◆ SetOtaUpdateId() [2/3]

void Aws::IoT::Model::DeleteOTAUpdateRequest::SetOtaUpdateId ( const Aws::String & value )

inline

The ID of the OTA update to delete.

Definition at line 54 of file DeleteOTAUpdateRequest.h.

◆ SetOtaUpdateId() [3/3]

void Aws::IoT::Model::DeleteOTAUpdateRequest::SetOtaUpdateId ( const char * value )

inline

The ID of the OTA update to delete.

Definition at line 64 of file DeleteOTAUpdateRequest.h.

◆ WithDeleteStream()

DeleteOTAUpdateRequest& Aws::IoT::Model::DeleteOTAUpdateRequest::WithDeleteStream ( bool value )

inline

When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted. Ignored if the stream specified in the OTAUpdate is supplied by the user.

Definition at line 108 of file DeleteOTAUpdateRequest.h.

◆ WithForceDeleteAWSJob()

DeleteOTAUpdateRequest& Aws::IoT::Model::DeleteOTAUpdateRequest::WithForceDeleteAWSJob ( bool value )

inline

When true, deletes the IoT job created by the OTAUpdate process even if it is "IN_PROGRESS". Otherwise, if the job is not in a terminal state ("COMPLETED" or "CANCELED") an exception will occur. The default is false.

Definition at line 137 of file DeleteOTAUpdateRequest.h.

◆ WithOtaUpdateId() [1/3]

DeleteOTAUpdateRequest& Aws::IoT::Model::DeleteOTAUpdateRequest::WithOtaUpdateId ( Aws::String && value )

inline

The ID of the OTA update to delete.

Definition at line 74 of file DeleteOTAUpdateRequest.h.

◆ WithOtaUpdateId() [2/3]

DeleteOTAUpdateRequest& Aws::IoT::Model::DeleteOTAUpdateRequest::WithOtaUpdateId ( const Aws::String & value )

inline

The ID of the OTA update to delete.

Definition at line 69 of file DeleteOTAUpdateRequest.h.

◆ WithOtaUpdateId() [3/3]

DeleteOTAUpdateRequest& Aws::IoT::Model::DeleteOTAUpdateRequest::WithOtaUpdateId ( const char * value )

inline

The ID of the OTA update to delete.

Definition at line 79 of file DeleteOTAUpdateRequest.h.

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

aws-cpp-sdk-iot/include/aws/iot/model/DeleteOTAUpdateRequest.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DeleteOTAUpdateRequest()

Member Function Documentation

◆ AddQueryStringParameters()

◆ DeleteStreamHasBeenSet()

◆ ForceDeleteAWSJobHasBeenSet()

◆ GetDeleteStream()

◆ GetForceDeleteAWSJob()

◆ GetOtaUpdateId()

◆ GetServiceRequestName()

◆ OtaUpdateIdHasBeenSet()

◆ SerializePayload()

◆ SetDeleteStream()

◆ SetForceDeleteAWSJob()

◆ SetOtaUpdateId() [1/3]

◆ SetOtaUpdateId() [2/3]

◆ SetOtaUpdateId() [3/3]

◆ WithDeleteStream()

◆ WithForceDeleteAWSJob()

◆ WithOtaUpdateId() [1/3]

◆ WithOtaUpdateId() [2/3]

◆ WithOtaUpdateId() [3/3]