| <!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>JmsIO.Read (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="JmsIO.Read (Apache Beam 2.47.0)"; |
| } |
| } |
| 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/jms/JmsIO.MessageMapper.html" title="interface in org.apache.beam.sdk.io.jms"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Write.html" title="class in org.apache.beam.sdk.io.jms"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/io/jms/JmsIO.Read.html" target="_top">Frames</a></li> |
| <li><a href="JmsIO.Read.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.sdk.transforms.PTransform">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.jms</div> |
| <h2 title="Class JmsIO.Read" class="title">Class JmsIO.Read<T></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">org.apache.beam.sdk.transforms.PTransform</a><<a href="../../../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a>,<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><T>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.io.jms.JmsIO.Read<T></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.io.Serializable, <a href="../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></dd> |
| </dl> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.html" title="class in org.apache.beam.sdk.io.jms">JmsIO</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract static class <span class="typeNameLabel">JmsIO.Read<T></span> |
| extends <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a>,<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><T>></pre> |
| <div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> to read from a JMS destination. See <a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.html" title="class in org.apache.beam.sdk.io.jms"><code>JmsIO</code></a> for more information on |
| usage and configuration.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../serialized-form.html#org.apache.beam.sdk.io.jms.JmsIO.Read">Serialized Form</a></dd> |
| </dl> |
| </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.sdk.transforms.PTransform"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.beam.sdk.transforms.<a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a></h3> |
| <code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#name">name</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#resourceHints">resourceHints</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html#Read--">Read</a></span>()</code> </td> |
| </tr> |
| </table> |
| </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/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="type parameter in JmsIO.Read">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html#expand-org.apache.beam.sdk.values.PBegin-">expand</a></span>(<a href="../../../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a> input)</code> |
| <div class="block">Override this method to specify how this <code>PTransform</code> should be expanded on the given |
| <code>InputT</code>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a></span>(<a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a> builder)</code> |
| <div class="block">Register display data for the given transform or component.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="class in org.apache.beam.sdk.io.jms">JmsIO.Read</a><<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="type parameter in JmsIO.Read">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html#withAutoScaler-org.apache.beam.sdk.io.jms.AutoScaler-">withAutoScaler</a></span>(<a href="../../../../../../org/apache/beam/sdk/io/jms/AutoScaler.html" title="interface in org.apache.beam.sdk.io.jms">AutoScaler</a> autoScaler)</code> |
| <div class="block">Sets the <a href="../../../../../../org/apache/beam/sdk/io/jms/AutoScaler.html" title="interface in org.apache.beam.sdk.io.jms"><code>AutoScaler</code></a> to use for reporting backlog during the execution of this source.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="class in org.apache.beam.sdk.io.jms">JmsIO.Read</a><<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="type parameter in JmsIO.Read">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html#withCloseTimeout-org.joda.time.Duration-">withCloseTimeout</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> closeTimeout)</code> |
| <div class="block">Sets the amount of time to wait for callbacks from the runner stating that the output has |
| been durably persisted before closing the connection to the JMS broker.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="class in org.apache.beam.sdk.io.jms">JmsIO.Read</a><<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="type parameter in JmsIO.Read">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html#withCoder-org.apache.beam.sdk.coders.Coder-">withCoder</a></span>(<a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="type parameter in JmsIO.Read">T</a>> coder)</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="class in org.apache.beam.sdk.io.jms">JmsIO.Read</a><<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="type parameter in JmsIO.Read">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html#withConnectionFactory-javax.jms.ConnectionFactory-">withConnectionFactory</a></span>(javax.jms.ConnectionFactory connectionFactory)</code> |
| <div class="block">Specify the JMS connection factory to connect to the JMS broker.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="class in org.apache.beam.sdk.io.jms">JmsIO.Read</a><<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="type parameter in JmsIO.Read">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html#withMaxNumRecords-long-">withMaxNumRecords</a></span>(long maxNumRecords)</code> |
| <div class="block">Define the max number of records that the source will read.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="class in org.apache.beam.sdk.io.jms">JmsIO.Read</a><<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="type parameter in JmsIO.Read">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html#withMaxReadTime-org.joda.time.Duration-">withMaxReadTime</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> maxReadTime)</code> |
| <div class="block">Define the max read time that the source will read.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="class in org.apache.beam.sdk.io.jms">JmsIO.Read</a><<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="type parameter in JmsIO.Read">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html#withMessageMapper-org.apache.beam.sdk.io.jms.JmsIO.MessageMapper-">withMessageMapper</a></span>(<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.MessageMapper.html" title="interface in org.apache.beam.sdk.io.jms">JmsIO.MessageMapper</a><<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="type parameter in JmsIO.Read">T</a>> messageMapper)</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="class in org.apache.beam.sdk.io.jms">JmsIO.Read</a><<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="type parameter in JmsIO.Read">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html#withPassword-java.lang.String-">withPassword</a></span>(java.lang.String password)</code> |
| <div class="block">Define the password to connect to the JMS broker (authenticated).</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="class in org.apache.beam.sdk.io.jms">JmsIO.Read</a><<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="type parameter in JmsIO.Read">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html#withQueue-java.lang.String-">withQueue</a></span>(java.lang.String queue)</code> |
| <div class="block">Specify the JMS queue destination name where to read messages from.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="class in org.apache.beam.sdk.io.jms">JmsIO.Read</a><<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="type parameter in JmsIO.Read">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html#withTopic-java.lang.String-">withTopic</a></span>(java.lang.String topic)</code> |
| <div class="block">Specify the JMS topic destination name where to receive messages from.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="class in org.apache.beam.sdk.io.jms">JmsIO.Read</a><<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="type parameter in JmsIO.Read">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html#withUsername-java.lang.String-">withUsername</a></span>(java.lang.String username)</code> |
| <div class="block">Define the username to connect to the JMS broker (authenticated).</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.transforms.PTransform"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.beam.sdk.transforms.<a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a></h3> |
| <code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#compose-org.apache.beam.sdk.transforms.SerializableFunction-">compose</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#compose-java.lang.String-org.apache.beam.sdk.transforms.SerializableFunction-">compose</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getAdditionalInputs--">getAdditionalInputs</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder--">getDefaultOutputCoder</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder-InputT-">getDefaultOutputCoder</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder-InputT-org.apache.beam.sdk.values.PCollection-">getDefaultOutputCoder</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getKindString--">getKindString</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getName--">getName</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getResourceHints--">getResourceHints</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#setResourceHints-org.apache.beam.sdk.transforms.resourcehints.ResourceHints-">setResourceHints</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#toString--">toString</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#validate-org.apache.beam.sdk.options.PipelineOptions-">validate</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#validate-org.apache.beam.sdk.options.PipelineOptions-java.util.Map-java.util.Map-">validate</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, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Read--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Read</h4> |
| <pre>public Read()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="withConnectionFactory-javax.jms.ConnectionFactory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withConnectionFactory</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="class in org.apache.beam.sdk.io.jms">JmsIO.Read</a><<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="type parameter in JmsIO.Read">T</a>> withConnectionFactory(javax.jms.ConnectionFactory connectionFactory)</pre> |
| <div class="block">Specify the JMS connection factory to connect to the JMS broker. |
| |
| <p>For instance: |
| |
| <pre><code> |
| pipeline.apply(JmsIO.read().withConnectionFactory(myConnectionFactory) |
| |
| </code></pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>connectionFactory</code> - The JMS <code>ConnectionFactory</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The corresponding <a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="class in org.apache.beam.sdk.io.jms"><code>JmsIO.Read</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withQueue-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withQueue</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="class in org.apache.beam.sdk.io.jms">JmsIO.Read</a><<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="type parameter in JmsIO.Read">T</a>> withQueue(java.lang.String queue)</pre> |
| <div class="block">Specify the JMS queue destination name where to read messages from. The <a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="class in org.apache.beam.sdk.io.jms"><code>JmsIO.Read</code></a> |
| acts as a consumer on the queue. |
| |
| <p>This method is exclusive with <a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html#withTopic-java.lang.String-"><code>withTopic(String)</code></a>. The user has to |
| specify a destination: queue or topic. |
| |
| <p>For instance: |
| |
| <pre><code> |
| pipeline.apply(JmsIO.read().withQueue("my-queue") |
| |
| </code></pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>queue</code> - The JMS queue name where to read messages from.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The corresponding <a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="class in org.apache.beam.sdk.io.jms"><code>JmsIO.Read</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withTopic-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withTopic</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="class in org.apache.beam.sdk.io.jms">JmsIO.Read</a><<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="type parameter in JmsIO.Read">T</a>> withTopic(java.lang.String topic)</pre> |
| <div class="block">Specify the JMS topic destination name where to receive messages from. The <a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="class in org.apache.beam.sdk.io.jms"><code>JmsIO.Read</code></a> |
| acts as a subscriber on the topic. |
| |
| <p>This method is exclusive with <a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html#withQueue-java.lang.String-"><code>withQueue(String)</code></a>. The user has to |
| specify a destination: queue or topic. |
| |
| <p>For instance: |
| |
| <pre><code> |
| pipeline.apply(JmsIO.read().withTopic("my-topic") |
| |
| </code></pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>topic</code> - The JMS topic name.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The corresponding <a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="class in org.apache.beam.sdk.io.jms"><code>JmsIO.Read</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withUsername-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withUsername</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="class in org.apache.beam.sdk.io.jms">JmsIO.Read</a><<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="type parameter in JmsIO.Read">T</a>> withUsername(java.lang.String username)</pre> |
| <div class="block">Define the username to connect to the JMS broker (authenticated).</div> |
| </li> |
| </ul> |
| <a name="withPassword-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withPassword</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="class in org.apache.beam.sdk.io.jms">JmsIO.Read</a><<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="type parameter in JmsIO.Read">T</a>> withPassword(java.lang.String password)</pre> |
| <div class="block">Define the password to connect to the JMS broker (authenticated).</div> |
| </li> |
| </ul> |
| <a name="withMaxNumRecords-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withMaxNumRecords</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="class in org.apache.beam.sdk.io.jms">JmsIO.Read</a><<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="type parameter in JmsIO.Read">T</a>> withMaxNumRecords(long maxNumRecords)</pre> |
| <div class="block">Define the max number of records that the source will read. Using a max number of records |
| different from <code>Long.MAX_VALUE</code> means the source will be <code>Bounded</code>, and will stop |
| once the max number of records read is reached. |
| |
| <p>For instance: |
| |
| <pre><code> |
| pipeline.apply(JmsIO.read().withNumRecords(1000) |
| |
| </code></pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maxNumRecords</code> - The max number of records to read from the JMS destination.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The corresponding <a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="class in org.apache.beam.sdk.io.jms"><code>JmsIO.Read</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withMaxReadTime-org.joda.time.Duration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withMaxReadTime</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="class in org.apache.beam.sdk.io.jms">JmsIO.Read</a><<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="type parameter in JmsIO.Read">T</a>> withMaxReadTime(<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> maxReadTime)</pre> |
| <div class="block">Define the max read time that the source will read. Using a non null max read time duration |
| means the source will be <code>Bounded</code>, and will stop once the max read time is reached. |
| |
| <p>For instance: |
| |
| <pre><code> |
| pipeline.apply(JmsIO.read().withMaxReadTime(Duration.minutes(10)) |
| |
| </code></pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maxReadTime</code> - The max read time duration.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The corresponding <a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="class in org.apache.beam.sdk.io.jms"><code>JmsIO.Read</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withMessageMapper-org.apache.beam.sdk.io.jms.JmsIO.MessageMapper-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withMessageMapper</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="class in org.apache.beam.sdk.io.jms">JmsIO.Read</a><<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="type parameter in JmsIO.Read">T</a>> withMessageMapper(<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.MessageMapper.html" title="interface in org.apache.beam.sdk.io.jms">JmsIO.MessageMapper</a><<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="type parameter in JmsIO.Read">T</a>> messageMapper)</pre> |
| </li> |
| </ul> |
| <a name="withCoder-org.apache.beam.sdk.coders.Coder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withCoder</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="class in org.apache.beam.sdk.io.jms">JmsIO.Read</a><<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="type parameter in JmsIO.Read">T</a>> withCoder(<a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="type parameter in JmsIO.Read">T</a>> coder)</pre> |
| </li> |
| </ul> |
| <a name="withAutoScaler-org.apache.beam.sdk.io.jms.AutoScaler-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withAutoScaler</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="class in org.apache.beam.sdk.io.jms">JmsIO.Read</a><<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="type parameter in JmsIO.Read">T</a>> withAutoScaler(<a href="../../../../../../org/apache/beam/sdk/io/jms/AutoScaler.html" title="interface in org.apache.beam.sdk.io.jms">AutoScaler</a> autoScaler)</pre> |
| <div class="block">Sets the <a href="../../../../../../org/apache/beam/sdk/io/jms/AutoScaler.html" title="interface in org.apache.beam.sdk.io.jms"><code>AutoScaler</code></a> to use for reporting backlog during the execution of this source.</div> |
| </li> |
| </ul> |
| <a name="withCloseTimeout-org.joda.time.Duration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withCloseTimeout</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="class in org.apache.beam.sdk.io.jms">JmsIO.Read</a><<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="type parameter in JmsIO.Read">T</a>> withCloseTimeout(<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> closeTimeout)</pre> |
| <div class="block">Sets the amount of time to wait for callbacks from the runner stating that the output has |
| been durably persisted before closing the connection to the JMS broker. Any callbacks that do |
| not occur will cause unacknowledged messages to be returned to the JMS broker and redelivered |
| to other clients.</div> |
| </li> |
| </ul> |
| <a name="expand-org.apache.beam.sdk.values.PBegin-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>expand</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="type parameter in JmsIO.Read">T</a>> expand(<a href="../../../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a> input)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#expand-InputT-">PTransform</a></code></span></div> |
| <div class="block">Override this method to specify how this <code>PTransform</code> should be expanded on the given |
| <code>InputT</code>. |
| |
| <p>NOTE: This method should not be called directly. Instead apply the <code>PTransform</code> should |
| be applied to the <code>InputT</code> using the <code>apply</code> method. |
| |
| <p>Composite transforms, which are defined in terms of other transforms, should return the |
| output of one of the composed transforms. Non-composite transforms, which do not apply any |
| transforms internally, should return a new unbound output and register evaluators (via |
| backend-specific registration methods).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#expand-InputT-">expand</a></code> in class <code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a>,<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="type parameter in JmsIO.Read">T</a>>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>populateDisplayData</h4> |
| <pre>public void populateDisplayData(<a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a> builder)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">PTransform</a></code></span></div> |
| <div class="block">Register display data for the given transform or component. |
| |
| <p><code>populateDisplayData(DisplayData.Builder)</code> is invoked by Pipeline runners to collect |
| display data via <a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.html#from-org.apache.beam.sdk.transforms.display.HasDisplayData-"><code>DisplayData.from(HasDisplayData)</code></a>. Implementations may call <code>super.populateDisplayData(builder)</code> in order to register display data in the current namespace, |
| but should otherwise use <code>subcomponent.populateDisplayData(builder)</code> to use the namespace |
| of the subcomponent. |
| |
| <p>By default, does not register any display data. Implementors may override this method to |
| provide their own display data.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a></code> in interface <code><a href="../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a></code> in class <code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a>,<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Read.html" title="type parameter in JmsIO.Read">T</a>>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>builder</code> - The builder to populate with display data.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display"><code>HasDisplayData</code></a></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/jms/JmsIO.MessageMapper.html" title="interface in org.apache.beam.sdk.io.jms"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/io/jms/JmsIO.Write.html" title="class in org.apache.beam.sdk.io.jms"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/io/jms/JmsIO.Read.html" target="_top">Frames</a></li> |
| <li><a href="JmsIO.Read.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.sdk.transforms.PTransform">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
