| <!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_161-google-v7) on Thu Oct 18 16:14:32 PDT 2018 --> |
| <title>FlinkJobInvocation (Apache Beam 2.8.0-SNAPSHOT)</title> |
| <meta name="date" content="2018-10-18"> |
| <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="FlinkJobInvocation (Apache Beam 2.8.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":10,"i5":10,"i6":10}; |
| 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/runners/flink/FlinkExecutionEnvironments.html" title="class in org.apache.beam.runners.flink"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/runners/flink/FlinkJobInvoker.html" title="class in org.apache.beam.runners.flink"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/runners/flink/FlinkJobInvocation.html" target="_top">Frames</a></li> |
| <li><a href="FlinkJobInvocation.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>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.runners.flink</div> |
| <h2 title="Class FlinkJobInvocation" class="title">Class FlinkJobInvocation</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.runners.flink.FlinkJobInvocation</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvocation.html" title="interface in org.apache.beam.runners.fnexecution.jobsubmission">JobInvocation</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">FlinkJobInvocation</span> |
| extends java.lang.Object |
| implements <a href="../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvocation.html" title="interface in org.apache.beam.runners.fnexecution.jobsubmission">JobInvocation</a></pre> |
| <div class="block">Invocation of a Flink Job via <a href="../../../../../org/apache/beam/runners/flink/FlinkRunner.html" title="class in org.apache.beam.runners.flink"><code>FlinkRunner</code></a>.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkJobInvocation.html#addMessageListener-java.util.function.Consumer-">addMessageListener</a></span>(java.util.function.Consumer<org.apache.beam.model.jobmanagement.v1.JobApi.JobMessage> messageStreamObserver)</code> |
| <div class="block">Listen for job messages with a <code>Consumer</code>.</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/runners/flink/FlinkJobInvocation.html#addStateListener-java.util.function.Consumer-">addStateListener</a></span>(java.util.function.Consumer<org.apache.beam.model.jobmanagement.v1.JobApi.JobState.Enum> stateStreamObserver)</code> |
| <div class="block">Listen for job state changes with a <code>Consumer</code>.</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/runners/flink/FlinkJobInvocation.html#cancel--">cancel</a></span>()</code> |
| <div class="block">Cancel the job.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/beam/runners/flink/FlinkJobInvocation.html" title="class in org.apache.beam.runners.flink">FlinkJobInvocation</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkJobInvocation.html#create-java.lang.String-java.lang.String-com.google.common.util.concurrent.ListeningExecutorService-org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline-org.apache.beam.runners.flink.FlinkPipelineOptions-java.util.List-">create</a></span>(java.lang.String id, |
| java.lang.String retrievalToken, |
| <a href="http://google.github.io/guava/releases/20.0/api/docs/com/google/common/util/concurrent/ListeningExecutorService.html?is-external=true" title="class or interface in com.google.common.util.concurrent">ListeningExecutorService</a> executorService, |
| org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline pipeline, |
| <a href="../../../../../org/apache/beam/runners/flink/FlinkPipelineOptions.html" title="interface in org.apache.beam.runners.flink">FlinkPipelineOptions</a> pipelineOptions, |
| java.util.List<java.lang.String> filesToStage)</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkJobInvocation.html#getId--">getId</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>org.apache.beam.model.jobmanagement.v1.JobApi.JobState.Enum</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkJobInvocation.html#getState--">getState</a></span>()</code> |
| <div class="block">Retrieve the job's current state.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkJobInvocation.html#start--">start</a></span>()</code> |
| <div class="block">Start the job.</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, toString, wait, wait, wait</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.runners.fnexecution.jobsubmission.JobInvocation"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.beam.runners.fnexecution.jobsubmission.<a href="../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvocation.html" title="interface in org.apache.beam.runners.fnexecution.jobsubmission">JobInvocation</a></h3> |
| <code><a href="../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvocation.html#isTerminated-org.apache.beam.model.jobmanagement.v1.JobApi.JobState.Enum-">isTerminated</a></code></li> |
| </ul> |
| </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="create-java.lang.String-java.lang.String-com.google.common.util.concurrent.ListeningExecutorService-org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline-org.apache.beam.runners.flink.FlinkPipelineOptions-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>public static <a href="../../../../../org/apache/beam/runners/flink/FlinkJobInvocation.html" title="class in org.apache.beam.runners.flink">FlinkJobInvocation</a> create(java.lang.String id, |
| java.lang.String retrievalToken, |
| <a href="http://google.github.io/guava/releases/20.0/api/docs/com/google/common/util/concurrent/ListeningExecutorService.html?is-external=true" title="class or interface in com.google.common.util.concurrent">ListeningExecutorService</a> executorService, |
| org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline pipeline, |
| <a href="../../../../../org/apache/beam/runners/flink/FlinkPipelineOptions.html" title="interface in org.apache.beam.runners.flink">FlinkPipelineOptions</a> pipelineOptions, |
| java.util.List<java.lang.String> filesToStage)</pre> |
| </li> |
| </ul> |
| <a name="start--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>start</h4> |
| <pre>public void start()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvocation.html#start--">JobInvocation</a></code></span></div> |
| <div class="block">Start the job.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvocation.html#start--">start</a></code> in interface <code><a href="../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvocation.html" title="interface in org.apache.beam.runners.fnexecution.jobsubmission">JobInvocation</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getId</h4> |
| <pre>public java.lang.String getId()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvocation.html#getId--">getId</a></code> in interface <code><a href="../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvocation.html" title="interface in org.apache.beam.runners.fnexecution.jobsubmission">JobInvocation</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Unique identifier for the job invocation.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="cancel--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cancel</h4> |
| <pre>public void cancel()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvocation.html#cancel--">JobInvocation</a></code></span></div> |
| <div class="block">Cancel the job.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvocation.html#cancel--">cancel</a></code> in interface <code><a href="../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvocation.html" title="interface in org.apache.beam.runners.fnexecution.jobsubmission">JobInvocation</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getState--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getState</h4> |
| <pre>public org.apache.beam.model.jobmanagement.v1.JobApi.JobState.Enum getState()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvocation.html#getState--">JobInvocation</a></code></span></div> |
| <div class="block">Retrieve the job's current state.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvocation.html#getState--">getState</a></code> in interface <code><a href="../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvocation.html" title="interface in org.apache.beam.runners.fnexecution.jobsubmission">JobInvocation</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addStateListener-java.util.function.Consumer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addStateListener</h4> |
| <pre>public void addStateListener(java.util.function.Consumer<org.apache.beam.model.jobmanagement.v1.JobApi.JobState.Enum> stateStreamObserver)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvocation.html#addStateListener-java.util.function.Consumer-">JobInvocation</a></code></span></div> |
| <div class="block">Listen for job state changes with a <code>Consumer</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvocation.html#addStateListener-java.util.function.Consumer-">addStateListener</a></code> in interface <code><a href="../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvocation.html" title="interface in org.apache.beam.runners.fnexecution.jobsubmission">JobInvocation</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addMessageListener-java.util.function.Consumer-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>addMessageListener</h4> |
| <pre>public void addMessageListener(java.util.function.Consumer<org.apache.beam.model.jobmanagement.v1.JobApi.JobMessage> messageStreamObserver)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvocation.html#addMessageListener-java.util.function.Consumer-">JobInvocation</a></code></span></div> |
| <div class="block">Listen for job messages with a <code>Consumer</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvocation.html#addMessageListener-java.util.function.Consumer-">addMessageListener</a></code> in interface <code><a href="../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvocation.html" title="interface in org.apache.beam.runners.fnexecution.jobsubmission">JobInvocation</a></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><a href="../../../../../org/apache/beam/runners/flink/FlinkExecutionEnvironments.html" title="class in org.apache.beam.runners.flink"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/runners/flink/FlinkJobInvoker.html" title="class in org.apache.beam.runners.flink"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/runners/flink/FlinkJobInvocation.html" target="_top">Frames</a></li> |
| <li><a href="FlinkJobInvocation.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>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> |
