http://git-wip-us.apache.org/repos/asf/beam-site/blob/c196579f/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/flink/FlinkDetachedRunnerResult.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/flink/FlinkDetachedRunnerResult.html b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/flink/FlinkDetachedRunnerResult.html new file mode 100644 index 0000000..a78a11e --- /dev/null +++ b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/flink/FlinkDetachedRunnerResult.html @@ -0,0 +1,379 @@ +<!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:04 PDT 2017 --> +<title>FlinkDetachedRunnerResult</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="FlinkDetachedRunnerResult"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":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/flink/DefaultParallelismFactory.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/FlinkPipelineOptions.html" title="interface 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/FlinkDetachedRunnerResult.html" target="_top">Frames</a></li> +<li><a href="FlinkDetachedRunnerResult.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 FlinkDetachedRunnerResult" class="title">Class FlinkDetachedRunnerResult</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.flink.FlinkDetachedRunnerResult</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/sdk/PipelineResult.html" title="interface in org.apache.beam.sdk">PipelineResult</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">FlinkDetachedRunnerResult</span> +extends java.lang.Object +implements <a href="../../../../../org/apache/beam/sdk/PipelineResult.html" title="interface in org.apache.beam.sdk">PipelineResult</a></pre> +<div class="block">Result of a detached execution of a <a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> with Flink. + In detached execution, results and job execution are currently unavailable.</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> +<ul class="blockList"> +<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.beam.sdk.PipelineResult"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface org.apache.beam.sdk.<a href="../../../../../org/apache/beam/sdk/PipelineResult.html" title="interface in org.apache.beam.sdk">PipelineResult</a></h3> +<code><a href="../../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a></code></li> +</ul> +</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><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/runners/flink/FlinkDetachedRunnerResult.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/runners/flink/FlinkDetachedRunnerResult.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/runners/flink/FlinkDetachedRunnerResult.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>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkDetachedRunnerResult.html#toString--">toString</a></span>()</code> </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/runners/flink/FlinkDetachedRunnerResult.html#waitUntilFinish--">waitUntilFinish</a></span>()</code> +<div class="block">Waits until the pipeline finishes and returns the final status.</div> +</td> +</tr> +<tr id="i5" 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/runners/flink/FlinkDetachedRunnerResult.html#waitUntilFinish-org.joda.time.Duration-">waitUntilFinish</a></span>(<a href="http://www.joda.org/joda-time/apidocs/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> +<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"> +<!-- ============ 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>public <a href="../../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a> getState()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html#getState--">PipelineResult</a></code></span></div> +<div class="block">Retrieves the current state of the pipeline execution.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html#getState--">getState</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html" title="interface in org.apache.beam.sdk">PipelineResult</a></code></dd> +<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="metrics--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>metrics</h4> +<pre>public <a href="../../../../../org/apache/beam/sdk/metrics/MetricResults.html" title="class in org.apache.beam.sdk.metrics">MetricResults</a> metrics()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html#metrics--">PipelineResult</a></code></span></div> +<div class="block">Returns the object to access metrics from the pipeline.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html#metrics--">metrics</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html" title="interface in org.apache.beam.sdk">PipelineResult</a></code></dd> +</dl> +</li> +</ul> +<a name="cancel--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>cancel</h4> +<pre>public <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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html#cancel--">PipelineResult</a></code></span></div> +<div class="block">Cancels the pipeline execution.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html#cancel--">cancel</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html" title="interface in org.apache.beam.sdk">PipelineResult</a></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if there is a problem executing the cancel request.</dd> +</dl> +</li> +</ul> +<a name="waitUntilFinish--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>waitUntilFinish</h4> +<pre>public <a href="../../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a> waitUntilFinish()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html#waitUntilFinish--">PipelineResult</a></code></span></div> +<div class="block">Waits until the pipeline finishes and returns the final status.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html#waitUntilFinish--">waitUntilFinish</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html" title="interface in org.apache.beam.sdk">PipelineResult</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The final state of the pipeline.</dd> +</dl> +</li> +</ul> +<a name="waitUntilFinish-org.joda.time.Duration-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>waitUntilFinish</h4> +<pre>public <a href="../../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a> waitUntilFinish(<a href="http://www.joda.org/joda-time/apidocs/org/joda/time/Duration.html?is-external=true"; title="class or interface in org.joda.time">Duration</a> duration)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html#waitUntilFinish-org.joda.time.Duration-">PipelineResult</a></code></span></div> +<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="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html#waitUntilFinish-org.joda.time.Duration-">waitUntilFinish</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html" title="interface in org.apache.beam.sdk">PipelineResult</a></code></dd> +<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> +</dl> +</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><a href="../../../../../org/apache/beam/runners/flink/DefaultParallelismFactory.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/FlinkPipelineOptions.html" title="interface 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/FlinkDetachedRunnerResult.html" target="_top">Frames</a></li> +<li><a href="FlinkDetachedRunnerResult.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>
http://git-wip-us.apache.org/repos/asf/beam-site/blob/c196579f/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/flink/FlinkPipelineOptions.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/flink/FlinkPipelineOptions.html b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/flink/FlinkPipelineOptions.html new file mode 100644 index 0000000..edffc29 --- /dev/null +++ b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/flink/FlinkPipelineOptions.html @@ -0,0 +1,570 @@ +<!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:04 PDT 2017 --> +<title>FlinkPipelineOptions</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="FlinkPipelineOptions"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":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/runners/flink/FlinkDetachedRunnerResult.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/FlinkRunner.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/FlinkPipelineOptions.html" target="_top">Frames</a></li> +<li><a href="FlinkPipelineOptions.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="Interface FlinkPipelineOptions" class="title">Interface FlinkPipelineOptions</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../../org/apache/beam/sdk/options/ApplicationNameOptions.html" title="interface in org.apache.beam.sdk.options">ApplicationNameOptions</a>, <a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a>, <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a>, <a href="../../../../../org/apache/beam/sdk/options/StreamingOptions.html" title="interface in org.apache.beam.sdk.options">StreamingOptions</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">FlinkPipelineOptions</span> +extends <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a>, <a href="../../../../../org/apache/beam/sdk/options/ApplicationNameOptions.html" title="interface in org.apache.beam.sdk.options">ApplicationNameOptions</a>, <a href="../../../../../org/apache/beam/sdk/options/StreamingOptions.html" title="interface in org.apache.beam.sdk.options">StreamingOptions</a></pre> +<div class="block">Options which can be used to configure a Flink PipelineRunner.</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> +<ul class="blockList"> +<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.beam.sdk.options.PipelineOptions"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface org.apache.beam.sdk.options.<a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a></h3> +<code><a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.AtomicLongFactory.html" title="class in org.apache.beam.sdk.options">PipelineOptions.AtomicLongFactory</a>, <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.CheckEnabled.html" title="enum in org.apache.beam.sdk.options">PipelineOptions.CheckEnabled</a>, <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.DirectRunner.html" title="class in org.apache.beam.sdk.options">PipelineOptions.DirectRunner</a>, <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.JobNameFactory.html" title="class in org.apache.beam.sdk.options">PipelineOptions.JobNameFactory</a></code></li> +</ul> +</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>java.lang.Long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkPipelineOptions.html#getCheckpointingInterval--">getCheckpointingInterval</a></span>()</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>java.lang.Boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkPipelineOptions.html#getEnableMetrics--">getEnableMetrics</a></span>()</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>java.lang.Long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkPipelineOptions.html#getExecutionRetryDelay--">getExecutionRetryDelay</a></span>()</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>java.util.List<java.lang.String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkPipelineOptions.html#getFilesToStage--">getFilesToStage</a></span>()</code> +<div class="block">List of local files to make available to workers.</div> +</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/FlinkPipelineOptions.html#getFlinkMaster--">getFlinkMaster</a></span>()</code> +<div class="block">The url of the Flink JobManager on which to execute pipelines.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>java.lang.Integer</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkPipelineOptions.html#getNumberOfExecutionRetries--">getNumberOfExecutionRetries</a></span>()</code> </td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>java.lang.Boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkPipelineOptions.html#getObjectReuse--">getObjectReuse</a></span>()</code> </td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>java.lang.Integer</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkPipelineOptions.html#getParallelism--">getParallelism</a></span>()</code> </td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>java.lang.Boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkPipelineOptions.html#getRetainExternalizedCheckpointsOnCancellation--">getRetainExternalizedCheckpointsOnCancellation</a></span>()</code> </td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>org.apache.flink.runtime.state.AbstractStateBackend</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkPipelineOptions.html#getStateBackend--">getStateBackend</a></span>()</code> +<div class="block">State backend to store Beam's state during computation.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>java.lang.Boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkPipelineOptions.html#isExternalizedCheckpointsEnabled--">isExternalizedCheckpointsEnabled</a></span>()</code> +<div class="block">Enables or disables externalized checkpoints.</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/runners/flink/FlinkPipelineOptions.html#setCheckpointingInterval-java.lang.Long-">setCheckpointingInterval</a></span>(java.lang.Long interval)</code> </td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkPipelineOptions.html#setEnableMetrics-java.lang.Boolean-">setEnableMetrics</a></span>(java.lang.Boolean enableMetrics)</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/runners/flink/FlinkPipelineOptions.html#setExecutionRetryDelay-java.lang.Long-">setExecutionRetryDelay</a></span>(java.lang.Long delay)</code> </td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkPipelineOptions.html#setExternalizedCheckpointsEnabled-java.lang.Boolean-">setExternalizedCheckpointsEnabled</a></span>(java.lang.Boolean externalCheckpoints)</code> </td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkPipelineOptions.html#setFilesToStage-java.util.List-">setFilesToStage</a></span>(java.util.List<java.lang.String> value)</code> </td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkPipelineOptions.html#setFlinkMaster-java.lang.String-">setFlinkMaster</a></span>(java.lang.String value)</code> </td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkPipelineOptions.html#setNumberOfExecutionRetries-java.lang.Integer-">setNumberOfExecutionRetries</a></span>(java.lang.Integer retries)</code> </td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkPipelineOptions.html#setObjectReuse-java.lang.Boolean-">setObjectReuse</a></span>(java.lang.Boolean reuse)</code> </td> +</tr> +<tr id="i19" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkPipelineOptions.html#setParallelism-java.lang.Integer-">setParallelism</a></span>(java.lang.Integer value)</code> </td> +</tr> +<tr id="i20" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkPipelineOptions.html#setRetainExternalizedCheckpointsOnCancellation-java.lang.Boolean-">setRetainExternalizedCheckpointsOnCancellation</a></span>(java.lang.Boolean retainOnCancellation)</code> </td> +</tr> +<tr id="i21" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkPipelineOptions.html#setStateBackend-org.apache.flink.runtime.state.AbstractStateBackend-">setStateBackend</a></span>(org.apache.flink.runtime.state.AbstractStateBackend stateBackend)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.options.StreamingOptions"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.beam.sdk.options.<a href="../../../../../org/apache/beam/sdk/options/StreamingOptions.html" title="interface in org.apache.beam.sdk.options">StreamingOptions</a></h3> +<code><a href="../../../../../org/apache/beam/sdk/options/StreamingOptions.html#isStreaming--">isStreaming</a>, <a href="../../../../../org/apache/beam/sdk/options/StreamingOptions.html#setStreaming-boolean-">setStreaming</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.options.ApplicationNameOptions"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.beam.sdk.options.<a href="../../../../../org/apache/beam/sdk/options/ApplicationNameOptions.html" title="interface in org.apache.beam.sdk.options">ApplicationNameOptions</a></h3> +<code><a href="../../../../../org/apache/beam/sdk/options/ApplicationNameOptions.html#getAppName--">getAppName</a>, <a href="../../../../../org/apache/beam/sdk/options/ApplicationNameOptions.html#setAppName-java.lang.String-">setAppName</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.options.PipelineOptions"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.beam.sdk.options.<a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a></h3> +<code><a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html#as-java.lang.Class-">as</a>, <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html#getJobName--">getJobName</a>, <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html#getOptionsId--">getOptionsId</a>, <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html#getRunner--">getRunner</a>, <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html#getStableUniqueNames--">getStableUniqueNames</a>, <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html#getTempLocation--">getTempLocation</a>, <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html#outputRuntimeOptions--">outputRuntimeOptions</a>, <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html#setJobName-java.lang.String-">setJobName</a>, <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html#setOptionsId-long-">setOpti onsId</a>, <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html#setRunner-java.lang.Class-">setRunner</a>, <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html#setStableUniqueNames-org.apache.beam.sdk.options.PipelineOptions.CheckEnabled-">setStableUniqueNames</a>, <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html#setTempLocation-java.lang.String-">setTempLocation</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.transforms.display.HasDisplayData"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.beam.sdk.transforms.display.<a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></h3> +<code><a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</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="getFilesToStage--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilesToStage</h4> +<pre>java.util.List<java.lang.String> getFilesToStage()</pre> +<div class="block">List of local files to make available to workers. + + <p>Jars are placed on the worker's classpath. + + <p>The default value is the list of jars from the main program's classpath.</div> +</li> +</ul> +<a name="setFilesToStage-java.util.List-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFilesToStage</h4> +<pre>void setFilesToStage(java.util.List<java.lang.String> value)</pre> +</li> +</ul> +<a name="getFlinkMaster--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFlinkMaster</h4> +<pre>java.lang.String getFlinkMaster()</pre> +<div class="block">The url of the Flink JobManager on which to execute pipelines. This can either be + the the address of a cluster JobManager, in the form "host:port" or one of the special + Strings "[local]", "[collection]" or "[auto]". "[local]" will start a local Flink + Cluster in the JVM, "[collection]" will execute the pipeline on Java Collections while + "[auto]" will let the system decide where to execute the pipeline based on the environment.</div> +</li> +</ul> +<a name="setFlinkMaster-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFlinkMaster</h4> +<pre>void setFlinkMaster(java.lang.String value)</pre> +</li> +</ul> +<a name="getParallelism--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getParallelism</h4> +<pre><a href="../../../../../org/apache/beam/sdk/options/Default.InstanceFactory.html" title="annotation in org.apache.beam.sdk.options">@Default.InstanceFactory</a>(<a href="../../../../../org/apache/beam/sdk/options/Default.InstanceFactory.html#value--">value</a>=<a href="../../../../../org/apache/beam/runners/flink/DefaultParallelismFactory.html" title="class in org.apache.beam.runners.flink">DefaultParallelismFactory.class</a>) +java.lang.Integer getParallelism()</pre> +</li> +</ul> +<a name="setParallelism-java.lang.Integer-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setParallelism</h4> +<pre>void setParallelism(java.lang.Integer value)</pre> +</li> +</ul> +<a name="getCheckpointingInterval--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCheckpointingInterval</h4> +<pre><a href="../../../../../org/apache/beam/sdk/options/Default.Long.html" title="annotation in org.apache.beam.sdk.options">@Default.Long</a>(<a href="../../../../../org/apache/beam/sdk/options/Default.Long.html#value--">value</a>=-1L) +java.lang.Long getCheckpointingInterval()</pre> +</li> +</ul> +<a name="setCheckpointingInterval-java.lang.Long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCheckpointingInterval</h4> +<pre>void setCheckpointingInterval(java.lang.Long interval)</pre> +</li> +</ul> +<a name="getNumberOfExecutionRetries--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNumberOfExecutionRetries</h4> +<pre><a href="../../../../../org/apache/beam/sdk/options/Default.Integer.html" title="annotation in org.apache.beam.sdk.options">@Default.Integer</a>(<a href="../../../../../org/apache/beam/sdk/options/Default.Integer.html#value--">value</a>=-1) +java.lang.Integer getNumberOfExecutionRetries()</pre> +</li> +</ul> +<a name="setNumberOfExecutionRetries-java.lang.Integer-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setNumberOfExecutionRetries</h4> +<pre>void setNumberOfExecutionRetries(java.lang.Integer retries)</pre> +</li> +</ul> +<a name="getExecutionRetryDelay--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExecutionRetryDelay</h4> +<pre><a href="../../../../../org/apache/beam/sdk/options/Default.Long.html" title="annotation in org.apache.beam.sdk.options">@Default.Long</a>(<a href="../../../../../org/apache/beam/sdk/options/Default.Long.html#value--">value</a>=-1L) +java.lang.Long getExecutionRetryDelay()</pre> +</li> +</ul> +<a name="setExecutionRetryDelay-java.lang.Long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setExecutionRetryDelay</h4> +<pre>void setExecutionRetryDelay(java.lang.Long delay)</pre> +</li> +</ul> +<a name="getObjectReuse--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getObjectReuse</h4> +<pre><a href="../../../../../org/apache/beam/sdk/options/Default.Boolean.html" title="annotation in org.apache.beam.sdk.options">@Default.Boolean</a>(<a href="../../../../../org/apache/beam/sdk/options/Default.Boolean.html#value--">value</a>=false) +java.lang.Boolean getObjectReuse()</pre> +</li> +</ul> +<a name="setObjectReuse-java.lang.Boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setObjectReuse</h4> +<pre>void setObjectReuse(java.lang.Boolean reuse)</pre> +</li> +</ul> +<a name="getStateBackend--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStateBackend</h4> +<pre>org.apache.flink.runtime.state.AbstractStateBackend getStateBackend()</pre> +<div class="block">State backend to store Beam's state during computation. + Note: Only applicable when executing in streaming mode.</div> +</li> +</ul> +<a name="setStateBackend-org.apache.flink.runtime.state.AbstractStateBackend-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setStateBackend</h4> +<pre>void setStateBackend(org.apache.flink.runtime.state.AbstractStateBackend stateBackend)</pre> +</li> +</ul> +<a name="getEnableMetrics--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEnableMetrics</h4> +<pre><a href="../../../../../org/apache/beam/sdk/options/Default.Boolean.html" title="annotation in org.apache.beam.sdk.options">@Default.Boolean</a>(<a href="../../../../../org/apache/beam/sdk/options/Default.Boolean.html#value--">value</a>=true) +java.lang.Boolean getEnableMetrics()</pre> +</li> +</ul> +<a name="setEnableMetrics-java.lang.Boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setEnableMetrics</h4> +<pre>void setEnableMetrics(java.lang.Boolean enableMetrics)</pre> +</li> +</ul> +<a name="isExternalizedCheckpointsEnabled--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isExternalizedCheckpointsEnabled</h4> +<pre><a href="../../../../../org/apache/beam/sdk/options/Default.Boolean.html" title="annotation in org.apache.beam.sdk.options">@Default.Boolean</a>(<a href="../../../../../org/apache/beam/sdk/options/Default.Boolean.html#value--">value</a>=false) +java.lang.Boolean isExternalizedCheckpointsEnabled()</pre> +<div class="block">Enables or disables externalized checkpoints.</div> +</li> +</ul> +<a name="setExternalizedCheckpointsEnabled-java.lang.Boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setExternalizedCheckpointsEnabled</h4> +<pre>void setExternalizedCheckpointsEnabled(java.lang.Boolean externalCheckpoints)</pre> +</li> +</ul> +<a name="getRetainExternalizedCheckpointsOnCancellation--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRetainExternalizedCheckpointsOnCancellation</h4> +<pre><a href="../../../../../org/apache/beam/sdk/options/Default.Boolean.html" title="annotation in org.apache.beam.sdk.options">@Default.Boolean</a>(<a href="../../../../../org/apache/beam/sdk/options/Default.Boolean.html#value--">value</a>=false) +java.lang.Boolean getRetainExternalizedCheckpointsOnCancellation()</pre> +</li> +</ul> +<a name="setRetainExternalizedCheckpointsOnCancellation-java.lang.Boolean-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setRetainExternalizedCheckpointsOnCancellation</h4> +<pre>void setRetainExternalizedCheckpointsOnCancellation(java.lang.Boolean retainOnCancellation)</pre> +</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/FlinkDetachedRunnerResult.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/FlinkRunner.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/FlinkPipelineOptions.html" target="_top">Frames</a></li> +<li><a href="FlinkPipelineOptions.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> http://git-wip-us.apache.org/repos/asf/beam-site/blob/c196579f/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/flink/FlinkRunner.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/flink/FlinkRunner.html b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/flink/FlinkRunner.html new file mode 100644 index 0000000..f145a3c --- /dev/null +++ b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/flink/FlinkRunner.html @@ -0,0 +1,334 @@ +<!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:04 PDT 2017 --> +<title>FlinkRunner</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="FlinkRunner"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9,"i2":10,"i3":10,"i4":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/FlinkPipelineOptions.html" title="interface in org.apache.beam.runners.flink"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/flink/FlinkRunnerRegistrar.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/FlinkRunner.html" target="_top">Frames</a></li> +<li><a href="FlinkRunner.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 FlinkRunner" class="title">Class FlinkRunner</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/beam/sdk/PipelineRunner.html" title="class in org.apache.beam.sdk">org.apache.beam.sdk.PipelineRunner</a><<a href="../../../../../org/apache/beam/sdk/PipelineResult.html" title="interface in org.apache.beam.sdk">PipelineResult</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.flink.FlinkRunner</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">FlinkRunner</span> +extends <a href="../../../../../org/apache/beam/sdk/PipelineRunner.html" title="class in org.apache.beam.sdk">PipelineRunner</a><<a href="../../../../../org/apache/beam/sdk/PipelineResult.html" title="interface in org.apache.beam.sdk">PipelineResult</a>></pre> +<div class="block">A <a href="../../../../../org/apache/beam/sdk/PipelineRunner.html" title="class in org.apache.beam.sdk"><code>PipelineRunner</code></a> that executes the operations in the + pipeline by first translating them to a Flink Plan and then executing them either locally + or on a Flink cluster, depending on the configuration.</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>protected static java.util.List<java.lang.String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkRunner.html#detectClassPathResourcesToStage-java.lang.ClassLoader-">detectClassPathResourcesToStage</a></span>(java.lang.ClassLoader classLoader)</code> +<div class="block">Attempts to detect all the resources the class loader has access to.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/beam/runners/flink/FlinkRunner.html" title="class in org.apache.beam.runners.flink">FlinkRunner</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkRunner.html#fromOptions-org.apache.beam.sdk.options.PipelineOptions-">fromOptions</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">Construct a runner from the provided options.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/runners/flink/FlinkPipelineOptions.html" title="interface in org.apache.beam.runners.flink">FlinkPipelineOptions</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkRunner.html#getPipelineOptions--">getPipelineOptions</a></span>()</code> +<div class="block">For testing.</div> +</td> +</tr> +<tr id="i3" 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/runners/flink/FlinkRunner.html#run-org.apache.beam.sdk.Pipeline-">run</a></span>(<a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk">Pipeline</a> pipeline)</code> +<div class="block">Processes the given <a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a>, potentially asynchronously, returning a runner-specific + type of result.</div> +</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/FlinkRunner.html#toString--">toString</a></span>()</code> </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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="fromOptions-org.apache.beam.sdk.options.PipelineOptions-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fromOptions</h4> +<pre>public static <a href="../../../../../org/apache/beam/runners/flink/FlinkRunner.html" title="class in org.apache.beam.runners.flink">FlinkRunner</a> fromOptions(<a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a> options)</pre> +<div class="block">Construct a runner from the provided options.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>options</code> - Properties which configure the runner.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The newly created runner.</dd> +</dl> +</li> +</ul> +<a name="run-org.apache.beam.sdk.Pipeline-"> +<!-- --> +</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/Pipeline.html" title="class in org.apache.beam.sdk">Pipeline</a> pipeline)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/beam/sdk/PipelineRunner.html#run-org.apache.beam.sdk.Pipeline-">PipelineRunner</a></code></span></div> +<div class="block">Processes the given <a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a>, potentially asynchronously, returning a runner-specific + type of result.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/PipelineRunner.html#run-org.apache.beam.sdk.Pipeline-">run</a></code> in class <code><a href="../../../../../org/apache/beam/sdk/PipelineRunner.html" title="class in org.apache.beam.sdk">PipelineRunner</a><<a href="../../../../../org/apache/beam/sdk/PipelineResult.html" title="interface in org.apache.beam.sdk">PipelineResult</a>></code></dd> +</dl> +</li> +</ul> +<a name="getPipelineOptions--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPipelineOptions</h4> +<pre>public <a href="../../../../../org/apache/beam/runners/flink/FlinkPipelineOptions.html" title="interface in org.apache.beam.runners.flink">FlinkPipelineOptions</a> getPipelineOptions()</pre> +<div class="block">For testing.</div> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockList"> +<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> +<a name="detectClassPathResourcesToStage-java.lang.ClassLoader-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>detectClassPathResourcesToStage</h4> +<pre>protected static java.util.List<java.lang.String> detectClassPathResourcesToStage(java.lang.ClassLoader classLoader)</pre> +<div class="block">Attempts to detect all the resources the class loader has access to. This does not recurse + to class loader parents stopping it from pulling in resources from the system class loader.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>classLoader</code> - The URLClassLoader to use to detect resources to stage.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A list of absolute paths to the resources the class loader uses.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - If either the class loader is not a URLClassLoader or one + of the resources the class loader exposes is not a file resource.</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/FlinkPipelineOptions.html" title="interface in org.apache.beam.runners.flink"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/flink/FlinkRunnerRegistrar.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/FlinkRunner.html" target="_top">Frames</a></li> +<li><a href="FlinkRunner.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> http://git-wip-us.apache.org/repos/asf/beam-site/blob/c196579f/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/flink/FlinkRunnerRegistrar.Options.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/flink/FlinkRunnerRegistrar.Options.html b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/flink/FlinkRunnerRegistrar.Options.html new file mode 100644 index 0000000..029fe98 --- /dev/null +++ b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/flink/FlinkRunnerRegistrar.Options.html @@ -0,0 +1,284 @@ +<!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:04 PDT 2017 --> +<title>FlinkRunnerRegistrar.Options</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="FlinkRunnerRegistrar.Options"; + } + } + catch(err) { + } +//--> +var methods = {"i0":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/flink/FlinkRunnerRegistrar.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/FlinkRunnerRegistrar.Runner.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/FlinkRunnerRegistrar.Options.html" target="_top">Frames</a></li> +<li><a href="FlinkRunnerRegistrar.Options.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.flink</div> +<h2 title="Class FlinkRunnerRegistrar.Options" class="title">Class FlinkRunnerRegistrar.Options</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.flink.FlinkRunnerRegistrar.Options</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/sdk/options/PipelineOptionsRegistrar.html" title="interface in org.apache.beam.sdk.options">PipelineOptionsRegistrar</a></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../org/apache/beam/runners/flink/FlinkRunnerRegistrar.html" title="class in org.apache.beam.runners.flink">FlinkRunnerRegistrar</a></dd> +</dl> +<hr> +<br> +<pre>@AutoService(value=<a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsRegistrar.html" title="interface in org.apache.beam.sdk.options">PipelineOptionsRegistrar.class</a>) +public static class <span class="typeNameLabel">FlinkRunnerRegistrar.Options</span> +extends java.lang.Object +implements <a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsRegistrar.html" title="interface in org.apache.beam.sdk.options">PipelineOptionsRegistrar</a></pre> +<div class="block">Pipeline options registrar.</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/flink/FlinkRunnerRegistrar.Options.html#Options--">Options</a></span>()</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>java.lang.Iterable<java.lang.Class<? extends <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a>>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkRunnerRegistrar.Options.html#getPipelineOptions--">getPipelineOptions</a></span>()</code> </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="Options--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Options</h4> +<pre>public 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="getPipelineOptions--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getPipelineOptions</h4> +<pre>public java.lang.Iterable<java.lang.Class<? extends <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a>>> getPipelineOptions()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsRegistrar.html#getPipelineOptions--">getPipelineOptions</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsRegistrar.html" title="interface in org.apache.beam.sdk.options">PipelineOptionsRegistrar</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/FlinkRunnerRegistrar.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/FlinkRunnerRegistrar.Runner.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/FlinkRunnerRegistrar.Options.html" target="_top">Frames</a></li> +<li><a href="FlinkRunnerRegistrar.Options.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> http://git-wip-us.apache.org/repos/asf/beam-site/blob/c196579f/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/flink/FlinkRunnerRegistrar.Runner.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/flink/FlinkRunnerRegistrar.Runner.html b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/flink/FlinkRunnerRegistrar.Runner.html new file mode 100644 index 0000000..d90d2e6 --- /dev/null +++ b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/flink/FlinkRunnerRegistrar.Runner.html @@ -0,0 +1,288 @@ +<!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:04 PDT 2017 --> +<title>FlinkRunnerRegistrar.Runner</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="FlinkRunnerRegistrar.Runner"; + } + } + catch(err) { + } +//--> +var methods = {"i0":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/flink/FlinkRunnerRegistrar.Options.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/FlinkRunnerResult.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/FlinkRunnerRegistrar.Runner.html" target="_top">Frames</a></li> +<li><a href="FlinkRunnerRegistrar.Runner.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.flink</div> +<h2 title="Class FlinkRunnerRegistrar.Runner" class="title">Class FlinkRunnerRegistrar.Runner</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.flink.FlinkRunnerRegistrar.Runner</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>org.apache.beam.sdk.runners.PipelineRunnerRegistrar</dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../org/apache/beam/runners/flink/FlinkRunnerRegistrar.html" title="class in org.apache.beam.runners.flink">FlinkRunnerRegistrar</a></dd> +</dl> +<hr> +<br> +<pre>@AutoService(value=org.apache.beam.sdk.runners.PipelineRunnerRegistrar.class) +public static class <span class="typeNameLabel">FlinkRunnerRegistrar.Runner</span> +extends java.lang.Object +implements org.apache.beam.sdk.runners.PipelineRunnerRegistrar</pre> +<div class="block">Pipeline runner registrar.</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/flink/FlinkRunnerRegistrar.Runner.html#Runner--">Runner</a></span>()</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>java.lang.Iterable<java.lang.Class<? extends <a href="../../../../../org/apache/beam/sdk/PipelineRunner.html" title="class in org.apache.beam.sdk">PipelineRunner</a><?>>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkRunnerRegistrar.Runner.html#getPipelineRunners--">getPipelineRunners</a></span>()</code> +<div class="block">Get the set of <a href="../../../../../org/apache/beam/sdk/PipelineRunner.html" title="class in org.apache.beam.sdk"><code>PipelineRunners</code></a> to register.</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="Runner--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Runner</h4> +<pre>public Runner()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getPipelineRunners--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getPipelineRunners</h4> +<pre>public java.lang.Iterable<java.lang.Class<? extends <a href="../../../../../org/apache/beam/sdk/PipelineRunner.html" title="class in org.apache.beam.sdk">PipelineRunner</a><?>>> getPipelineRunners()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code>org.apache.beam.sdk.runners.PipelineRunnerRegistrar</code></span></div> +<div class="block">Get the set of <a href="../../../../../org/apache/beam/sdk/PipelineRunner.html" title="class in org.apache.beam.sdk"><code>PipelineRunners</code></a> to register.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>getPipelineRunners</code> in interface <code>org.apache.beam.sdk.runners.PipelineRunnerRegistrar</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/FlinkRunnerRegistrar.Options.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/FlinkRunnerResult.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/FlinkRunnerRegistrar.Runner.html" target="_top">Frames</a></li> +<li><a href="FlinkRunnerRegistrar.Runner.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>
