Aws::Iotcommands::CommandExecutionEvent Class Reference

#include <CommandExecutionEvent.h>

Public Member Functions
	CommandExecutionEvent ()=default
	CommandExecutionEvent (const Crt::JsonView &doc)
CommandExecutionEvent &	operator= (const Crt::JsonView &doc)
void	SerializeToObject (Crt::JsonObject &doc) const
void	SetExecutionId (Aws::Crt::ByteCursor value)
void	SetPayload (Aws::Crt::ByteCursor payload)
void	SetContentType (Aws::Crt::ByteCursor contentType)
void	SetTimeout (int32_t messageExpiryInterval)

Public Attributes
Aws::Crt::Optional< Aws::Crt::Vector< uint8_t > >	Payload
Aws::Crt::Optional< Aws::Crt::String >	ExecutionId
Aws::Crt::Optional< Aws::Crt::String >	ContentType
Aws::Crt::Optional< int32_t >	Timeout

Detailed Description

Sent whenever a command execution is added for a thing or a client.

Constructor & Destructor Documentation

CommandExecutionEvent() [1/2]

Aws::Iotcommands::CommandExecutionEvent::CommandExecutionEvent ( )

default

CommandExecutionEvent() [2/2]

Aws::Iotcommands::CommandExecutionEvent::CommandExecutionEvent

(

const Crt::JsonView &

doc

)

Member Function Documentation

operator=()

CommandExecutionEvent & Aws::Iotcommands::CommandExecutionEvent::operator=

(

const Crt::JsonView &

doc

)

SerializeToObject()

void Aws::Iotcommands::CommandExecutionEvent::SerializeToObject

(

Crt::JsonObject &

doc

)

const

SetContentType()

void Aws::Iotcommands::CommandExecutionEvent::SetContentType

(

Aws::Crt::ByteCursor

contentType

)

SetExecutionId()

void Aws::Iotcommands::CommandExecutionEvent::SetExecutionId

(

Aws::Crt::ByteCursor

value

)

SetPayload()

void Aws::Iotcommands::CommandExecutionEvent::SetPayload

(

Aws::Crt::ByteCursor

payload

)

SetTimeout()

void Aws::Iotcommands::CommandExecutionEvent::SetTimeout

(

int32_t

messageExpiryInterval

)

Member Data Documentation

ContentType

Aws::Crt::Optional<Aws::Crt::String> Aws::Iotcommands::CommandExecutionEvent::ContentType

Data format of the payload. It is supposed to be a MIME type (IANA media type), but can be an arbitrary string.

ExecutionId

Aws::Crt::Optional<Aws::Crt::String> Aws::Iotcommands::CommandExecutionEvent::ExecutionId

Unique ID for the specific execution of a command. A command can have multiple executions, each with a unique ID.

Payload

Aws::Crt::Optional<Aws::Crt::Vector<uint8_t> > Aws::Iotcommands::CommandExecutionEvent::Payload

Opaque data containing instructions sent from the IoT commands service.

Timeout

Aws::Crt::Optional<int32_t> Aws::Iotcommands::CommandExecutionEvent::Timeout

Number of seconds before the IoT commands service decides that this command execution is timed out.

---

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

• commands/include/aws/iotcommands/CommandExecutionEvent.h
• commands/source/CommandExecutionEvent.cpp