| <!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>ObjectPool.ClientPool (Apache Beam 2.47.0)</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="ObjectPool.ClientPool (Apache Beam 2.47.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":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/aws2/common/ObjectPool.html" title="class in org.apache.beam.sdk.io.aws2.common"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/RetryConfiguration.html" title="class in org.apache.beam.sdk.io.aws2.common"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/aws2/common/ObjectPool.ClientPool.html" target="_top">Frames</a></li> |
| <li><a href="ObjectPool.ClientPool.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><a href="#nested.classes.inherited.from.class.org.apache.beam.sdk.io.aws2.common.ObjectPool">Nested</a> | </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.aws2.common</div> |
| <h2 title="Class ObjectPool.ClientPool" class="title">Class ObjectPool.ClientPool<ClientT extends <a href="https://static.javadoc.io/software.amazon.awssdk/sdk-core/2.17.127/software/amazon/awssdk/core/SdkClient.html?is-external=true" title="class or interface in software.amazon.awssdk.core">SdkClient</a>></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/ObjectPool.html" title="class in org.apache.beam.sdk.io.aws2.common">org.apache.beam.sdk.io.aws2.common.ObjectPool</a><<a href="https://static.javadoc.io/org.apache.commons/commons-lang3/3.9/org/apache/commons/lang3/tuple/Pair.html?is-external=true" title="class or interface in org.apache.commons.lang3.tuple">Pair</a><<a href="../../../../../../../org/apache/beam/sdk/io/aws2/options/AwsOptions.html" title="interface in org.apache.beam.sdk.io.aws2.options">AwsOptions</a>,<a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/ClientConfiguration.html" title="class in org.apache.beam.sdk.io.aws2.common">ClientConfiguration</a>>,ClientT></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.io.aws2.common.ObjectPool.ClientPool<ClientT></li> |
| </ul> |
| </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/aws2/common/ObjectPool.html" title="class in org.apache.beam.sdk.io.aws2.common">ObjectPool</a><<a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/ObjectPool.html" title="type parameter in ObjectPool">KeyT</a>,<a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/ObjectPool.html" title="type parameter in ObjectPool">ObjectT</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static class <span class="typeNameLabel">ObjectPool.ClientPool<ClientT extends <a href="https://static.javadoc.io/software.amazon.awssdk/sdk-core/2.17.127/software/amazon/awssdk/core/SdkClient.html?is-external=true" title="class or interface in software.amazon.awssdk.core">SdkClient</a>></span> |
| extends <a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/ObjectPool.html" title="class in org.apache.beam.sdk.io.aws2.common">ObjectPool</a><<a href="https://static.javadoc.io/org.apache.commons/commons-lang3/3.9/org/apache/commons/lang3/tuple/Pair.html?is-external=true" title="class or interface in org.apache.commons.lang3.tuple">Pair</a><<a href="../../../../../../../org/apache/beam/sdk/io/aws2/options/AwsOptions.html" title="interface in org.apache.beam.sdk.io.aws2.options">AwsOptions</a>,<a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/ClientConfiguration.html" title="class in org.apache.beam.sdk.io.aws2.common">ClientConfiguration</a>>,ClientT></pre> |
| <div class="block">Client pool to easily share AWS clients per configuration.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.beam.sdk.io.aws2.common.ObjectPool"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.apache.beam.sdk.io.aws2.common.<a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/ObjectPool.html" title="class in org.apache.beam.sdk.io.aws2.common">ObjectPool</a></h3> |
| <code><a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/ObjectPool.ClientPool.html" title="class in org.apache.beam.sdk.io.aws2.common">ObjectPool.ClientPool</a><<a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/ObjectPool.ClientPool.html" title="type parameter in ObjectPool.ClientPool">ClientT</a> extends <a href="https://static.javadoc.io/software.amazon.awssdk/sdk-core/2.17.127/software/amazon/awssdk/core/SdkClient.html?is-external=true" title="class or interface in software.amazon.awssdk.core">SdkClient</a>></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========== 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/aws2/common/ObjectPool.ClientPool.html" title="type parameter in ObjectPool.ClientPool">ClientT</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/ObjectPool.ClientPool.html#retain-org.apache.beam.sdk.io.aws2.options.AwsOptions-org.apache.beam.sdk.io.aws2.common.ClientConfiguration-">retain</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/aws2/options/AwsOptions.html" title="interface in org.apache.beam.sdk.io.aws2.options">AwsOptions</a> provider, |
| <a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/ClientConfiguration.html" title="class in org.apache.beam.sdk.io.aws2.common">ClientConfiguration</a> config)</code> |
| <div class="block">Retain a reference to a shared client instance.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.io.aws2.common.ObjectPool"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.beam.sdk.io.aws2.common.<a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/ObjectPool.html" title="class in org.apache.beam.sdk.io.aws2.common">ObjectPool</a></h3> |
| <code><a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/ObjectPool.html#pooledClientFactory-BuilderT-">pooledClientFactory</a>, <a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/ObjectPool.html#release-ObjectT-">release</a>, <a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/ObjectPool.html#releaseByKey-KeyT-">releaseByKey</a>, <a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/ObjectPool.html#retain-KeyT-">retain</a></code></li> |
| </ul> |
| <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="retain-org.apache.beam.sdk.io.aws2.options.AwsOptions-org.apache.beam.sdk.io.aws2.common.ClientConfiguration-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>retain</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/ObjectPool.ClientPool.html" title="type parameter in ObjectPool.ClientPool">ClientT</a> retain(<a href="../../../../../../../org/apache/beam/sdk/io/aws2/options/AwsOptions.html" title="interface in org.apache.beam.sdk.io.aws2.options">AwsOptions</a> provider, |
| <a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/ClientConfiguration.html" title="class in org.apache.beam.sdk.io.aws2.common">ClientConfiguration</a> config)</pre> |
| <div class="block">Retain a reference to a shared client instance. If not available, an instance is created.</div> |
| </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/aws2/common/ObjectPool.html" title="class in org.apache.beam.sdk.io.aws2.common"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/RetryConfiguration.html" title="class in org.apache.beam.sdk.io.aws2.common"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/aws2/common/ObjectPool.ClientPool.html" target="_top">Frames</a></li> |
| <li><a href="ObjectPool.ClientPool.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><a href="#nested.classes.inherited.from.class.org.apache.beam.sdk.io.aws2.common.ObjectPool">Nested</a> | </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> |
