http://git-wip-us.apache.org/repos/asf/beam-site/blob/c196579f/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/sdk/Pipeline.PipelineVisitor.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/sdk/Pipeline.PipelineVisitor.html b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/sdk/Pipeline.PipelineVisitor.html new file mode 100644 index 0000000..61cfcc6 --- /dev/null +++ b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/sdk/Pipeline.PipelineVisitor.html @@ -0,0 +1,323 @@ +<!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_112-google-v7) on Fri May 12 16:50:05 PDT 2017 --> +<title>Pipeline.PipelineVisitor</title> +<meta name="date" content="2017-05-12"> +<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"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":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/sdk/Pipeline.PipelineVisitor.Defaults.html" title="class in org.apache.beam.sdk">Pipeline.PipelineVisitor.Defaults</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#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="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#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="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#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="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="blockListLast"> +<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> +</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>
http://git-wip-us.apache.org/repos/asf/beam-site/blob/c196579f/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/sdk/Pipeline.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/sdk/Pipeline.html b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/sdk/Pipeline.html new file mode 100644 index 0000000..f688f43 --- /dev/null +++ b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/sdk/Pipeline.html @@ -0,0 +1,631 @@ +<!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_112-google-v7) on Fri May 12 16:50:05 PDT 2017 --> +<title>Pipeline</title> +<meta name="date" content="2017-05-12"> +<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"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":9,"i3":9,"i4":10,"i5":9,"i6":9,"i7":10,"i8":10,"i9":10,"i10":10,"i11":42,"i12":10,"i13":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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>Prev Class</li> +<li><a href="../../../../org/apache/beam/sdk/Pipeline.PipelineExecutionException.html" title="class 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.html" target="_top">Frames</a></li> +<li><a href="Pipeline.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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="Class Pipeline" class="title">Class Pipeline</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.sdk.Pipeline</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../org/apache/beam/sdk/testing/TestPipeline.html" title="class in org.apache.beam.sdk.testing">TestPipeline</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">Pipeline</span> +extends java.lang.Object</pre> +<div class="block">A <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> manages a directed acyclic graph of <a href="../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransforms</code></a>, and the + <a href="../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollections</code></a> that the <a href="../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransforms</code></a> consume and produce. + + <p>Each <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> is self-contained and isolated from any other + <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a>. The <a href="../../../../org/apache/beam/sdk/values/PValue.html" title="interface in org.apache.beam.sdk.values"><code>PValues</code></a> that are inputs and outputs of each of a + <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline's</code></a> <a href="../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransforms</code></a> are also owned by that + <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a>. A <a href="../../../../org/apache/beam/sdk/values/PValue.html" title="interface in org.apache.beam.sdk.values"><code>PValue</code></a> owned by one <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> can be read only by + <a href="../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransforms</code></a> also owned by that <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a>. <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipelines</code></a> + can safely be executed concurrently. + + <p>Here is a typical example of use: + <pre> <code> + // Start by defining the options for the pipeline. + PipelineOptions options = PipelineOptionsFactory.create(); + // Then create the pipeline. The runner is determined by the options. + Pipeline p = Pipeline.create(options); + + // A root PTransform, like TextIO.Read or Create, gets added + // to the Pipeline by being applied: + PCollection<String> lines = + p.apply(TextIO.read().from("gs://bucket/dir/file*.txt")); + + // A Pipeline can have multiple root transforms: + PCollection<String> moreLines = + p.apply(TextIO.read().from("gs://bucket/other/dir/file*.txt")); + PCollection<String> yetMoreLines = + p.apply(Create.of("yet", "more", "lines").withCoder(StringUtf8Coder.of())); + + // Further PTransforms can be applied, in an arbitrary (acyclic) graph. + // Subsequent PTransforms (and intermediate PCollections etc.) are + // implicitly part of the same Pipeline. + PCollection<String> allLines = + PCollectionList.of(lines).and(moreLines).and(yetMoreLines) + .apply(new Flatten<String>()); + PCollection<KV<String, Integer>> wordCounts = + allLines + .apply(ParDo.of(new ExtractWords())) + .apply(new Count<String>()); + PCollection<String> formattedWordCounts = + wordCounts.apply(ParDo.of(new FormatCounts())); + formattedWordCounts.apply(TextIO.write().to("gs://bucket/dir/counts.txt")); + + // PTransforms aren't executed when they're applied, rather they're + // just added to the Pipeline. Once the whole Pipeline of PTransforms + // is constructed, the Pipeline's PTransforms can be run using a + // PipelineRunner. The default PipelineRunner executes the Pipeline + // directly, sequentially, in this one process, which is useful for + // unit tests and simple experiments: + p.run(); + + </code> </pre></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">Class 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.PipelineExecutionException.html" title="class in org.apache.beam.sdk">Pipeline.PipelineExecutionException</a></span></code> +<div class="block">Thrown during execution of a <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a>, whenever user code within that + <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> throws an exception.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.html" title="interface in org.apache.beam.sdk">Pipeline.PipelineVisitor</a></span></code> +<div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b></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"> </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/Pipeline.html#Pipeline-org.apache.beam.sdk.options.PipelineOptions-">Pipeline</a></span>(<a href="../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a> options)</code> </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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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><OutputT extends <a href="../../../../org/apache/beam/sdk/values/POutput.html" title="interface in org.apache.beam.sdk.values">POutput</a>><br>OutputT</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/Pipeline.html#apply-org.apache.beam.sdk.transforms.PTransform-">apply</a></span>(<a href="../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><? super <a href="../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a>,OutputT> root)</code> +<div class="block">Like <a href="../../../../org/apache/beam/sdk/Pipeline.html#apply-java.lang.String-org.apache.beam.sdk.transforms.PTransform-"><code>apply(String, PTransform)</code></a> but the transform node in the <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> + graph will be named according to <a href="../../../../org/apache/beam/sdk/transforms/PTransform.html#getName--"><code>PTransform.getName()</code></a>.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><OutputT extends <a href="../../../../org/apache/beam/sdk/values/POutput.html" title="interface in org.apache.beam.sdk.values">POutput</a>><br>OutputT</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/Pipeline.html#apply-java.lang.String-org.apache.beam.sdk.transforms.PTransform-">apply</a></span>(java.lang.String name, + <a href="../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><? super <a href="../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a>,OutputT> root)</code> +<div class="block">Adds a root <a href="../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a>, such as <a href="../../../../org/apache/beam/sdk/io/Read.html" title="class in org.apache.beam.sdk.io"><code>Read</code></a> or <a href="../../../../org/apache/beam/sdk/transforms/Create.html" title="class in org.apache.beam.sdk.transforms"><code>Create</code></a>, to this <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a>.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static <InputT extends <a href="../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values">PInput</a>,OutputT extends <a href="../../../../org/apache/beam/sdk/values/POutput.html" title="interface in org.apache.beam.sdk.values">POutput</a>><br>OutputT</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/Pipeline.html#applyTransform-InputT-org.apache.beam.sdk.transforms.PTransform-">applyTransform</a></span>(InputT input, + <a href="../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><? super InputT,OutputT> transform)</code> +<div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b></div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>static <InputT extends <a href="../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values">PInput</a>,OutputT extends <a href="../../../../org/apache/beam/sdk/values/POutput.html" title="interface in org.apache.beam.sdk.values">POutput</a>><br>OutputT</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/Pipeline.html#applyTransform-java.lang.String-InputT-org.apache.beam.sdk.transforms.PTransform-">applyTransform</a></span>(java.lang.String name, + InputT input, + <a href="../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><? super InputT,OutputT> transform)</code> +<div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b></div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/Pipeline.html#begin--">begin</a></span>()</code> +<div class="block">Returns a <a href="../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values"><code>PBegin</code></a> owned by this Pipeline.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk">Pipeline</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/Pipeline.html#create--">create</a></span>()</code> +<div class="block">Constructs a pipeline from default <a href="../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a>.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk">Pipeline</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/Pipeline.html#create-org.apache.beam.sdk.options.PipelineOptions-">create</a></span>(<a href="../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a> options)</code> +<div class="block">Constructs a pipeline from the provided <a href="../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a>.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/beam/sdk/coders/CoderRegistry.html" title="class in org.apache.beam.sdk.coders">CoderRegistry</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/Pipeline.html#getCoderRegistry--">getCoderRegistry</a></span>()</code> +<div class="block">Returns the <a href="../../../../org/apache/beam/sdk/coders/CoderRegistry.html" title="class in org.apache.beam.sdk.coders"><code>CoderRegistry</code></a> that this <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> uses.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/Pipeline.html#replaceAll-java.util.List-">replaceAll</a></span>(java.util.List<org.apache.beam.sdk.runners.PTransformOverride> overrides)</code> +<div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b></div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/beam/sdk/PipelineResult.html" title="interface in org.apache.beam.sdk">PipelineResult</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/Pipeline.html#run--">run</a></span>()</code> +<div class="block">Runs this <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> according to the <a href="../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> used to create the <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> via <a href="../../../../org/apache/beam/sdk/Pipeline.html#create-org.apache.beam.sdk.options.PipelineOptions-"><code>create(PipelineOptions)</code></a>.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/beam/sdk/PipelineResult.html" title="interface in org.apache.beam.sdk">PipelineResult</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/Pipeline.html#run-org.apache.beam.sdk.options.PipelineOptions-">run</a></span>(<a href="../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a> options)</code> +<div class="block">Runs this <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> using the given <a href="../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a>, using the runner specified + by the options.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/Pipeline.html#setCoderRegistry-org.apache.beam.sdk.coders.CoderRegistry-">setCoderRegistry</a></span>(<a href="../../../../org/apache/beam/sdk/coders/CoderRegistry.html" title="class in org.apache.beam.sdk.coders">CoderRegistry</a> coderRegistry)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">this should never be used - every <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> has a registry throughout its + lifetime.</span></div> +</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/Pipeline.html#toString--">toString</a></span>()</code> </td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/Pipeline.html#traverseTopologically-org.apache.beam.sdk.Pipeline.PipelineVisitor-">traverseTopologically</a></span>(<a href="../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.html" title="interface in org.apache.beam.sdk">Pipeline.PipelineVisitor</a> visitor)</code> +<div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b></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 java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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="Pipeline-org.apache.beam.sdk.options.PipelineOptions-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Pipeline</h4> +<pre>protected Pipeline(<a href="../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a> options)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="create--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>create</h4> +<pre>public static <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk">Pipeline</a> create()</pre> +<div class="block">Constructs a pipeline from default <a href="../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a>.</div> +</li> +</ul> +<a name="create-org.apache.beam.sdk.options.PipelineOptions-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>create</h4> +<pre>public static <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk">Pipeline</a> create(<a href="../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a> options)</pre> +<div class="block">Constructs a pipeline from the provided <a href="../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a>.</div> +</li> +</ul> +<a name="begin--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>begin</h4> +<pre>public <a href="../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a> begin()</pre> +<div class="block">Returns a <a href="../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values"><code>PBegin</code></a> owned by this Pipeline. This serves as the input of a root <a href="../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> such as <a href="../../../../org/apache/beam/sdk/io/Read.html" title="class in org.apache.beam.sdk.io"><code>Read</code></a> or <a href="../../../../org/apache/beam/sdk/transforms/Create.html" title="class in org.apache.beam.sdk.transforms"><code>Create</code></a>.</div> +</li> +</ul> +<a name="apply-org.apache.beam.sdk.transforms.PTransform-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>apply</h4> +<pre>public <OutputT extends <a href="../../../../org/apache/beam/sdk/values/POutput.html" title="interface in org.apache.beam.sdk.values">POutput</a>> OutputT apply(<a href="../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><? super <a href="../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a>,OutputT> root)</pre> +<div class="block">Like <a href="../../../../org/apache/beam/sdk/Pipeline.html#apply-java.lang.String-org.apache.beam.sdk.transforms.PTransform-"><code>apply(String, PTransform)</code></a> but the transform node in the <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> + graph will be named according to <a href="../../../../org/apache/beam/sdk/transforms/PTransform.html#getName--"><code>PTransform.getName()</code></a>.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/beam/sdk/Pipeline.html#apply-java.lang.String-org.apache.beam.sdk.transforms.PTransform-"><code>apply(String, PTransform)</code></a></dd> +</dl> +</li> +</ul> +<a name="apply-java.lang.String-org.apache.beam.sdk.transforms.PTransform-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>apply</h4> +<pre>public <OutputT extends <a href="../../../../org/apache/beam/sdk/values/POutput.html" title="interface in org.apache.beam.sdk.values">POutput</a>> OutputT apply(java.lang.String name, + <a href="../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><? super <a href="../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a>,OutputT> root)</pre> +<div class="block">Adds a root <a href="../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a>, such as <a href="../../../../org/apache/beam/sdk/io/Read.html" title="class in org.apache.beam.sdk.io"><code>Read</code></a> or <a href="../../../../org/apache/beam/sdk/transforms/Create.html" title="class in org.apache.beam.sdk.transforms"><code>Create</code></a>, to this <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a>. + + <p>The node in the <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> graph will use the provided <code>name</code>. This name is used + in various places, including the monitoring UI, logging, and to stably identify this node in + the <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> graph upon update. + + <p>Alias for <code>begin().apply(name, root)</code>.</div> +</li> +</ul> +<a name="replaceAll-java.util.List-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>replaceAll</h4> +<pre><a href="../../../../org/apache/beam/sdk/annotations/Internal.html" title="annotation in org.apache.beam.sdk.annotations">@Internal</a> +public void replaceAll(java.util.List<org.apache.beam.sdk.runners.PTransformOverride> overrides)</pre> +<div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b> + + <p>Replaces all nodes that match a <code>PTransformOverride</code> in this pipeline. Overrides are + applied in the order they are present within the list. + + <p>After all nodes are replaced, ensures that no nodes in the updated graph match any of the + overrides.</div> +</li> +</ul> +<a name="run--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>run</h4> +<pre>public <a href="../../../../org/apache/beam/sdk/PipelineResult.html" title="interface in org.apache.beam.sdk">PipelineResult</a> run()</pre> +<div class="block">Runs this <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> according to the <a href="../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> used to create the <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> via <a href="../../../../org/apache/beam/sdk/Pipeline.html#create-org.apache.beam.sdk.options.PipelineOptions-"><code>create(PipelineOptions)</code></a>.</div> +</li> +</ul> +<a name="run-org.apache.beam.sdk.options.PipelineOptions-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>run</h4> +<pre>public <a href="../../../../org/apache/beam/sdk/PipelineResult.html" title="interface in org.apache.beam.sdk">PipelineResult</a> run(<a href="../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a> options)</pre> +<div class="block">Runs this <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> using the given <a href="../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a>, using the runner specified + by the options.</div> +</li> +</ul> +<a name="getCoderRegistry--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCoderRegistry</h4> +<pre>public <a href="../../../../org/apache/beam/sdk/coders/CoderRegistry.html" title="class in org.apache.beam.sdk.coders">CoderRegistry</a> getCoderRegistry()</pre> +<div class="block">Returns the <a href="../../../../org/apache/beam/sdk/coders/CoderRegistry.html" title="class in org.apache.beam.sdk.coders"><code>CoderRegistry</code></a> that this <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> uses.</div> +</li> +</ul> +<a name="setCoderRegistry-org.apache.beam.sdk.coders.CoderRegistry-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCoderRegistry</h4> +<pre>@Deprecated +public void setCoderRegistry(<a href="../../../../org/apache/beam/sdk/coders/CoderRegistry.html" title="class in org.apache.beam.sdk.coders">CoderRegistry</a> coderRegistry)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">this should never be used - every <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> has a registry throughout its + lifetime.</span></div> +</li> +</ul> +<a name="traverseTopologically-org.apache.beam.sdk.Pipeline.PipelineVisitor-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>traverseTopologically</h4> +<pre><a href="../../../../org/apache/beam/sdk/annotations/Internal.html" title="annotation in org.apache.beam.sdk.annotations">@Internal</a> +public void traverseTopologically(<a href="../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.html" title="interface in org.apache.beam.sdk">Pipeline.PipelineVisitor</a> visitor)</pre> +<div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b> + + <p>Invokes the <a href="../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.html" title="interface in org.apache.beam.sdk"><code>PipelineVisitor's</code></a> + <a href="../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.html#visitPrimitiveTransform-org.apache.beam.sdk.runners.TransformHierarchy.Node-"><code>Pipeline.PipelineVisitor.visitPrimitiveTransform(org.apache.beam.sdk.runners.TransformHierarchy.Node)</code></a> and + <a href="../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.html#visitValue-org.apache.beam.sdk.values.PValue-org.apache.beam.sdk.runners.TransformHierarchy.Node-"><code>Pipeline.PipelineVisitor.visitValue(org.apache.beam.sdk.values.PValue, org.apache.beam.sdk.runners.TransformHierarchy.Node)</code></a> operations on each of this + <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline's</code></a> transform and value nodes, in forward + topological order. + + <p>Traversal of the <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> causes <a href="../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransforms</code></a> and + <a href="../../../../org/apache/beam/sdk/values/PValue.html" title="interface in org.apache.beam.sdk.values"><code>PValues</code></a> owned by the <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> to be marked as finished, + at which point they may no longer be modified. + + <p>Typically invoked by <a href="../../../../org/apache/beam/sdk/PipelineRunner.html" title="class in org.apache.beam.sdk"><code>PipelineRunner</code></a> subclasses.</div> +</li> +</ul> +<a name="applyTransform-org.apache.beam.sdk.values.PInput-org.apache.beam.sdk.transforms.PTransform-"> +<!-- --> +</a><a name="applyTransform-InputT-org.apache.beam.sdk.transforms.PTransform-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>applyTransform</h4> +<pre><a href="../../../../org/apache/beam/sdk/annotations/Internal.html" title="annotation in org.apache.beam.sdk.annotations">@Internal</a> +public static <InputT extends <a href="../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values">PInput</a>,OutputT extends <a href="../../../../org/apache/beam/sdk/values/POutput.html" title="interface in org.apache.beam.sdk.values">POutput</a>> OutputT applyTransform(InputT input, + <a href="../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><? super InputT,OutputT> transform)</pre> +<div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b> + + <p>Like <a href="../../../../org/apache/beam/sdk/Pipeline.html#applyTransform-java.lang.String-InputT-org.apache.beam.sdk.transforms.PTransform-"><code>applyTransform(String, PInput, PTransform)</code></a> but defaulting to the name + provided by the <a href="../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a>.</div> +</li> +</ul> +<a name="applyTransform-java.lang.String-org.apache.beam.sdk.values.PInput-org.apache.beam.sdk.transforms.PTransform-"> +<!-- --> +</a><a name="applyTransform-java.lang.String-InputT-org.apache.beam.sdk.transforms.PTransform-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>applyTransform</h4> +<pre><a href="../../../../org/apache/beam/sdk/annotations/Internal.html" title="annotation in org.apache.beam.sdk.annotations">@Internal</a> +public static <InputT extends <a href="../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values">PInput</a>,OutputT extends <a href="../../../../org/apache/beam/sdk/values/POutput.html" title="interface in org.apache.beam.sdk.values">POutput</a>> OutputT applyTransform(java.lang.String name, + InputT input, + <a href="../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><? super InputT,OutputT> transform)</pre> +<div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b> + + <p>Applies the given <code>PTransform</code> to this input <code>InputT</code> and returns + its <code>OutputT</code>. This uses <code>name</code> to identify this specific application + of the transform. This name is used in various places, including the monitoring UI, + logging, and to stably identify this application node in the <a href="../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> graph during + update. + + <p>Each <a href="../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values"><code>PInput</code></a> subclass that provides an <code>apply</code> method should delegate to + this method to ensure proper registration with the <a href="../../../../org/apache/beam/sdk/PipelineRunner.html" title="class in org.apache.beam.sdk"><code>PipelineRunner</code></a>.</div> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../org/apache/beam/sdk/Pipeline.PipelineExecutionException.html" title="class 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.html" target="_top">Frames</a></li> +<li><a href="Pipeline.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/beam-site/blob/c196579f/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/sdk/PipelineResult.State.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/sdk/PipelineResult.State.html b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/sdk/PipelineResult.State.html new file mode 100644 index 0000000..0344c1e --- /dev/null +++ b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/sdk/PipelineResult.State.html @@ -0,0 +1,462 @@ +<!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_112-google-v7) on Fri May 12 16:50:05 PDT 2017 --> +<title>PipelineResult.State</title> +<meta name="date" content="2017-05-12"> +<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="PipelineResult.State"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":9,"i3":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/PipelineResult.html" title="interface in org.apache.beam.sdk"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/beam/sdk/PipelineRunner.html" title="class 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/PipelineResult.State.html" target="_top">Frames</a></li> +<li><a href="PipelineResult.State.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#enum.constant.summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li>Field | </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="Enum PipelineResult.State" class="title">Enum PipelineResult.State</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Enum<<a href="../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.sdk.PipelineResult.State</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, java.lang.Comparable<<a href="../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a>></dd> +</dl> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../../org/apache/beam/sdk/PipelineResult.html" title="interface in org.apache.beam.sdk">PipelineResult</a></dd> +</dl> +<hr> +<br> +<pre>public static enum <span class="typeNameLabel">PipelineResult.State</span> +extends java.lang.Enum<<a href="../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a>></pre> +<div class="block">Possible job states, for both completed and ongoing jobs. + + <p>When determining if a job is still running, consult the <a href="../../../../org/apache/beam/sdk/PipelineResult.State.html#isTerminal--"><code>isTerminal()</code></a> method rather + than inspecting the precise state.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum.constant.summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/PipelineResult.State.html#CANCELLED">CANCELLED</a></span></code> +<div class="block">The job has been explicitly cancelled.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/PipelineResult.State.html#DONE">DONE</a></span></code> +<div class="block">The job has successfully completed.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/PipelineResult.State.html#FAILED">FAILED</a></span></code> +<div class="block">The job has failed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/PipelineResult.State.html#RUNNING">RUNNING</a></span></code> +<div class="block">The job is currently running.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/PipelineResult.State.html#STOPPED">STOPPED</a></span></code> +<div class="block">The job has been paused, or has not yet started.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/PipelineResult.State.html#UNKNOWN">UNKNOWN</a></span></code> +<div class="block">The job state could not be obtained or was not specified.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/PipelineResult.State.html#UPDATED">UPDATED</a></span></code> +<div class="block">The job has been updated.</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/PipelineResult.State.html#hasReplacementJob--">hasReplacementJob</a></span>()</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/PipelineResult.State.html#isTerminal--">isTerminal</a></span>()</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/PipelineResult.State.html#valueOf-java.lang.String-">valueOf</a></span>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/PipelineResult.State.html#values--">values</a></span>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Enum</h3> +<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum.constant.detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="UNKNOWN"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>UNKNOWN</h4> +<pre>public static final <a href="../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a> UNKNOWN</pre> +<div class="block">The job state could not be obtained or was not specified.</div> +</li> +</ul> +<a name="STOPPED"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>STOPPED</h4> +<pre>public static final <a href="../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a> STOPPED</pre> +<div class="block">The job has been paused, or has not yet started.</div> +</li> +</ul> +<a name="RUNNING"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RUNNING</h4> +<pre>public static final <a href="../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a> RUNNING</pre> +<div class="block">The job is currently running.</div> +</li> +</ul> +<a name="DONE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DONE</h4> +<pre>public static final <a href="../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a> DONE</pre> +<div class="block">The job has successfully completed.</div> +</li> +</ul> +<a name="FAILED"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FAILED</h4> +<pre>public static final <a href="../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a> FAILED</pre> +<div class="block">The job has failed.</div> +</li> +</ul> +<a name="CANCELLED"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CANCELLED</h4> +<pre>public static final <a href="../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a> CANCELLED</pre> +<div class="block">The job has been explicitly cancelled.</div> +</li> +</ul> +<a name="UPDATED"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>UPDATED</h4> +<pre>public static final <a href="../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a> UPDATED</pre> +<div class="block">The job has been updated.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (PipelineResult.State c : PipelineResult.State.values()) + System.out.println(c); +</pre></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an array containing the constants of this enum type, in the order they are declared</dd> +</dl> +</li> +</ul> +<a name="valueOf-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a> valueOf(java.lang.String name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the enum constant with the specified name</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd> +<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd> +</dl> +</li> +</ul> +<a name="isTerminal--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isTerminal</h4> +<pre>public final boolean isTerminal()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><code>true</code> if the job state can no longer complete work.</dd> +</dl> +</li> +</ul> +<a name="hasReplacementJob--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>hasReplacementJob</h4> +<pre>public final boolean hasReplacementJob()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><code>true</code> if this job state indicates that a replacement job exists.</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/PipelineResult.html" title="interface in org.apache.beam.sdk"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/beam/sdk/PipelineRunner.html" title="class 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/PipelineResult.State.html" target="_top">Frames</a></li> +<li><a href="PipelineResult.State.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#enum.constant.summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
