Class: Message

aws-greengrass-core-sdk.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:

Members

ingestTime

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

ingestTime

Source:

payload

The binary message data.
Source:

payload

Source:

sequenceNumber

The sequence number of this message within the stream.
Source:

sequenceNumber

Source:

streamName

The name of the stream which this message is in.
Source:

streamName

Source:

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:
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:
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:
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:
Returns:
Type
aws-greengrass-core-sdk.StreamManager.Message