Google Git
Sign in
apache / beam-site / refs/heads/revert-643-revert-642-updates_release_2.47.0 / . / javadoc / 2.47.0 / org / apache / beam / sdk / transforms / DoFn.html
blob: 5218aae091b7980c56a03f67144f50c018117c00 [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>DoFn (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="DoFn (Apache Beam 2.47.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":42,"i1":10,"i2":10,"i3":10,"i4":42};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/Distinct.WithRepresentativeValues.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/DoFn.AlwaysFetched.html" title="annotation 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/DoFn.html" target="_top">Frames</a></li>
<li><a href="DoFn.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><a href="#nested.class.summary">Nested</a>&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 DoFn" class="title">Class DoFn&lt;InputT,OutputT&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.transforms.DoFn&lt;InputT,OutputT&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>InputT</code> - the type of the (main) input elements</dd>
<dd><code>OutputT</code> - the type of the (main) output elements</dd>
</dl>
<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>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.BatchStatefulDoFn.html" title="class in org.apache.beam.runners.dataflow">BatchStatefulParDoOverrides.BatchStatefulDoFn</a>, <a href="../../../../../org/apache/beam/sdk/extensions/sql/impl/transform/BeamSetOperatorsTransforms.SetOperatorFilteringDoFn.html" title="class in org.apache.beam.sdk.extensions.sql.impl.transform">BeamSetOperatorsTransforms.SetOperatorFilteringDoFn</a>, <a href="../../../../../org/apache/beam/sdk/extensions/sql/impl/transform/BeamSqlOutputToConsoleFn.html" title="class in org.apache.beam.sdk.extensions.sql.impl.transform">BeamSqlOutputToConsoleFn</a>, <a href="../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/dofn/CleanUpReadChangeStreamDoFn.html" title="class in org.apache.beam.sdk.io.gcp.spanner.changestreams.dofn">CleanUpReadChangeStreamDoFn</a>, <a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunner.StreamingPCollectionViewWriterFn.html" title="class in org.apache.beam.runners.dataflow">DataflowRunner.StreamingPCollectionViewWriterFn</a>, <a href="../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/dofn/DetectNewPartitionsDoFn.html" title="class in org.apache.beam.sdk.io.gcp.spanner.changestreams.dofn">DetectNewPartitionsDoFn</a>, <a href="../../../../../org/apache/beam/sdk/io/gcp/bigtable/changestreams/dofn/DetectNewPartitionsDoFn.html" title="class in org.apache.beam.sdk.io.gcp.bigtable.changestreams.dofn">DetectNewPartitionsDoFn</a>, <a href="../../../../../org/apache/beam/sdk/io/gcp/healthcare/FhirIO.Deidentify.DeidentifyFn.html" title="class in org.apache.beam.sdk.io.gcp.healthcare">FhirIO.Deidentify.DeidentifyFn</a>, <a href="../../../../../org/apache/beam/sdk/io/gcp/healthcare/FhirIO.Export.ExportResourcesFn.html" title="class in org.apache.beam.sdk.io.gcp.healthcare">FhirIO.Export.ExportResourcesFn</a>, <a href="../../../../../org/apache/beam/sdk/extensions/timeseries/FillGaps.FillGapsDoFn.html" title="class in org.apache.beam.sdk.extensions.timeseries">FillGaps.FillGapsDoFn</a>, <a href="../../../../../org/apache/beam/sdk/io/gcp/healthcare/HL7v2IO.HL7v2Read.FetchHL7v2Message.HL7v2MessageGetFn.html" title="class in org.apache.beam.sdk.io.gcp.healthcare">HL7v2IO.HL7v2Read.FetchHL7v2Message.HL7v2MessageGetFn</a>, <a href="../../../../../org/apache/beam/sdk/io/gcp/healthcare/HL7v2IO.Read.FetchHL7v2Message.HL7v2MessageGetFn.html" title="class in org.apache.beam.sdk.io.gcp.healthcare">HL7v2IO.Read.FetchHL7v2Message.HL7v2MessageGetFn</a>, <a href="../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/dofn/InitializeDoFn.html" title="class in org.apache.beam.sdk.io.gcp.spanner.changestreams.dofn">InitializeDoFn</a>, <a href="../../../../../org/apache/beam/sdk/io/gcp/bigtable/changestreams/dofn/InitializeDoFn.html" title="class in org.apache.beam.sdk.io.gcp.bigtable.changestreams.dofn">InitializeDoFn</a>, <a href="../../../../../org/apache/beam/sdk/transforms/JsonToRow.JsonToRowWithErrFn.ParseWithError.html" title="class in org.apache.beam.sdk.transforms">JsonToRow.JsonToRowWithErrFn.ParseWithError</a>, <a href="../../../../../org/apache/beam/io/debezium/KafkaSourceConsumerFn.html" title="class in org.apache.beam.io.debezium">KafkaSourceConsumerFn</a>, <a href="../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/dofn/PostProcessingMetricsDoFn.html" title="class in org.apache.beam.sdk.io.gcp.spanner.changestreams.dofn">PostProcessingMetricsDoFn</a>, <a href="../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubIO.Write.PubsubBoundedWriter.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubIO.Write.PubsubBoundedWriter</a>, <a href="../../../../../org/apache/beam/sdk/io/gcp/pubsublite/internal/PubsubLiteSink.html" title="class in org.apache.beam.sdk.io.gcp.pubsublite.internal">PubsubLiteSink</a>, <a href="../../../../../org/apache/beam/sdk/io/gcp/datastore/RampupThrottlingFn.html" title="class in org.apache.beam.sdk.io.gcp.datastore">RampupThrottlingFn</a>, <a href="../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/dofn/ReadChangeStreamPartitionDoFn.html" title="class in org.apache.beam.sdk.io.gcp.spanner.changestreams.dofn">ReadChangeStreamPartitionDoFn</a>, <a href="../../../../../org/apache/beam/sdk/io/gcp/bigtable/changestreams/dofn/ReadChangeStreamPartitionDoFn.html" title="class in org.apache.beam.sdk.io.gcp.bigtable.changestreams.dofn">ReadChangeStreamPartitionDoFn</a>, <a href="../../../../../org/apache/beam/sdk/io/pulsar/ReadFromPulsarDoFn.html" title="class in org.apache.beam.sdk.io.pulsar">ReadFromPulsarDoFn</a>, <a href="../../../../../org/apache/beam/sdk/io/gcp/spanner/ReadSpannerSchema.html" title="class in org.apache.beam.sdk.io.gcp.spanner">ReadSpannerSchema</a>, <a href="../../../../../org/apache/beam/sdk/transforms/Reshuffle.AssignShardFn.html" title="class in org.apache.beam.sdk.transforms">Reshuffle.AssignShardFn</a>, <a href="../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Read.CleanTmpFilesFromGcsFn.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Read.CleanTmpFilesFromGcsFn</a>, <a href="../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Read.MapCsvToStringArrayFn.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Read.MapCsvToStringArrayFn</a>, <a href="../../../../../org/apache/beam/sdk/io/gcp/bigquery/StorageApiConvertMessages.ConvertMessagesDoFn.html" title="class in org.apache.beam.sdk.io.gcp.bigquery">StorageApiConvertMessages.ConvertMessagesDoFn</a>, <a href="../../../../../org/apache/beam/sdk/io/gcp/bigquery/StorageApiFlushAndFinalizeDoFn.html" title="class in org.apache.beam.sdk.io.gcp.bigquery">StorageApiFlushAndFinalizeDoFn</a>, <a href="../../../../../org/apache/beam/sdk/io/gcp/bigquery/UpdateSchemaDestination.html" title="class in org.apache.beam.sdk.io.gcp.bigquery">UpdateSchemaDestination</a>, <a href="../../../../../org/apache/beam/sdk/values/ValueWithRecordId.StripIdsDoFn.html" title="class in org.apache.beam.sdk.values">ValueWithRecordId.StripIdsDoFn</a>, <a href="../../../../../org/apache/beam/sdk/transforms/View.ToListViewDoFn.html" title="class in org.apache.beam.sdk.transforms">View.ToListViewDoFn</a>, <a href="../../../../../org/apache/beam/sdk/transforms/Watch.WatchGrowthFn.html" title="class in org.apache.beam.sdk.transforms">Watch.WatchGrowthFn</a>, <a href="../../../../../org/apache/beam/sdk/io/pulsar/WriteToPulsarDoFn.html" title="class in org.apache.beam.sdk.io.pulsar">WriteToPulsarDoFn</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">DoFn&lt;InputT,OutputT&gt;</span>
extends java.lang.Object
implements java.io.Serializable, <a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></pre>
<div class="block">The argument to <a href="../../../../../org/apache/beam/sdk/transforms/ParDo.html" title="class in org.apache.beam.sdk.transforms"><code>ParDo</code></a> providing the code to use to process elements of the input <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a>.
<p>See <a href="../../../../../org/apache/beam/sdk/transforms/ParDo.html" title="class in org.apache.beam.sdk.transforms"><code>ParDo</code></a> for more explanation, examples of use, and discussion of constraints on
<code>DoFn</code>s, including their serializability, lack of access to global shared mutable state,
requirements for failure tolerance, and benefits of optimization.
<p><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFns</code></a> can be tested by using <a href="../../../../../org/apache/beam/sdk/testing/TestPipeline.html" title="class in org.apache.beam.sdk.testing"><code>TestPipeline</code></a>. You can verify their
functional correctness in a local test using the <code>DirectRunner</code> as well as running
integration tests with your production runner of choice. Typically, you can generate the input
data using <a href="../../../../../org/apache/beam/sdk/transforms/Create.html#of-java.lang.Iterable-"><code>Create.of(java.lang.Iterable&lt;T&gt;)</code></a> or other transforms. However, if you need to test the behavior of
<a href="../../../../../org/apache/beam/sdk/transforms/DoFn.StartBundle.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.StartBundle</code></a> and <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.FinishBundle.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.FinishBundle</code></a> with particular bundle boundaries, you can use
<a href="../../../../../org/apache/beam/sdk/testing/TestStream.html" title="class in org.apache.beam.sdk.testing"><code>TestStream</code></a>.
<p>Implementations must define a method annotated with <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.ProcessElement.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.ProcessElement</code></a> that satisfies the
requirements described there. See the <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.ProcessElement.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.ProcessElement</code></a> for details.
<p>Example usage:
<pre><code>
PCollection&lt;String&gt; lines = ... ;
PCollection&lt;String&gt; words =
lines.apply(ParDo.of(new DoFn&lt;String, String&gt;()) {
@ProcessElement
public void processElement( @Element String element, BoundedWindow window) {
...
}}));
</code></pre></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.apache.beam.sdk.transforms.DoFn">Serialized Form</a></dd>
</dl>
</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">&nbsp;</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 interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.AlwaysFetched.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.AlwaysFetched</a></span></code>
<div class="block">Annotation for declaring that a state parameter is always fetched.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.BoundedPerElement.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.BoundedPerElement</a></span></code>
<div class="block">Annotation on a <a href="https://s.apache.org/splittable-do-fn">splittable</a> <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a>
specifying that the <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a> performs a bounded amount of work per input element, so
applying it to a bounded <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> will produce also a bounded <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.BundleFinalizer.html" title="interface in org.apache.beam.sdk.transforms">DoFn.BundleFinalizer</a></span></code>
<div class="block">A parameter that is accessible during <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.StartBundle.html" title="annotation in org.apache.beam.sdk.transforms"><code>@StartBundle</code></a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.ProcessElement.html" title="annotation in org.apache.beam.sdk.transforms"><code>@ProcessElement</code></a> and <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.FinishBundle.html" title="annotation in org.apache.beam.sdk.transforms"><code>@FinishBundle</code></a> that allows the caller
to register a callback that will be invoked after the bundle has been successfully completed
and the runner has commit the output.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.Element.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.Element</a></span></code>
<div class="block">Parameter annotation for the input element for <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.ProcessElement.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.ProcessElement</code></a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.GetInitialRestriction.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.GetInitialRestriction</code></a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.GetSize.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.GetSize</code></a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.SplitRestriction.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.SplitRestriction</code></a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.GetInitialWatermarkEstimatorState.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.GetInitialWatermarkEstimatorState</code></a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.NewWatermarkEstimator.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.NewWatermarkEstimator</code></a>, and <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.NewTracker.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.NewTracker</code></a>
methods.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.FieldAccess.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.FieldAccess</a></span></code>
<div class="block">Annotation for specifying specific fields that are accessed in a Schema PCollection.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.FinishBundle.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.FinishBundle</a></span></code>
<div class="block">Annotation for the method to use to finish processing a batch of elements.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.FinishBundleContext.html" title="class in org.apache.beam.sdk.transforms">DoFn.FinishBundleContext</a></span></code>
<div class="block">Information accessible while within the <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.FinishBundle.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.FinishBundle</code></a> method.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.GetInitialRestriction.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.GetInitialRestriction</a></span></code>
<div class="block">Annotation for the method that maps an element to an initial restriction for a <a
href="https://s.apache.org/splittable-do-fn">splittable</a> <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.GetInitialWatermarkEstimatorState.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.GetInitialWatermarkEstimatorState</a></span></code>
<div class="block">Annotation for the method that maps an element and restriction to initial watermark estimator
state for a <a href="https://s.apache.org/splittable-do-fn">splittable</a> <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.GetRestrictionCoder.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.GetRestrictionCoder</a></span></code>
<div class="block">Annotation for the method that returns the coder to use for the restriction of a <a
href="https://s.apache.org/splittable-do-fn">splittable</a> <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.GetSize.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.GetSize</a></span></code>
<div class="block">Annotation for the method that returns the corresponding size for an element and restriction
pair.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.GetWatermarkEstimatorStateCoder.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.GetWatermarkEstimatorStateCoder</a></span></code>
<div class="block">Annotation for the method that returns the coder to use for the watermark estimator state of a
<a href="https://s.apache.org/splittable-do-fn">splittable</a> <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.Key.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.Key</a></span></code>
<div class="block">Parameter annotation for dereferencing input element key in <a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values"><code>KV</code></a> pair.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.MultiOutputReceiver.html" title="interface in org.apache.beam.sdk.transforms">DoFn.MultiOutputReceiver</a></span></code>
<div class="block">Receives tagged output for a multi-output function.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.NewTracker.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.NewTracker</a></span></code>
<div class="block">Annotation for the method that creates a new <a href="../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn"><code>RestrictionTracker</code></a> for the restriction of
a <a href="https://s.apache.org/splittable-do-fn">splittable</a> <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.NewWatermarkEstimator.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.NewWatermarkEstimator</a></span></code>
<div class="block">Annotation for the method that creates a new <a href="../../../../../org/apache/beam/sdk/transforms/splittabledofn/WatermarkEstimator.html" title="interface in org.apache.beam.sdk.transforms.splittabledofn"><code>WatermarkEstimator</code></a> for the watermark state
of a <a href="https://s.apache.org/splittable-do-fn">splittable</a> <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.OnTimer.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.OnTimer</a></span></code>
<div class="block">Annotation for registering a callback for a timer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.OnTimerContext.html" title="class in org.apache.beam.sdk.transforms">DoFn.OnTimerContext</a></span></code>
<div class="block">Information accessible when running a <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.OnTimer.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.OnTimer</code></a> method.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.OnTimerFamily.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.OnTimerFamily</a></span></code>
<div class="block">Annotation for registering a callback for a timerFamily.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.OnWindowExpiration.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.OnWindowExpiration</a></span></code>
<div class="block">Annotation for the method to use for performing actions on window expiration.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.OnWindowExpirationContext.html" title="class in org.apache.beam.sdk.transforms">DoFn.OnWindowExpirationContext</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.OutputReceiver.html" title="interface in org.apache.beam.sdk.transforms">DoFn.OutputReceiver</a>&lt;<a href="../../../../../org/apache/beam/sdk/transforms/DoFn.OutputReceiver.html" title="type parameter in DoFn.OutputReceiver">T</a>&gt;</span></code>
<div class="block">Receives values of the given type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.ProcessContext.html" title="class in org.apache.beam.sdk.transforms">DoFn.ProcessContext</a></span></code>
<div class="block">Information accessible when running a <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.ProcessElement.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.ProcessElement</code></a> method.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.ProcessContinuation.html" title="class in org.apache.beam.sdk.transforms">DoFn.ProcessContinuation</a></span></code>
<div class="block">When used as a return value of <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.ProcessElement.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.ProcessElement</code></a>, indicates whether there is more work to
be done for the current element.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.ProcessElement.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.ProcessElement</a></span></code>
<div class="block">Annotation for the method to use for processing elements.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.RequiresStableInput.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.RequiresStableInput</a></span></code>
<div class="block"><b><i>Experimental - no backwards compatibility guarantees.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.RequiresTimeSortedInput.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.RequiresTimeSortedInput</a></span></code>
<div class="block"><b><i>Experimental - no backwards compatibility guarantees.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.Restriction.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.Restriction</a></span></code>
<div class="block">Parameter annotation for the restriction for <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.GetSize.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.GetSize</code></a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.SplitRestriction.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.SplitRestriction</code></a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.GetInitialWatermarkEstimatorState.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.GetInitialWatermarkEstimatorState</code></a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.NewWatermarkEstimator.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.NewWatermarkEstimator</code></a>, and <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.NewTracker.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.NewTracker</code></a>
methods.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.Setup.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.Setup</a></span></code>
<div class="block">Annotation for the method to use to prepare an instance for processing bundles of elements.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.SideInput.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.SideInput</a></span></code>
<div class="block">Parameter annotation for the SideInput for a <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.ProcessElement.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.ProcessElement</code></a> method.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.SplitRestriction.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.SplitRestriction</a></span></code>
<div class="block">Annotation for the method that splits restriction of a <a
href="https://s.apache.org/splittable-do-fn">splittable</a> <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a> into multiple parts to
be processed in parallel.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.StartBundle.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.StartBundle</a></span></code>
<div class="block">Annotation for the method to use to prepare an instance for processing a batch of elements.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.StartBundleContext.html" title="class in org.apache.beam.sdk.transforms">DoFn.StartBundleContext</a></span></code>
<div class="block">Information accessible while within the <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.StartBundle.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.StartBundle</code></a> method.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.StateId.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.StateId</a></span></code>
<div class="block">Annotation for declaring and dereferencing state cells.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.Teardown.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.Teardown</a></span></code>
<div class="block">Annotation for the method to use to clean up this instance before it is discarded.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.TimerFamily.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.TimerFamily</a></span></code>
<div class="block">Parameter annotation for the TimerMap for a <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.ProcessElement.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.ProcessElement</code></a> method.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.TimerId.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.TimerId</a></span></code>
<div class="block">Annotation for declaring and dereferencing timers.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.Timestamp.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.Timestamp</a></span></code>
<div class="block">Parameter annotation for the input element timestamp for <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.ProcessElement.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.ProcessElement</code></a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.GetInitialRestriction.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.GetInitialRestriction</code></a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.GetSize.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.GetSize</code></a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.SplitRestriction.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.SplitRestriction</code></a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.GetInitialWatermarkEstimatorState.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.GetInitialWatermarkEstimatorState</code></a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.NewWatermarkEstimator.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.NewWatermarkEstimator</code></a>, and <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.NewTracker.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.NewTracker</code></a>
methods.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.TruncateRestriction.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.TruncateRestriction</a></span></code>
<div class="block">Annotation for the method that truncates the restriction of a <a
href="https://s.apache.org/splittable-do-fn">splittable</a> <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a> into a bounded one.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.UnboundedPerElement.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.UnboundedPerElement</a></span></code>
<div class="block">Annotation on a <a href="https://s.apache.org/splittable-do-fn">splittable</a> <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a>
specifying that the <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a> performs an unbounded amount of work per input element, so
applying it to a bounded <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> will produce an unbounded <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.WatermarkEstimatorState.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.WatermarkEstimatorState</a></span></code>
<div class="block">Parameter annotation for the watermark estimator state for the <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.NewWatermarkEstimator.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.NewWatermarkEstimator</code></a>
method.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.WindowedContext.html" title="class in org.apache.beam.sdk.transforms">DoFn.WindowedContext</a></span></code>
<div class="block">Information accessible to all methods in this <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a> where the context is in some window.</div>
</td>
</tr>
</table>
</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">&nbsp;</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/transforms/DoFn.html#DoFn--">DoFn</a></span>()</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="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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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="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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html#getAllowedTimestampSkew--">getAllowedTimestampSkew</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">This method permits a <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a> to emit elements behind the watermark. These
elements are considered late, and if behind the <a href="../../../../../org/apache/beam/sdk/transforms/windowing/Window.html#withAllowedLateness-org.joda.time.Duration-"><code>allowed lateness</code></a> of a downstream <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> may be silently dropped. See
https://github.com/apache/beam/issues/18065 for details on a replacement.</span></div>
</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a>&lt;<a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="type parameter in DoFn">InputT</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html#getInputTypeDescriptor--">getInputTypeDescriptor</a></span>()</code>
<div class="block">Returns a <a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values"><code>TypeDescriptor</code></a> capturing what is known statically about the input type of
this <code>DoFn</code> instance's most-derived class.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a>&lt;<a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="type parameter in DoFn">OutputT</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html#getOutputTypeDescriptor--">getOutputTypeDescriptor</a></span>()</code>
<div class="block">Returns a <a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values"><code>TypeDescriptor</code></a> capturing what is known statically about the output type of
this <code>DoFn</code> instance's most-derived class.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.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>&nbsp;builder)</code>
<div class="block">Register display data for the given transform or component.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html#prepareForProcessing--">prepareForProcessing</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.Setup.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.Setup</code></a> or <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.StartBundle.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.StartBundle</code></a> instead. This method will be removed in a
future release.</span></div>
</div>
</td>
</tr>
</table>
<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="DoFn--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DoFn</h4>
<pre>public&nbsp;DoFn()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getAllowedTimestampSkew--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllowedTimestampSkew</h4>
<pre>@Deprecated
public&nbsp;<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>&nbsp;getAllowedTimestampSkew()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">This method permits a <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a> to emit elements behind the watermark. These
elements are considered late, and if behind the <a href="../../../../../org/apache/beam/sdk/transforms/windowing/Window.html#withAllowedLateness-org.joda.time.Duration-"><code>allowed lateness</code></a> of a downstream <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> may be silently dropped. See
https://github.com/apache/beam/issues/18065 for details on a replacement.</span></div>
<div class="block">Returns the allowed timestamp skew duration, which is the maximum duration that timestamps can
be shifted backward in <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.WindowedContext.html#outputWithTimestamp-OutputT-org.joda.time.Instant-"><code>DoFn.WindowedContext.outputWithTimestamp(OutputT, org.joda.time.Instant)</code></a>.
<p>The default value is <code>Duration.ZERO</code>, in which case timestamps can only be shifted
forward to future. For infinite skew, return <code>Duration.millis(Long.MAX_VALUE)</code>.</div>
</li>
</ul>
<a name="getInputTypeDescriptor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInputTypeDescriptor</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a>&lt;<a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="type parameter in DoFn">InputT</a>&gt;&nbsp;getInputTypeDescriptor()</pre>
<div class="block">Returns a <a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values"><code>TypeDescriptor</code></a> capturing what is known statically about the input type of
this <code>DoFn</code> instance's most-derived class.
<p>See <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html#getOutputTypeDescriptor--"><code>getOutputTypeDescriptor()</code></a> for more discussion.</div>
</li>
</ul>
<a name="getOutputTypeDescriptor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutputTypeDescriptor</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a>&lt;<a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="type parameter in DoFn">OutputT</a>&gt;&nbsp;getOutputTypeDescriptor()</pre>
<div class="block">Returns a <a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values"><code>TypeDescriptor</code></a> capturing what is known statically about the output type of
this <code>DoFn</code> instance's most-derived class.
<p>In the normal case of a concrete <code>DoFn</code> subclass with no generic type parameters of
its own (including anonymous inner classes), this will be a complete non-generic type, which is
good for choosing a default output <code>Coder&lt;O&gt;</code> for the output <code>PCollection&lt;O&gt;</code>.</div>
</li>
</ul>
<a name="prepareForProcessing--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prepareForProcessing</h4>
<pre>@Deprecated
public final&nbsp;void&nbsp;prepareForProcessing()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.Setup.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.Setup</code></a> or <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.StartBundle.html" title="annotation in org.apache.beam.sdk.transforms"><code>DoFn.StartBundle</code></a> instead. This method will be removed in a
future release.</span></div>
<div class="block">Finalize the <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a> construction to prepare for processing. This method should be called
by runners before any processing methods.</div>
</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&nbsp;void&nbsp;populateDisplayData(<a href="../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a>&nbsp;builder)</pre>
<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>&nbsp;in interface&nbsp;<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="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/transforms/Distinct.WithRepresentativeValues.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/DoFn.AlwaysFetched.html" title="annotation 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/DoFn.html" target="_top">Frames</a></li>
<li><a href="DoFn.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><a href="#nested.class.summary">Nested</a>&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>