| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>PipelineResult (Apache Beam 2.38.0-SNAPSHOT)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="PipelineResult (Apache Beam 2.38.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":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.PipelineVisitor.Defaults.html" title="class in org.apache.beam.sdk"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/beam/sdk/PipelineResult.State.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/PipelineResult.html" target="_top">Frames</a></li> |
| <li><a href="PipelineResult.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 PipelineResult" class="title">Interface PipelineResult</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../org/apache/beam/runners/jobsubmission/PortablePipelineResult.html" title="interface in org.apache.beam.runners.jobsubmission">PortablePipelineResult</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html" title="class in org.apache.beam.runners.dataflow">DataflowPipelineJob</a>, <a href="../../../../org/apache/beam/runners/dataflow/util/DataflowTemplateJob.html" title="class in org.apache.beam.runners.dataflow.util">DataflowTemplateJob</a>, <a href="../../../../org/apache/beam/runners/direct/DirectRunner.DirectPipelineResult.html" title="class in org.apache.beam.runners.direct">DirectRunner.DirectPipelineResult</a>, <a href="../../../../org/apache/beam/runners/jet/FailedRunningPipelineResults.html" title="class in org.apache.beam.runners.jet">FailedRunningPipelineResults</a>, <a href="../../../../org/apache/beam/runners/flink/FlinkDetachedRunnerResult.html" title="class in org.apache.beam.runners.flink">FlinkDetachedRunnerResult</a>, <a href="../../../../org/apache/beam/runners/flink/FlinkPortableRunnerResult.html" title="class in org.apache.beam.runners.flink">FlinkPortableRunnerResult</a>, <a href="../../../../org/apache/beam/runners/flink/FlinkRunnerResult.html" title="class in org.apache.beam.runners.flink">FlinkRunnerResult</a>, <a href="../../../../org/apache/beam/runners/jet/JetPipelineResult.html" title="class in org.apache.beam.runners.jet">JetPipelineResult</a>, <a href="../../../../org/apache/beam/runners/spark/SparkPipelineResult.html" title="class in org.apache.beam.runners.spark">SparkPipelineResult</a>, <a href="../../../../org/apache/beam/runners/spark/SparkRunnerDebugger.DebugSparkPipelineResult.html" title="class in org.apache.beam.runners.spark">SparkRunnerDebugger.DebugSparkPipelineResult</a>, <a href="../../../../org/apache/beam/runners/spark/structuredstreaming/SparkStructuredStreamingPipelineResult.html" title="class in org.apache.beam.runners.spark.structuredstreaming">SparkStructuredStreamingPipelineResult</a>, <a href="../../../../org/apache/beam/runners/twister2/Twister2PipelineResult.html" title="class in org.apache.beam.runners.twister2">Twister2PipelineResult</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">PipelineResult</span></pre> |
| <div class="block">Result of <a href="../../../../org/apache/beam/sdk/Pipeline.html#run--"><code>Pipeline.run()</code></a>. |
| |
| <p>This is often a job handle to an underlying data processing engine.</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/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a></span></code> |
| <div class="block">Possible job states, for both completed and ongoing jobs.</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/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.html#cancel--">cancel</a></span>()</code> |
| <div class="block">Cancels the pipeline execution.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><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.html#getState--">getState</a></span>()</code> |
| <div class="block">Retrieves the current state of the pipeline execution.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/beam/sdk/metrics/MetricResults.html" title="class in org.apache.beam.sdk.metrics">MetricResults</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/beam/sdk/PipelineResult.html#metrics--">metrics</a></span>()</code> |
| <div class="block">Returns the object to access metrics from the pipeline.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><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.html#waitUntilFinish--">waitUntilFinish</a></span>()</code> |
| <div class="block">Waits until the pipeline finishes and returns the final status.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><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.html#waitUntilFinish-org.joda.time.Duration-">waitUntilFinish</a></span>(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> duration)</code> |
| <div class="block">Waits until the pipeline finishes and returns the final status.</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="getState--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getState</h4> |
| <pre><a href="../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a> getState()</pre> |
| <div class="block">Retrieves the current state of the pipeline execution.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk"><code>PipelineResult.State</code></a> representing the state of this pipeline.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="cancel--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cancel</h4> |
| <pre><a href="../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a> cancel() |
| throws java.io.IOException</pre> |
| <div class="block">Cancels the pipeline execution.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if there is a problem executing the cancel request.</dd> |
| <dd><code>java.lang.UnsupportedOperationException</code> - if the runner does not support cancellation.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="waitUntilFinish-org.joda.time.Duration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>waitUntilFinish</h4> |
| <pre><a href="../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a> waitUntilFinish(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> duration)</pre> |
| <div class="block">Waits until the pipeline finishes and returns the final status. It times out after the given |
| duration.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>duration</code> - The time to wait for the pipeline to finish. Provide a value less than 1 ms for |
| an infinite wait.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The final state of the pipeline or null on timeout.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.UnsupportedOperationException</code> - if the runner does not support waiting to finish with a |
| timeout.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="waitUntilFinish--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>waitUntilFinish</h4> |
| <pre><a href="../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a> waitUntilFinish()</pre> |
| <div class="block">Waits until the pipeline finishes and returns the final status.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The final state of the pipeline.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.UnsupportedOperationException</code> - if the runner does not support waiting to finish.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="metrics--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>metrics</h4> |
| <pre><a href="../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a>(<a href="../../../../org/apache/beam/sdk/annotations/Experimental.html#value--">value</a>=<a href="../../../../org/apache/beam/sdk/annotations/Experimental.Kind.html#METRICS">METRICS</a>) |
| <a href="../../../../org/apache/beam/sdk/metrics/MetricResults.html" title="class in org.apache.beam.sdk.metrics">MetricResults</a> metrics()</pre> |
| <div class="block">Returns the object to access metrics from the pipeline.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.UnsupportedOperationException</code> - if the runner doesn't support retrieving metrics.</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/Pipeline.PipelineVisitor.Defaults.html" title="class in org.apache.beam.sdk"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/beam/sdk/PipelineResult.State.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/PipelineResult.html" target="_top">Frames</a></li> |
| <li><a href="PipelineResult.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> |