GEODE-10346: Correct description of batch-time-interval in doc. (#7742)

apache · Sep 16, 2022 · 982333d · 982333d
1 parent e72da0d
commit 982333d
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/geode-docs/reference/topics/cache_xml.html.md.erb b/geode-docs/reference/topics/cache_xml.html.md.erb
@@ -267,7 +267,7 @@ Configures a gateway sender to distribute region events to another <%=vars.produ
 </tr>
 <tr>
 <td>batch-time-interval</td>
-<td>Maximum number of milliseconds that can elapse between sending batches.</td>
+<td>Maximum amount of time, in ms, that can elapse before a batch is delivered, when no events are found in the queue to reach the batch-size.</td>
 <td>1000</td>
 </tr>
 <tr>
@@ -539,7 +539,7 @@ Configures a queue for sending region events to an AsyncEventListener implementa
 </tr>
 <tr>
 <td>batch-time-interval</td>
-<td>Maximum number of milliseconds that can elapse between sending batches.</td>
+<td>Maximum amount of time, in ms, that can elapse before a batch is delivered, when no events are found in the queue to reach the batch-size.</td>
 <td>5</td>
 </tr>
 <tr>

diff --git a/geode-docs/tools_modules/gfsh/command-pages/alter.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/alter.html.md.erb
@@ -238,7 +238,7 @@ The required option, `--id`, identifies the gateway sender to be altered.
 </tr>
 <tr>
 <td><span class="keyword parmname">&#8209;&#8209;batch-time-interval</span></td>
-<td>Maximum time, in milliseconds, that can elapse between sending batches.</td>
+<td>Maximum amount of time, in ms, that can elapse before a batch is delivered, when no events are found in the queue to reach the batch-size.</td>
 </tr>
 <tr>
 <td><span class="keyword parmname">&#8209;&#8209;gateway-event-filter</span></td>

diff --git a/geode-docs/tools_modules/gfsh/command-pages/create.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/create.html.md.erb
@@ -132,7 +132,7 @@ create async-event-queue --id=value --listener=value [--groups=value(,value)*]
 </tr>
 <tr>
 <td><span class="keyword parmname">&#8209;&#8209;batch-time-interval</span></td>
-<td>Maximum amount of time, in ms, that can elapse before a batch is delivered.</td>
+<td>Maximum amount of time, in ms, that can elapse before a batch is delivered, when no events are found in the queue to reach the batch-size.</td>
 <td>5</td>
 </tr>
 <tr>
@@ -585,7 +585,7 @@ create gateway-sender --id=value --remote-distributed-system-id=value
 </tr>
 <tr>
 <td><span class="keyword parmname">&#8209;&#8209;batch-time-interval</span></td>
-<td>Maximum number of milliseconds that can elapse between sending batches.</td>
+<td>Maximum amount of time, in ms, that can elapse before a batch is delivered, when no events are found in the queue to reach the batch-size.</td>
 <td>1000</td>
 </tr>
 <tr>