| <!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>RabbitMqIO (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="RabbitMqIO (Apache Beam 2.47.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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>Prev Class</li> |
| <li><a href="../../../../../../org/apache/beam/sdk/io/rabbitmq/RabbitMqIO.Read.html" title="class in org.apache.beam.sdk.io.rabbitmq"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/io/rabbitmq/RabbitMqIO.html" target="_top">Frames</a></li> |
| <li><a href="RabbitMqIO.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.class.summary">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.rabbitmq</div> |
| <h2 title="Class RabbitMqIO" class="title">Class RabbitMqIO</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.io.rabbitmq.RabbitMqIO</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre><a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a>(<a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html#value--">value</a>=<a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.Kind.html#SOURCE_SINK">SOURCE_SINK</a>) |
| public class <span class="typeNameLabel">RabbitMqIO</span> |
| extends java.lang.Object</pre> |
| <div class="block">A IO to publish or consume messages with a RabbitMQ broker. |
| |
| <p>Documentation in this module tends to reference interacting with a "queue" vs interacting with |
| an "exchange". AMQP doesn't technically work this way. For readers, notes on reading from/writing |
| to a "queue" implies the "default exchange" is in use, operating as a "direct exchange". Notes on |
| interacting with an "exchange" are more flexible and are generally more applicable. |
| |
| <h3>Consuming messages from RabbitMQ server</h3> |
| |
| <p><a href="../../../../../../org/apache/beam/sdk/io/rabbitmq/RabbitMqIO.html" title="class in org.apache.beam.sdk.io.rabbitmq"><code>RabbitMqIO</code></a> <a href="../../../../../../org/apache/beam/sdk/io/rabbitmq/RabbitMqIO.Read.html" title="class in org.apache.beam.sdk.io.rabbitmq"><code>RabbitMqIO.Read</code></a> returns an unbounded <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> containing RabbitMQ |
| messages body (as <code>byte[]</code>) wrapped as <a href="../../../../../../org/apache/beam/sdk/io/rabbitmq/RabbitMqMessage.html" title="class in org.apache.beam.sdk.io.rabbitmq"><code>RabbitMqMessage</code></a>. |
| |
| <p>To configure a RabbitMQ source, you have to provide a RabbitMQ <code>URI</code> to connect to a |
| RabbitMQ broker. The following example illustrates various options for configuring the source, |
| reading from a named queue on the default exchange: |
| |
| <pre><code> |
| PCollection<RabbitMqMessage> messages = pipeline.apply( |
| RabbitMqIO.read().withUri("amqp://user:password@localhost:5672").withQueue("QUEUE")) |
| |
| </code></pre> |
| |
| <p>Often one will want to read from an exchange. The exchange can be declared by Beam or can be |
| pre-existing. The supplied <code>routingKey</code> has variable functionality depending on the |
| exchange type. As examples: |
| |
| <pre><code> |
| // reading from an fanout (pubsub) exchange, declared (non-durable) by RabbitMqIO. |
| // Note the routingKey is 'null' as a fanout exchange publishes all messages to |
| // all queues, and the specified binding will be ignored |
| PCollection<RabbitMqMessage> messages = pipeline.apply(RabbitMqIO.read() |
| .withUri("amqp://user:password@localhost:5672").withExchange("EXCHANGE", "fanout", null)); |
| |
| // reading from an existing topic exchange named 'EVENTS' |
| // this will use a dynamically-created, non-durable queue subscribing to all |
| // messages with a routing key beginning with 'users.' |
| PCollection<RabbitMqMessage> messages = pipeline.apply(RabbitMqIO.read() |
| .withUri("amqp://user:password@localhost:5672").withExchange("EVENTS", "users.#")); |
| </code></pre> |
| |
| <h3>Publishing messages to RabbitMQ server</h3> |
| |
| <p><a href="../../../../../../org/apache/beam/sdk/io/rabbitmq/RabbitMqIO.html" title="class in org.apache.beam.sdk.io.rabbitmq"><code>RabbitMqIO</code></a> <a href="../../../../../../org/apache/beam/sdk/io/rabbitmq/RabbitMqIO.Write.html" title="class in org.apache.beam.sdk.io.rabbitmq"><code>RabbitMqIO.Write</code></a> can send <a href="../../../../../../org/apache/beam/sdk/io/rabbitmq/RabbitMqMessage.html" title="class in org.apache.beam.sdk.io.rabbitmq"><code>RabbitMqMessage</code></a> to a RabbitMQ server queue |
| or exchange. |
| |
| <p>As for the <a href="../../../../../../org/apache/beam/sdk/io/rabbitmq/RabbitMqIO.Read.html" title="class in org.apache.beam.sdk.io.rabbitmq"><code>RabbitMqIO.Read</code></a>, the <a href="../../../../../../org/apache/beam/sdk/io/rabbitmq/RabbitMqIO.Write.html" title="class in org.apache.beam.sdk.io.rabbitmq"><code>RabbitMqIO.Write</code></a> is configured with a RabbitMQ URI. |
| |
| <p>Examples |
| |
| <pre><code> |
| // Publishing to a named, non-durable exchange, declared by Beam: |
| pipeline |
| .apply(...) // provide PCollection<RabbitMqMessage> |
| .apply(RabbitMqIO.write().withUri("amqp://user:password@localhost:5672").withExchange("EXCHANGE", "fanout")); |
| |
| // Publishing to an existing exchange |
| pipeline |
| .apply(...) // provide PCollection<RabbitMqMessage> |
| .apply(RabbitMqIO.write().withUri("amqp://user:password@localhost:5672").withExchange("EXCHANGE")); |
| |
| // Publishing to a named queue in the default exchange: |
| pipeline |
| .apply(...) // provide PCollection<RabbitMqMessage> |
| .apply(RabbitMqIO.write().withUri("amqp://user:password@localhost:5672").withQueue("QUEUE")); |
| </code></pre></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> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/rabbitmq/RabbitMqIO.Read.html" title="class in org.apache.beam.sdk.io.rabbitmq">RabbitMqIO.Read</a></span></code> |
| <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 consume messages from RabbitMQ server.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/rabbitmq/RabbitMqIO.Write.html" title="class in org.apache.beam.sdk.io.rabbitmq">RabbitMqIO.Write</a></span></code> |
| <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 publish messages to a RabbitMQ server.</div> |
| </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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>static <a href="../../../../../../org/apache/beam/sdk/io/rabbitmq/RabbitMqIO.Read.html" title="class in org.apache.beam.sdk.io.rabbitmq">RabbitMqIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/rabbitmq/RabbitMqIO.html#read--">read</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/io/rabbitmq/RabbitMqIO.Write.html" title="class in org.apache.beam.sdk.io.rabbitmq">RabbitMqIO.Write</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/rabbitmq/RabbitMqIO.html#write--">write</a></span>()</code> </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="read--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>read</h4> |
| <pre>public static <a href="../../../../../../org/apache/beam/sdk/io/rabbitmq/RabbitMqIO.Read.html" title="class in org.apache.beam.sdk.io.rabbitmq">RabbitMqIO.Read</a> read()</pre> |
| </li> |
| </ul> |
| <a name="write--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>write</h4> |
| <pre>public static <a href="../../../../../../org/apache/beam/sdk/io/rabbitmq/RabbitMqIO.Write.html" title="class in org.apache.beam.sdk.io.rabbitmq">RabbitMqIO.Write</a> write()</pre> |
| </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>Prev Class</li> |
| <li><a href="../../../../../../org/apache/beam/sdk/io/rabbitmq/RabbitMqIO.Read.html" title="class in org.apache.beam.sdk.io.rabbitmq"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/io/rabbitmq/RabbitMqIO.html" target="_top">Frames</a></li> |
| <li><a href="RabbitMqIO.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.class.summary">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> |
