Skip to content

Commit 7fb58df

Browse files
fuatbasikfuatbasik
committed
Update javadocs
1 parent 47c7ca2 commit 7fb58df

4 files changed

Lines changed: 74 additions & 23 deletions

File tree

‎docs/index-all.html‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -562,6 +562,14 @@ <h2 class="title">S</h2>
562562
</a>
563563
<h2 class="title">T</h2>
564564
<dl>
565+
<dt><span class="memberNameLink"><a href="software/amazon/s3/analyticsaccelerator/util/retry/DefaultRetryStrategyImpl.html#timeout-long-int-">timeout(long, int)</a></span> - Method in class software.amazon.s3.analyticsaccelerator.util.retry.<a href="software/amazon/s3/analyticsaccelerator/util/retry/DefaultRetryStrategyImpl.html" title="class in software.amazon.s3.analyticsaccelerator.util.retry">DefaultRetryStrategyImpl</a></dt>
566+
<dd>
567+
<div class="block">Create a timeout for read from storage operations and with specified retry count.</div>
568+
</dd>
569+
<dt><span class="memberNameLink"><a href="software/amazon/s3/analyticsaccelerator/util/retry/RetryStrategy.html#timeout-long-int-">timeout(long, int)</a></span> - Method in interface software.amazon.s3.analyticsaccelerator.util.retry.<a href="software/amazon/s3/analyticsaccelerator/util/retry/RetryStrategy.html" title="interface in software.amazon.s3.analyticsaccelerator.util.retry">RetryStrategy</a></dt>
570+
<dd>
571+
<div class="block">Create a timeout for read from storage operations and with specified retry count.</div>
572+
</dd>
565573
<dt><span class="memberNameLink"><a href="software/amazon/s3/analyticsaccelerator/request/ObjectMetadata.ObjectMetadataBuilder.html#toString--">toString()</a></span> - Method in class software.amazon.s3.analyticsaccelerator.request.<a href="software/amazon/s3/analyticsaccelerator/request/ObjectMetadata.ObjectMetadataBuilder.html" title="class in software.amazon.s3.analyticsaccelerator.request">ObjectMetadata.ObjectMetadataBuilder</a></dt>
566574
<dd>&nbsp;</dd>
567575
<dt><span class="memberNameLink"><a href="software/amazon/s3/analyticsaccelerator/request/ObjectMetadata.html#toString--">toString()</a></span> - Method in class software.amazon.s3.analyticsaccelerator.request.<a href="software/amazon/s3/analyticsaccelerator/request/ObjectMetadata.html" title="class in software.amazon.s3.analyticsaccelerator.request">ObjectMetadata</a></dt>

‎docs/software/amazon/s3/analyticsaccelerator/util/package-tree.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,8 @@ <h2 title="Enum Hierarchy">Enum Hierarchy</h2>
9191
<ul>
9292
<li type="circle">java.lang.Enum&lt;E&gt; (implements java.lang.Comparable&lt;T&gt;, java.io.Serializable)
9393
<ul>
94-
<li type="circle">software.amazon.s3.analyticsaccelerator.util.<a href="../../../../../software/amazon/s3/analyticsaccelerator/util/PrefetchMode.html" title="enum in software.amazon.s3.analyticsaccelerator.util"><span class="typeNameLink">PrefetchMode</span></a></li>
9594
<li type="circle">software.amazon.s3.analyticsaccelerator.util.<a href="../../../../../software/amazon/s3/analyticsaccelerator/util/InputPolicy.html" title="enum in software.amazon.s3.analyticsaccelerator.util"><span class="typeNameLink">InputPolicy</span></a></li>
95+
<li type="circle">software.amazon.s3.analyticsaccelerator.util.<a href="../../../../../software/amazon/s3/analyticsaccelerator/util/PrefetchMode.html" title="enum in software.amazon.s3.analyticsaccelerator.util"><span class="typeNameLink">PrefetchMode</span></a></li>
9696
</ul>
9797
</li>
9898
</ul>

‎docs/software/amazon/s3/analyticsaccelerator/util/retry/DefaultRetryStrategyImpl.html‎

Lines changed: 35 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
catch(err) {
1818
}
1919
//-->
20-
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
20+
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
2121
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
2222
var altColor = "altColor";
2323
var rowColor = "rowColor";
@@ -117,8 +117,9 @@ <h2 title="Class DefaultRetryStrategyImpl" class="title">Class DefaultRetryStrat
117117
<div class="block">Retry strategy implementation for seekable input stream operations. Uses Failsafe library to
118118
execute operations with configurable retry policies.
119119

120-
<p>This strategy will be additive to readTimeout and readRetryCount set on PhysicalIO
121-
configuration.</div>
120+
<p>If provided with a timeout this strategy will overwrite readTimeout and readRetryCount set on
121+
PhysicalIOConfiguration. If not, values from PhysicalIOConfiguration will be used to manage
122+
storage read timeouts.</div>
122123
</li>
123124
</ul>
124125
</div>
@@ -197,6 +198,13 @@ <h3>Method Summary</h3>
197198
<div class="block">Merge two retry strategies and return a new <a href="../../../../../../software/amazon/s3/analyticsaccelerator/util/retry/RetryStrategy.html" title="interface in software.amazon.s3.analyticsaccelerator.util.retry"><code>RetryStrategy</code></a>.</div>
198199
</td>
199200
</tr>
201+
<tr id="i5" class="rowColor">
202+
<td class="colFirst"><code>void</code></td>
203+
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../software/amazon/s3/analyticsaccelerator/util/retry/DefaultRetryStrategyImpl.html#timeout-long-int-">timeout</a></span>(long&nbsp;timeoutDurationMillis,
204+
int&nbsp;retryCount)</code>
205+
<div class="block">Create a timeout for read from storage operations and with specified retry count.</div>
206+
</td>
207+
</tr>
200208
</table>
201209
<ul class="blockList">
202210
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
@@ -273,16 +281,13 @@ <h3>Method Detail</h3>
273281
<ul class="blockList">
274282
<li class="blockList">
275283
<h4>execute</h4>
276-
<pre>public&nbsp;void&nbsp;execute(software.amazon.s3.analyticsaccelerator.util.retry.IORunnable&nbsp;runnable)
277-
throws java.io.IOException</pre>
284+
<pre>public&nbsp;void&nbsp;execute(software.amazon.s3.analyticsaccelerator.util.retry.IORunnable&nbsp;runnable)</pre>
278285
<div class="block">Executes a runnable operation with retry logic.</div>
279286
<dl>
280287
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
281288
<dd><code><a href="../../../../../../software/amazon/s3/analyticsaccelerator/util/retry/RetryStrategy.html#execute-software.amazon.s3.analyticsaccelerator.util.retry.IORunnable-">execute</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../software/amazon/s3/analyticsaccelerator/util/retry/RetryStrategy.html" title="interface in software.amazon.s3.analyticsaccelerator.util.retry">RetryStrategy</a></code></dd>
282289
<dt><span class="paramLabel">Parameters:</span></dt>
283290
<dd><code>runnable</code> - the operation to execute</dd>
284-
<dt><span class="throwsLabel">Throws:</span></dt>
285-
<dd><code>java.io.IOException</code> - if the operation fails after all retries</dd>
286291
</dl>
287292
</li>
288293
</ul>
@@ -292,8 +297,7 @@ <h4>execute</h4>
292297
<ul class="blockList">
293298
<li class="blockList">
294299
<h4>get</h4>
295-
<pre>public&nbsp;&lt;T&gt;&nbsp;T&nbsp;get(software.amazon.s3.analyticsaccelerator.util.retry.IOSupplier&lt;T&gt;&nbsp;supplier)
296-
throws java.io.IOException</pre>
300+
<pre>public&nbsp;&lt;T&gt;&nbsp;T&nbsp;get(software.amazon.s3.analyticsaccelerator.util.retry.IOSupplier&lt;T&gt;&nbsp;supplier)</pre>
297301
<div class="block">Executes a supplier operation with retry logic.</div>
298302
<dl>
299303
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
@@ -304,8 +308,6 @@ <h4>get</h4>
304308
<dd><code>supplier</code> - the operation that returns a byte array</dd>
305309
<dt><span class="returnLabel">Returns:</span></dt>
306310
<dd>the result of the supplier operation</dd>
307-
<dt><span class="throwsLabel">Throws:</span></dt>
308-
<dd><code>java.io.IOException</code> - if the operation fails after all retries</dd>
309311
</dl>
310312
</li>
311313
</ul>
@@ -348,7 +350,7 @@ <h4>merge</h4>
348350
<a name="getRetryPolicies--">
349351
<!-- -->
350352
</a>
351-
<ul class="blockListLast">
353+
<ul class="blockList">
352354
<li class="blockList">
353355
<h4>getRetryPolicies</h4>
354356
<pre>public&nbsp;java.util.List&lt;<a href="../../../../../../software/amazon/s3/analyticsaccelerator/util/retry/RetryPolicy.html" title="interface in software.amazon.s3.analyticsaccelerator.util.retry">RetryPolicy</a>&gt;&nbsp;getRetryPolicies()</pre>
@@ -362,6 +364,27 @@ <h4>getRetryPolicies</h4>
362364
</dl>
363365
</li>
364366
</ul>
367+
<a name="timeout-long-int-">
368+
<!-- -->
369+
</a>
370+
<ul class="blockListLast">
371+
<li class="blockList">
372+
<h4>timeout</h4>
373+
<pre>public&nbsp;void&nbsp;timeout(long&nbsp;timeoutDurationMillis,
374+
int&nbsp;retryCount)</pre>
375+
<div class="block">Create a timeout for read from storage operations and with specified retry count. This will
376+
override settings in PhysicalIOConfiguration (blockreadtimeout and blockreadretrycount) if set.
377+
If user does not set a timeout in their retry strategy, a timeout will be set based on
378+
aforementioned configuration. set blockreadtimeout = 0 to disable timeouts</div>
379+
<dl>
380+
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
381+
<dd><code><a href="../../../../../../software/amazon/s3/analyticsaccelerator/util/retry/RetryStrategy.html#timeout-long-int-">timeout</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../software/amazon/s3/analyticsaccelerator/util/retry/RetryStrategy.html" title="interface in software.amazon.s3.analyticsaccelerator.util.retry">RetryStrategy</a></code></dd>
382+
<dt><span class="paramLabel">Parameters:</span></dt>
383+
<dd><code>timeoutDurationMillis</code> - Timeout duration for reading from storage</dd>
384+
<dd><code>retryCount</code> - Number of times to retry if Timeout Exceeds</dd>
385+
</dl>
386+
</li>
387+
</ul>
365388
</li>
366389
</ul>
367390
</li>

‎docs/software/amazon/s3/analyticsaccelerator/util/retry/RetryStrategy.html‎

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
catch(err) {
1818
}
1919
//-->
20-
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6};
20+
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6};
2121
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
2222
var altColor = "altColor";
2323
var rowColor = "rowColor";
@@ -153,6 +153,13 @@ <h3>Method Summary</h3>
153153
<div class="block">Merge two retry strategies and return a new <a href="../../../../../../software/amazon/s3/analyticsaccelerator/util/retry/RetryStrategy.html" title="interface in software.amazon.s3.analyticsaccelerator.util.retry"><code>RetryStrategy</code></a>.</div>
154154
</td>
155155
</tr>
156+
<tr id="i5" class="rowColor">
157+
<td class="colFirst"><code>void</code></td>
158+
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../software/amazon/s3/analyticsaccelerator/util/retry/RetryStrategy.html#timeout-long-int-">timeout</a></span>(long&nbsp;durationInMillis,
159+
int&nbsp;retryCount)</code>
160+
<div class="block">Create a timeout for read from storage operations and with specified retry count.</div>
161+
</td>
162+
</tr>
156163
</table>
157164
</li>
158165
</ul>
@@ -174,14 +181,11 @@ <h3>Method Detail</h3>
174181
<ul class="blockList">
175182
<li class="blockList">
176183
<h4>execute</h4>
177-
<pre>void&nbsp;execute(software.amazon.s3.analyticsaccelerator.util.retry.IORunnable&nbsp;runnable)
178-
throws java.io.IOException</pre>
184+
<pre>void&nbsp;execute(software.amazon.s3.analyticsaccelerator.util.retry.IORunnable&nbsp;runnable)</pre>
179185
<div class="block">Executes a runnable with retry logic.</div>
180186
<dl>
181187
<dt><span class="paramLabel">Parameters:</span></dt>
182188
<dd><code>runnable</code> - the operation to execute</dd>
183-
<dt><span class="throwsLabel">Throws:</span></dt>
184-
<dd><code>java.io.IOException</code> - if the operation fails after all retry attempts</dd>
185189
</dl>
186190
</li>
187191
</ul>
@@ -191,8 +195,7 @@ <h4>execute</h4>
191195
<ul class="blockList">
192196
<li class="blockList">
193197
<h4>get</h4>
194-
<pre>&lt;T&gt;&nbsp;T&nbsp;get(software.amazon.s3.analyticsaccelerator.util.retry.IOSupplier&lt;T&gt;&nbsp;supplier)
195-
throws java.io.IOException</pre>
198+
<pre>&lt;T&gt;&nbsp;T&nbsp;get(software.amazon.s3.analyticsaccelerator.util.retry.IOSupplier&lt;T&gt;&nbsp;supplier)</pre>
196199
<div class="block">Executes a supplier with retry logic.</div>
197200
<dl>
198201
<dt><span class="paramLabel">Type Parameters:</span></dt>
@@ -201,8 +204,6 @@ <h4>get</h4>
201204
<dd><code>supplier</code> - the operation to execute</dd>
202205
<dt><span class="returnLabel">Returns:</span></dt>
203206
<dd>result of the supplier</dd>
204-
<dt><span class="throwsLabel">Throws:</span></dt>
205-
<dd><code>java.io.IOException</code> - if the operation fails after all retry attempts</dd>
206207
</dl>
207208
</li>
208209
</ul>
@@ -243,7 +244,7 @@ <h4>merge</h4>
243244
<a name="getRetryPolicies--">
244245
<!-- -->
245246
</a>
246-
<ul class="blockListLast">
247+
<ul class="blockList">
247248
<li class="blockList">
248249
<h4>getRetryPolicies</h4>
249250
<pre>java.util.List&lt;<a href="../../../../../../software/amazon/s3/analyticsaccelerator/util/retry/RetryPolicy.html" title="interface in software.amazon.s3.analyticsaccelerator.util.retry">RetryPolicy</a>&gt;&nbsp;getRetryPolicies()</pre>
@@ -254,6 +255,25 @@ <h4>getRetryPolicies</h4>
254255
</dl>
255256
</li>
256257
</ul>
258+
<a name="timeout-long-int-">
259+
<!-- -->
260+
</a>
261+
<ul class="blockListLast">
262+
<li class="blockList">
263+
<h4>timeout</h4>
264+
<pre>void&nbsp;timeout(long&nbsp;durationInMillis,
265+
int&nbsp;retryCount)</pre>
266+
<div class="block">Create a timeout for read from storage operations and with specified retry count. This will
267+
override settings in PhysicalIOConfiguration (blockreadtimeout and blockreadretrycount) if set.
268+
If user does not set a timeout in their retry strategy, a timeout will be set based on
269+
aforementioned configuration. set blockreadtimeout = 0 to disable timeouts.</div>
270+
<dl>
271+
<dt><span class="paramLabel">Parameters:</span></dt>
272+
<dd><code>durationInMillis</code> - Timeout duration for reading from storage</dd>
273+
<dd><code>retryCount</code> - Number of times to retry if Timeout Exceeds</dd>
274+
</dl>
275+
</li>
276+
</ul>
257277
</li>
258278
</ul>
259279
</li>

0 commit comments

Comments
 (0)