|
38 | 38 | /** |
39 | 39 | * Represents the batching settings to use for an API method that is capable of batching. |
40 | 40 | * |
| 41 | + * <p>By default the settings are configured to <b>not</b> use batching (i.e. the batch size |
| 42 | + * threshold is 1). This is the safest default behavior, which has meaning in all possible |
| 43 | + * scenarios. Users are expected to configure actual batching thresholds explicitly: the element |
| 44 | + * count, the request bytes count and the delay. |
| 45 | + * |
41 | 46 | * <p>Warning: With the wrong settings, it is possible to cause long periods of dead waiting time. |
42 | 47 | * |
43 | 48 | * <p>When batching is turned on for an API method, a call to that method will result in the request |
|
50 | 55 | * |
51 | 56 | * <ul> |
52 | 57 | * <li><b>Delay Threshold</b>: Counting from the time that the first message is queued, once this |
53 | | - * delay has passed, then send the batch. |
| 58 | + * delay has passed, then send the batch. The default value is 1 millisecond. |
54 | 59 | * <li><b>Message Count Threshold</b>: Once this many messages are queued, send all of the |
55 | | - * messages in a single call, even if the delay threshold hasn't elapsed yet. |
| 60 | + * messages in a single call, even if the delay threshold hasn't elapsed yet. The default |
| 61 | + * value is 1 message. |
56 | 62 | * <li><b>Request Byte Threshold</b>: Once the number of bytes in the batched request reaches this |
57 | 63 | * threshold, send all of the messages in a single call, even if neither the delay or message |
58 | | - * count thresholds have been exceeded yet. |
| 64 | + * count thresholds have been exceeded yet. The default value is 1 byte. |
59 | 65 | * </ul> |
60 | 66 | * |
61 | 67 | * <p>These thresholds are treated as triggers, not as limits. Thus, if a request is made with 2x |
|
0 commit comments