http://git-wip-us.apache.org/repos/asf/beam-site/blob/dc04d667/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/DataflowRunner.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/DataflowRunner.html b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/DataflowRunner.html new file mode 100644 index 0000000..bf09b29 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/DataflowRunner.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 Wed Mar 08 17:12:53 PST 2017 --> +<title>DataflowRunner</title> +<meta name="date" content="2017-03-08"> +<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="DataflowRunner"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9,"i2":10,"i3":10,"i4":10,"i5":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/dataflow/DataflowPipelineTranslator.JobSpecification.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunner.StreamingPCollectionViewWriterFn.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/dataflow/DataflowRunner.html" target="_top">Frames</a></li> +<li><a href="DataflowRunner.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><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.dataflow</div> +<h2 title="Class DataflowRunner" class="title">Class DataflowRunner</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/beam/sdk/runners/PipelineRunner.html" title="class in org.apache.beam.sdk.runners">org.apache.beam.sdk.runners.PipelineRunner</a><<a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html" title="class in org.apache.beam.runners.dataflow">DataflowPipelineJob</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.dataflow.DataflowRunner</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">DataflowRunner</span> +extends <a href="../../../../../org/apache/beam/sdk/runners/PipelineRunner.html" title="class in org.apache.beam.sdk.runners">PipelineRunner</a><<a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html" title="class in org.apache.beam.runners.dataflow">DataflowPipelineJob</a>></pre> +<div class="block">A <a href="../../../../../org/apache/beam/sdk/runners/PipelineRunner.html" title="class in org.apache.beam.sdk.runners"><code>PipelineRunner</code></a> that executes the operations in the pipeline by first translating them + to the Dataflow representation using the <a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.html" title="class in org.apache.beam.runners.dataflow"><code>DataflowPipelineTranslator</code></a> and then submitting + them to a Dataflow service for execution. + + <h3>Permissions</h3> + + <p>When reading from a Dataflow source or writing to a Dataflow sink using + <code>DataflowRunner</code>, the Google cloudservices account and the Google compute engine service + account of the GCP project running the Dataflow Job will need access to the corresponding + source/sink. + + <p>Please see <a href="https://cloud.google.com/dataflow/security-and-permissions";>Google Cloud + Dataflow Security and Permissions</a> for more details.</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">Class 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/dataflow/DataflowRunner.StreamingPCollectionViewWriterFn.html" title="class in org.apache.beam.runners.dataflow">DataflowRunner.StreamingPCollectionViewWriterFn</a><<a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunner.StreamingPCollectionViewWriterFn.html" title="type parameter in DataflowRunner.StreamingPCollectionViewWriterFn">T</a>></span></code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +</td> +</tr> +</table> +</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>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunner.html#PROJECT_ID_REGEXP">PROJECT_ID_REGEXP</a></span></code> +<div class="block">Project IDs must contain lowercase letters, digits, or dashes.</div> +</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="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunner.html#DataflowRunner-org.apache.beam.runners.dataflow.options.DataflowPipelineOptions-">DataflowRunner</a></span>(<a href="../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.html" title="interface in org.apache.beam.runners.dataflow.options">DataflowPipelineOptions</a> options)</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="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/dataflow/DataflowRunner.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/dataflow/DataflowRunner.html" title="class in org.apache.beam.runners.dataflow">DataflowRunner</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunner.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/dataflow/DataflowPipelineTranslator.html" title="class in org.apache.beam.runners.dataflow">DataflowPipelineTranslator</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunner.html#getTranslator--">getTranslator</a></span>()</code> +<div class="block">Returns the DataflowPipelineTranslator associated with this object.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html" title="class in org.apache.beam.runners.dataflow">DataflowPipelineJob</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunner.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 Pipeline, returning the results.</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/dataflow/DataflowRunner.html#setHooks-org.apache.beam.runners.dataflow.DataflowRunnerHooks-">setHooks</a></span>(<a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunnerHooks.html" title="class in org.apache.beam.runners.dataflow">DataflowRunnerHooks</a> hooks)</code> +<div class="block">Sets callbacks to invoke during execution see <code>DataflowRunnerHooks</code>.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunner.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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="PROJECT_ID_REGEXP"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PROJECT_ID_REGEXP</h4> +<pre>public static final java.lang.String PROJECT_ID_REGEXP</pre> +<div class="block">Project IDs must contain lowercase letters, digits, or dashes. + IDs must start with a letter and may not end with a dash. + This regex isn't exact - this allows for patterns that would be rejected by + the service, but this is sufficient for basic validation of project IDs.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.beam.runners.dataflow.DataflowRunner.PROJECT_ID_REGEXP">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="DataflowRunner-org.apache.beam.runners.dataflow.options.DataflowPipelineOptions-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DataflowRunner</h4> +<pre>protected DataflowRunner(<a href="../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.html" title="interface in org.apache.beam.runners.dataflow.options">DataflowPipelineOptions</a> 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="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/dataflow/DataflowRunner.html" title="class in org.apache.beam.runners.dataflow">DataflowRunner</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 that 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/runners/dataflow/DataflowPipelineJob.html" title="class in org.apache.beam.runners.dataflow">DataflowPipelineJob</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/runners/PipelineRunner.html#run-org.apache.beam.sdk.Pipeline-">PipelineRunner</a></code></span></div> +<div class="block">Processes the given Pipeline, returning the results.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/runners/PipelineRunner.html#run-org.apache.beam.sdk.Pipeline-">run</a></code> in class <code><a href="../../../../../org/apache/beam/sdk/runners/PipelineRunner.html" title="class in org.apache.beam.sdk.runners">PipelineRunner</a><<a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html" title="class in org.apache.beam.runners.dataflow">DataflowPipelineJob</a>></code></dd> +</dl> +</li> +</ul> +<a name="getTranslator--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTranslator</h4> +<pre>public <a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.html" title="class in org.apache.beam.runners.dataflow">DataflowPipelineTranslator</a> getTranslator()</pre> +<div class="block">Returns the DataflowPipelineTranslator associated with this object.</div> +</li> +</ul> +<a name="setHooks-org.apache.beam.runners.dataflow.DataflowRunnerHooks-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setHooks</h4> +<pre><a href="../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a> +public void setHooks(<a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunnerHooks.html" title="class in org.apache.beam.runners.dataflow">DataflowRunnerHooks</a> hooks)</pre> +<div class="block">Sets callbacks to invoke during execution see <code>DataflowRunnerHooks</code>.</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/dataflow/DataflowPipelineTranslator.JobSpecification.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunner.StreamingPCollectionViewWriterFn.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/dataflow/DataflowRunner.html" target="_top">Frames</a></li> +<li><a href="DataflowRunner.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><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>
http://git-wip-us.apache.org/repos/asf/beam-site/blob/dc04d667/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/DataflowRunnerHooks.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/DataflowRunnerHooks.html b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/DataflowRunnerHooks.html new file mode 100644 index 0000000..c3e054d --- /dev/null +++ b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/DataflowRunnerHooks.html @@ -0,0 +1,283 @@ +<!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 Wed Mar 08 17:12:53 PST 2017 --> +<title>DataflowRunnerHooks</title> +<meta name="date" content="2017-03-08"> +<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="DataflowRunnerHooks"; + } + } + 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/dataflow/DataflowRunner.StreamingPCollectionViewWriterFn.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunnerInfo.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/dataflow/DataflowRunnerHooks.html" target="_top">Frames</a></li> +<li><a href="DataflowRunnerHooks.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.dataflow</div> +<h2 title="Class DataflowRunnerHooks" class="title">Class DataflowRunnerHooks</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.dataflow.DataflowRunnerHooks</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre><a href="../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a> +public class <span class="typeNameLabel">DataflowRunnerHooks</span> +extends java.lang.Object</pre> +<div class="block">An instance of this class can be passed to the + <a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunner.html" title="class in org.apache.beam.runners.dataflow"><code>DataflowRunner</code></a> to add user defined hooks to be + invoked at various times during pipeline execution.</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/dataflow/DataflowRunnerHooks.html#DataflowRunnerHooks--">DataflowRunnerHooks</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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunnerHooks.html#modifyEnvironmentBeforeSubmission-com.google.api.services.dataflow.model.Environment-">modifyEnvironmentBeforeSubmission</a></span>(com.google.api.services.dataflow.model.Environment environment)</code> +<div class="block">Allows the user to modify the environment of their job before their job is submitted + to the service for execution.</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="DataflowRunnerHooks--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DataflowRunnerHooks</h4> +<pre>public DataflowRunnerHooks()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="modifyEnvironmentBeforeSubmission-com.google.api.services.dataflow.model.Environment-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>modifyEnvironmentBeforeSubmission</h4> +<pre>public void modifyEnvironmentBeforeSubmission(com.google.api.services.dataflow.model.Environment environment)</pre> +<div class="block">Allows the user to modify the environment of their job before their job is submitted + to the service for execution.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>environment</code> - The environment of the job. Users can make change to this instance in order + to change the environment with which their job executes on the service.</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/dataflow/DataflowRunner.StreamingPCollectionViewWriterFn.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunnerInfo.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/dataflow/DataflowRunnerHooks.html" target="_top">Frames</a></li> +<li><a href="DataflowRunnerHooks.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/dc04d667/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/DataflowRunnerInfo.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/DataflowRunnerInfo.html b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/DataflowRunnerInfo.html new file mode 100644 index 0000000..efe3e7f --- /dev/null +++ b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/DataflowRunnerInfo.html @@ -0,0 +1,287 @@ +<!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 Wed Mar 08 17:12:53 PST 2017 --> +<title>DataflowRunnerInfo</title> +<meta name="date" content="2017-03-08"> +<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="DataflowRunnerInfo"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":9,"i2":10,"i3":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/dataflow/DataflowRunnerHooks.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/dataflow/DataflowServiceException.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/dataflow/DataflowRunnerInfo.html" target="_top">Frames</a></li> +<li><a href="DataflowRunnerInfo.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.dataflow</div> +<h2 title="Class DataflowRunnerInfo" class="title">Class DataflowRunnerInfo</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.dataflow.DataflowRunnerInfo</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">DataflowRunnerInfo</span> +extends java.lang.Object</pre> +<div class="block">Populates versioning and other information for <a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunner.html" title="class in org.apache.beam.runners.dataflow"><code>DataflowRunner</code></a>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunnerInfo.html#getBatchWorkerHarnessContainerImage--">getBatchWorkerHarnessContainerImage</a></span>()</code> +<div class="block">Provides the batch worker harness container image name.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunnerInfo.html" title="class in org.apache.beam.runners.dataflow">DataflowRunnerInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunnerInfo.html#getDataflowRunnerInfo--">getDataflowRunnerInfo</a></span>()</code> +<div class="block">Returns an instance of <a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunnerInfo.html" title="class in org.apache.beam.runners.dataflow"><code>DataflowRunnerInfo</code></a>.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunnerInfo.html#getEnvironmentMajorVersion--">getEnvironmentMajorVersion</a></span>()</code> +<div class="block">Provides the environment's major version number.</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/dataflow/DataflowRunnerInfo.html#getStreamingWorkerHarnessContainerImage--">getStreamingWorkerHarnessContainerImage</a></span>()</code> +<div class="block">Provides the streaming worker harness container image name.</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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getDataflowRunnerInfo--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataflowRunnerInfo</h4> +<pre>public static <a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunnerInfo.html" title="class in org.apache.beam.runners.dataflow">DataflowRunnerInfo</a> getDataflowRunnerInfo()</pre> +<div class="block">Returns an instance of <a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunnerInfo.html" title="class in org.apache.beam.runners.dataflow"><code>DataflowRunnerInfo</code></a>.</div> +</li> +</ul> +<a name="getEnvironmentMajorVersion--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEnvironmentMajorVersion</h4> +<pre>public java.lang.String getEnvironmentMajorVersion()</pre> +<div class="block">Provides the environment's major version number.</div> +</li> +</ul> +<a name="getBatchWorkerHarnessContainerImage--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBatchWorkerHarnessContainerImage</h4> +<pre>public java.lang.String getBatchWorkerHarnessContainerImage()</pre> +<div class="block">Provides the batch worker harness container image name.</div> +</li> +</ul> +<a name="getStreamingWorkerHarnessContainerImage--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getStreamingWorkerHarnessContainerImage</h4> +<pre>public java.lang.String getStreamingWorkerHarnessContainerImage()</pre> +<div class="block">Provides the streaming worker harness container image name.</div> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunnerHooks.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/dataflow/DataflowServiceException.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/dataflow/DataflowRunnerInfo.html" target="_top">Frames</a></li> +<li><a href="DataflowRunnerInfo.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/dc04d667/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/DataflowServiceException.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/DataflowServiceException.html b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/DataflowServiceException.html new file mode 100644 index 0000000..e6ed745 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/DataflowServiceException.html @@ -0,0 +1,238 @@ +<!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 Wed Mar 08 17:12:53 PST 2017 --> +<title>DataflowServiceException</title> +<meta name="date" content="2017-03-08"> +<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="DataflowServiceException"; + } + } + catch(err) { + } +//--> +</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/dataflow/DataflowRunnerInfo.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/dataflow/DataflowServiceException.html" target="_top">Frames</a></li> +<li><a href="DataflowServiceException.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="#methods.inherited.from.class.org.apache.beam.runners.dataflow.DataflowJobException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</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.dataflow</div> +<h2 title="Class DataflowServiceException" class="title">Class DataflowServiceException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li>java.lang.RuntimeException</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/beam/runners/dataflow/DataflowJobException.html" title="class in org.apache.beam.runners.dataflow">org.apache.beam.runners.dataflow.DataflowJobException</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.dataflow.DataflowServiceException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">DataflowServiceException</span> +extends <a href="../../../../../org/apache/beam/runners/dataflow/DataflowJobException.html" title="class in org.apache.beam.runners.dataflow">DataflowJobException</a></pre> +<div class="block">Signals there was an error retrieving information about a job from the Cloud Dataflow Service.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../serialized-form.html#org.apache.beam.runners.dataflow.DataflowServiceException">Serialized Form</a></dd> +</dl> +</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> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.runners.dataflow.DataflowJobException"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.beam.runners.dataflow.<a href="../../../../../org/apache/beam/runners/dataflow/DataflowJobException.html" title="class in org.apache.beam.runners.dataflow">DataflowJobException</a></h3> +<code><a href="../../../../../org/apache/beam/runners/dataflow/DataflowJobException.html#getJob--">getJob</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</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, wait, wait, wait</code></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/dataflow/DataflowRunnerInfo.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/dataflow/DataflowServiceException.html" target="_top">Frames</a></li> +<li><a href="DataflowServiceException.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="#methods.inherited.from.class.org.apache.beam.runners.dataflow.DataflowJobException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</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/dc04d667/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/options/CloudDebuggerOptions.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/options/CloudDebuggerOptions.html b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/options/CloudDebuggerOptions.html new file mode 100644 index 0000000..ed8280e --- /dev/null +++ b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/options/CloudDebuggerOptions.html @@ -0,0 +1,303 @@ +<!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 Wed Mar 08 17:12:53 PST 2017 --> +<title>CloudDebuggerOptions</title> +<meta name="date" content="2017-03-08"> +<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="CloudDebuggerOptions"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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>Prev Class</li> +<li><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html" title="interface in org.apache.beam.runners.dataflow.options"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/dataflow/options/CloudDebuggerOptions.html" target="_top">Frames</a></li> +<li><a href="CloudDebuggerOptions.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.dataflow.options</div> +<h2 title="Interface CloudDebuggerOptions" class="title">Interface CloudDebuggerOptions</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.html" title="interface in org.apache.beam.runners.dataflow.options">DataflowPipelineOptions</a>, <a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowWorkerHarnessOptions.html" title="interface in org.apache.beam.runners.dataflow.options">DataflowWorkerHarnessOptions</a>, <a href="../../../../../../org/apache/beam/runners/dataflow/testing/TestDataflowPipelineOptions.html" title="interface in org.apache.beam.runners.dataflow.testing">TestDataflowPipelineOptions</a></dd> +</dl> +<hr> +<br> +<pre><a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a> + <a href="../../../../../../org/apache/beam/sdk/options/Hidden.html" title="annotation in org.apache.beam.sdk.options">@Hidden</a> +public interface <span class="typeNameLabel">CloudDebuggerOptions</span></pre> +<div class="block">Options for controlling Cloud Debugger.</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="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>com.google.api.services.clouddebugger.v2.model.Debuggee</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/CloudDebuggerOptions.html#getDebuggee--">getDebuggee</a></span>()</code> +<div class="block">The Cloud Debugger debuggee to associate with.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/CloudDebuggerOptions.html#getEnableCloudDebugger--">getEnableCloudDebugger</a></span>()</code> +<div class="block">Whether to enable the Cloud Debugger snapshot agent for the current job.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/CloudDebuggerOptions.html#getMaxConditionCost--">getMaxConditionCost</a></span>()</code> +<div class="block">The maximum cost (as a ratio of CPU time) allowed for evaluating conditional snapshots.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/CloudDebuggerOptions.html#setDebuggee-com.google.api.services.clouddebugger.v2.model.Debuggee-">setDebuggee</a></span>(com.google.api.services.clouddebugger.v2.model.Debuggee debuggee)</code> </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/dataflow/options/CloudDebuggerOptions.html#setEnableCloudDebugger-boolean-">setEnableCloudDebugger</a></span>(boolean enabled)</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/CloudDebuggerOptions.html#setMaxConditionCost-double-">setMaxConditionCost</a></span>(double maxConditionCost)</code> </td> +</tr> +</table> +</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="getEnableCloudDebugger--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEnableCloudDebugger</h4> +<pre>boolean getEnableCloudDebugger()</pre> +<div class="block">Whether to enable the Cloud Debugger snapshot agent for the current job.</div> +</li> +</ul> +<a name="setEnableCloudDebugger-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setEnableCloudDebugger</h4> +<pre>void setEnableCloudDebugger(boolean enabled)</pre> +</li> +</ul> +<a name="getDebuggee--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDebuggee</h4> +<pre><a href="../../../../../../org/apache/beam/sdk/options/Hidden.html" title="annotation in org.apache.beam.sdk.options">@Hidden</a> + @Nullable +com.google.api.services.clouddebugger.v2.model.Debuggee getDebuggee()</pre> +<div class="block">The Cloud Debugger debuggee to associate with. This should not be set directly.</div> +</li> +</ul> +<a name="setDebuggee-com.google.api.services.clouddebugger.v2.model.Debuggee-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDebuggee</h4> +<pre>void setDebuggee(com.google.api.services.clouddebugger.v2.model.Debuggee debuggee)</pre> +</li> +</ul> +<a name="getMaxConditionCost--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMaxConditionCost</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.01) +double getMaxConditionCost()</pre> +<div class="block">The maximum cost (as a ratio of CPU time) allowed for evaluating conditional snapshots.</div> +</li> +</ul> +<a name="setMaxConditionCost-double-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setMaxConditionCost</h4> +<pre>void setMaxConditionCost(double maxConditionCost)</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>Prev Class</li> +<li><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html" title="interface in org.apache.beam.runners.dataflow.options"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/dataflow/options/CloudDebuggerOptions.html" target="_top">Frames</a></li> +<li><a href="CloudDebuggerOptions.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/dc04d667/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.DataflowClientFactory.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.DataflowClientFactory.html b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.DataflowClientFactory.html new file mode 100644 index 0000000..a84c3ae --- /dev/null +++ b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.DataflowClientFactory.html @@ -0,0 +1,291 @@ +<!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 Wed Mar 08 17:12:53 PST 2017 --> +<title>DataflowPipelineDebugOptions.DataflowClientFactory</title> +<meta name="date" content="2017-03-08"> +<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="DataflowPipelineDebugOptions.DataflowClientFactory"; + } + } + 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/dataflow/options/DataflowPipelineDebugOptions.html" title="interface in org.apache.beam.runners.dataflow.options"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.StagerFactory.html" title="class in org.apache.beam.runners.dataflow.options"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.DataflowClientFactory.html" target="_top">Frames</a></li> +<li><a href="DataflowPipelineDebugOptions.DataflowClientFactory.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.dataflow.options</div> +<h2 title="Class DataflowPipelineDebugOptions.DataflowClientFactory" class="title">Class DataflowPipelineDebugOptions.DataflowClientFactory</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.dataflow.options.DataflowPipelineDebugOptions.DataflowClientFactory</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/DefaultValueFactory.html" title="interface in org.apache.beam.sdk.options">DefaultValueFactory</a><com.google.api.services.dataflow.Dataflow></dd> +</dl> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.html" title="interface in org.apache.beam.runners.dataflow.options">DataflowPipelineDebugOptions</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="typeNameLabel">DataflowPipelineDebugOptions.DataflowClientFactory</span> +extends java.lang.Object +implements <a href="../../../../../../org/apache/beam/sdk/options/DefaultValueFactory.html" title="interface in org.apache.beam.sdk.options">DefaultValueFactory</a><com.google.api.services.dataflow.Dataflow></pre> +<div class="block">Returns the default Dataflow client built from the passed in PipelineOptions.</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/dataflow/options/DataflowPipelineDebugOptions.DataflowClientFactory.html#DataflowClientFactory--">DataflowClientFactory</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>com.google.api.services.dataflow.Dataflow</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.DataflowClientFactory.html#create-org.apache.beam.sdk.options.PipelineOptions-">create</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">Creates a default value for a getter marked with <a href="../../../../../../org/apache/beam/sdk/options/Default.InstanceFactory.html" title="annotation in org.apache.beam.sdk.options"><code>Default.InstanceFactory</code></a>.</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="DataflowClientFactory--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DataflowClientFactory</h4> +<pre>public DataflowClientFactory()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="create-org.apache.beam.sdk.options.PipelineOptions-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>create</h4> +<pre>public com.google.api.services.dataflow.Dataflow create(<a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a> options)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/beam/sdk/options/DefaultValueFactory.html#create-org.apache.beam.sdk.options.PipelineOptions-">DefaultValueFactory</a></code></span></div> +<div class="block">Creates a default value for a getter marked with <a href="../../../../../../org/apache/beam/sdk/options/Default.InstanceFactory.html" title="annotation in org.apache.beam.sdk.options"><code>Default.InstanceFactory</code></a>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/beam/sdk/options/DefaultValueFactory.html#create-org.apache.beam.sdk.options.PipelineOptions-">create</a></code> in interface <code><a href="../../../../../../org/apache/beam/sdk/options/DefaultValueFactory.html" title="interface in org.apache.beam.sdk.options">DefaultValueFactory</a><com.google.api.services.dataflow.Dataflow></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>options</code> - The current pipeline options.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The default value to be used for the annotated getter.</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/dataflow/options/DataflowPipelineDebugOptions.html" title="interface in org.apache.beam.runners.dataflow.options"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.StagerFactory.html" title="class in org.apache.beam.runners.dataflow.options"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/dataflow/options/DataflowPipelineDebugOptions.DataflowClientFactory.html" target="_top">Frames</a></li> +<li><a href="DataflowPipelineDebugOptions.DataflowClientFactory.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>
