Class: MessageStreamInfo

.StreamManager~MessageStreamInfo(definition, storageStatus, exportStatuses)

Message stream information including its definition, storage status and export status.

Constructor

new MessageStreamInfo(definition, storageStatus, exportStatuses)

Parameters:
Name Type Default Description
definition aws-greengrass-core-sdk.StreamManager.MessageStreamDefinition null
storageStatus aws-greengrass-core-sdk.StreamManager.MessageStreamInfo~MessageStreamInfo._storageStatus null Stream status including oldest/newest sequence number and total bytes.
exportStatuses Array.<aws-greengrass-core-sdk.StreamManager.MessageStreamInfo~MessageStreamInfo._exportStatuses> null
Source:

Members

(static) _exportStatuses#errorMessage

Error message from the last export attempt if it failed.
Source:

(static) _exportStatuses#errorMessage

Source:

(static) _exportStatuses#exportConfigIdentifier

The unique export identifier.
Source:

(static) _exportStatuses#exportConfigIdentifier

Source:

(static) _exportStatuses#exportedBytesFromStream

Total bytes exported from the stream for this Export Config. It does not include the failed export attempts or messages which are skipped because of some non-retryable error.
Source:

(static) _exportStatuses#exportedBytesFromStream

Source:

(static) _exportStatuses#exportedMessagesCount

Total messages exported/processed.
Source:

(static) _exportStatuses#exportedMessagesCount

Source:

(static) _exportStatuses#lastExportedSequenceNumber

The sequence number of the last message which was successfully exported.
Source:

(static) _exportStatuses#lastExportedSequenceNumber

Source:

(static) _exportStatuses#lastExportTime

The last time an export was attempted. Data is Unix epoch time in milliseconds.
Source:

(static) _exportStatuses#lastExportTime

Source:

(static) _storageStatus#newestSequenceNumber

The sequence number of the last appended message.
Source:

(static) _storageStatus#newestSequenceNumber

Source:

(static) _storageStatus#oldestSequenceNumber

The sequence number of the first message which is still accessible in the stream.
Source:

(static) _storageStatus#oldestSequenceNumber

Source:

(static) _storageStatus#totalBytes

The current total size of the stream in bytes.
Source:

(static) _storageStatus#totalBytes

Source:

definition

Source:

definition

Source:

exportStatuses

Source:

exportStatuses

Source:

storageStatus

Stream status including oldest/newest sequence number and total bytes.
Source:

storageStatus

Source:

Methods

(static) _exportStatuses#withErrorMessage(value) → {aws-greengrass-core-sdk.StreamManager.MessageStreamInfo~MessageStreamInfo._exportStatuses}

Parameters:
Name Type Description
value String Error message from the last export attempt if it failed.
Source:
Returns:
Type
aws-greengrass-core-sdk.StreamManager.MessageStreamInfo~MessageStreamInfo._exportStatuses

(static) _exportStatuses#withExportConfigIdentifier(value) → {aws-greengrass-core-sdk.StreamManager.MessageStreamInfo~MessageStreamInfo._exportStatuses}

Parameters:
Name Type Description
value String The unique export identifier.
Source:
Returns:
Type
aws-greengrass-core-sdk.StreamManager.MessageStreamInfo~MessageStreamInfo._exportStatuses

(static) _exportStatuses#withExportedBytesFromStream(value) → {aws-greengrass-core-sdk.StreamManager.MessageStreamInfo~MessageStreamInfo._exportStatuses}

Parameters:
Name Type Description
value Number Total bytes exported from the stream for this Export Config. It does not include the failed export attempts or messages which are skipped because of some non-retryable error.
Source:
Returns:
Type
aws-greengrass-core-sdk.StreamManager.MessageStreamInfo~MessageStreamInfo._exportStatuses

(static) _exportStatuses#withExportedMessagesCount(value) → {aws-greengrass-core-sdk.StreamManager.MessageStreamInfo~MessageStreamInfo._exportStatuses}

Parameters:
Name Type Description
value Number Total messages exported/processed.
Source:
Returns:
Type
aws-greengrass-core-sdk.StreamManager.MessageStreamInfo~MessageStreamInfo._exportStatuses

(static) _exportStatuses#withLastExportedSequenceNumber(value) → {aws-greengrass-core-sdk.StreamManager.MessageStreamInfo~MessageStreamInfo._exportStatuses}

Parameters:
Name Type Description
value Number The sequence number of the last message which was successfully exported.
Source:
Returns:
Type
aws-greengrass-core-sdk.StreamManager.MessageStreamInfo~MessageStreamInfo._exportStatuses

(static) _exportStatuses#withLastExportTime(value) → {aws-greengrass-core-sdk.StreamManager.MessageStreamInfo~MessageStreamInfo._exportStatuses}

Parameters:
Name Type Description
value Number The last time an export was attempted. Data is Unix epoch time in milliseconds.
Source:
Returns:
Type
aws-greengrass-core-sdk.StreamManager.MessageStreamInfo~MessageStreamInfo._exportStatuses

(static) _storageStatus#withNewestSequenceNumber(value) → {aws-greengrass-core-sdk.StreamManager.MessageStreamInfo~MessageStreamInfo._storageStatus}

Parameters:
Name Type Description
value Number The sequence number of the last appended message.
Source:
Returns:
Type
aws-greengrass-core-sdk.StreamManager.MessageStreamInfo~MessageStreamInfo._storageStatus

(static) _storageStatus#withOldestSequenceNumber(value) → {aws-greengrass-core-sdk.StreamManager.MessageStreamInfo~MessageStreamInfo._storageStatus}

Parameters:
Name Type Description
value Number The sequence number of the first message which is still accessible in the stream.
Source:
Returns:
Type
aws-greengrass-core-sdk.StreamManager.MessageStreamInfo~MessageStreamInfo._storageStatus

(static) _storageStatus#withTotalBytes(value) → {aws-greengrass-core-sdk.StreamManager.MessageStreamInfo~MessageStreamInfo._storageStatus}

Parameters:
Name Type Description
value Number The current total size of the stream in bytes.
Source:
Returns:
Type
aws-greengrass-core-sdk.StreamManager.MessageStreamInfo~MessageStreamInfo._storageStatus

withDefinition(value) → {aws-greengrass-core-sdk.StreamManager.MessageStreamInfo}

Parameters:
Name Type Description
value aws-greengrass-core-sdk.StreamManager.MessageStreamDefinition
Source:
Returns:
Type
aws-greengrass-core-sdk.StreamManager.MessageStreamInfo

withExportStatuses(value) → {aws-greengrass-core-sdk.StreamManager.MessageStreamInfo}

Parameters:
Name Type Description
value Array.<aws-greengrass-core-sdk.StreamManager.MessageStreamInfo~MessageStreamInfo._exportStatuses>
Source:
Returns:
Type
aws-greengrass-core-sdk.StreamManager.MessageStreamInfo

withStorageStatus(value) → {aws-greengrass-core-sdk.StreamManager.MessageStreamInfo}

Parameters:
Name Type Description
value aws-greengrass-core-sdk.StreamManager.MessageStreamInfo~MessageStreamInfo._storageStatus Stream status including oldest/newest sequence number and total bytes.
Source:
Returns:
Type
aws-greengrass-core-sdk.StreamManager.MessageStreamInfo