| <!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:30 PST 2020 --> |
| <title>SerializableFunction (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="SerializableFunction (Apache Beam 2.20.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":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/transforms/SerializableComparator.html" title="interface in org.apache.beam.sdk.transforms"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunctions.html" title="class in org.apache.beam.sdk.transforms"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/sdk/transforms/SerializableFunction.html" target="_top">Frames</a></li> |
| <li><a href="SerializableFunction.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.transforms</div> |
| <h2 title="Interface SerializableFunction" class="title">Interface SerializableFunction<InputT,OutputT></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>InputT</code> - input value type</dd> |
| <dd><code>OutputT</code> - output value type</dd> |
| </dl> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../../org/apache/beam/sdk/transforms/ProcessFunction.html" title="interface in org.apache.beam.sdk.transforms">ProcessFunction</a><InputT,OutputT>, java.io.Serializable</dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Write.FieldValueExtractFn.html" title="interface in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO.Write.FieldValueExtractFn</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/beam/sdk/io/mongodb/AggregationQuery.html" title="class in org.apache.beam.sdk.io.mongodb">AggregationQuery</a>, <a href="../../../../../org/apache/beam/sdk/extensions/sql/impl/transform/BeamJoinTransforms.ExtractJoinFields.html" title="class in org.apache.beam.sdk.extensions.sql.impl.transform">BeamJoinTransforms.ExtractJoinFields</a>, <a href="../../../../../org/apache/beam/sdk/extensions/sql/impl/transform/BeamJoinTransforms.JoinParts2WholeRow.html" title="class in org.apache.beam.sdk.extensions.sql.impl.transform">BeamJoinTransforms.JoinParts2WholeRow</a>, <a href="../../../../../org/apache/beam/sdk/extensions/sql/impl/transform/BeamSetOperatorsTransforms.BeamSqlRow2KvFn.html" title="class in org.apache.beam.sdk.extensions.sql.impl.transform">BeamSetOperatorsTransforms.BeamSqlRow2KvFn</a>, <a href="../../../../../org/apache/beam/sdk/io/mongodb/FindQuery.html" title="class in org.apache.beam.sdk.io.mongodb">FindQuery</a>, <a href="../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.DataSourceProviderFromDataSourceConfiguration.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.DataSourceProviderFromDataSourceConfiguration</a>, <a href="../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.PoolableDataSourceProvider.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.PoolableDataSourceProvider</a>, <a href="../../../../../org/apache/beam/sdk/testing/PAssert.PCollectionContentsAssert.MatcherCheckerFn.html" title="class in org.apache.beam.sdk.testing">PAssert.PCollectionContentsAssert.MatcherCheckerFn</a>, <a href="../../../../../org/apache/beam/sdk/transforms/SimpleFunction.html" title="class in org.apache.beam.sdk.transforms">SimpleFunction</a>, <a href="../../../../../org/apache/beam/sdk/transforms/WithFailures.ExceptionAsMapHandler.html" title="class in org.apache.beam.sdk.transforms">WithFailures.ExceptionAsMapHandler</a>, <a href="../../../../../org/apache/beam/runners/spark/structuredstreaming/examples/WordCount.FormatAsTextFn.html" title="class in org.apache.beam.runners.spark.structuredstreaming.examples">WordCount.FormatAsTextFn</a></dd> |
| </dl> |
| <dl> |
| <dt>Functional Interface:</dt> |
| <dd>This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@FunctionalInterface |
| public interface <span class="typeNameLabel">SerializableFunction<InputT,OutputT></span> |
| extends <a href="../../../../../org/apache/beam/sdk/transforms/ProcessFunction.html" title="interface in org.apache.beam.sdk.transforms">ProcessFunction</a><InputT,OutputT>, java.io.Serializable</pre> |
| <div class="block">A function that computes an output value of type <code>OutputT</code> from an input value of type |
| <code>InputT</code>, is <code>Serializable</code>, and does not allow checked exceptions to be declared. |
| |
| <p>To allow checked exceptions, implement the superinterface <a href="../../../../../org/apache/beam/sdk/transforms/ProcessFunction.html" title="interface in org.apache.beam.sdk.transforms"><code>ProcessFunction</code></a> instead. To |
| allow more robust <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> inference, see <a href="../../../../../org/apache/beam/sdk/transforms/InferableFunction.html" title="class in org.apache.beam.sdk.transforms"><code>InferableFunction</code></a>.</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><a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="type parameter in SerializableFunction">OutputT</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html#apply-InputT-">apply</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="type parameter in SerializableFunction">InputT</a> input)</code> |
| <div class="block">Returns the result of invoking this function on the given input.</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="apply-java.lang.Object-"> |
| <!-- --> |
| </a><a name="apply-InputT-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>apply</h4> |
| <pre><a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="type parameter in SerializableFunction">OutputT</a> apply(<a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="type parameter in SerializableFunction">InputT</a> input)</pre> |
| <div class="block">Returns the result of invoking this function on the given input.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/beam/sdk/transforms/ProcessFunction.html#apply-InputT-">apply</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/transforms/ProcessFunction.html" title="interface in org.apache.beam.sdk.transforms">ProcessFunction</a><<a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="type parameter in SerializableFunction">InputT</a>,<a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="type parameter in SerializableFunction">OutputT</a>></code></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/transforms/SerializableComparator.html" title="interface in org.apache.beam.sdk.transforms"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunctions.html" title="class in org.apache.beam.sdk.transforms"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/sdk/transforms/SerializableFunction.html" target="_top">Frames</a></li> |
| <li><a href="SerializableFunction.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> |