JSDoc: Class: MessageStreamInfo

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:

data/index.js, line 6728

Members

(static) _exportStatuses#errorMessage

Error message from the last export attempt if it failed.

Source:

data/index.js, line 7201

(static) _exportStatuses#errorMessage

Source:

data/index.js, line 7207

(static) _exportStatuses#exportConfigIdentifier

The unique export identifier.

Source:

data/index.js, line 7120

(static) _exportStatuses#exportConfigIdentifier

Source:

data/index.js, line 7126

(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:

data/index.js, line 7228

(static) _exportStatuses#exportedBytesFromStream

Source:

data/index.js, line 7234

(static) _exportStatuses#exportedMessagesCount

Total messages exported/processed.

Source:

data/index.js, line 7255

(static) _exportStatuses#exportedMessagesCount

Source:

data/index.js, line 7261

(static) _exportStatuses#lastExportedSequenceNumber

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

Source:

data/index.js, line 7147

(static) _exportStatuses#lastExportedSequenceNumber

Source:

data/index.js, line 7153

(static) _exportStatuses#lastExportTime

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

Source:

data/index.js, line 7174

(static) _exportStatuses#lastExportTime

Source:

data/index.js, line 7180

(static) _storageStatus#newestSequenceNumber

The sequence number of the last appended message.

Source:

data/index.js, line 6941

(static) _storageStatus#newestSequenceNumber

Source:

data/index.js, line 6947

(static) _storageStatus#oldestSequenceNumber

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

Source:

data/index.js, line 6914

(static) _storageStatus#oldestSequenceNumber

Source:

data/index.js, line 6920

(static) _storageStatus#totalBytes

The current total size of the stream in bytes.

Source:

data/index.js, line 6968

(static) _storageStatus#totalBytes

Source:

data/index.js, line 6974

definition

Source:

data/index.js, line 6757

definition

Source:

data/index.js, line 6763

exportStatuses

Source:

data/index.js, line 6810

exportStatuses

Source:

data/index.js, line 6816

storageStatus

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

Source:

data/index.js, line 6784

storageStatus

Source:

data/index.js, line 6790

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:

data/index.js, line 7218

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:

data/index.js, line 7137

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:

data/index.js, line 7245

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:

data/index.js, line 7272

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:

data/index.js, line 7164

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:

data/index.js, line 7191

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:

data/index.js, line 6958

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:

data/index.js, line 6931

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:

data/index.js, line 6985

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:

data/index.js, line 6774

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:

data/index.js, line 6830

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:

data/index.js, line 6801

Returns:

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