Class: StatusMessage

aws-greengrass-core-sdk .StreamManager~StatusMessage(eventType, statusLevel, status, statusContext, message, timestampEpochMs)

Status object appended to a status-stream.

Constructor

new StatusMessage(eventType, statusLevel, status, statusContext, message, timestampEpochMs)

Parameters:

Name	Type	Default	Description
`eventType`	aws-greengrass-core-sdk.StreamManager.EventType	null
`statusLevel`	aws-greengrass-core-sdk.StreamManager.StatusLevel	null
`status`	aws-greengrass-core-sdk.StreamManager.Status	null
`statusContext`	aws-greengrass-core-sdk.StreamManager.StatusContext	null
`message`	String	null	String describing the status message.
`timestampEpochMs`	Number	null	The time this status was added to the status-stream (in milliseconds since epoch).

Source:

stream-manager/data/index.js, line 2005

Members

eventType

Source:

stream-manager/data/index.js, line 2049

eventType

Source:

stream-manager/data/index.js, line 2055

message

String describing the status message.

Source:

stream-manager/data/index.js, line 2154

message

Source:

stream-manager/data/index.js, line 2160

status

Source:

stream-manager/data/index.js, line 2101

status

Source:

stream-manager/data/index.js, line 2107

statusContext

Source:

stream-manager/data/index.js, line 2127

statusContext

Source:

stream-manager/data/index.js, line 2133

statusLevel

Source:

stream-manager/data/index.js, line 2075

statusLevel

Source:

stream-manager/data/index.js, line 2081

timestampEpochMs

The time this status was added to the status-stream (in milliseconds since epoch).

Source:

stream-manager/data/index.js, line 2181

timestampEpochMs

Source:

stream-manager/data/index.js, line 2187

Methods

withEventType(value) → {aws-greengrass-core-sdk.StreamManager.StatusMessage}

Parameters:

Name	Type	Description
`value`	aws-greengrass-core-sdk.StreamManager.EventType

Source:

stream-manager/data/index.js, line 2066

Returns:

Type: aws-greengrass-core-sdk.StreamManager.StatusMessage

withMessage(value) → {aws-greengrass-core-sdk.StreamManager.StatusMessage}

Parameters:

Name	Type	Description
`value`	String	String describing the status message.

Source:

stream-manager/data/index.js, line 2171

Returns:

Type: aws-greengrass-core-sdk.StreamManager.StatusMessage

withStatus(value) → {aws-greengrass-core-sdk.StreamManager.StatusMessage}

Parameters:

Name	Type	Description
`value`	aws-greengrass-core-sdk.StreamManager.Status

Source:

stream-manager/data/index.js, line 2118

Returns:

Type: aws-greengrass-core-sdk.StreamManager.StatusMessage

withStatusContext(value) → {aws-greengrass-core-sdk.StreamManager.StatusMessage}

Parameters:

Name	Type	Description
`value`	aws-greengrass-core-sdk.StreamManager.StatusContext

Source:

stream-manager/data/index.js, line 2144

Returns:

Type: aws-greengrass-core-sdk.StreamManager.StatusMessage

withStatusLevel(value) → {aws-greengrass-core-sdk.StreamManager.StatusMessage}

Parameters:

Name	Type	Description
`value`	aws-greengrass-core-sdk.StreamManager.StatusLevel

Source:

stream-manager/data/index.js, line 2092

Returns:

Type: aws-greengrass-core-sdk.StreamManager.StatusMessage

withTimestampEpochMs(value) → {aws-greengrass-core-sdk.StreamManager.StatusMessage}

Parameters:

Name	Type	Description
`value`	Number	The time this status was added to the status-stream (in milliseconds since epoch).

Source:

stream-manager/data/index.js, line 2198

Returns:

Type: aws-greengrass-core-sdk.StreamManager.StatusMessage