blob: 1829de5d1ebfb175b4483fdf29efc4af15e7ce72 [file] [log] [blame]
<!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>SimpleFunction (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="SimpleFunction (Apache Beam 2.47.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/transforms/Sets.html" title="class in org.apache.beam.sdk.transforms"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/beam/sdk/transforms/Sum.html" title="class in org.apache.beam.sdk.transforms"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/sdk/transforms/SimpleFunction.html" target="_top">Frames</a></li>
<li><a href="SimpleFunction.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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="Class SimpleFunction" class="title">Class SimpleFunction&lt;InputT,OutputT&gt;</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/InferableFunction.html" title="class in org.apache.beam.sdk.transforms">org.apache.beam.sdk.transforms.InferableFunction</a>&lt;InputT,OutputT&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.transforms.SimpleFunction&lt;InputT,OutputT&gt;</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>, <a href="../../../../../org/apache/beam/sdk/transforms/ProcessFunction.html" title="interface in org.apache.beam.sdk.transforms">ProcessFunction</a>&lt;InputT,OutputT&gt;, <a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a>&lt;InputT,OutputT&gt;</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/apache/beam/sdk/io/gcp/bigtable/BeamRowToBigtableMutation.ToBigtableRowFn.html" title="class in org.apache.beam.sdk.io.gcp.bigtable">BeamRowToBigtableMutation.ToBigtableRowFn</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/transforms/WithFailures.ExceptionAsMapHandler.html" title="class in org.apache.beam.sdk.transforms">WithFailures.ExceptionAsMapHandler</a>, <a href="../../../../../org/apache/beam/sdk/transforms/WithFailures.ThrowableHandler.html" title="class in org.apache.beam.sdk.transforms">WithFailures.ThrowableHandler</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>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">SimpleFunction&lt;InputT,OutputT&gt;</span>
extends <a href="../../../../../org/apache/beam/sdk/transforms/InferableFunction.html" title="class in org.apache.beam.sdk.transforms">InferableFunction</a>&lt;InputT,OutputT&gt;
implements <a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a>&lt;InputT,OutputT&gt;</pre>
<div class="block">A <a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms"><code>SerializableFunction</code></a> which is not a <i>functional interface</i>. Concrete subclasses
allow us to infer type information, which in turn aids <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> inference.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.apache.beam.sdk.transforms.SimpleFunction">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/SimpleFunction.html#SimpleFunction--">SimpleFunction</a></span>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/SimpleFunction.html#SimpleFunction-org.apache.beam.sdk.transforms.SerializableFunction-">SimpleFunction</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a>&lt;<a href="../../../../../org/apache/beam/sdk/transforms/SimpleFunction.html" title="type parameter in SimpleFunction">InputT</a>,<a href="../../../../../org/apache/beam/sdk/transforms/SimpleFunction.html" title="type parameter in SimpleFunction">OutputT</a>&gt;&nbsp;fn)</code>&nbsp;</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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/SimpleFunction.html" title="type parameter in SimpleFunction">OutputT</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/SimpleFunction.html#apply-InputT-">apply</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/SimpleFunction.html" title="type parameter in SimpleFunction">InputT</a>&nbsp;input)</code>
<div class="block">Returns the result of invoking this function on the given input.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static &lt;InputT,OutputT&gt;<br><a href="../../../../../org/apache/beam/sdk/transforms/SimpleFunction.html" title="class in org.apache.beam.sdk.transforms">SimpleFunction</a>&lt;InputT,OutputT&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/SimpleFunction.html#fromSerializableFunctionWithOutputType-org.apache.beam.sdk.transforms.SerializableFunction-org.apache.beam.sdk.values.TypeDescriptor-">fromSerializableFunctionWithOutputType</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a>&lt;InputT,OutputT&gt;&nbsp;fn,
<a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a>&lt;OutputT&gt;&nbsp;outputType)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.transforms.InferableFunction">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.beam.sdk.transforms.<a href="../../../../../org/apache/beam/sdk/transforms/InferableFunction.html" title="class in org.apache.beam.sdk.transforms">InferableFunction</a></h3>
<code><a href="../../../../../org/apache/beam/sdk/transforms/InferableFunction.html#fromProcessFunctionWithOutputType-org.apache.beam.sdk.transforms.ProcessFunction-org.apache.beam.sdk.values.TypeDescriptor-">fromProcessFunctionWithOutputType</a>, <a href="../../../../../org/apache/beam/sdk/transforms/InferableFunction.html#getInputTypeDescriptor--">getInputTypeDescriptor</a>, <a href="../../../../../org/apache/beam/sdk/transforms/InferableFunction.html#getOutputTypeDescriptor--">getOutputTypeDescriptor</a>, <a href="../../../../../org/apache/beam/sdk/transforms/InferableFunction.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</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&nbsp;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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SimpleFunction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SimpleFunction</h4>
<pre>protected&nbsp;SimpleFunction()</pre>
</li>
</ul>
<a name="SimpleFunction-org.apache.beam.sdk.transforms.SerializableFunction-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SimpleFunction</h4>
<pre>protected&nbsp;SimpleFunction(<a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a>&lt;<a href="../../../../../org/apache/beam/sdk/transforms/SimpleFunction.html" title="type parameter in SimpleFunction">InputT</a>,<a href="../../../../../org/apache/beam/sdk/transforms/SimpleFunction.html" title="type parameter in SimpleFunction">OutputT</a>&gt;&nbsp;fn)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ 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="blockList">
<li class="blockList">
<h4>apply</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/beam/sdk/transforms/SimpleFunction.html" title="type parameter in SimpleFunction">OutputT</a>&nbsp;apply(<a href="../../../../../org/apache/beam/sdk/transforms/SimpleFunction.html" title="type parameter in SimpleFunction">InputT</a>&nbsp;input)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/beam/sdk/transforms/ProcessFunction.html#apply-InputT-">ProcessFunction</a></code></span></div>
<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>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/beam/sdk/transforms/ProcessFunction.html" title="interface in org.apache.beam.sdk.transforms">ProcessFunction</a>&lt;<a href="../../../../../org/apache/beam/sdk/transforms/SimpleFunction.html" title="type parameter in SimpleFunction">InputT</a>,<a href="../../../../../org/apache/beam/sdk/transforms/SimpleFunction.html" title="type parameter in SimpleFunction">OutputT</a>&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html#apply-InputT-">apply</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a>&lt;<a href="../../../../../org/apache/beam/sdk/transforms/SimpleFunction.html" title="type parameter in SimpleFunction">InputT</a>,<a href="../../../../../org/apache/beam/sdk/transforms/SimpleFunction.html" title="type parameter in SimpleFunction">OutputT</a>&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/beam/sdk/transforms/InferableFunction.html#apply-InputT-">apply</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/beam/sdk/transforms/InferableFunction.html" title="class in org.apache.beam.sdk.transforms">InferableFunction</a>&lt;<a href="../../../../../org/apache/beam/sdk/transforms/SimpleFunction.html" title="type parameter in SimpleFunction">InputT</a>,<a href="../../../../../org/apache/beam/sdk/transforms/SimpleFunction.html" title="type parameter in SimpleFunction">OutputT</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="fromSerializableFunctionWithOutputType-org.apache.beam.sdk.transforms.SerializableFunction-org.apache.beam.sdk.values.TypeDescriptor-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>fromSerializableFunctionWithOutputType</h4>
<pre>public static&nbsp;&lt;InputT,OutputT&gt;&nbsp;<a href="../../../../../org/apache/beam/sdk/transforms/SimpleFunction.html" title="class in org.apache.beam.sdk.transforms">SimpleFunction</a>&lt;InputT,OutputT&gt;&nbsp;fromSerializableFunctionWithOutputType(<a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a>&lt;InputT,OutputT&gt;&nbsp;fn,
<a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a>&lt;OutputT&gt;&nbsp;outputType)</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><a href="../../../../../org/apache/beam/sdk/transforms/Sets.html" title="class in org.apache.beam.sdk.transforms"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/beam/sdk/transforms/Sum.html" title="class in org.apache.beam.sdk.transforms"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/sdk/transforms/SimpleFunction.html" target="_top">Frames</a></li>
<li><a href="SimpleFunction.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>