blob: edf36fd440f7d0a195a3a66cc2ada4363d600d1b [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_181-google-v7) on Mon Jan 27 16:42:29 PST 2020 -->
<title>SparkJobInvoker (Apache Beam 2.20.0-SNAPSHOT)</title>
<meta name="date" content="2020-01-27">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SparkJobInvoker (Apache Beam 2.20.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":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/spark/SparkContextOptions.EmptyListenersList.html" title="class in org.apache.beam.runners.spark"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/beam/runners/spark/SparkJobServerDriver.html" title="class in org.apache.beam.runners.spark"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/runners/spark/SparkJobInvoker.html" target="_top">Frames</a></li>
<li><a href="SparkJobInvoker.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.spark</div>
<h2 title="Class SparkJobInvoker" class="title">Class SparkJobInvoker</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvoker.html" title="class in org.apache.beam.runners.fnexecution.jobsubmission">org.apache.beam.runners.fnexecution.jobsubmission.JobInvoker</a></li>
<li>
<ul class="inheritance">
<li>org.apache.beam.runners.spark.SparkJobInvoker</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">SparkJobInvoker</span>
extends <a href="../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvoker.html" title="class in org.apache.beam.runners.fnexecution.jobsubmission">JobInvoker</a></pre>
<div class="block">Creates a job invocation to manage the Spark runner's execution of a portable pipeline.</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>static <a href="../../../../../org/apache/beam/runners/spark/SparkJobInvoker.html" title="class in org.apache.beam.runners.spark">SparkJobInvoker</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/spark/SparkJobInvoker.html#create-org.apache.beam.runners.spark.SparkJobServerDriver.SparkServerConfiguration-">create</a></span>(<a href="../../../../../org/apache/beam/runners/spark/SparkJobServerDriver.SparkServerConfiguration.html" title="class in org.apache.beam.runners.spark">SparkJobServerDriver.SparkServerConfiguration</a>&nbsp;configuration)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvocation.html" title="class in org.apache.beam.runners.fnexecution.jobsubmission">JobInvocation</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/spark/SparkJobInvoker.html#invokeWithExecutor-org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline-org.apache.beam.vendor.grpc.v1p26p0.com.google.protobuf.Struct-java.lang.String-org.apache.beam.vendor.guava.v26_0_jre.com.google.common.util.concurrent.ListeningExecutorService-">invokeWithExecutor</a></span>(org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline&nbsp;pipeline,
org.apache.beam.vendor.grpc.v1p26p0.com.google.protobuf.Struct&nbsp;options,
java.lang.String&nbsp;retrievalToken,
org.apache.beam.vendor.guava.v26_0_jre.com.google.common.util.concurrent.ListeningExecutorService&nbsp;executorService)</code>
<div class="block">Start running a job, abstracting its state as a <a href="../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvocation.html" title="class in org.apache.beam.runners.fnexecution.jobsubmission"><code>JobInvocation</code></a> instance.</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&nbsp;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">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="create-org.apache.beam.runners.spark.SparkJobServerDriver.SparkServerConfiguration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/beam/runners/spark/SparkJobInvoker.html" title="class in org.apache.beam.runners.spark">SparkJobInvoker</a>&nbsp;create(<a href="../../../../../org/apache/beam/runners/spark/SparkJobServerDriver.SparkServerConfiguration.html" title="class in org.apache.beam.runners.spark">SparkJobServerDriver.SparkServerConfiguration</a>&nbsp;configuration)</pre>
</li>
</ul>
<a name="invokeWithExecutor-org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline-org.apache.beam.vendor.grpc.v1p26p0.com.google.protobuf.Struct-java.lang.String-org.apache.beam.vendor.guava.v26_0_jre.com.google.common.util.concurrent.ListeningExecutorService-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>invokeWithExecutor</h4>
<pre>protected&nbsp;<a href="../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvocation.html" title="class in org.apache.beam.runners.fnexecution.jobsubmission">JobInvocation</a>&nbsp;invokeWithExecutor(org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline&nbsp;pipeline,
org.apache.beam.vendor.grpc.v1p26p0.com.google.protobuf.Struct&nbsp;options,
<a href="https://static.javadoc.io/com.google.code.findbugs/jsr305/3.0.2/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a>
java.lang.String&nbsp;retrievalToken,
org.apache.beam.vendor.guava.v26_0_jre.com.google.common.util.concurrent.ListeningExecutorService&nbsp;executorService)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvoker.html#invokeWithExecutor-org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline-org.apache.beam.vendor.grpc.v1p26p0.com.google.protobuf.Struct-java.lang.String-org.apache.beam.vendor.guava.v26_0_jre.com.google.common.util.concurrent.ListeningExecutorService-">JobInvoker</a></code></span></div>
<div class="block">Start running a job, abstracting its state as a <a href="../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvocation.html" title="class in org.apache.beam.runners.fnexecution.jobsubmission"><code>JobInvocation</code></a> instance.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvoker.html#invokeWithExecutor-org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline-org.apache.beam.vendor.grpc.v1p26p0.com.google.protobuf.Struct-java.lang.String-org.apache.beam.vendor.guava.v26_0_jre.com.google.common.util.concurrent.ListeningExecutorService-">invokeWithExecutor</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/beam/runners/fnexecution/jobsubmission/JobInvoker.html" title="class in org.apache.beam.runners.fnexecution.jobsubmission">JobInvoker</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/spark/SparkContextOptions.EmptyListenersList.html" title="class in org.apache.beam.runners.spark"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/beam/runners/spark/SparkJobServerDriver.html" title="class in org.apache.beam.runners.spark"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/runners/spark/SparkJobInvoker.html" target="_top">Frames</a></li>
<li><a href="SparkJobInvoker.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>