QueueBufferConfig

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

public class QueueBufferConfig
extends java.lang.Object

フィールドの概要

フィールド
修飾子とタイプ	フィールドと説明
`static int`	`LONGPOLL_WAIT_TIMEOUT_SECONDS_DEFAULT`
`static long`	`MAX_BATCH_OPEN_MS_DEFAULT` 200 ミリ秒
`static long`	`MAX_BATCH_SIZE_BYTES`
`static long`	`MAX_BATCH_SIZE_BYTES_DEFAULT` 64 KB
`static int`	`MAX_BATCH_SIZE_DEFAULT`
`static int`	`MAX_DONE_RECEIVE_BATCHES_DEFAULT` 10 バッチ
`static int`	`MAX_INFLIGHT_OUTBOUND_BATCHES_DEFAULT` 5 バッチ
`static int`	`MAX_INFLIGHT_RECEIVE_BATCHES_DEFAULT` 10 バッチ
`static int`	`VISIBILITY_TIMEOUT_SECONDS_DEFAULT` キューのタイムアウト（-1：デフォルトタイムアウトを使用）

コンストラクタの概要

コンストラクタ
コンストラクタと説明
`QueueBufferConfig()`
`QueueBufferConfig(long maxBatchOpenMs, int maxInflightOutboundBatches, int maxInflightReceiveBatches, int maxDoneReceiveBatches, boolean paramLongPoll, long maxBatchSizeBytes, int visibilityTimeout, int longPollTimeout, int maxBatch)`
`QueueBufferConfig(QueueBufferConfig other)` コピーコンストラクタ

メソッドの概要

メソッド
修飾子とタイプ	メソッドと説明
`int`	`getLongPollWaitTimeoutSeconds()` 受信呼び出しは秒単位で指定し、キューが空になるまでサーバー上でブロックされます。
`long`	`getMaxBatchOpenMs()` 追加のアウトバウンド要求のため送信バッチを開いたままとする最大時間（ミリ秒）。
`int`	`getMaxBatchSize()` バッファクライアントが単一のバッチリクエストに入れるエントリの最大数を指定します。
`long`	`getMaxBatchSizeBytes()` SendMessage または SendMessageBatch メッセージの最大サイズ。
`int`	`getMaxDoneReceiveBatches()` バッファで待機している受信完了バッチ数がその値を超えた場合、新しいメッセージのクエリを停止します。
`int`	`getMaxInflightOutboundBatches()` アウトバウンド要求の種類別同時バッチ最大数。
`int`	`getMaxInflightReceiveBatches()` 同時受信するメッセージバッチの最大数。
`int`	`getVisibilityTimeoutSeconds()` キューからメッセージを取得するときに使用するカスタムタイムアウト。
`boolean`	`isLongPoll()`
`void`	`setLongPoll(boolean longPoll)` Long-Pollを使用する受信要求に対しては、"true"を指定。
`void`	`setLongPollWaitTimeoutSeconds(int longPollWaitTimeoutSeconds)` 受信呼び出しは秒単位で指定し、キューが空になるまでサーバー上でブロックされます。
`void`	`setMaxBatchOpenMs(long maxBatchOpenMs)` 追加のアウトバウンド要求のため送信バッチを開いたままとする最大時間（ミリ秒）。
`void`	`setMaxBatchSize(int maxBatchSize)` バッファクライアントが単一のバッチリクエストに入れるエントリの最大数を指定します。
`void`	`setMaxBatchSizeBytes(long maxBatchSizeBytes)` SendMessage または SendMessageBatch メッセージの最大サイズ。
`void`	`setMaxDoneReceiveBatches(int maxDoneReceiveBatches)` バッファで待機している受信完了バッチ数がその値を超えた場合、新しいメッセージのクエリを停止します。
`void`	`setMaxInflightOutboundBatches(int maxInflightOutboundBatches)` アウトバウンド要求の種類別同時バッチ最大数。
`void`	`setMaxInflightReceiveBatches(int maxInflightReceiveBatches)` 同時受信するメッセージバッチの最大数。
`void`	`setVisibilityTimeoutSeconds(int visibilityTimeoutSeconds)` キューからメッセージを取得するときに使用するカスタムタイムアウト。
`java.lang.String`	`toString()`
`QueueBufferConfig`	`withLongPoll(boolean longPoll)`
`QueueBufferConfig`	`withLongPollWaitTimeoutSeconds(int longPollWaitTimeoutSeconds)`
`QueueBufferConfig`	`withMaxBatchOpenMs(long maxBatchOpenMs)`
`QueueBufferConfig`	`withMaxBatchSize(int maxBatchSize)` バッファクライアントが単一のバッチリクエストに入れるエントリの最大数を指定します。
`QueueBufferConfig`	`withMaxBatchSizeBytes(long maxBatchSizeBytes)`
`QueueBufferConfig`	`withMaxDoneReceiveBatches(int maxDoneReceiveBatches)`
`QueueBufferConfig`	`withMaxInflightOutboundBatches(int maxInflightOutboundBatches)`
`QueueBufferConfig`	`withMaxInflightReceiveBatches(int maxInflightReceiveBatches)`
`QueueBufferConfig`	`withVisibilityTimeoutSeconds(int visibilityTimeoutSeconds)`

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- フィールドの詳細
  - MAX_BATCH_SIZE_DEFAULT
```
public static final int MAX_BATCH_SIZE_DEFAULT
```
    関連項目:
    定数フィールド値
  - MAX_BATCH_SIZE_BYTES
```
public static final long MAX_BATCH_SIZE_BYTES
```
    関連項目:
    定数フィールド値
  - MAX_BATCH_OPEN_MS_DEFAULT
```
public static final long MAX_BATCH_OPEN_MS_DEFAULT
```
    200 ミリ秒
    
    関連項目:
    定数フィールド値
  - MAX_INFLIGHT_OUTBOUND_BATCHES_DEFAULT
```
public static final int MAX_INFLIGHT_OUTBOUND_BATCHES_DEFAULT
```
    5 バッチ
    
    関連項目:
    定数フィールド値
  - MAX_INFLIGHT_RECEIVE_BATCHES_DEFAULT
```
public static final int MAX_INFLIGHT_RECEIVE_BATCHES_DEFAULT
```
    10 バッチ
    
    関連項目:
    定数フィールド値
  - MAX_DONE_RECEIVE_BATCHES_DEFAULT
```
public static final int MAX_DONE_RECEIVE_BATCHES_DEFAULT
```
    10 バッチ
    
    関連項目:
    定数フィールド値
  - MAX_BATCH_SIZE_BYTES_DEFAULT
```
public static final long MAX_BATCH_SIZE_BYTES_DEFAULT
```
    64 KB
    
    関連項目:
    定数フィールド値
  - VISIBILITY_TIMEOUT_SECONDS_DEFAULT
```
public static final int VISIBILITY_TIMEOUT_SECONDS_DEFAULT
```
    キューのタイムアウト（-1：デフォルトタイムアウトを使用）
    
    関連項目:
    定数フィールド値
  - LONGPOLL_WAIT_TIMEOUT_SECONDS_DEFAULT
```
public static final int LONGPOLL_WAIT_TIMEOUT_SECONDS_DEFAULT
```
    関連項目:
    定数フィールド値
- コンストラクタの詳細
  - 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)
```
    コピーコンストラクタ
- メソッドの詳細
  - toString
```
public java.lang.String toString()
```
    オーバーライド:
    
    toString クラス内 java.lang.Object
  - getMaxBatchOpenMs
```
public long getMaxBatchOpenMs()
```
    追加のアウトバウンド要求のため送信バッチを開いたままとする最大時間（ミリ秒）。タイムアウトを超えるメッセージは、他のメッセージがバッチに追加されるのを待ちます。このタイムアウトを大きくすると、呼び出し数が減りスループットを増加させるだけでなく、メッセージの平均待ち時間を増加させます。
  - setMaxBatchOpenMs
```
public void setMaxBatchOpenMs(long maxBatchOpenMs)
```
    追加のアウトバウンド要求のため送信バッチを開いたままとする最大時間（ミリ秒）。タイムアウトを超えるメッセージは、他のメッセージがバッチに追加されるのを待ちます。このタイムアウトを大きくすると、呼び出し数が減りスループットを増加させるだけでなく、メッセージの平均待ち時間を増加させます。
  - withMaxBatchOpenMs
```
public QueueBufferConfig withMaxBatchOpenMs(long maxBatchOpenMs)
```
  - isLongPoll
```
public boolean isLongPoll()
```
    戻り値:
    キューサーバからメッセージを取得するときにLong-Pollを使用する場合は、true。それ以外の場合は、false。
  - setLongPoll
```
public void setLongPoll(boolean longPoll)
```
    Long-Pollを使用する受信要求に対しては、"true"を指定。
  - withLongPoll
```
public QueueBufferConfig withLongPoll(boolean longPoll)
```
  - getMaxInflightOutboundBatches
```
public int getMaxInflightOutboundBatches()
```
    アウトバウンド要求の種類別同時バッチ最大数。数値が大きいほどスレッドを消費し、より大きなスループットを達成することができます。
  - setMaxInflightOutboundBatches
```
public void setMaxInflightOutboundBatches(int maxInflightOutboundBatches)
```
    アウトバウンド要求の種類別同時バッチ最大数。数値が大きいほどスレッドを消費し、より大きなスループットを達成することができます。
  - withMaxInflightOutboundBatches
```
public QueueBufferConfig withMaxInflightOutboundBatches(int maxInflightOutboundBatches)
```
  - getMaxInflightReceiveBatches
```
public int getMaxInflightReceiveBatches()
```
    同時受信するメッセージバッチの最大数。数値が大きいほどスレッドを消費し、より早くキューサーバからメッセージを取得します。
  - setMaxInflightReceiveBatches
```
public void setMaxInflightReceiveBatches(int maxInflightReceiveBatches)
```
    同時受信するメッセージバッチの最大数。数値が大きいほどスレッドを消費し、より早くキューサーバからメッセージを取得します。
  - withMaxInflightReceiveBatches
```
public QueueBufferConfig withMaxInflightReceiveBatches(int maxInflightReceiveBatches)
```
  - getMaxDoneReceiveBatches
```
public int getMaxDoneReceiveBatches()
```
    バッファで待機している受信完了バッチ数がその値を超えた場合、新しいメッセージのクエリを停止します。この数値を超えたメッセージバッファキューは、クライアント側のバッファにプリフェッチされた状態となり、より速く受信要求を満たします。プリフェッチされたメッセージは、プリフェッチの時点でタイムアウトを開始します。メッセージが他のクライアントを処理するために使用できないローカルバッファ内にあり、クライアントがそれを取得した時、既に一部がタイムアウトしている可能性があります。バッチごとの最大プリフェッチメッセージ数は10で、maxDoneReceiveBatches × 10の値を超えることはありません。
  - setMaxDoneReceiveBatches
```
public void setMaxDoneReceiveBatches(int maxDoneReceiveBatches)
```
    バッファで待機している受信完了バッチ数がその値を超えた場合、新しいメッセージのクエリを停止します。この数値を超えたメッセージバッファキューは、クライアント側のバッファにプリフェッチされた状態となり、より速く受信要求を満たします。プリフェッチされたメッセージは、プリフェッチの時点でタイムアウトを開始します。メッセージが他のクライアントを処理するために使用できないローカルバッファ内にあり、クライアントがそれを取得した時、既に一部がタイムアウトしている可能性があります。バッチごとの最大プリフェッチメッセージ数は10で、maxDoneReceiveBatches × 10の値を超えることはありません。
  - withMaxDoneReceiveBatches
```
public QueueBufferConfig withMaxDoneReceiveBatches(int maxDoneReceiveBatches)
```
  - getMaxBatchSizeBytes
```
public long getMaxBatchSizeBytes()
```
    SendMessage または SendMessageBatch メッセージの最大サイズ。(バイト単位)。この設定がサーバに適用され、クライアントからこの設定を超えるサイズの要求が送信された場合、サーバーは要求を拒否します。
  - setMaxBatchSizeBytes
```
public void setMaxBatchSizeBytes(long maxBatchSizeBytes)
```
    SendMessage または SendMessageBatch メッセージの最大サイズ。(バイト単位)。この設定がサーバに適用され、クライアントからこの設定を超えるサイズの要求が送信された場合、サーバーは要求を拒否します。
  - withMaxBatchSizeBytes
```
public QueueBufferConfig withMaxBatchSizeBytes(long maxBatchSizeBytes)
```
  - getVisibilityTimeoutSeconds
```
public int getVisibilityTimeoutSeconds()
```
    キューからメッセージを取得するときに使用するカスタムタイムアウト。 0以上を設定した場合、キューのデフォルトタイムアウトより優先されます。デフォルトタイムアウトを使用する場合は-1を設定します。0秒のタイムアウトはサポートされていません。
  - setVisibilityTimeoutSeconds
```
public void setVisibilityTimeoutSeconds(int visibilityTimeoutSeconds)
```
    キューからメッセージを取得するときに使用するカスタムタイムアウト。 0以上を設定した場合、キューのデフォルトタイムアウトより優先されます。デフォルトタイムアウトを使用する場合は-1を設定します。0秒のタイムアウトはサポートされていません。
  - withVisibilityTimeoutSeconds
```
public QueueBufferConfig withVisibilityTimeoutSeconds(int visibilityTimeoutSeconds)
```
  - setLongPollWaitTimeoutSeconds
```
public void setLongPollWaitTimeoutSeconds(int longPollWaitTimeoutSeconds)
```
    受信呼び出しは秒単位で指定し、キューが空になるまでサーバー上でブロックされます。 Long-Pollが無効になっている場合は、この設定は影響しません。
  - getLongPollWaitTimeoutSeconds
```
public int getLongPollWaitTimeoutSeconds()
```
    受信呼び出しは秒単位で指定し、キューが空になるまでサーバー上でブロックされます。 Long-Pollが無効になっている場合は、この設定は影響しません。
  - withLongPollWaitTimeoutSeconds
```
public QueueBufferConfig withLongPollWaitTimeoutSeconds(int longPollWaitTimeoutSeconds)
```
  - getMaxBatchSize
```
public int getMaxBatchSize()
```
    バッファクライアントが単一のバッチリクエストに入れるエントリの最大数を指定します。
  - setMaxBatchSize
```
public void setMaxBatchSize(int maxBatchSize)
```
    バッファクライアントが単一のバッチリクエストに入れるエントリの最大数を指定します。
  - withMaxBatchSize
```
public QueueBufferConfig withMaxBatchSize(int maxBatchSize)
```
    バッファクライアントが単一のバッチリクエストに入れるエントリの最大数を指定します。

クラス QueueBufferConfig

フィールドの概要

コンストラクタの概要

メソッドの概要

クラスから継承されたメソッド java.lang.Object

フィールドの詳細

MAX_BATCH_SIZE_DEFAULT

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

コンストラクタの詳細

QueueBufferConfig

QueueBufferConfig

QueueBufferConfig

メソッドの詳細

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