Class: Message

.StreamManager~Message(streamName, sequenceNumber, ingestTime, payload)

Message object containing metadata and the user's payload.

Constructor

new Message(streamName, sequenceNumber, ingestTime, payload)

Parameters:

Name	Type	Default	Description
`streamName`	String	null	The name of the stream which this message is in.
`sequenceNumber`	Number	null	The sequence number of this message within the stream.
`ingestTime`	Number	null	The time that the message was ingested to Stream Manager. Data is Unix epoch time in milliseconds.
`payload`	Buffer	null	The binary message data.

Source:

data/index.js, line 8507

Members

ingestTime

The time that the message was ingested to Stream Manager. Data is Unix epoch time in milliseconds.

Source:

data/index.js, line 8594

ingestTime

Source:

data/index.js, line 8600

payload

The binary message data.

Source:

data/index.js, line 8621

payload

Source:

data/index.js, line 8627

sequenceNumber

The sequence number of this message within the stream.

Source:

data/index.js, line 8567

sequenceNumber

Source:

data/index.js, line 8573

streamName

The name of the stream which this message is in.

Source:

data/index.js, line 8540

streamName

Source:

data/index.js, line 8546

Methods

withIngestTime(value) → {aws-greengrass-core-sdk.StreamManager.Message}

Parameters:

Name	Type	Description
`value`	Number	The time that the message was ingested to Stream Manager. Data is Unix epoch time in milliseconds.

Source:

data/index.js, line 8611

Returns:

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

withPayload(value) → {aws-greengrass-core-sdk.StreamManager.Message}

Parameters:

Name	Type	Description
`value`	Buffer	The binary message data.

Source:

data/index.js, line 8638

Returns:

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

withSequenceNumber(value) → {aws-greengrass-core-sdk.StreamManager.Message}

Parameters:

Name	Type	Description
`value`	Number	The sequence number of this message within the stream.

Source:

data/index.js, line 8584

Returns:

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

withStreamName(value) → {aws-greengrass-core-sdk.StreamManager.Message}

Parameters:

Name	Type	Description
`value`	String	The name of the stream which this message is in.

Source:

data/index.js, line 8557

Returns:

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