| <!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:31 PST 2020 --> |
| <title>Pipeline.PipelineVisitor (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="Pipeline.PipelineVisitor (Apache Beam 2.20.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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/Pipeline.PipelineExecutionException.html" title="class in org.apache.beam.sdk"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.CompositeBehavior.html" title="enum in org.apache.beam.sdk"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/beam/sdk/Pipeline.PipelineVisitor.html" target="_top">Frames</a></li> |
| <li><a href="Pipeline.PipelineVisitor.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.beam.sdk</div> |
| <h2 title="Interface Pipeline.PipelineVisitor" class="title">Interface Pipeline.PipelineVisitor</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/beam/runners/gearpump/translators/GearpumpPipelineTranslator.html" title="class in org.apache.beam.runners.gearpump.translators">GearpumpPipelineTranslator</a>, <a href="../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.Defaults.html" title="class in org.apache.beam.sdk">Pipeline.PipelineVisitor.Defaults</a>, <a href="../../../../org/apache/beam/runners/spark/structuredstreaming/translation/PipelineTranslator.html" title="class in org.apache.beam.runners.spark.structuredstreaming.translation">PipelineTranslator</a>, <a href="../../../../org/apache/beam/runners/spark/structuredstreaming/translation/batch/PipelineTranslatorBatch.html" title="class in org.apache.beam.runners.spark.structuredstreaming.translation.batch">PipelineTranslatorBatch</a>, <a href="../../../../org/apache/beam/runners/spark/structuredstreaming/translation/streaming/PipelineTranslatorStreaming.html" title="class in org.apache.beam.runners.spark.structuredstreaming.translation.streaming">PipelineTranslatorStreaming</a>, <a href="../../../../org/apache/beam/runners/spark/SparkNativePipelineVisitor.html" title="class in org.apache.beam.runners.spark">SparkNativePipelineVisitor</a>, <a href="../../../../org/apache/beam/runners/spark/SparkRunner.Evaluator.html" title="class in org.apache.beam.runners.spark">SparkRunner.Evaluator</a></dd> |
| </dl> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk">Pipeline</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre><a href="../../../../org/apache/beam/sdk/annotations/Internal.html" title="annotation in org.apache.beam.sdk.annotations">@Internal</a> |
| public static interface <span class="typeNameLabel">Pipeline.PipelineVisitor</span></pre> |
| <div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b> |
| |
| <p>A <a href="../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.html" title="interface in org.apache.beam.sdk"><code>Pipeline.PipelineVisitor</code></a> can be passed into <a href="../../../../org/apache/beam/sdk/Pipeline.html#traverseTopologically-org.apache.beam.sdk.Pipeline.PipelineVisitor-"><code>Pipeline.traverseTopologically(org.apache.beam.sdk.Pipeline.PipelineVisitor)</code></a> to be |
| called for each of the transforms and values in the <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a>.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.CompositeBehavior.html" title="enum in org.apache.beam.sdk">Pipeline.PipelineVisitor.CompositeBehavior</a></span></code> |
| <div class="block">Control enum for indicating whether or not a traversal should process the contents of a |
| composite transform or not.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.Defaults.html" title="class in org.apache.beam.sdk">Pipeline.PipelineVisitor.Defaults</a></span></code> |
| <div class="block">Default no-op <a href="../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.html" title="interface in org.apache.beam.sdk"><code>Pipeline.PipelineVisitor</code></a> that enters all composite transforms.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="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/Pipeline.PipelineVisitor.CompositeBehavior.html" title="enum in org.apache.beam.sdk">Pipeline.PipelineVisitor.CompositeBehavior</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.html#enterCompositeTransform-org.apache.beam.sdk.runners.TransformHierarchy.Node-">enterCompositeTransform</a></span>(org.apache.beam.sdk.runners.TransformHierarchy.Node node)</code> |
| <div class="block">Called for each composite transform after all topological predecessors have been visited but |
| before any of its component transforms.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.html#enterPipeline-org.apache.beam.sdk.Pipeline-">enterPipeline</a></span>(<a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk">Pipeline</a> p)</code> |
| <div class="block">Called before visiting anything values or transforms, as many uses of a visitor require |
| access to the <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> object itself.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.html#leaveCompositeTransform-org.apache.beam.sdk.runners.TransformHierarchy.Node-">leaveCompositeTransform</a></span>(org.apache.beam.sdk.runners.TransformHierarchy.Node node)</code> |
| <div class="block">Called for each composite transform after all of its component transforms and their outputs |
| have been visited.</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/Pipeline.PipelineVisitor.html#leavePipeline-org.apache.beam.sdk.Pipeline-">leavePipeline</a></span>(<a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk">Pipeline</a> pipeline)</code> |
| <div class="block">Called when all values and transforms in a <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> have been visited.</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/Pipeline.PipelineVisitor.html#visitPrimitiveTransform-org.apache.beam.sdk.runners.TransformHierarchy.Node-">visitPrimitiveTransform</a></span>(org.apache.beam.sdk.runners.TransformHierarchy.Node node)</code> |
| <div class="block">Called for each primitive transform after all of its topological predecessors and inputs have |
| been visited.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.html#visitValue-org.apache.beam.sdk.values.PValue-org.apache.beam.sdk.runners.TransformHierarchy.Node-">visitValue</a></span>(<a href="../../../../org/apache/beam/sdk/values/PValue.html" title="interface in org.apache.beam.sdk.values">PValue</a> value, |
| org.apache.beam.sdk.runners.TransformHierarchy.Node producer)</code> |
| <div class="block">Called for each value after the transform that produced the value has been visited.</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="enterPipeline-org.apache.beam.sdk.Pipeline-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>enterPipeline</h4> |
| <pre>void enterPipeline(<a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk">Pipeline</a> p)</pre> |
| <div class="block">Called before visiting anything values or transforms, as many uses of a visitor require |
| access to the <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> object itself.</div> |
| </li> |
| </ul> |
| <a name="enterCompositeTransform-org.apache.beam.sdk.runners.TransformHierarchy.Node-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>enterCompositeTransform</h4> |
| <pre><a href="../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.CompositeBehavior.html" title="enum in org.apache.beam.sdk">Pipeline.PipelineVisitor.CompositeBehavior</a> enterCompositeTransform(org.apache.beam.sdk.runners.TransformHierarchy.Node node)</pre> |
| <div class="block">Called for each composite transform after all topological predecessors have been visited but |
| before any of its component transforms. |
| |
| <p>The return value controls whether or not child transforms are visited.</div> |
| </li> |
| </ul> |
| <a name="leaveCompositeTransform-org.apache.beam.sdk.runners.TransformHierarchy.Node-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>leaveCompositeTransform</h4> |
| <pre>void leaveCompositeTransform(org.apache.beam.sdk.runners.TransformHierarchy.Node node)</pre> |
| <div class="block">Called for each composite transform after all of its component transforms and their outputs |
| have been visited.</div> |
| </li> |
| </ul> |
| <a name="visitPrimitiveTransform-org.apache.beam.sdk.runners.TransformHierarchy.Node-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>visitPrimitiveTransform</h4> |
| <pre>void visitPrimitiveTransform(org.apache.beam.sdk.runners.TransformHierarchy.Node node)</pre> |
| <div class="block">Called for each primitive transform after all of its topological predecessors and inputs have |
| been visited.</div> |
| </li> |
| </ul> |
| <a name="visitValue-org.apache.beam.sdk.values.PValue-org.apache.beam.sdk.runners.TransformHierarchy.Node-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>visitValue</h4> |
| <pre>void visitValue(<a href="../../../../org/apache/beam/sdk/values/PValue.html" title="interface in org.apache.beam.sdk.values">PValue</a> value, |
| org.apache.beam.sdk.runners.TransformHierarchy.Node producer)</pre> |
| <div class="block">Called for each value after the transform that produced the value has been visited.</div> |
| </li> |
| </ul> |
| <a name="leavePipeline-org.apache.beam.sdk.Pipeline-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>leavePipeline</h4> |
| <pre>void leavePipeline(<a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk">Pipeline</a> pipeline)</pre> |
| <div class="block">Called when all values and transforms in a <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> have been visited.</div> |
| </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/Pipeline.PipelineExecutionException.html" title="class in org.apache.beam.sdk"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.CompositeBehavior.html" title="enum in org.apache.beam.sdk"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/beam/sdk/Pipeline.PipelineVisitor.html" target="_top">Frames</a></li> |
| <li><a href="Pipeline.PipelineVisitor.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
