Skip to content

/AWS1/CL_IOWGETFUOTATASKRSP

GetFuotaTaskResponse

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_arn TYPE /AWS1/IOWFUOTATASKARN /AWS1/IOWFUOTATASKARN

The arn of a FUOTA task.

iv_id TYPE /AWS1/IOWFUOTATASKID /AWS1/IOWFUOTATASKID

The ID of a FUOTA task.

iv_status TYPE /AWS1/IOWFUOTATASKSTATUS /AWS1/IOWFUOTATASKSTATUS

The status of a FUOTA task.

iv_name TYPE /AWS1/IOWFUOTATASKNAME /AWS1/IOWFUOTATASKNAME

The name of a FUOTA task.

iv_description TYPE /AWS1/IOWDESCRIPTION /AWS1/IOWDESCRIPTION

The description of the new resource.

io_lorawan TYPE REF TO /AWS1/CL_IOWLORAWANFUOTATSKG00 /AWS1/CL_IOWLORAWANFUOTATSKG00

The LoRaWAN information returned from getting a FUOTA task.

iv_firmwareupdateimage TYPE /AWS1/IOWFIRMWAREUPDATEIMAGE /AWS1/IOWFIRMWAREUPDATEIMAGE

The S3 URI points to a firmware update image that is to be used with a FUOTA task.

iv_firmwareupdaterole TYPE /AWS1/IOWFIRMWAREUPDATEROLE /AWS1/IOWFIRMWAREUPDATEROLE

The firmware update role that is to be used with a FUOTA task.

iv_createdat TYPE /AWS1/IOWCREATEDAT /AWS1/IOWCREATEDAT

Created at timestamp for the resource.

iv_redundancypercent TYPE /AWS1/IOWREDUNDANCYPERCENT /AWS1/IOWREDUNDANCYPERCENT

The percentage of the added fragments that are redundant. For example, if the size of the firmware image file is 100 bytes and the fragment size is 10 bytes, with RedundancyPercent set to 50(%), the final number of encoded fragments is (100 / 10) + (100 / 10 * 50%) = 15.

iv_fragmentsizebytes TYPE /AWS1/IOWFRAGMENTSIZEBYTES /AWS1/IOWFRAGMENTSIZEBYTES

The size of each fragment in bytes. This parameter is supported only for FUOTA tasks with multicast groups.

iv_fragmentintervalms TYPE /AWS1/IOWFRAGMENTINTERVALMS /AWS1/IOWFRAGMENTINTERVALMS

The interval for sending fragments in milliseconds, rounded to the nearest second.

This interval only determines the timing for when the Cloud sends down the fragments to yor device. There can be a delay for when your device will receive these fragments. This delay depends on the device's class and the communication delay with the cloud.

iv_descriptor TYPE /AWS1/IOWFILEDESCRIPTOR /AWS1/IOWFILEDESCRIPTOR

The descriptor is the metadata about the file that is transferred to the device using FUOTA, such as the software version. It is a binary field encoded in base64.


Queryable Attributes

Arn

The arn of a FUOTA task.

Accessible with the following methods

Method Description
GET_ARN() Getter for ARN, with configurable default
ASK_ARN() Getter for ARN w/ exceptions if field has no value
HAS_ARN() Determine if ARN has a value

Id

The ID of a FUOTA task.

Accessible with the following methods

Method Description
GET_ID() Getter for ID, with configurable default
ASK_ID() Getter for ID w/ exceptions if field has no value
HAS_ID() Determine if ID has a value

Status

The status of a FUOTA task.

Accessible with the following methods

Method Description
GET_STATUS() Getter for STATUS, with configurable default
ASK_STATUS() Getter for STATUS w/ exceptions if field has no value
HAS_STATUS() Determine if STATUS has a value

Name

The name of a FUOTA task.

Accessible with the following methods

Method Description
GET_NAME() Getter for NAME, with configurable default
ASK_NAME() Getter for NAME w/ exceptions if field has no value
HAS_NAME() Determine if NAME has a value

Description

The description of the new resource.

Accessible with the following methods

Method Description
GET_DESCRIPTION() Getter for DESCRIPTION, with configurable default
ASK_DESCRIPTION() Getter for DESCRIPTION w/ exceptions if field has no value
HAS_DESCRIPTION() Determine if DESCRIPTION has a value

LoRaWAN

The LoRaWAN information returned from getting a FUOTA task.

Accessible with the following methods

Method Description
GET_LORAWAN() Getter for LORAWAN

FirmwareUpdateImage

The S3 URI points to a firmware update image that is to be used with a FUOTA task.

Accessible with the following methods

Method Description
GET_FIRMWAREUPDATEIMAGE() Getter for FIRMWAREUPDATEIMAGE, with configurable default
ASK_FIRMWAREUPDATEIMAGE() Getter for FIRMWAREUPDATEIMAGE w/ exceptions if field has no
HAS_FIRMWAREUPDATEIMAGE() Determine if FIRMWAREUPDATEIMAGE has a value

FirmwareUpdateRole

The firmware update role that is to be used with a FUOTA task.

Accessible with the following methods

Method Description
GET_FIRMWAREUPDATEROLE() Getter for FIRMWAREUPDATEROLE, with configurable default
ASK_FIRMWAREUPDATEROLE() Getter for FIRMWAREUPDATEROLE w/ exceptions if field has no
HAS_FIRMWAREUPDATEROLE() Determine if FIRMWAREUPDATEROLE has a value

CreatedAt

Created at timestamp for the resource.

Accessible with the following methods

Method Description
GET_CREATEDAT() Getter for CREATEDAT, with configurable default
ASK_CREATEDAT() Getter for CREATEDAT w/ exceptions if field has no value
HAS_CREATEDAT() Determine if CREATEDAT has a value

RedundancyPercent

The percentage of the added fragments that are redundant. For example, if the size of the firmware image file is 100 bytes and the fragment size is 10 bytes, with RedundancyPercent set to 50(%), the final number of encoded fragments is (100 / 10) + (100 / 10 * 50%) = 15.

Accessible with the following methods

Method Description
GET_REDUNDANCYPERCENT() Getter for REDUNDANCYPERCENT, with configurable default
ASK_REDUNDANCYPERCENT() Getter for REDUNDANCYPERCENT w/ exceptions if field has no v
HAS_REDUNDANCYPERCENT() Determine if REDUNDANCYPERCENT has a value

FragmentSizeBytes

The size of each fragment in bytes. This parameter is supported only for FUOTA tasks with multicast groups.

Accessible with the following methods

Method Description
GET_FRAGMENTSIZEBYTES() Getter for FRAGMENTSIZEBYTES, with configurable default
ASK_FRAGMENTSIZEBYTES() Getter for FRAGMENTSIZEBYTES w/ exceptions if field has no v
HAS_FRAGMENTSIZEBYTES() Determine if FRAGMENTSIZEBYTES has a value

FragmentIntervalMS

The interval for sending fragments in milliseconds, rounded to the nearest second.

This interval only determines the timing for when the Cloud sends down the fragments to yor device. There can be a delay for when your device will receive these fragments. This delay depends on the device's class and the communication delay with the cloud.

Accessible with the following methods

Method Description
GET_FRAGMENTINTERVALMS() Getter for FRAGMENTINTERVALMS, with configurable default
ASK_FRAGMENTINTERVALMS() Getter for FRAGMENTINTERVALMS w/ exceptions if field has no
HAS_FRAGMENTINTERVALMS() Determine if FRAGMENTINTERVALMS has a value

Descriptor

The descriptor is the metadata about the file that is transferred to the device using FUOTA, such as the software version. It is a binary field encoded in base64.

Accessible with the following methods

Method Description
GET_DESCRIPTOR() Getter for DESCRIPTOR, with configurable default
ASK_DESCRIPTOR() Getter for DESCRIPTOR w/ exceptions if field has no value
HAS_DESCRIPTOR() Determine if DESCRIPTOR has a value