Class: ReadMessagesRequest

aws-greengrass-core-sdk.StreamManager~ReadMessagesRequest(requestId, streamName, readMessagesOptions)

(Internal Only) Request object for reading from a message stream. readMessagesOptions is optional.

Constructor

new ReadMessagesRequest(requestId, streamName, readMessagesOptions)

Parameters:
Name Type Default Description
requestId String null
streamName String null
readMessagesOptions aws-greengrass-core-sdk.StreamManager.ReadMessagesOptions null
Source:

Members

readMessagesOptions

Source:

readMessagesOptions

Source:

requestId

Source:

requestId

Source:

streamName

Source:

streamName

Source:

Methods

withReadMessagesOptions(value) → {aws-greengrass-core-sdk.StreamManager.ReadMessagesRequest}

Parameters:
Name Type Description
value aws-greengrass-core-sdk.StreamManager.ReadMessagesOptions
Source:
Returns:
Type
aws-greengrass-core-sdk.StreamManager.ReadMessagesRequest

withRequestId(value) → {aws-greengrass-core-sdk.StreamManager.ReadMessagesRequest}

Parameters:
Name Type Description
value String
Source:
Returns:
Type
aws-greengrass-core-sdk.StreamManager.ReadMessagesRequest

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

Parameters:
Name Type Description
value String
Source:
Returns:
Type
aws-greengrass-core-sdk.StreamManager.ReadMessagesRequest