| <!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 (1.8.0_181-google-v7) on Mon Jan 27 16:42:28 PST 2020 --> |
| <title>Mapper (Apache Beam 2.20.0-SNAPSHOT)</title> |
| <meta name="date" content="2020-01-27"> |
| <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="Mapper (Apache Beam 2.20.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/cassandra/CassandraIO.Write.html" title="class in org.apache.beam.sdk.io.cassandra"><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/cassandra/Mapper.html" target="_top">Frames</a></li> |
| <li><a href="Mapper.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.cassandra</div> |
| <h2 title="Interface Mapper" class="title">Interface Mapper<T></h2> |
| </div> |
| <div class="contentContainer"> |
| <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 interface <span class="typeNameLabel">Mapper<T></span></pre> |
| <div class="block">This interface allows you to implement a custom mapper to read and persist elements from/to |
| Cassandra. |
| |
| <p>To Implement a custom mapper you need to: 1) Create an implementation of <a href="../../../../../../org/apache/beam/sdk/io/cassandra/Mapper.html" title="interface in org.apache.beam.sdk.io.cassandra"><code>Mapper</code></a>. 2) |
| Create a <a href="../../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms"><code>SerializableFunction</code></a> that instantiates the <a href="../../../../../../org/apache/beam/sdk/io/cassandra/Mapper.html" title="interface in org.apache.beam.sdk.io.cassandra"><code>Mapper</code></a> for a given Session, |
| for an example see <code>DefaultObjectMapperFactory</code>). 3) Pass this function to <a href="../../../../../../org/apache/beam/sdk/io/cassandra/CassandraIO.Read.html#withMapperFactoryFn-org.apache.beam.sdk.transforms.SerializableFunction-"><code>CassandraIO.Read.withMapperFactoryFn(SerializableFunction)</code></a> in the CassandraIO builder. <br> |
| Example: |
| |
| <pre><code> |
| SerializableFunction<Session, Mapper> factory = new MyCustomFactory(); |
| pipeline |
| .apply(...) |
| .apply(CassandraIO.<>read() |
| .withMapperFactoryFn(factory)); |
| </code></pre></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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>java.util.concurrent.Future<java.lang.Void></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cassandra/Mapper.html#deleteAsync-T-">deleteAsync</a></span>(<a href="../../../../../../org/apache/beam/sdk/io/cassandra/Mapper.html" title="type parameter in Mapper">T</a> entity)</code> |
| <div class="block">This method is called for each delete event.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.util.Iterator<<a href="../../../../../../org/apache/beam/sdk/io/cassandra/Mapper.html" title="type parameter in Mapper">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cassandra/Mapper.html#map-com.datastax.driver.core.ResultSet-">map</a></span>(<a href="https://static.javadoc.io/com.datastax.cassandra/cassandra-driver-core/3.8.0/com/datastax/driver/core/ResultSet.html?is-external=true" title="class or interface in com.datastax.driver.core">ResultSet</a> resultSet)</code> |
| <div class="block">This method is called when reading data from Cassandra.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.util.concurrent.Future<java.lang.Void></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cassandra/Mapper.html#saveAsync-T-">saveAsync</a></span>(<a href="../../../../../../org/apache/beam/sdk/io/cassandra/Mapper.html" title="type parameter in Mapper">T</a> entity)</code> |
| <div class="block">This method is called for each save event.</div> |
| </td> |
| </tr> |
| </table> |
| </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="map-com.datastax.driver.core.ResultSet-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>map</h4> |
| <pre>java.util.Iterator<<a href="../../../../../../org/apache/beam/sdk/io/cassandra/Mapper.html" title="type parameter in Mapper">T</a>> map(<a href="https://static.javadoc.io/com.datastax.cassandra/cassandra-driver-core/3.8.0/com/datastax/driver/core/ResultSet.html?is-external=true" title="class or interface in com.datastax.driver.core">ResultSet</a> resultSet)</pre> |
| <div class="block">This method is called when reading data from Cassandra. It should map a ResultSet into the |
| corresponding Java objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resultSet</code> - A resultset containing rows.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>An iterator containing the objects that you want to provide to your downstream |
| pipeline.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="deleteAsync-java.lang.Object-"> |
| <!-- --> |
| </a><a name="deleteAsync-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteAsync</h4> |
| <pre>java.util.concurrent.Future<java.lang.Void> deleteAsync(<a href="../../../../../../org/apache/beam/sdk/io/cassandra/Mapper.html" title="type parameter in Mapper">T</a> entity)</pre> |
| <div class="block">This method is called for each delete event. The input argument is the Object that should be |
| deleted in Cassandra. The return value should be a Future that completes when the delete action |
| is completed.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>entity</code> - Entity to be deleted.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="saveAsync-java.lang.Object-"> |
| <!-- --> |
| </a><a name="saveAsync-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>saveAsync</h4> |
| <pre>java.util.concurrent.Future<java.lang.Void> saveAsync(<a href="../../../../../../org/apache/beam/sdk/io/cassandra/Mapper.html" title="type parameter in Mapper">T</a> entity)</pre> |
| <div class="block">This method is called for each save event. The input argument is the Object that should be |
| saved or updated in Cassandra. The return value should be a future that completes when the save |
| action is completed.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>entity</code> - Entity to be saved.</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/cassandra/CassandraIO.Write.html" title="class in org.apache.beam.sdk.io.cassandra"><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/cassandra/Mapper.html" target="_top">Frames</a></li> |
| <li><a href="Mapper.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> |
