Class: ReadMessagesRequest

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

data/index.js, line 8322

Members

readMessagesOptions

Source:

data/index.js, line 8400

readMessagesOptions

Source:

data/index.js, line 8406

requestId

Source:

data/index.js, line 8348

requestId

Source:

data/index.js, line 8354

streamName

Source:

data/index.js, line 8374

streamName

Source:

data/index.js, line 8380

Methods

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

Parameters:

Name	Type	Description
`value`	aws-greengrass-core-sdk.StreamManager.ReadMessagesOptions

Source:

data/index.js, line 8417

Returns:

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

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

Parameters:

Name	Type	Description
`value`	String

Source:

data/index.js, line 8365

Returns:

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

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

Parameters:

Name	Type	Description
`value`	String

Source:

data/index.js, line 8391

Returns:

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