JSDoc: Class: StatusContext

Constructor

new StatusContext(s3ExportTaskDefinition, exportIdentifier, streamName, sequenceNumber)

Parameters:

Name	Type	Default	Description
`s3ExportTaskDefinition`	aws-greengrass-core-sdk.StreamManager.S3ExportTaskDefinition	null	The task definition of an S3 upload task if the status is associated with it, ie, if the eventType = S3Task.
`exportIdentifier`	String	null	The export identifier the status is associated with.
`streamName`	String	null	The name of the stream the status is associated with.
`sequenceNumber`	Number	null	The sequence number of the message the status is associated with.

Source:

data/index.js, line 1772

Members

exportIdentifier

The export identifier the status is associated with.

Source:

data/index.js, line 1832

exportIdentifier

Source:

data/index.js, line 1838

s3ExportTaskDefinition

The task definition of an S3 upload task if the status is associated with it, ie, if the eventType = S3Task.

Source:

data/index.js, line 1805

s3ExportTaskDefinition

Source:

data/index.js, line 1811

sequenceNumber

The sequence number of the message the status is associated with.

Source:

data/index.js, line 1886

sequenceNumber

Source:

data/index.js, line 1892

streamName

The name of the stream the status is associated with.

Source:

data/index.js, line 1859

streamName

Source:

data/index.js, line 1865

Methods

withExportIdentifier(value) → {aws-greengrass-core-sdk.StreamManager.StatusContext}

Parameters:

Name	Type	Description
`value`	String	The export identifier the status is associated with.

Source:

data/index.js, line 1849

Returns:

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

withS3ExportTaskDefinition(value) → {aws-greengrass-core-sdk.StreamManager.StatusContext}

Parameters:

Name	Type	Description
`value`	aws-greengrass-core-sdk.StreamManager.S3ExportTaskDefinition	The task definition of an S3 upload task if the status is associated with it, ie, if the eventType = S3Task.

Source:

data/index.js, line 1822

Returns:

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

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

Parameters:

Name	Type	Description
`value`	Number	The sequence number of the message the status is associated with.

Source:

data/index.js, line 1903

Returns:

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

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

Parameters:

Name	Type	Description
`value`	String	The name of the stream the status is associated with.

Source:

data/index.js, line 1876

Returns:

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