| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_181-google-v7) on Wed Aug 14 17:37:12 PDT 2019 --> |
| <title>JobInvocation (Apache Beam 2.15.0-SNAPSHOT)</title> |
| <meta name="date" content="2019-08-14"> |
| <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="JobInvocation (Apache Beam 2.15.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; |
| var tabs = {65535:["t0","All 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/fnexecution/jobsubmission/InMemoryJobService.html" title="class in org.apache.beam.runners.fnexecution.jobsubmission"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvoker.html" title="class in org.apache.beam.runners.fnexecution.jobsubmission"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/runners/fnexecution/jobsubmission/JobInvocation.html" target="_top">Frames</a></li> |
| <li><a href="JobInvocation.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><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.runners.fnexecution.jobsubmission</div> |
| <h2 title="Class JobInvocation" class="title">Class JobInvocation</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.runners.fnexecution.jobsubmission.JobInvocation</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">JobInvocation</span> |
| extends java.lang.Object</pre> |
| <div class="block">Internal representation of a Job which has been invoked (prepared and run) by a client.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== 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="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvocation.html#JobInvocation-org.apache.beam.runners.fnexecution.provisioning.JobInfo-org.apache.beam.vendor.guava.v26_0_jre.com.google.common.util.concurrent.ListeningExecutorService-org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline-org.apache.beam.runners.fnexecution.jobsubmission.PortablePipelineRunner-">JobInvocation</a></span>(<a href="../../../../../../org/apache/beam/runners/fnexecution/provisioning/JobInfo.html" title="class in org.apache.beam.runners.fnexecution.provisioning">JobInfo</a> jobInfo, |
| org.apache.beam.vendor.guava.v26_0_jre.com.google.common.util.concurrent.ListeningExecutorService executorService, |
| org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline pipeline, |
| <a href="../../../../../../org/apache/beam/runners/fnexecution/jobsubmission/PortablePipelineRunner.html" title="interface in org.apache.beam.runners.fnexecution.jobsubmission">PortablePipelineRunner</a> pipelineRunner)</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="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/fnexecution/jobsubmission/JobInvocation.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/fnexecution/jobsubmission/JobInvocation.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/fnexecution/jobsubmission/JobInvocation.html#cancel--">cancel</a></span>()</code> |
| <div class="block">Cancel the job.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvocation.html#getId--">getId</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvocation.html#getPipeline--">getPipeline</a></span>()</code> |
| <div class="block">Retrieve the job's pipeline.</div> |
| </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/fnexecution/jobsubmission/JobInvocation.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/fnexecution/jobsubmission/JobInvocation.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> |
| </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="JobInvocation-org.apache.beam.runners.fnexecution.provisioning.JobInfo-org.apache.beam.vendor.guava.v26_0_jre.com.google.common.util.concurrent.ListeningExecutorService-org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline-org.apache.beam.runners.fnexecution.jobsubmission.PortablePipelineRunner-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>JobInvocation</h4> |
| <pre>public JobInvocation(<a href="../../../../../../org/apache/beam/runners/fnexecution/provisioning/JobInfo.html" title="class in org.apache.beam.runners.fnexecution.provisioning">JobInfo</a> jobInfo, |
| org.apache.beam.vendor.guava.v26_0_jre.com.google.common.util.concurrent.ListeningExecutorService executorService, |
| org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline pipeline, |
| <a href="../../../../../../org/apache/beam/runners/fnexecution/jobsubmission/PortablePipelineRunner.html" title="interface in org.apache.beam.runners.fnexecution.jobsubmission">PortablePipelineRunner</a> pipelineRunner)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="start--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>start</h4> |
| <pre>public void start()</pre> |
| <div class="block">Start the job.</div> |
| </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="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">Cancel the job.</div> |
| </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">Retrieve the job's current state.</div> |
| </li> |
| </ul> |
| <a name="getPipeline--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPipeline</h4> |
| <pre>public org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline getPipeline()</pre> |
| <div class="block">Retrieve the job's pipeline.</div> |
| </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">Listen for job state changes with a <code>Consumer</code>.</div> |
| </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">Listen for job messages with a <code>Consumer</code>.</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/runners/fnexecution/jobsubmission/InMemoryJobService.html" title="class in org.apache.beam.runners.fnexecution.jobsubmission"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvoker.html" title="class in org.apache.beam.runners.fnexecution.jobsubmission"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/runners/fnexecution/jobsubmission/JobInvocation.html" target="_top">Frames</a></li> |
| <li><a href="JobInvocation.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><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> |
