ReadMessagesOptions

java.lang.Object
- com.amazonaws.greengrass.streammanager.model.ReadMessagesOptions

```
public class ReadMessagesOptions
extends Object
```
Options for the ReadMessages API. All fields are optional.

Constructor Summary

Constructors
Constructor and Description
`ReadMessagesOptions()` No args constructor for use in serialization
`ReadMessagesOptions(Long desiredStartSequenceNumber, Long minMessageCount, Long maxMessageCount, Long readTimeoutMillis)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)`
`Long`	`getDesiredStartSequenceNumber()` The desired beginning sequence number to start reading from.
`Long`	`getMaxMessageCount()` The maximum number of messages that will be returned.
`Long`	`getMinMessageCount()` The minimum number of messages that will be returned.
`Long`	`getReadTimeoutMillis()` The time to wait for messages in milliseconds.
`int`	`hashCode()`
`void`	`setDesiredStartSequenceNumber(Long desiredStartSequenceNumber)` The desired beginning sequence number to start reading from.
`void`	`setMaxMessageCount(Long maxMessageCount)` The maximum number of messages that will be returned.
`void`	`setMinMessageCount(Long minMessageCount)` The minimum number of messages that will be returned.
`void`	`setReadTimeoutMillis(Long readTimeoutMillis)` The time to wait for messages in milliseconds.
`String`	`toString()`
`ReadMessagesOptions`	`withDesiredStartSequenceNumber(Long desiredStartSequenceNumber)`
`ReadMessagesOptions`	`withMaxMessageCount(Long maxMessageCount)`
`ReadMessagesOptions`	`withMinMessageCount(Long minMessageCount)`
`ReadMessagesOptions`	`withReadTimeoutMillis(Long readTimeoutMillis)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ReadMessagesOptions
```
public ReadMessagesOptions()
```
    No args constructor for use in serialization
  - ReadMessagesOptions
```
public ReadMessagesOptions(Long desiredStartSequenceNumber,
                           Long minMessageCount,
                           Long maxMessageCount,
                           Long readTimeoutMillis)
```
    Parameters:
    
    readTimeoutMillis -
    
    desiredStartSequenceNumber -
    
    maxMessageCount -
    
    minMessageCount -
- Method Detail
  - getDesiredStartSequenceNumber
```
public Long getDesiredStartSequenceNumber()
```
    The desired beginning sequence number to start reading from. If the desired sequence number is less than the current minimum of the stream, then it will instead start reading from the current minimum.
  - setDesiredStartSequenceNumber
```
public void setDesiredStartSequenceNumber(Long desiredStartSequenceNumber)
```
    The desired beginning sequence number to start reading from. If the desired sequence number is less than the current minimum of the stream, then it will instead start reading from the current minimum.
  - withDesiredStartSequenceNumber
```
public ReadMessagesOptions withDesiredStartSequenceNumber(Long desiredStartSequenceNumber)
```
  - getMinMessageCount
```
public Long getMinMessageCount()
```
    The minimum number of messages that will be returned. If not enough messages are available for reading, then NotEnoughMessages exception will be thrown. The minimum values is 1 and the maximum value is 2147483647.
  - setMinMessageCount
```
public void setMinMessageCount(Long minMessageCount)
```
    The minimum number of messages that will be returned. If not enough messages are available for reading, then NotEnoughMessages exception will be thrown. The minimum values is 1 and the maximum value is 2147483647.
  - withMinMessageCount
```
public ReadMessagesOptions withMinMessageCount(Long minMessageCount)
```
  - getMaxMessageCount
```
public Long getMaxMessageCount()
```
    The maximum number of messages that will be returned. The minimum values is the value of the minimum message count and the maximum value is 2147483647.
  - setMaxMessageCount
```
public void setMaxMessageCount(Long maxMessageCount)
```
    The maximum number of messages that will be returned. The minimum values is the value of the minimum message count and the maximum value is 2147483647.
  - withMaxMessageCount
```
public ReadMessagesOptions withMaxMessageCount(Long maxMessageCount)
```
  - getReadTimeoutMillis
```
public Long getReadTimeoutMillis()
```
    The time to wait for messages in milliseconds. Default is 0, meaning that the server will not wait for messages. If it can fulfill the minimum messages it will return them, but otherwise NotEnoughMessages exception will be thrown. If the timeout is greater than zero, then the server will wait up to that time for more messages to be appended to the stream, waiting until the minimum number of messages is reached. The maximum value is the value of the client timeout.
  - setReadTimeoutMillis
```
public void setReadTimeoutMillis(Long readTimeoutMillis)
```
    The time to wait for messages in milliseconds. Default is 0, meaning that the server will not wait for messages. If it can fulfill the minimum messages it will return them, but otherwise NotEnoughMessages exception will be thrown. If the timeout is greater than zero, then the server will wait up to that time for more messages to be appended to the stream, waiting until the minimum number of messages is reached. The maximum value is the value of the client timeout.
  - withReadTimeoutMillis
```
public ReadMessagesOptions withReadTimeoutMillis(Long readTimeoutMillis)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object

Class ReadMessagesOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ReadMessagesOptions

ReadMessagesOptions

Method Detail

getDesiredStartSequenceNumber

setDesiredStartSequenceNumber

withDesiredStartSequenceNumber

getMinMessageCount

setMinMessageCount

withMinMessageCount

getMaxMessageCount

setMaxMessageCount

withMaxMessageCount

getReadTimeoutMillis

setReadTimeoutMillis

withReadTimeoutMillis

toString

hashCode

equals