| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- GitHub action javadoc-cleanup --> |
| <link rel="canonical" href="https://beam.apache.org/releases/javadoc/current/org/apache/beam/it/kafka/KafkaResourceManager.Builder.html"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <!-- End javadoc-cleanup block --> |
| <!-- Generated by javadoc --> |
| <title>KafkaResourceManager.Builder (Apache Beam 2.55.1)</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="KafkaResourceManager.Builder (Apache Beam 2.55.1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":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/it/kafka/KafkaResourceManager.html" title="class in org.apache.beam.it.kafka"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/it/kafka/KafkaResourceManagerException.html" title="class in org.apache.beam.it.kafka"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/it/kafka/KafkaResourceManager.Builder.html" target="_top">Frames</a></li> |
| <li><a href="KafkaResourceManager.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><a href="#fields.inherited.from.class.org.apache.beam.it.testcontainers.TestContainerResourceManager.Builder">Field</a> | </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.it.kafka</div> |
| <h2 title="Class KafkaResourceManager.Builder" class="title">Class KafkaResourceManager.Builder</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/beam/it/testcontainers/TestContainerResourceManager.Builder.html" title="class in org.apache.beam.it.testcontainers">org.apache.beam.it.testcontainers.TestContainerResourceManager.Builder</a><<a href="../../../../../org/apache/beam/it/kafka/KafkaResourceManager.html" title="class in org.apache.beam.it.kafka">KafkaResourceManager</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.it.kafka.KafkaResourceManager.Builder</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/it/kafka/KafkaResourceManager.html" title="class in org.apache.beam.it.kafka">KafkaResourceManager</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static final class <span class="typeNameLabel">KafkaResourceManager.Builder</span> |
| extends <a href="../../../../../org/apache/beam/it/testcontainers/TestContainerResourceManager.Builder.html" title="class in org.apache.beam.it.testcontainers">TestContainerResourceManager.Builder</a><<a href="../../../../../org/apache/beam/it/kafka/KafkaResourceManager.html" title="class in org.apache.beam.it.kafka">KafkaResourceManager</a>></pre> |
| <div class="block">Builder for <a href="../../../../../org/apache/beam/it/kafka/KafkaResourceManager.html" title="class in org.apache.beam.it.kafka"><code>KafkaResourceManager</code></a>.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.beam.it.testcontainers.TestContainerResourceManager.Builder"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.beam.it.testcontainers.<a href="../../../../../org/apache/beam/it/testcontainers/TestContainerResourceManager.Builder.html" title="class in org.apache.beam.it.testcontainers">TestContainerResourceManager.Builder</a></h3> |
| <code><a href="../../../../../org/apache/beam/it/testcontainers/TestContainerResourceManager.Builder.html#containerImageName">containerImageName</a>, <a href="../../../../../org/apache/beam/it/testcontainers/TestContainerResourceManager.Builder.html#containerImageTag">containerImageTag</a>, <a href="../../../../../org/apache/beam/it/testcontainers/TestContainerResourceManager.Builder.html#host">host</a>, <a href="../../../../../org/apache/beam/it/testcontainers/TestContainerResourceManager.Builder.html#port">port</a>, <a href="../../../../../org/apache/beam/it/testcontainers/TestContainerResourceManager.Builder.html#testId">testId</a>, <a href="../../../../../org/apache/beam/it/testcontainers/TestContainerResourceManager.Builder.html#useStaticContainer">useStaticContainer</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/it/kafka/KafkaResourceManager.html" title="class in org.apache.beam.it.kafka">KafkaResourceManager</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/it/kafka/KafkaResourceManager.Builder.html#build--">build</a></span>()</code> |
| <div class="block">Builds and returns a Resource Manager that extends TestContainerResourceManager.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/it/kafka/KafkaResourceManager.Builder.html" title="class in org.apache.beam.it.kafka">KafkaResourceManager.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/it/kafka/KafkaResourceManager.Builder.html#setNumTopics-int-">setNumTopics</a></span>(int numTopics)</code> |
| <div class="block">Sets the number of topics to be used instead of explicitly assign the topic names.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/it/kafka/KafkaResourceManager.Builder.html" title="class in org.apache.beam.it.kafka">KafkaResourceManager.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/it/kafka/KafkaResourceManager.Builder.html#setTopicNames-java.util.Set-">setTopicNames</a></span>(java.util.Set<java.lang.String> topicNames)</code> |
| <div class="block">Sets names of topics to be used to that of a static kafka instance.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.it.testcontainers.TestContainerResourceManager.Builder"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.beam.it.testcontainers.<a href="../../../../../org/apache/beam/it/testcontainers/TestContainerResourceManager.Builder.html" title="class in org.apache.beam.it.testcontainers">TestContainerResourceManager.Builder</a></h3> |
| <code><a href="../../../../../org/apache/beam/it/testcontainers/TestContainerResourceManager.Builder.html#setContainerImageName-java.lang.String-">setContainerImageName</a>, <a href="../../../../../org/apache/beam/it/testcontainers/TestContainerResourceManager.Builder.html#setContainerImageTag-java.lang.String-">setContainerImageTag</a>, <a href="../../../../../org/apache/beam/it/testcontainers/TestContainerResourceManager.Builder.html#setHost-java.lang.String-">setHost</a>, <a href="../../../../../org/apache/beam/it/testcontainers/TestContainerResourceManager.Builder.html#setPort-int-">setPort</a>, <a href="../../../../../org/apache/beam/it/testcontainers/TestContainerResourceManager.Builder.html#useStaticContainer--">useStaticContainer</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="setTopicNames-java.util.Set-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTopicNames</h4> |
| <pre>public <a href="../../../../../org/apache/beam/it/kafka/KafkaResourceManager.Builder.html" title="class in org.apache.beam.it.kafka">KafkaResourceManager.Builder</a> setTopicNames(java.util.Set<java.lang.String> topicNames)</pre> |
| <div class="block">Sets names of topics to be used to that of a static kafka instance. Use this method only when |
| attempting to operate on pre-existing kafka topics. |
| |
| <p>Note: if a topic name is set, and a static kafka server is being used |
| (useStaticContainer() is also called on the builder), then a topic will be created on the |
| static server if it does not exist, and it will NOT be removed when cleanupAll() is called on |
| the KafkaResourceManager.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>topicNames</code> - A set of topic names.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this builder object with the topic name set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setNumTopics-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNumTopics</h4> |
| <pre>public <a href="../../../../../org/apache/beam/it/kafka/KafkaResourceManager.Builder.html" title="class in org.apache.beam.it.kafka">KafkaResourceManager.Builder</a> setNumTopics(int numTopics)</pre> |
| <div class="block">Sets the number of topics to be used instead of explicitly assign the topic names. |
| |
| <p>Note: if number of topics is set, and a static kafka server is being used |
| (useStaticContainer() is also called on the builder), then the assigned number of topics will |
| be created on the static server, and it will be removed when cleanupAll() is called on the |
| KafkaResourceManager.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>numTopics</code> - number of topics to be created. Default is 1.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this builder object with numTopics set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="build--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>build</h4> |
| <pre>public <a href="../../../../../org/apache/beam/it/kafka/KafkaResourceManager.html" title="class in org.apache.beam.it.kafka">KafkaResourceManager</a> build()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/beam/it/testcontainers/TestContainerResourceManager.Builder.html#build--">TestContainerResourceManager.Builder</a></code></span></div> |
| <div class="block">Builds and returns a Resource Manager that extends TestContainerResourceManager.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/beam/it/testcontainers/TestContainerResourceManager.Builder.html#build--">build</a></code> in class <code><a href="../../../../../org/apache/beam/it/testcontainers/TestContainerResourceManager.Builder.html" title="class in org.apache.beam.it.testcontainers">TestContainerResourceManager.Builder</a><<a href="../../../../../org/apache/beam/it/kafka/KafkaResourceManager.html" title="class in org.apache.beam.it.kafka">KafkaResourceManager</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an instance of TestContainerResourceManager</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/it/kafka/KafkaResourceManager.html" title="class in org.apache.beam.it.kafka"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/it/kafka/KafkaResourceManagerException.html" title="class in org.apache.beam.it.kafka"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/it/kafka/KafkaResourceManager.Builder.html" target="_top">Frames</a></li> |
| <li><a href="KafkaResourceManager.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><a href="#fields.inherited.from.class.org.apache.beam.it.testcontainers.TestContainerResourceManager.Builder">Field</a> | </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> |
