JobsUpdateRequest_t Struct Reference

Structure for Jobs_UpdateMsg request parameters. More...

#include <jobs.h>

Data Fields
JobCurrentStatus_t	status
const char *	expectedVersion
size_t	expectedVersionLength
const char *	statusDetails
size_t	statusDetailsLength

Detailed Description

Structure for Jobs_UpdateMsg request parameters.

Note

For optional fields setting a pointer to NULL or the length to 0U will disable this field from being used.

Optional fields include:

• expectedVersion
• expectedVersionLength
• statusDetails
• statusDetailsLength

The status details must be a JSON formatted key-value pair.

Field Documentation

status

JobCurrentStatus_t JobsUpdateRequest_t::status

Status to update the job to.

expectedVersion

const char* JobsUpdateRequest_t::expectedVersion

Expected version, optional.

expectedVersionLength

size_t JobsUpdateRequest_t::expectedVersionLength

Expected version length, optional.

statusDetails

const char* JobsUpdateRequest_t::statusDetails

JSON key-value pair, optional.

statusDetailsLength

size_t JobsUpdateRequest_t::statusDetailsLength

JSON key-value pair length, optional.

---

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

• jobs.h