QueueBufferConfig (AWS Java SDK for Amazon SQS 1.11.94 API)

java.lang.Object
- com.amazonaws.services.sqs.buffered.QueueBufferConfig

public class QueueBufferConfig
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`LONGPOLL_WAIT_TIMEOUT_SECONDS_DEFAULT`
`static long`	`MAX_BATCH_OPEN_MS_DEFAULT` 200 milliseconds
`static long`	`MAX_BATCH_SIZE_BYTES_DEFAULT` 256 kilobytes
`static int`	`MAX_BATCH_SIZE_DEFAULT`
`static int`	`MAX_DONE_RECEIVE_BATCHES_DEFAULT` 10 batches
`static int`	`MAX_INFLIGHT_OUTBOUND_BATCHES_DEFAULT` 5 batches
`static int`	`MAX_INFLIGHT_RECEIVE_BATCHES_DEFAULT` 10 batches
`static long`	`SERVICE_MAX_BATCH_SIZE_BYTES` Updated as the service now supports messages of size max 256 KiB.
`static int`	`VISIBILITY_TIMEOUT_SECONDS_DEFAULT` -1, which means use the visibility timeout of the queue

Constructor Summary

Constructors
Constructor and Description
`QueueBufferConfig()`
`QueueBufferConfig(long maxBatchOpenMs, int maxInflightOutboundBatches, int maxInflightReceiveBatches, int maxDoneReceiveBatches, boolean paramLongPoll, long maxBatchSizeBytes, int visibilityTimeout, int longPollTimeout, int maxBatch)`
`QueueBufferConfig(QueueBufferConfig other)` copy constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getLongPollWaitTimeoutSeconds()` Specifies the amount of time, in seconds, the receive call will block on the server waiting for messages to arrive if the queue is empty when the receive call is first made.
`long`	`getMaxBatchOpenMs()` The maximum time (milliseconds) a send batch is held open for additional outbound requests.
`int`	`getMaxBatchSize()` Specifies the maximum number of entries the buffered client will put in a single batch request.
`long`	`getMaxBatchSizeBytes()` Maximum permitted size of a SendMessage or SendMessageBatch message, in bytes.
`int`	`getMaxDoneReceiveBatches()` If more than that number of completed receive batches are waiting in the buffer, the querying for new messages will stop. The larger this number, the more messages the queue buffer will pre-fetch and keep in the buffer on the client side, and the faster receive requests will be satisfied.
`int`	`getMaxInflightOutboundBatches()` The maximum number of concurrent batches for each type of outbound request.
`int`	`getMaxInflightReceiveBatches()` The maximum number of concurrent receive message batches.
`int`	`getVisibilityTimeoutSeconds()` Custom visibility timeout to use when retrieving messages from SQS.
`boolean`	`isFlushOnShutdown()` Returns the flushOnShutdown value.
`boolean`	`isLongPoll()`
`void`	`setFlushOnShutdown(boolean flushOnShutdown)` Sets the flushOnShutdown option.
`void`	`setLongPoll(boolean longPoll)` Specify "true" for receive requests to use long polling.
`void`	`setLongPollWaitTimeoutSeconds(int longPollWaitTimeoutSeconds)` Specifies the amount of time, in seconds, the receive call will block on the server waiting for messages to arrive if the queue is empty when the receive call is first made.
`void`	`setMaxBatchOpenMs(long maxBatchOpenMs)` The maximum time (milliseconds) a send batch is held open for additional outbound requests.
`void`	`setMaxBatchSize(int maxBatchSize)` Specifies the maximum number of entries the buffered client will put in a single batch request.
`void`	`setMaxBatchSizeBytes(long maxBatchSizeBytes)` Maximum permitted size of a SendMessage or SendMessageBatch message, in bytes.
`void`	`setMaxDoneReceiveBatches(int maxDoneReceiveBatches)` If more than that number of completed receive batches are waiting in the buffer, the querying for new messages will stop.
`void`	`setMaxInflightOutboundBatches(int maxInflightOutboundBatches)` The maximum number of concurrent batches for each type of outbound request.
`void`	`setMaxInflightReceiveBatches(int maxInflightReceiveBatches)` The maximum number of concurrent receive message batches.
`void`	`setVisibilityTimeoutSeconds(int visibilityTimeoutSeconds)` Custom visibility timeout to use when retrieving messages from SQS.
`String`	`toString()`
`QueueBufferConfig`	`withFlushOnShutdown(boolean flushOnShutdown)` Sets the flushOnShutdown option.
`QueueBufferConfig`	`withLongPoll(boolean longPoll)` Specify "true" for receive requests to use long polling.
`QueueBufferConfig`	`withLongPollWaitTimeoutSeconds(int longPollWaitTimeoutSeconds)` Specifies the amount of time, in seconds, the receive call will block on the server waiting for messages to arrive if the queue is empty when the receive call is first made.
`QueueBufferConfig`	`withMaxBatchOpenMs(long maxBatchOpenMs)` The maximum time (milliseconds) a send batch is held open for additional outbound requests.
`QueueBufferConfig`	`withMaxBatchSize(int maxBatchSize)` Specifies the maximum number of entries the buffered client will put in a single batch request.
`QueueBufferConfig`	`withMaxBatchSizeBytes(long maxBatchSizeBytes)` Maximum permitted size of a SendMessage or SendMessageBatch message, in bytes.
`QueueBufferConfig`	`withMaxDoneReceiveBatches(int maxDoneReceiveBatches)` If more than that number of completed receive batches are waiting in the buffer, the querying for new messages will stop.
`QueueBufferConfig`	`withMaxInflightOutboundBatches(int maxInflightOutboundBatches)` The maximum number of concurrent batches for each type of outbound request.
`QueueBufferConfig`	`withMaxInflightReceiveBatches(int maxInflightReceiveBatches)` The maximum number of concurrent receive message batches.
`QueueBufferConfig`	`withVisibilityTimeoutSeconds(int visibilityTimeoutSeconds)` Custom visibility timeout to use when retrieving messages from SQS.

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

- Field Detail
  - MAX_BATCH_SIZE_DEFAULT
```
public static final int MAX_BATCH_SIZE_DEFAULT
```
    See Also:
    
    Constant Field Values
  - SERVICE_MAX_BATCH_SIZE_BYTES
```
public static final long SERVICE_MAX_BATCH_SIZE_BYTES
```
    Updated as the service now supports messages of size max 256 KiB.
    
    See Also:
    
    Constant Field Values
  - MAX_BATCH_OPEN_MS_DEFAULT
```
public static final long MAX_BATCH_OPEN_MS_DEFAULT
```
    200 milliseconds
    
    See Also:
    
    Constant Field Values
  - MAX_INFLIGHT_OUTBOUND_BATCHES_DEFAULT
```
public static final int MAX_INFLIGHT_OUTBOUND_BATCHES_DEFAULT
```
    5 batches
    
    See Also:
    
    Constant Field Values
  - MAX_INFLIGHT_RECEIVE_BATCHES_DEFAULT
```
public static final int MAX_INFLIGHT_RECEIVE_BATCHES_DEFAULT
```
    10 batches
    
    See Also:
    
    Constant Field Values
  - MAX_DONE_RECEIVE_BATCHES_DEFAULT
```
public static final int MAX_DONE_RECEIVE_BATCHES_DEFAULT
```
    10 batches
    
    See Also:
    
    Constant Field Values
  - MAX_BATCH_SIZE_BYTES_DEFAULT
```
public static final long MAX_BATCH_SIZE_BYTES_DEFAULT
```
    256 kilobytes
    
    See Also:
    
    Constant Field Values
  - VISIBILITY_TIMEOUT_SECONDS_DEFAULT
```
public static final int VISIBILITY_TIMEOUT_SECONDS_DEFAULT
```
    -1, which means use the visibility timeout of the queue
    
    See Also:
    
    Constant Field Values
  - LONGPOLL_WAIT_TIMEOUT_SECONDS_DEFAULT
```
public static final int LONGPOLL_WAIT_TIMEOUT_SECONDS_DEFAULT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - QueueBufferConfig
```
public QueueBufferConfig(long maxBatchOpenMs,
                         int maxInflightOutboundBatches,
                         int maxInflightReceiveBatches,
                         int maxDoneReceiveBatches,
                         boolean paramLongPoll,
                         long maxBatchSizeBytes,
                         int visibilityTimeout,
                         int longPollTimeout,
                         int maxBatch)
```
  - QueueBufferConfig
```
public QueueBufferConfig()
```
  - QueueBufferConfig
```
public QueueBufferConfig(QueueBufferConfig other)
```
    copy constructor
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getMaxBatchOpenMs
```
public long getMaxBatchOpenMs()
```
    The maximum time (milliseconds) a send batch is held open for additional outbound requests. The longer this timeout, the longer messages wait for other messages to be added to the batch. Increasing this timeout reduces the number of calls made and increases throughput, but also increases average message latency.
  - setMaxBatchOpenMs
```
public void setMaxBatchOpenMs(long maxBatchOpenMs)
```
    The maximum time (milliseconds) a send batch is held open for additional outbound requests. The longer this timeout, the longer messages wait for other messages to be added to the batch. Increasing this timeout reduces the number of calls made and increases throughput, but also increases average message latency.
  - withMaxBatchOpenMs
```
public QueueBufferConfig withMaxBatchOpenMs(long maxBatchOpenMs)
```
    The maximum time (milliseconds) a send batch is held open for additional outbound requests. The longer this timeout, the longer messages wait for other messages to be added to the batch. Increasing this timeout reduces the number of calls made and increases throughput, but also increases average message latency.
  - isLongPoll
```
public boolean isLongPoll()
```
    Returns:
    
    true if the queue buffer will use long polling while retrieving messages from the SQS server, false otherwise.
  - setLongPoll
```
public void setLongPoll(boolean longPoll)
```
    Specify "true" for receive requests to use long polling.
  - withLongPoll
```
public QueueBufferConfig withLongPoll(boolean longPoll)
```
    Specify "true" for receive requests to use long polling.
  - getMaxInflightOutboundBatches
```
public int getMaxInflightOutboundBatches()
```
    The maximum number of concurrent batches for each type of outbound request. The greater the number, the greater the throughput that can be achieved (at the expense of consuming more threads).
  - setMaxInflightOutboundBatches
```
public void setMaxInflightOutboundBatches(int maxInflightOutboundBatches)
```
    The maximum number of concurrent batches for each type of outbound request. The greater the number, the greater the throughput that can be achieved (at the expense of consuming more threads).
  - withMaxInflightOutboundBatches
```
public QueueBufferConfig withMaxInflightOutboundBatches(int maxInflightOutboundBatches)
```
    The maximum number of concurrent batches for each type of outbound request. The greater the number, the greater the throughput that can be achieved (at the expense of consuming more threads).
  - getMaxInflightReceiveBatches
```
public int getMaxInflightReceiveBatches()
```
    The maximum number of concurrent receive message batches. The greater this number, the faster the queue will be pulling messages from the SQS servers (at the expense of consuming more threads).
  - setMaxInflightReceiveBatches
```
public void setMaxInflightReceiveBatches(int maxInflightReceiveBatches)
```
    The maximum number of concurrent receive message batches. The greater this number, the faster the queue will be pulling messages from the SQS servers (at the expense of consuming more threads).
  - withMaxInflightReceiveBatches
```
public QueueBufferConfig withMaxInflightReceiveBatches(int maxInflightReceiveBatches)
```
    The maximum number of concurrent receive message batches. The greater this number, the faster the queue will be pulling messages from the SQS servers (at the expense of consuming more threads).
  - getMaxDoneReceiveBatches
```
public int getMaxDoneReceiveBatches()
```
    If more than that number of completed receive batches are waiting in the buffer, the querying for new messages will stop.
    The larger this number, the more messages the queue buffer will pre-fetch and keep in the buffer on the client side, and the faster receive requests will be satisfied.
    The visibility timeout of a pre-fetched message starts at the point of pre-fetch, which means that while the message is in the local buffer it is unavailable for other clients to process, and when this client retrieves it, part of the visibility timeout may have already expired.
    The number of messages prefetched will not exceed 10 * maxDoneReceiveBatches, as there can be a maximum of 10 messages per batch.
  - setMaxDoneReceiveBatches
```
public void setMaxDoneReceiveBatches(int maxDoneReceiveBatches)
```
    If more than that number of completed receive batches are waiting in the buffer, the querying for new messages will stop. The larger this number, the more messages the buffer queue will pre-fetch and keep in the buffer on the client side, and the faster receive requests will be satisfied. The visibility timeout of a pre-fetched message starts at the point of pre-fetch, which means that while the message is in the local buffer it is unavailable for other clients to process, and when this client retrieves it, part of the visibility timeout may have already expired. The number of messages prefetched will not exceed maxBatchSize * maxDoneReceiveBatches.
  - withMaxDoneReceiveBatches
```
public QueueBufferConfig withMaxDoneReceiveBatches(int maxDoneReceiveBatches)
```
    If more than that number of completed receive batches are waiting in the buffer, the querying for new messages will stop. The larger this number, the more messages the buffer queue will pre-fetch and keep in the buffer on the client side, and the faster receive requests will be satisfied. The visibility timeout of a pre-fetched message starts at the point of pre-fetch, which means that while the message is in the local buffer it is unavailable for other clients to process, and when this client retrieves it, part of the visibility timeout may have already expired. The number of messages prefetched will not exceed maxBatchSize * maxDoneReceiveBatches.
  - getMaxBatchSizeBytes
```
public long getMaxBatchSizeBytes()
```
    Maximum permitted size of a SendMessage or SendMessageBatch message, in bytes. This setting is also enforced on the server, and if this client submits a request of a size larger than the server can support, the server will reject the request.
  - setMaxBatchSizeBytes
```
public void setMaxBatchSizeBytes(long maxBatchSizeBytes)
```
    Maximum permitted size of a SendMessage or SendMessageBatch message, in bytes. This setting is also enforced on the server, and if this client submits a request of a size larger than the server can support, the server will reject the request.
    
    Throws:
    
    IllegalArgumentException - if the size being set is greater than the service allowed size for message body.
  - withMaxBatchSizeBytes
```
public QueueBufferConfig withMaxBatchSizeBytes(long maxBatchSizeBytes)
```
    Maximum permitted size of a SendMessage or SendMessageBatch message, in bytes. This setting is also enforced on the server, and if this client submits a request of a size larger than the server can support, the server will reject the request.
    
    Throws:
    
    IllegalArgumentException - if the size being set is greater than the service allowed size for message body.
  - getVisibilityTimeoutSeconds
```
public int getVisibilityTimeoutSeconds()
```
    Custom visibility timeout to use when retrieving messages from SQS. If set to a value greater than zero, this timeout will override the default visibility timeout set on the SQS queue. Set it to -1 to use the default visiblity timeout of the queue. Visibility timeout of 0 seconds is not supported.
  - setVisibilityTimeoutSeconds
```
public void setVisibilityTimeoutSeconds(int visibilityTimeoutSeconds)
```
    Custom visibility timeout to use when retrieving messages from SQS. If set to a value greater than zero, this timeout will override the default visibility timeout set on the SQS queue. Set it to -1 to use the default visiblity timeout of the queue. Visibility timeout of 0 seconds is not supported.
  - withVisibilityTimeoutSeconds
```
public QueueBufferConfig withVisibilityTimeoutSeconds(int visibilityTimeoutSeconds)
```
    Custom visibility timeout to use when retrieving messages from SQS. If set to a value greater than zero, this timeout will override the default visibility timeout set on the SQS queue. Set it to -1 to use the default visiblity timeout of the queue. Visibility timeout of 0 seconds is not supported.
  - setLongPollWaitTimeoutSeconds
```
public void setLongPollWaitTimeoutSeconds(int longPollWaitTimeoutSeconds)
```
    Specifies the amount of time, in seconds, the receive call will block on the server waiting for messages to arrive if the queue is empty when the receive call is first made. This setting has no effect if long polling is disabled.
  - getLongPollWaitTimeoutSeconds
```
public int getLongPollWaitTimeoutSeconds()
```
    Specifies the amount of time, in seconds, the receive call will block on the server waiting for messages to arrive if the queue is empty when the receive call is first made. This setting has no effect if long polling is disabled.
  - withLongPollWaitTimeoutSeconds
```
public QueueBufferConfig withLongPollWaitTimeoutSeconds(int longPollWaitTimeoutSeconds)
```
    Specifies the amount of time, in seconds, the receive call will block on the server waiting for messages to arrive if the queue is empty when the receive call is first made. This setting has no effect if long polling is disabled.
  - getMaxBatchSize
```
public int getMaxBatchSize()
```
    Specifies the maximum number of entries the buffered client will put in a single batch request.
  - setMaxBatchSize
```
public void setMaxBatchSize(int maxBatchSize)
```
    Specifies the maximum number of entries the buffered client will put in a single batch request.
  - withMaxBatchSize
```
public QueueBufferConfig withMaxBatchSize(int maxBatchSize)
```
    Specifies the maximum number of entries the buffered client will put in a single batch request.
  - isFlushOnShutdown
```
public boolean isFlushOnShutdown()
```
    Returns the flushOnShutdown value. The default value is false which indicates flushOnShutdown is disabled. Enabling this option will flush the pending requests in the SendQueueBuffer during shutdown.
    
    Returns:
    
    true if flushOnShutdown is enabled, otherwise false.
  - setFlushOnShutdown
```
public void setFlushOnShutdown(boolean flushOnShutdown)
```
    Sets the flushOnShutdown option. The default value is false which indicates flushOnShutdown is disabled. Enabling this option will flush the pending requests in the SendQueueBuffer during shutdown.
    
    Parameters:
    
    flushOnShutdown - boolean value to configure flushOnShutdown.
  - withFlushOnShutdown
```
public QueueBufferConfig withFlushOnShutdown(boolean flushOnShutdown)
```
    Sets the flushOnShutdown option. The default value is false which indicates flushOnShutdown is disabled. Enabling this option will flush the pending requests in the SendQueueBuffer during shutdown.
    
    Parameters:
    
    flushOnShutdown - boolean value to configure flushOnShutdown.
    
    Returns:
    
    This object for method chaining.

Class QueueBufferConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAX_BATCH_SIZE_DEFAULT

SERVICE_MAX_BATCH_SIZE_BYTES

MAX_BATCH_OPEN_MS_DEFAULT

MAX_INFLIGHT_OUTBOUND_BATCHES_DEFAULT

MAX_INFLIGHT_RECEIVE_BATCHES_DEFAULT

MAX_DONE_RECEIVE_BATCHES_DEFAULT

MAX_BATCH_SIZE_BYTES_DEFAULT

VISIBILITY_TIMEOUT_SECONDS_DEFAULT

LONGPOLL_WAIT_TIMEOUT_SECONDS_DEFAULT

Constructor Detail

QueueBufferConfig

QueueBufferConfig

QueueBufferConfig

Method Detail

toString

getMaxBatchOpenMs

setMaxBatchOpenMs

withMaxBatchOpenMs

isLongPoll

setLongPoll

withLongPoll

getMaxInflightOutboundBatches

setMaxInflightOutboundBatches

withMaxInflightOutboundBatches

getMaxInflightReceiveBatches

setMaxInflightReceiveBatches

withMaxInflightReceiveBatches

getMaxDoneReceiveBatches

setMaxDoneReceiveBatches

withMaxDoneReceiveBatches

getMaxBatchSizeBytes

setMaxBatchSizeBytes

withMaxBatchSizeBytes

getVisibilityTimeoutSeconds

setVisibilityTimeoutSeconds

withVisibilityTimeoutSeconds

setLongPollWaitTimeoutSeconds

getLongPollWaitTimeoutSeconds

withLongPollWaitTimeoutSeconds

getMaxBatchSize

setMaxBatchSize

withMaxBatchSize

isFlushOnShutdown

setFlushOnShutdown

withFlushOnShutdown