Class: StatusContext

aws-greengrass-core-sdk.StreamManager~StatusContext(s3ExportTaskDefinition, exportIdentifier, streamName, sequenceNumber)

Context associated with a status message. Describes which stream, export config, message, the status is associated with.

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:

Members

exportIdentifier

The export identifier the status is associated with.
Source:

exportIdentifier

Source:

s3ExportTaskDefinition

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

s3ExportTaskDefinition

Source:

sequenceNumber

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

sequenceNumber

Source:

streamName

The name of the stream the status is associated with.
Source:

streamName

Source:

Methods

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

Parameters:
Name Type Description
value String The export identifier the status is associated with.
Source:
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:
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:
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:
Returns:
Type
aws-greengrass-core-sdk.StreamManager.StatusContext