http://git-wip-us.apache.org/repos/asf/beam-site/blob/c196579f/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/spark/SparkPipelineOptions.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/spark/SparkPipelineOptions.html b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/spark/SparkPipelineOptions.html new file mode 100644 index 0000000..a46f165 --- /dev/null +++ b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/spark/SparkPipelineOptions.html @@ -0,0 +1,543 @@ +<!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>SparkPipelineOptions</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="SparkPipelineOptions"; + } + } + 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}; +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/spark/SparkNativePipelineVisitor.html" title="class in org.apache.beam.runners.spark"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/spark/SparkPipelineOptions.TmpCheckpointDirFactory.html" title="class in org.apache.beam.runners.spark"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/spark/SparkPipelineOptions.html" target="_top">Frames</a></li> +<li><a href="SparkPipelineOptions.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.class.summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.beam.runners.spark</div> +<h2 title="Interface SparkPipelineOptions" class="title">Interface SparkPipelineOptions</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> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../../org/apache/beam/runners/spark/SparkContextOptions.html" title="interface in org.apache.beam.runners.spark">SparkContextOptions</a>, <a href="../../../../../org/apache/beam/runners/spark/TestSparkPipelineOptions.html" title="interface in org.apache.beam.runners.spark">TestSparkPipelineOptions</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">SparkPipelineOptions</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/StreamingOptions.html" title="interface in org.apache.beam.sdk.options">StreamingOptions</a>, <a href="../../../../../org/apache/beam/sdk/options/ApplicationNameOptions.html" title="interface in org.apache.beam.sdk.options">ApplicationNameOptions</a></pre> +<div class="block">Spark runner <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> handles Spark execution-related configurations, + such as the master address, batch-interval, and other user-related knobs.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/spark/SparkPipelineOptions.TmpCheckpointDirFactory.html" title="class in org.apache.beam.runners.spark">SparkPipelineOptions.TmpCheckpointDirFactory</a></span></code> +<div class="block">Returns the default checkpoint directory of /tmp/${job.name}.</div> +</td> +</tr> +</table> +<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/spark/SparkPipelineOptions.html#getBatchIntervalMillis--">getBatchIntervalMillis</a></span>()</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/spark/SparkPipelineOptions.html#getCheckpointDir--">getCheckpointDir</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/spark/SparkPipelineOptions.html#getCheckpointDurationMillis--">getCheckpointDurationMillis</a></span>()</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>java.lang.Boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/spark/SparkPipelineOptions.html#getEnableSparkMetricSinks--">getEnableSparkMetricSinks</a></span>()</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>java.lang.Long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/spark/SparkPipelineOptions.html#getMaxRecordsPerBatch--">getMaxRecordsPerBatch</a></span>()</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>java.lang.Long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/spark/SparkPipelineOptions.html#getMinReadTimeMillis--">getMinReadTimeMillis</a></span>()</code> </td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>java.lang.Double</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/spark/SparkPipelineOptions.html#getReadTimePercentage--">getReadTimePercentage</a></span>()</code> </td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/spark/SparkPipelineOptions.html#getSparkMaster--">getSparkMaster</a></span>()</code> </td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/spark/SparkPipelineOptions.html#getStorageLevel--">getStorageLevel</a></span>()</code> </td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/spark/SparkPipelineOptions.html#getUsesProvidedSparkContext--">getUsesProvidedSparkContext</a></span>()</code> </td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/spark/SparkPipelineOptions.html#setBatchIntervalMillis-java.lang.Long-">setBatchIntervalMillis</a></span>(java.lang.Long batchInterval)</code> </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/spark/SparkPipelineOptions.html#setCheckpointDir-java.lang.String-">setCheckpointDir</a></span>(java.lang.String checkpointDir)</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/spark/SparkPipelineOptions.html#setCheckpointDurationMillis-java.lang.Long-">setCheckpointDurationMillis</a></span>(java.lang.Long durationMillis)</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/spark/SparkPipelineOptions.html#setEnableSparkMetricSinks-java.lang.Boolean-">setEnableSparkMetricSinks</a></span>(java.lang.Boolean enableSparkMetricSinks)</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/spark/SparkPipelineOptions.html#setMaxRecordsPerBatch-java.lang.Long-">setMaxRecordsPerBatch</a></span>(java.lang.Long maxRecordsPerBatch)</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/spark/SparkPipelineOptions.html#setMinReadTimeMillis-java.lang.Long-">setMinReadTimeMillis</a></span>(java.lang.Long minReadTimeMillis)</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/spark/SparkPipelineOptions.html#setReadTimePercentage-java.lang.Double-">setReadTimePercentage</a></span>(java.lang.Double readTimePercentage)</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/spark/SparkPipelineOptions.html#setSparkMaster-java.lang.String-">setSparkMaster</a></span>(java.lang.String master)</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/spark/SparkPipelineOptions.html#setStorageLevel-java.lang.String-">setStorageLevel</a></span>(java.lang.String storageLevel)</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/spark/SparkPipelineOptions.html#setUsesProvidedSparkContext-boolean-">setUsesProvidedSparkContext</a></span>(boolean value)</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="getSparkMaster--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSparkMaster</h4> +<pre><a href="../../../../../org/apache/beam/sdk/options/Default.String.html" title="annotation in org.apache.beam.sdk.options">@Default.String</a>(<a href="../../../../../org/apache/beam/sdk/options/Default.String.html#value--">value</a>="local[4]") +java.lang.String getSparkMaster()</pre> +</li> +</ul> +<a name="setSparkMaster-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSparkMaster</h4> +<pre>void setSparkMaster(java.lang.String master)</pre> +</li> +</ul> +<a name="getBatchIntervalMillis--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBatchIntervalMillis</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>=500L) +java.lang.Long getBatchIntervalMillis()</pre> +</li> +</ul> +<a name="setBatchIntervalMillis-java.lang.Long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBatchIntervalMillis</h4> +<pre>void setBatchIntervalMillis(java.lang.Long batchInterval)</pre> +</li> +</ul> +<a name="getStorageLevel--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorageLevel</h4> +<pre><a href="../../../../../org/apache/beam/sdk/options/Default.String.html" title="annotation in org.apache.beam.sdk.options">@Default.String</a>(<a href="../../../../../org/apache/beam/sdk/options/Default.String.html#value--">value</a>="MEMORY_ONLY") +java.lang.String getStorageLevel()</pre> +</li> +</ul> +<a name="setStorageLevel-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setStorageLevel</h4> +<pre>void setStorageLevel(java.lang.String storageLevel)</pre> +</li> +</ul> +<a name="getMinReadTimeMillis--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMinReadTimeMillis</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>=200L) +java.lang.Long getMinReadTimeMillis()</pre> +</li> +</ul> +<a name="setMinReadTimeMillis-java.lang.Long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMinReadTimeMillis</h4> +<pre>void setMinReadTimeMillis(java.lang.Long minReadTimeMillis)</pre> +</li> +</ul> +<a name="getMaxRecordsPerBatch--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMaxRecordsPerBatch</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 getMaxRecordsPerBatch()</pre> +</li> +</ul> +<a name="setMaxRecordsPerBatch-java.lang.Long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaxRecordsPerBatch</h4> +<pre>void setMaxRecordsPerBatch(java.lang.Long maxRecordsPerBatch)</pre> +</li> +</ul> +<a name="getReadTimePercentage--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReadTimePercentage</h4> +<pre><a href="../../../../../org/apache/beam/sdk/options/Default.Double.html" title="annotation in org.apache.beam.sdk.options">@Default.Double</a>(<a href="../../../../../org/apache/beam/sdk/options/Default.Double.html#value--">value</a>=0.1) +java.lang.Double getReadTimePercentage()</pre> +</li> +</ul> +<a name="setReadTimePercentage-java.lang.Double-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setReadTimePercentage</h4> +<pre>void setReadTimePercentage(java.lang.Double readTimePercentage)</pre> +</li> +</ul> +<a name="getCheckpointDir--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCheckpointDir</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/spark/SparkPipelineOptions.TmpCheckpointDirFactory.html" title="class in org.apache.beam.runners.spark">SparkPipelineOptions.TmpCheckpointDirFactory.class</a>) +java.lang.String getCheckpointDir()</pre> +</li> +</ul> +<a name="setCheckpointDir-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCheckpointDir</h4> +<pre>void setCheckpointDir(java.lang.String checkpointDir)</pre> +</li> +</ul> +<a name="getCheckpointDurationMillis--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCheckpointDurationMillis</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 getCheckpointDurationMillis()</pre> +</li> +</ul> +<a name="setCheckpointDurationMillis-java.lang.Long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCheckpointDurationMillis</h4> +<pre>void setCheckpointDurationMillis(java.lang.Long durationMillis)</pre> +</li> +</ul> +<a name="getEnableSparkMetricSinks--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEnableSparkMetricSinks</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 getEnableSparkMetricSinks()</pre> +</li> +</ul> +<a name="setEnableSparkMetricSinks-java.lang.Boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setEnableSparkMetricSinks</h4> +<pre>void setEnableSparkMetricSinks(java.lang.Boolean enableSparkMetricSinks)</pre> +</li> +</ul> +<a name="getUsesProvidedSparkContext--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUsesProvidedSparkContext</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) +boolean getUsesProvidedSparkContext()</pre> +</li> +</ul> +<a name="setUsesProvidedSparkContext-boolean-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setUsesProvidedSparkContext</h4> +<pre>void setUsesProvidedSparkContext(boolean value)</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/spark/SparkNativePipelineVisitor.html" title="class in org.apache.beam.runners.spark"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/spark/SparkPipelineOptions.TmpCheckpointDirFactory.html" title="class in org.apache.beam.runners.spark"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/spark/SparkPipelineOptions.html" target="_top">Frames</a></li> +<li><a href="SparkPipelineOptions.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.class.summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/beam-site/blob/c196579f/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/spark/SparkPipelineResult.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/spark/SparkPipelineResult.html b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/spark/SparkPipelineResult.html new file mode 100644 index 0000000..53f4642 --- /dev/null +++ b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/spark/SparkPipelineResult.html @@ -0,0 +1,462 @@ +<!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>SparkPipelineResult</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="SparkPipelineResult"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":10,"i2":10,"i3":10,"i4":6,"i5":10,"i6":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/SparkPipelineOptions.TmpCheckpointDirFactory.html" title="class in org.apache.beam.runners.spark"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/spark/SparkRunner.html" title="class in org.apache.beam.runners.spark"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/spark/SparkPipelineResult.html" target="_top">Frames</a></li> +<li><a href="SparkPipelineResult.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><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </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.spark</div> +<h2 title="Class SparkPipelineResult" class="title">Class SparkPipelineResult</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.spark.SparkPipelineResult</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> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../org/apache/beam/runners/spark/SparkRunnerDebugger.DebugSparkPipelineResult.html" title="class in org.apache.beam.runners.spark">SparkRunnerDebugger.DebugSparkPipelineResult</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">SparkPipelineResult</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">Represents a Spark pipeline execution result.</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> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected org.apache.spark.api.java.JavaSparkContext</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/spark/SparkPipelineResult.html#javaSparkContext">javaSparkContext</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected java.util.concurrent.Future</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/spark/SparkPipelineResult.html#pipelineExecution">pipelineExecution</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <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/spark/SparkPipelineResult.html#state">state</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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 abstract <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/spark/SparkPipelineResult.html#awaitTermination-org.joda.time.Duration-">awaitTermination</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> </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/spark/SparkPipelineResult.html#cancel--">cancel</a></span>()</code> +<div class="block">Cancels the pipeline execution.</div> +</td> +</tr> +<tr id="i2" 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/spark/SparkPipelineResult.html#getState--">getState</a></span>()</code> +<div class="block">Retrieves the current state of the pipeline execution.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<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/spark/SparkPipelineResult.html#metrics--">metrics</a></span>()</code> +<div class="block">Returns the object to access metrics from the pipeline.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>protected abstract void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/spark/SparkPipelineResult.html#stop--">stop</a></span>()</code> </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/spark/SparkPipelineResult.html#waitUntilFinish--">waitUntilFinish</a></span>()</code> +<div class="block">Waits until the pipeline finishes and returns the final status.</div> +</td> +</tr> +<tr id="i6" 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/spark/SparkPipelineResult.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, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="pipelineExecution"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>pipelineExecution</h4> +<pre>protected final java.util.concurrent.Future pipelineExecution</pre> +</li> +</ul> +<a name="javaSparkContext"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>javaSparkContext</h4> +<pre>protected org.apache.spark.api.java.JavaSparkContext javaSparkContext</pre> +</li> +</ul> +<a name="state"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>state</h4> +<pre>protected <a href="../../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a> state</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="stop--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>stop</h4> +<pre>protected abstract void stop()</pre> +</li> +</ul> +<a name="awaitTermination-org.joda.time.Duration-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>awaitTermination</h4> +<pre>protected abstract <a href="../../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a> awaitTermination(<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) + throws java.util.concurrent.TimeoutException, + java.util.concurrent.ExecutionException, + java.lang.InterruptedException</pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.util.concurrent.TimeoutException</code></dd> +<dd><code>java.util.concurrent.ExecutionException</code></dd> +<dd><code>java.lang.InterruptedException</code></dd> +</dl> +</li> +</ul> +<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="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="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="blockListLast"> +<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> +</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/SparkPipelineOptions.TmpCheckpointDirFactory.html" title="class in org.apache.beam.runners.spark"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/spark/SparkRunner.html" title="class in org.apache.beam.runners.spark"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/spark/SparkPipelineResult.html" target="_top">Frames</a></li> +<li><a href="SparkPipelineResult.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><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </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/spark/SparkRunner.Evaluator.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/spark/SparkRunner.Evaluator.html b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/spark/SparkRunner.Evaluator.html new file mode 100644 index 0000000..09a8838 --- /dev/null +++ b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/spark/SparkRunner.Evaluator.html @@ -0,0 +1,449 @@ +<!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>SparkRunner.Evaluator</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="SparkRunner.Evaluator"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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/spark/SparkRunner.html" title="class in org.apache.beam.runners.spark"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/spark/SparkRunnerDebugger.html" title="class in org.apache.beam.runners.spark"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/spark/SparkRunner.Evaluator.html" target="_top">Frames</a></li> +<li><a href="SparkRunner.Evaluator.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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.spark</div> +<h2 title="Class SparkRunner.Evaluator" class="title">Class SparkRunner.Evaluator</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.Defaults.html" title="class in org.apache.beam.sdk">org.apache.beam.sdk.Pipeline.PipelineVisitor.Defaults</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.spark.SparkRunner.Evaluator</li> +</ul> +</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/Pipeline.PipelineVisitor.html" title="interface in org.apache.beam.sdk">Pipeline.PipelineVisitor</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../org/apache/beam/runners/spark/SparkNativePipelineVisitor.html" title="class in org.apache.beam.runners.spark">SparkNativePipelineVisitor</a></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../org/apache/beam/runners/spark/SparkRunner.html" title="class in org.apache.beam.runners.spark">SparkRunner</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="typeNameLabel">SparkRunner.Evaluator</span> +extends <a href="../../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.Defaults.html" title="class in org.apache.beam.sdk">Pipeline.PipelineVisitor.Defaults</a></pre> +<div class="block">Evaluator on the pipeline.</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.Pipeline.PipelineVisitor"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface org.apache.beam.sdk.<a href="../../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.html" title="interface in org.apache.beam.sdk">Pipeline.PipelineVisitor</a></h3> +<code><a href="../../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.CompositeBehavior.html" title="enum in org.apache.beam.sdk">Pipeline.PipelineVisitor.CompositeBehavior</a>, <a href="../../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.Defaults.html" title="class in org.apache.beam.sdk">Pipeline.PipelineVisitor.Defaults</a></code></li> +</ul> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected org.apache.beam.runners.spark.translation.EvaluationContext</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/spark/SparkRunner.Evaluator.html#ctxt">ctxt</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected org.apache.beam.runners.spark.translation.SparkPipelineTranslator</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/spark/SparkRunner.Evaluator.html#translator">translator</a></span></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== 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/spark/SparkRunner.Evaluator.html#Evaluator-org.apache.beam.runners.spark.translation.SparkPipelineTranslator-org.apache.beam.runners.spark.translation.EvaluationContext-">Evaluator</a></span>(org.apache.beam.runners.spark.translation.SparkPipelineTranslator translator, + org.apache.beam.runners.spark.translation.EvaluationContext ctxt)</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><a href="../../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.CompositeBehavior.html" title="enum in org.apache.beam.sdk">Pipeline.PipelineVisitor.CompositeBehavior</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/spark/SparkRunner.Evaluator.html#enterCompositeTransform-org.apache.beam.sdk.runners.TransformHierarchy.Node-">enterCompositeTransform</a></span>(org.apache.beam.sdk.runners.TransformHierarchy.Node node)</code> +<div class="block">Called for each composite transform after all topological predecessors have been visited + but before any of its component transforms.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../../org/apache/beam/sdk/values/PCollection.IsBounded.html" title="enum in org.apache.beam.sdk.values">PCollection.IsBounded</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/spark/SparkRunner.Evaluator.html#isBoundedCollection-java.util.Collection-">isBoundedCollection</a></span>(java.util.Collection<<a href="../../../../../org/apache/beam/sdk/values/PValue.html" title="interface in org.apache.beam.sdk.values">PValue</a>> pValues)</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/spark/SparkRunner.Evaluator.html#shouldDefer-org.apache.beam.sdk.runners.TransformHierarchy.Node-">shouldDefer</a></span>(org.apache.beam.sdk.runners.TransformHierarchy.Node node)</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>protected <TransformT extends <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><? super <a href="../../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values">PInput</a>,<a href="../../../../../org/apache/beam/sdk/values/POutput.html" title="interface in org.apache.beam.sdk.values">POutput</a>>><br>org.apache.beam.runners.spark.translation.TransformEvaluator<TransformT></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/spark/SparkRunner.Evaluator.html#translate-org.apache.beam.sdk.runners.TransformHierarchy.Node-TransformT-java.lang.Class-">translate</a></span>(org.apache.beam.sdk.runners.TransformHierarchy.Node node, + TransformT transform, + java.lang.Class<TransformT> transformClass)</code> +<div class="block">Determine if this Node belongs to a Bounded branch of the pipeline, or Unbounded, and + translate with the proper translator.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/spark/SparkRunner.Evaluator.html#visitPrimitiveTransform-org.apache.beam.sdk.runners.TransformHierarchy.Node-">visitPrimitiveTransform</a></span>(org.apache.beam.sdk.runners.TransformHierarchy.Node node)</code> +<div class="block">Called for each primitive transform after all of its topological predecessors + and inputs have been visited.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.Pipeline.PipelineVisitor.Defaults"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.beam.sdk.<a href="../../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.Defaults.html" title="class in org.apache.beam.sdk">Pipeline.PipelineVisitor.Defaults</a></h3> +<code><a href="../../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.Defaults.html#leaveCompositeTransform-org.apache.beam.sdk.runners.TransformHierarchy.Node-">leaveCompositeTransform</a>, <a href="../../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.Defaults.html#visitValue-org.apache.beam.sdk.values.PValue-org.apache.beam.sdk.runners.TransformHierarchy.Node-">visitValue</a></code></li> +</ul> +<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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="ctxt"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ctxt</h4> +<pre>protected final org.apache.beam.runners.spark.translation.EvaluationContext ctxt</pre> +</li> +</ul> +<a name="translator"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>translator</h4> +<pre>protected final org.apache.beam.runners.spark.translation.SparkPipelineTranslator translator</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Evaluator-org.apache.beam.runners.spark.translation.SparkPipelineTranslator-org.apache.beam.runners.spark.translation.EvaluationContext-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Evaluator</h4> +<pre>public Evaluator(org.apache.beam.runners.spark.translation.SparkPipelineTranslator translator, + org.apache.beam.runners.spark.translation.EvaluationContext ctxt)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="enterCompositeTransform-org.apache.beam.sdk.runners.TransformHierarchy.Node-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>enterCompositeTransform</h4> +<pre>public <a href="../../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.CompositeBehavior.html" title="enum in org.apache.beam.sdk">Pipeline.PipelineVisitor.CompositeBehavior</a> enterCompositeTransform(org.apache.beam.sdk.runners.TransformHierarchy.Node node)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.html#enterCompositeTransform-org.apache.beam.sdk.runners.TransformHierarchy.Node-">Pipeline.PipelineVisitor</a></code></span></div> +<div class="block">Called for each composite transform after all topological predecessors have been visited + but before any of its component transforms. + + <p>The return value controls whether or not child transforms are visited.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.html#enterCompositeTransform-org.apache.beam.sdk.runners.TransformHierarchy.Node-">enterCompositeTransform</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.html" title="interface in org.apache.beam.sdk">Pipeline.PipelineVisitor</a></code></dd> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.Defaults.html#enterCompositeTransform-org.apache.beam.sdk.runners.TransformHierarchy.Node-">enterCompositeTransform</a></code> in class <code><a href="../../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.Defaults.html" title="class in org.apache.beam.sdk">Pipeline.PipelineVisitor.Defaults</a></code></dd> +</dl> +</li> +</ul> +<a name="shouldDefer-org.apache.beam.sdk.runners.TransformHierarchy.Node-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>shouldDefer</h4> +<pre>protected boolean shouldDefer(org.apache.beam.sdk.runners.TransformHierarchy.Node node)</pre> +</li> +</ul> +<a name="visitPrimitiveTransform-org.apache.beam.sdk.runners.TransformHierarchy.Node-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visitPrimitiveTransform</h4> +<pre>public void visitPrimitiveTransform(org.apache.beam.sdk.runners.TransformHierarchy.Node node)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.html#visitPrimitiveTransform-org.apache.beam.sdk.runners.TransformHierarchy.Node-">Pipeline.PipelineVisitor</a></code></span></div> +<div class="block">Called for each primitive transform after all of its topological predecessors + and inputs have been visited.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.html#visitPrimitiveTransform-org.apache.beam.sdk.runners.TransformHierarchy.Node-">visitPrimitiveTransform</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.html" title="interface in org.apache.beam.sdk">Pipeline.PipelineVisitor</a></code></dd> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.Defaults.html#visitPrimitiveTransform-org.apache.beam.sdk.runners.TransformHierarchy.Node-">visitPrimitiveTransform</a></code> in class <code><a href="../../../../../org/apache/beam/sdk/Pipeline.PipelineVisitor.Defaults.html" title="class in org.apache.beam.sdk">Pipeline.PipelineVisitor.Defaults</a></code></dd> +</dl> +</li> +</ul> +<a name="translate-org.apache.beam.sdk.runners.TransformHierarchy.Node-org.apache.beam.sdk.transforms.PTransform-java.lang.Class-"> +<!-- --> +</a><a name="translate-org.apache.beam.sdk.runners.TransformHierarchy.Node-TransformT-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>translate</h4> +<pre>protected <TransformT extends <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><? super <a href="../../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values">PInput</a>,<a href="../../../../../org/apache/beam/sdk/values/POutput.html" title="interface in org.apache.beam.sdk.values">POutput</a>>> org.apache.beam.runners.spark.translation.TransformEvaluator<TransformT> translate(org.apache.beam.sdk.runners.TransformHierarchy.Node node, + TransformT transform, + java.lang.Class<TransformT> transformClass)</pre> +<div class="block">Determine if this Node belongs to a Bounded branch of the pipeline, or Unbounded, and + translate with the proper translator.</div> +</li> +</ul> +<a name="isBoundedCollection-java.util.Collection-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isBoundedCollection</h4> +<pre>protected <a href="../../../../../org/apache/beam/sdk/values/PCollection.IsBounded.html" title="enum in org.apache.beam.sdk.values">PCollection.IsBounded</a> isBoundedCollection(java.util.Collection<<a href="../../../../../org/apache/beam/sdk/values/PValue.html" title="interface in org.apache.beam.sdk.values">PValue</a>> pValues)</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/spark/SparkRunner.html" title="class in org.apache.beam.runners.spark"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/spark/SparkRunnerDebugger.html" title="class in org.apache.beam.runners.spark"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/spark/SparkRunner.Evaluator.html" target="_top">Frames</a></li> +<li><a href="SparkRunner.Evaluator.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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>
