| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>RpcQosOptions.Builder (Apache Beam 2.38.0-SNAPSHOT)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="RpcQosOptions.Builder (Apache Beam 2.38.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.html" title="class in org.apache.beam.sdk.io.gcp.firestore"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html" target="_top">Frames</a></li> |
| <li><a href="RpcQosOptions.Builder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.beam.sdk.io.gcp.firestore</div> |
| <h2 title="Class RpcQosOptions.Builder" class="title">Class RpcQosOptions.Builder</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.io.gcp.firestore.RpcQosOptions.Builder</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.html" title="class in org.apache.beam.sdk.io.gcp.firestore">RpcQosOptions</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static final class <span class="typeNameLabel">RpcQosOptions.Builder</span> |
| extends java.lang.Object</pre> |
| <div class="block">Mutable Builder class for creating instances of <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.html" title="class in org.apache.beam.sdk.io.gcp.firestore"><code>RpcQosOptions</code></a>. |
| |
| <p>A new instance of <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore"><code>RpcQosOptions.Builder</code></a> can be created via <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.html#newBuilder--"><code>RpcQosOptions.newBuilder()</code></a>. |
| |
| <p><i>NOTE:</i> All <code>with</code> methods in this class function as set rather than copy with |
| new value</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.html" title="class in org.apache.beam.sdk.io.gcp.firestore">RpcQosOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html#build--">build</a></span>()</code> |
| <div class="block">Create a new instance of <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.html" title="class in org.apache.beam.sdk.io.gcp.firestore"><code>RpcQosOptions</code></a> from the current builder state.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">RpcQosOptions.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html#withBatchInitialCount-int-">withBatchInitialCount</a></span>(int batchInitialCount)</code> |
| <div class="block">Configure the initial size of a batch; used in the absence of the QoS system having |
| significant data to determine a better batch size.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">RpcQosOptions.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html#withBatchMaxBytes-long-">withBatchMaxBytes</a></span>(long batchMaxBytes)</code> |
| <div class="block">Configure the maximum number of bytes to include in a batch.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">RpcQosOptions.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html#withBatchMaxCount-int-">withBatchMaxCount</a></span>(int batchMaxCount)</code> |
| <div class="block">Configure the maximum number of writes to include in a batch.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">RpcQosOptions.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html#withBatchTargetLatency-org.joda.time.Duration-">withBatchTargetLatency</a></span>(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> batchTargetLatency)</code> |
| <div class="block">Target latency for batch requests.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">RpcQosOptions.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html#withHintMaxNumWorkers-int-">withHintMaxNumWorkers</a></span>(int hintMaxNumWorkers)</code> |
| <div class="block">Provide a hint to the QoS system for the intended max number of workers for a pipeline.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">RpcQosOptions.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html#withInitialBackoff-org.joda.time.Duration-">withInitialBackoff</a></span>(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> initialBackoff)</code> |
| <div class="block">Configure the initial backoff duration to be used before retrying a request for the first |
| time.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">RpcQosOptions.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html#withMaxAttempts-int-">withMaxAttempts</a></span>(int maxAttempts)</code> |
| <div class="block">Configure the maximum number of times a request will be attempted for a complete successful |
| result.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">RpcQosOptions.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html#withOverloadRatio-double-">withOverloadRatio</a></span>(double overloadRatio)</code> |
| <div class="block">The target ratio between requests sent and successful requests.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">RpcQosOptions.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html#withReportDiagnosticMetrics--">withReportDiagnosticMetrics</a></span>()</code> |
| <div class="block">Whether additional diagnostic metrics should be reported for a Transform.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">RpcQosOptions.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html#withSamplePeriod-org.joda.time.Duration-">withSamplePeriod</a></span>(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> samplePeriod)</code> |
| <div class="block">Configure the length of time sampled request data will be retained.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">RpcQosOptions.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html#withSamplePeriodBucketSize-org.joda.time.Duration-">withSamplePeriodBucketSize</a></span>(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> samplePeriodBucketSize)</code> |
| <div class="block">Configure the size of buckets within the specified <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html#withSamplePeriod-org.joda.time.Duration-"><code>samplePeriod</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">RpcQosOptions.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html#withThrottleDuration-org.joda.time.Duration-">withThrottleDuration</a></span>(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> throttleDuration)</code> |
| <div class="block">Configure the amount of time an attempt will be throttled if deemed necessary based on |
| previous success rate.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="withMaxAttempts-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withMaxAttempts</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">RpcQosOptions.Builder</a> withMaxAttempts(int maxAttempts)</pre> |
| <div class="block">Configure the maximum number of times a request will be attempted for a complete successful |
| result. |
| |
| <p>For a stream based response, the full stream read must complete within the specified |
| number of attempts. Restarting a stream will count as a new attempt. |
| |
| <p><i>Default Value:</i> 5</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maxAttempts</code> - an int in the range 1 <= <code>maxAttempts</code> <= 5</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this builder</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.html#getMaxAttempts--"><code>RpcQosOptions.getMaxAttempts()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withInitialBackoff-org.joda.time.Duration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withInitialBackoff</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">RpcQosOptions.Builder</a> withInitialBackoff(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> initialBackoff)</pre> |
| <div class="block">Configure the initial backoff duration to be used before retrying a request for the first |
| time. |
| |
| <p><i>Default Value:</i> 5 sec</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>initialBackoff</code> - a <a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time"><code>Duration</code></a> in the range 5 sec <= <code>initialBackoff</code> <= 2 |
| min</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this builder</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.html#getInitialBackoff--"><code>RpcQosOptions.getInitialBackoff()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withSamplePeriod-org.joda.time.Duration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withSamplePeriod</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">RpcQosOptions.Builder</a> withSamplePeriod(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> samplePeriod)</pre> |
| <div class="block">Configure the length of time sampled request data will be retained. |
| |
| <p><i>Default Value:</i> 2 min</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>samplePeriod</code> - a <a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time"><code>Duration</code></a> in the range 2 min <= <code>samplePeriod</code> <= 20 min</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this builder</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.html#getSamplePeriod--"><code>RpcQosOptions.getSamplePeriod()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withSamplePeriodBucketSize-org.joda.time.Duration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withSamplePeriodBucketSize</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">RpcQosOptions.Builder</a> withSamplePeriodBucketSize(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> samplePeriodBucketSize)</pre> |
| <div class="block">Configure the size of buckets within the specified <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html#withSamplePeriod-org.joda.time.Duration-"><code>samplePeriod</code></a>. |
| |
| <p><i>Default Value:</i> 10 sec</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>samplePeriodBucketSize</code> - a <a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time"><code>Duration</code></a> in the range 10 sec <= <code>samplePeriodBucketSize</code> <= 20 min</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this builder</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.html#getSamplePeriodBucketSize--"><code>RpcQosOptions.getSamplePeriodBucketSize()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withOverloadRatio-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withOverloadRatio</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">RpcQosOptions.Builder</a> withOverloadRatio(double overloadRatio)</pre> |
| <div class="block">The target ratio between requests sent and successful requests. This is "K" in the formula in |
| <a target="_blank" rel="noopener noreferrer" |
| href="https://sre.google/sre-book/handling-overload/#e2101">SRE Book - Handling Overload</a> |
| |
| <p><i>Default Value:</i> 1.05</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>overloadRatio</code> - the target ratio between requests sent and successful requests. A double |
| in the range 1.0 <= <code>overloadRatio</code> <= 1.5</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this builder</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.html#getOverloadRatio--"><code>RpcQosOptions.getOverloadRatio()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withThrottleDuration-org.joda.time.Duration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withThrottleDuration</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">RpcQosOptions.Builder</a> withThrottleDuration(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> throttleDuration)</pre> |
| <div class="block">Configure the amount of time an attempt will be throttled if deemed necessary based on |
| previous success rate. |
| |
| <p><i>Default value:</i> 5 sec</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>throttleDuration</code> - a <a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time"><code>Duration</code></a> in the range 5 sec <= <code>throttleDuration</code> <= |
| 1 min</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this builder</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.html#getThrottleDuration--"><code>RpcQosOptions.getThrottleDuration()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withBatchInitialCount-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withBatchInitialCount</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">RpcQosOptions.Builder</a> withBatchInitialCount(int batchInitialCount)</pre> |
| <div class="block">Configure the initial size of a batch; used in the absence of the QoS system having |
| significant data to determine a better batch size. |
| |
| <p><i>Default Value:</i> 20</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>batchInitialCount</code> - an int in the range 1 <= <code>batchInitialCount</code> <= 500</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this builder</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.html#getBatchInitialCount--"><code>RpcQosOptions.getBatchInitialCount()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withBatchMaxCount-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withBatchMaxCount</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">RpcQosOptions.Builder</a> withBatchMaxCount(int batchMaxCount)</pre> |
| <div class="block">Configure the maximum number of writes to include in a batch. (Used in the absence of the QoS |
| system having significant data to determine a better value). The actual number of writes per |
| request may be lower if <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html#withBatchMaxBytes-long-"><code>batchMaxBytes</code></a> is reached first. |
| |
| <p><i>Default Value:</i> 500</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>batchMaxCount</code> - an int in the range 1 <= <code>batchMaxCount</code> <= 500</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this builder</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.html#getBatchMaxCount--"><code>RpcQosOptions.getBatchMaxCount()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withBatchMaxBytes-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withBatchMaxBytes</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">RpcQosOptions.Builder</a> withBatchMaxBytes(long batchMaxBytes)</pre> |
| <div class="block">Configure the maximum number of bytes to include in a batch. (Used in the absence of the QoS |
| system having significant data to determine a better value). The actual number of bytes per |
| request may be lower if <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html#withBatchMaxCount-int-"><code>batchMaxCount</code></a> is reached first. |
| |
| <p><i>Default Value:</i> 9.5 MiB</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>batchMaxBytes</code> - an int in the range 1 B <= <code>batchMaxBytes</code> <= 9.5 MiB</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this builder</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.html#getBatchMaxBytes--"><code>RpcQosOptions.getBatchMaxBytes()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withBatchTargetLatency-org.joda.time.Duration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withBatchTargetLatency</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">RpcQosOptions.Builder</a> withBatchTargetLatency(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> batchTargetLatency)</pre> |
| <div class="block">Target latency for batch requests. It aims for a target response time per RPC: the response |
| times for previous RPCs and the number of writes contained in them, calculates a rolling |
| average time-per-write, and chooses the number of writes for future requests to hit the |
| target time. |
| |
| <p><i>Default Value:</i> 5 sec</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>batchTargetLatency</code> - a <a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time"><code>Duration</code></a> in the range 5 sec <= <code>batchTargetLatency</code> |
| <= 2 min</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this builder</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.html#getBatchTargetLatency--"><code>RpcQosOptions.getBatchTargetLatency()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withHintMaxNumWorkers-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withHintMaxNumWorkers</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">RpcQosOptions.Builder</a> withHintMaxNumWorkers(int hintMaxNumWorkers)</pre> |
| <div class="block">Provide a hint to the QoS system for the intended max number of workers for a pipeline. The |
| provided value can be used to try to scale calculations to values appropriate for the |
| pipeline as a whole. |
| |
| <p>If you are running your pipeline on <a target="_blank" rel="noopener noreferrer" |
| href="https://cloud.google.com/dataflow">Cloud Dataflow</a> this parameter should be set to |
| the same value as <a target="_blank" rel="noopener noreferrer" |
| href="https://cloud.google.com/dataflow/docs/guides/specifying-exec-params#setting-other-cloud-dataflow-pipeline-options"><code>maxNumWorkers</code></a> |
| |
| <p><i>Default Value:</i> 500</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>hintMaxNumWorkers</code> - an int in the range 1 <= <code>hintMaxNumWorkers</code> <= |
| Integer.MAX_VALUE</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this builder</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.html#getHintMaxNumWorkers--"><code>RpcQosOptions.getHintMaxNumWorkers()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withReportDiagnosticMetrics--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withReportDiagnosticMetrics</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">RpcQosOptions.Builder</a> withReportDiagnosticMetrics()</pre> |
| <div class="block">Whether additional diagnostic metrics should be reported for a Transform. |
| |
| <p>If invoked on this builder, additional detailed diagnostic metrics will be reported for |
| the RPC QoS subsystem. |
| |
| <p>This parameter should be used with care as it will output ~40 additional custom metrics |
| which will count toward any possible pipeline metrics limits (For example <a target="_blank" |
| rel="noopener noreferrer" |
| href="https://cloud.google.com/dataflow/docs/guides/using-cloud-monitoring#custom_metrics">Dataflow |
| Custom Metrics</a> limits and <a target="_blank" rel="noopener noreferrer" |
| href="https://cloud.google.com/monitoring/quotas#custom_metrics_quotas">Cloud Monitoring |
| custom metrics quota</a>)</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this builder</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.html#isShouldReportDiagnosticMetrics--"><code>RpcQosOptions.isShouldReportDiagnosticMetrics()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="build--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>build</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.html" title="class in org.apache.beam.sdk.io.gcp.firestore">RpcQosOptions</a> build()</pre> |
| <div class="block">Create a new instance of <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.html" title="class in org.apache.beam.sdk.io.gcp.firestore"><code>RpcQosOptions</code></a> from the current builder state. |
| |
| <p>All provided values will be validated for non-nullness and that each value falls within |
| its allowed range.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new instance of <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.html" title="class in org.apache.beam.sdk.io.gcp.firestore"><code>RpcQosOptions</code></a> from the current builder state.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.NullPointerException</code> - if any nullable value is null</dd> |
| <dd><code>java.lang.IllegalArgumentException</code> - if any provided value does not fall within its allowed range</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.html" title="class in org.apache.beam.sdk.io.gcp.firestore"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html" target="_top">Frames</a></li> |
| <li><a href="RpcQosOptions.Builder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
