http://git-wip-us.apache.org/repos/asf/beam-site/blob/c196579f/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/DataflowClient.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/DataflowClient.html b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/DataflowClient.html new file mode 100644 index 0000000..296545e --- /dev/null +++ b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/DataflowClient.html @@ -0,0 +1,426 @@ +<!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:03 PDT 2017 --> +<title>DataflowClient</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="DataflowClient"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":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/CreateDataflowView.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/DataflowJobAlreadyExistsException.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/DataflowClient.html" target="_top">Frames</a></li> +<li><a href="DataflowClient.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 DataflowClient" class="title">Class DataflowClient</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.dataflow.DataflowClient</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">DataflowClient</span> +extends java.lang.Object</pre> +<div class="block">Wrapper around the generated <code>Dataflow</code> client to provide common functionality.</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>static <a href="../../../../../org/apache/beam/runners/dataflow/DataflowClient.html" title="class in org.apache.beam.runners.dataflow">DataflowClient</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowClient.html#create-org.apache.beam.runners.dataflow.options.DataflowPipelineOptions-">create</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> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>com.google.api.services.dataflow.model.Job</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowClient.html#createJob-com.google.api.services.dataflow.model.Job-">createJob</a></span>(com.google.api.services.dataflow.model.Job job)</code> +<div class="block">Creates the Dataflow <code>Job</code>.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>com.google.api.services.dataflow.model.Job</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowClient.html#getJob-java.lang.String-">getJob</a></span>(java.lang.String jobId)</code> +<div class="block">Gets the Dataflow <code>Job</code> with the given <code>jobId</code>.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>com.google.api.services.dataflow.model.JobMetrics</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowClient.html#getJobMetrics-java.lang.String-">getJobMetrics</a></span>(java.lang.String jobId)</code> +<div class="block">Gets the <code>JobMetrics</code> with the given <code>jobId</code>.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>com.google.api.services.dataflow.model.LeaseWorkItemResponse</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowClient.html#leaseWorkItem-java.lang.String-com.google.api.services.dataflow.model.LeaseWorkItemRequest-">leaseWorkItem</a></span>(java.lang.String jobId, + com.google.api.services.dataflow.model.LeaseWorkItemRequest request)</code> +<div class="block">Leases the work item for <code>jobId</code>.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>com.google.api.services.dataflow.model.ListJobMessagesResponse</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowClient.html#listJobMessages-java.lang.String-java.lang.String-">listJobMessages</a></span>(java.lang.String jobId, + java.lang.String pageToken)</code> +<div class="block">Lists job messages with the given <code>jobId</code>.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>com.google.api.services.dataflow.model.ListJobsResponse</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowClient.html#listJobs-java.lang.String-">listJobs</a></span>(java.lang.String pageToken)</code> +<div class="block">Lists Dataflow <code>Jobs</code> in the project associated with + the <a href="../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.html" title="interface in org.apache.beam.runners.dataflow.options"><code>DataflowPipelineOptions</code></a>.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>com.google.api.services.dataflow.model.ReportWorkItemStatusResponse</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowClient.html#reportWorkItemStatus-java.lang.String-com.google.api.services.dataflow.model.ReportWorkItemStatusRequest-">reportWorkItemStatus</a></span>(java.lang.String jobId, + com.google.api.services.dataflow.model.ReportWorkItemStatusRequest request)</code> +<div class="block">Reports the status of the work item for <code>jobId</code>.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>com.google.api.services.dataflow.model.Job</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowClient.html#updateJob-java.lang.String-com.google.api.services.dataflow.model.Job-">updateJob</a></span>(java.lang.String jobId, + com.google.api.services.dataflow.model.Job content)</code> +<div class="block">Updates the Dataflow <code>Job</code> with the given <code>jobId</code>.</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="create-org.apache.beam.runners.dataflow.options.DataflowPipelineOptions-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>create</h4> +<pre>public static <a href="../../../../../org/apache/beam/runners/dataflow/DataflowClient.html" title="class in org.apache.beam.runners.dataflow">DataflowClient</a> create(<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> +<a name="createJob-com.google.api.services.dataflow.model.Job-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createJob</h4> +<pre>public com.google.api.services.dataflow.model.Job createJob(@Nonnull + com.google.api.services.dataflow.model.Job job) + throws java.io.IOException</pre> +<div class="block">Creates the Dataflow <code>Job</code>.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +</dl> +</li> +</ul> +<a name="listJobs-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>listJobs</h4> +<pre>public com.google.api.services.dataflow.model.ListJobsResponse listJobs(@Nullable + java.lang.String pageToken) + throws java.io.IOException</pre> +<div class="block">Lists Dataflow <code>Jobs</code> in the project associated with + the <a href="../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.html" title="interface in org.apache.beam.runners.dataflow.options"><code>DataflowPipelineOptions</code></a>.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +</dl> +</li> +</ul> +<a name="updateJob-java.lang.String-com.google.api.services.dataflow.model.Job-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>updateJob</h4> +<pre>public com.google.api.services.dataflow.model.Job updateJob(@Nonnull + java.lang.String jobId, + @Nonnull + com.google.api.services.dataflow.model.Job content) + throws java.io.IOException</pre> +<div class="block">Updates the Dataflow <code>Job</code> with the given <code>jobId</code>.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +</dl> +</li> +</ul> +<a name="getJob-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getJob</h4> +<pre>public com.google.api.services.dataflow.model.Job getJob(@Nonnull + java.lang.String jobId) + throws java.io.IOException</pre> +<div class="block">Gets the Dataflow <code>Job</code> with the given <code>jobId</code>.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +</dl> +</li> +</ul> +<a name="getJobMetrics-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getJobMetrics</h4> +<pre>public com.google.api.services.dataflow.model.JobMetrics getJobMetrics(@Nonnull + java.lang.String jobId) + throws java.io.IOException</pre> +<div class="block">Gets the <code>JobMetrics</code> with the given <code>jobId</code>.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +</dl> +</li> +</ul> +<a name="listJobMessages-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>listJobMessages</h4> +<pre>public com.google.api.services.dataflow.model.ListJobMessagesResponse listJobMessages(@Nonnull + java.lang.String jobId, + @Nullable + java.lang.String pageToken) + throws java.io.IOException</pre> +<div class="block">Lists job messages with the given <code>jobId</code>.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +</dl> +</li> +</ul> +<a name="leaseWorkItem-java.lang.String-com.google.api.services.dataflow.model.LeaseWorkItemRequest-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>leaseWorkItem</h4> +<pre>public com.google.api.services.dataflow.model.LeaseWorkItemResponse leaseWorkItem(@Nonnull + java.lang.String jobId, + @Nonnull + com.google.api.services.dataflow.model.LeaseWorkItemRequest request) + throws java.io.IOException</pre> +<div class="block">Leases the work item for <code>jobId</code>.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +</dl> +</li> +</ul> +<a name="reportWorkItemStatus-java.lang.String-com.google.api.services.dataflow.model.ReportWorkItemStatusRequest-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>reportWorkItemStatus</h4> +<pre>public com.google.api.services.dataflow.model.ReportWorkItemStatusResponse reportWorkItemStatus(@Nonnull + java.lang.String jobId, + @Nonnull + com.google.api.services.dataflow.model.ReportWorkItemStatusRequest request) + throws java.io.IOException</pre> +<div class="block">Reports the status of the work item for <code>jobId</code>.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/beam/runners/dataflow/CreateDataflowView.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/DataflowJobAlreadyExistsException.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/DataflowClient.html" target="_top">Frames</a></li> +<li><a href="DataflowClient.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/beam-site/blob/c196579f/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/DataflowJobAlreadyExistsException.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/DataflowJobAlreadyExistsException.html b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/DataflowJobAlreadyExistsException.html new file mode 100644 index 0000000..f5038ca --- /dev/null +++ b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/DataflowJobAlreadyExistsException.html @@ -0,0 +1,286 @@ +<!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:03 PDT 2017 --> +<title>DataflowJobAlreadyExistsException</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="DataflowJobAlreadyExistsException"; + } + } + 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/DataflowClient.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/DataflowJobAlreadyUpdatedException.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/DataflowJobAlreadyExistsException.html" target="_top">Frames</a></li> +<li><a href="DataflowJobAlreadyExistsException.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="#methods.inherited.from.class.org.apache.beam.runners.dataflow.DataflowJobException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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 DataflowJobAlreadyExistsException" class="title">Class DataflowJobAlreadyExistsException</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.DataflowJobAlreadyExistsException</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">DataflowJobAlreadyExistsException</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">An exception that is thrown if the unique job name constraint of the Dataflow + service is broken because an existing job with the same job name is currently active. + The <a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html" title="class in org.apache.beam.runners.dataflow"><code>DataflowPipelineJob</code></a> contained within this exception contains information + about the pre-existing job.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../serialized-form.html#org.apache.beam.runners.dataflow.DataflowJobAlreadyExistsException">Serialized Form</a></dd> +</dl> +</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/DataflowJobAlreadyExistsException.html#DataflowJobAlreadyExistsException-org.apache.beam.runners.dataflow.DataflowPipelineJob-java.lang.String-">DataflowJobAlreadyExistsException</a></span>(<a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html" title="class in org.apache.beam.runners.dataflow">DataflowPipelineJob</a> job, + java.lang.String message)</code> +<div class="block">Create a new <code>DataflowJobAlreadyExistsException</code> with the specified <a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html" title="class in org.apache.beam.runners.dataflow"><code>DataflowPipelineJob</code></a> and message.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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 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="DataflowJobAlreadyExistsException-org.apache.beam.runners.dataflow.DataflowPipelineJob-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DataflowJobAlreadyExistsException</h4> +<pre>public DataflowJobAlreadyExistsException(<a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html" title="class in org.apache.beam.runners.dataflow">DataflowPipelineJob</a> job, + java.lang.String message)</pre> +<div class="block">Create a new <code>DataflowJobAlreadyExistsException</code> with the specified <a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html" title="class in org.apache.beam.runners.dataflow"><code>DataflowPipelineJob</code></a> and message.</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/DataflowClient.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/DataflowJobAlreadyUpdatedException.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/DataflowJobAlreadyExistsException.html" target="_top">Frames</a></li> +<li><a href="DataflowJobAlreadyExistsException.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="#methods.inherited.from.class.org.apache.beam.runners.dataflow.DataflowJobException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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/c196579f/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/DataflowJobAlreadyUpdatedException.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/DataflowJobAlreadyUpdatedException.html b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/DataflowJobAlreadyUpdatedException.html new file mode 100644 index 0000000..8682776 --- /dev/null +++ b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/DataflowJobAlreadyUpdatedException.html @@ -0,0 +1,285 @@ +<!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:03 PDT 2017 --> +<title>DataflowJobAlreadyUpdatedException</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="DataflowJobAlreadyUpdatedException"; + } + } + 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/DataflowJobAlreadyExistsException.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/DataflowJobException.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/DataflowJobAlreadyUpdatedException.html" target="_top">Frames</a></li> +<li><a href="DataflowJobAlreadyUpdatedException.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="#methods.inherited.from.class.org.apache.beam.runners.dataflow.DataflowJobException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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 DataflowJobAlreadyUpdatedException" class="title">Class DataflowJobAlreadyUpdatedException</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.DataflowJobAlreadyUpdatedException</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">DataflowJobAlreadyUpdatedException</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">An exception that is thrown if the existing job has already been updated within the Dataflow + service and is no longer able to be updated. The <a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html" title="class in org.apache.beam.runners.dataflow"><code>DataflowPipelineJob</code></a> contained within + this exception contains information about the pre-existing updated job.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../serialized-form.html#org.apache.beam.runners.dataflow.DataflowJobAlreadyUpdatedException">Serialized Form</a></dd> +</dl> +</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/DataflowJobAlreadyUpdatedException.html#DataflowJobAlreadyUpdatedException-org.apache.beam.runners.dataflow.DataflowPipelineJob-java.lang.String-">DataflowJobAlreadyUpdatedException</a></span>(<a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html" title="class in org.apache.beam.runners.dataflow">DataflowPipelineJob</a> job, + java.lang.String message)</code> +<div class="block">Create a new <code>DataflowJobAlreadyUpdatedException</code> with the specified <a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html" title="class in org.apache.beam.runners.dataflow"><code>DataflowPipelineJob</code></a> and message.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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 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="DataflowJobAlreadyUpdatedException-org.apache.beam.runners.dataflow.DataflowPipelineJob-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DataflowJobAlreadyUpdatedException</h4> +<pre>public DataflowJobAlreadyUpdatedException(<a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html" title="class in org.apache.beam.runners.dataflow">DataflowPipelineJob</a> job, + java.lang.String message)</pre> +<div class="block">Create a new <code>DataflowJobAlreadyUpdatedException</code> with the specified <a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html" title="class in org.apache.beam.runners.dataflow"><code>DataflowPipelineJob</code></a> and message.</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/DataflowJobAlreadyExistsException.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/DataflowJobException.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/DataflowJobAlreadyUpdatedException.html" target="_top">Frames</a></li> +<li><a href="DataflowJobAlreadyUpdatedException.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="#methods.inherited.from.class.org.apache.beam.runners.dataflow.DataflowJobException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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/c196579f/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/DataflowJobException.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/DataflowJobException.html b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/DataflowJobException.html new file mode 100644 index 0000000..2166f60 --- /dev/null +++ b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/DataflowJobException.html @@ -0,0 +1,273 @@ +<!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:03 PDT 2017 --> +<title>DataflowJobException</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="DataflowJobException"; + } + } + 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/DataflowJobAlreadyUpdatedException.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/DataflowPipelineJob.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/DataflowJobException.html" target="_top">Frames</a></li> +<li><a href="DataflowJobException.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 DataflowJobException" class="title">Class DataflowJobException</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>org.apache.beam.runners.dataflow.DataflowJobException</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> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../org/apache/beam/runners/dataflow/DataflowJobAlreadyExistsException.html" title="class in org.apache.beam.runners.dataflow">DataflowJobAlreadyExistsException</a>, <a href="../../../../../org/apache/beam/runners/dataflow/DataflowJobAlreadyUpdatedException.html" title="class in org.apache.beam.runners.dataflow">DataflowJobAlreadyUpdatedException</a>, <a href="../../../../../org/apache/beam/runners/dataflow/DataflowServiceException.html" title="class in org.apache.beam.runners.dataflow">DataflowServiceException</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">DataflowJobException</span> +extends java.lang.RuntimeException</pre> +<div class="block">A <code>RuntimeException</code> that contains information about a <a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html" title="class in org.apache.beam.runners.dataflow"><code>DataflowPipelineJob</code></a>.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../serialized-form.html#org.apache.beam.runners.dataflow.DataflowJobException">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> +<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/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/DataflowJobException.html#getJob--">getJob</a></span>()</code> +<div class="block">Returns the failed job.</div> +</td> +</tr> +</table> +<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 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="getJob--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getJob</h4> +<pre>public <a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html" title="class in org.apache.beam.runners.dataflow">DataflowPipelineJob</a> getJob()</pre> +<div class="block">Returns the failed job.</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/DataflowJobAlreadyUpdatedException.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/DataflowPipelineJob.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/DataflowJobException.html" target="_top">Frames</a></li> +<li><a href="DataflowJobException.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/beam-site/blob/c196579f/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/DataflowPipelineJob.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/DataflowPipelineJob.html b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/DataflowPipelineJob.html new file mode 100644 index 0000000..08bcc8a --- /dev/null +++ b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/DataflowPipelineJob.html @@ -0,0 +1,570 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_112-google-v7) on Fri May 12 16:50:03 PDT 2017 --> +<title>DataflowPipelineJob</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="DataflowPipelineJob"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":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/DataflowJobException.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/DataflowPipelineRegistrar.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/DataflowPipelineJob.html" target="_top">Frames</a></li> +<li><a href="DataflowPipelineJob.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.dataflow</div> +<h2 title="Class DataflowPipelineJob" class="title">Class DataflowPipelineJob</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.dataflow.DataflowPipelineJob</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/dataflow/util/DataflowTemplateJob.html" title="class in org.apache.beam.runners.dataflow.util">DataflowTemplateJob</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">DataflowPipelineJob</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">A DataflowPipelineJob represents a job submitted to Dataflow using + <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"> +<!-- ======== 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 java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html#jobId">jobId</a></span></code> +<div class="block">The id for the job.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected static org.apache.beam.sdk.util.FluentBackoff</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html#STATUS_BACKOFF_FACTORY">STATUS_BACKOFF_FACTORY</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="http://google.github.io/guava/releases/20.0/api/docs/com/google/common/collect/BiMap.html?is-external=true" title="class or interface in com.google.common.collect">BiMap</a><org.apache.beam.sdk.runners.AppliedPTransform<?,?,?>,java.lang.String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html#transformStepNames">transformStepNames</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/dataflow/DataflowPipelineJob.html#DataflowPipelineJob-org.apache.beam.runners.dataflow.DataflowClient-java.lang.String-org.apache.beam.runners.dataflow.options.DataflowPipelineOptions-java.util.Map-">DataflowPipelineJob</a></span>(<a href="../../../../../org/apache/beam/runners/dataflow/DataflowClient.html" title="class in org.apache.beam.runners.dataflow">DataflowClient</a> dataflowClient, + java.lang.String jobId, + <a href="../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.html" title="interface in org.apache.beam.runners.dataflow.options">DataflowPipelineOptions</a> dataflowOptions, + java.util.Map<org.apache.beam.sdk.runners.AppliedPTransform<?,?,?>,java.lang.String> transformStepNames)</code> +<div class="block">Constructs the job.</div> +</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/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/dataflow/DataflowPipelineJob.html#cancel--">cancel</a></span>()</code> +<div class="block">Cancels the pipeline execution.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html#getJobId--">getJobId</a></span>()</code> +<div class="block">Get the id of this job.</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/DataflowPipelineJob.html#getProjectId--">getProjectId</a></span>()</code> +<div class="block">Get the project this job exists in.</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/DataflowPipelineJob.html#getReplacedByJob--">getReplacedByJob</a></span>()</code> +<div class="block">Returns a new <a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html" title="class in org.apache.beam.runners.dataflow"><code>DataflowPipelineJob</code></a> for the job that replaced this one, if applicable.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html#getState--">getState</a></span>()</code> +<div class="block">Retrieves the current state of the pipeline execution.</div> +</td> +</tr> +<tr id="i5" 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/dataflow/DataflowPipelineJob.html#metrics--">metrics</a></span>()</code> +<div class="block">Returns the object to access metrics from the pipeline.</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/dataflow/DataflowPipelineJob.html#waitUntilFinish--">waitUntilFinish</a></span>()</code> +<div class="block">Waits until the pipeline finishes and returns the final status.</div> +</td> +</tr> +<tr id="i7" 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/dataflow/DataflowPipelineJob.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> +<tr id="i8" 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/dataflow/DataflowPipelineJob.html#waitUntilFinish-org.joda.time.Duration-org.apache.beam.runners.dataflow.util.MonitoringUtil.JobMessagesHandler-">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, + <a href="../../../../../org/apache/beam/runners/dataflow/util/MonitoringUtil.JobMessagesHandler.html" title="interface in org.apache.beam.runners.dataflow.util">MonitoringUtil.JobMessagesHandler</a> messageHandler)</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="jobId"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>jobId</h4> +<pre>protected java.lang.String jobId</pre> +<div class="block">The id for the job.</div> +</li> +</ul> +<a name="transformStepNames"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>transformStepNames</h4> +<pre>protected <a href="http://google.github.io/guava/releases/20.0/api/docs/com/google/common/collect/BiMap.html?is-external=true" title="class or interface in com.google.common.collect">BiMap</a><org.apache.beam.sdk.runners.AppliedPTransform<?,?,?>,java.lang.String> transformStepNames</pre> +</li> +</ul> +<a name="STATUS_BACKOFF_FACTORY"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>STATUS_BACKOFF_FACTORY</h4> +<pre>protected static final org.apache.beam.sdk.util.FluentBackoff STATUS_BACKOFF_FACTORY</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="DataflowPipelineJob-org.apache.beam.runners.dataflow.DataflowClient-java.lang.String-org.apache.beam.runners.dataflow.options.DataflowPipelineOptions-java.util.Map-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DataflowPipelineJob</h4> +<pre>public DataflowPipelineJob(<a href="../../../../../org/apache/beam/runners/dataflow/DataflowClient.html" title="class in org.apache.beam.runners.dataflow">DataflowClient</a> dataflowClient, + java.lang.String jobId, + <a href="../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.html" title="interface in org.apache.beam.runners.dataflow.options">DataflowPipelineOptions</a> dataflowOptions, + java.util.Map<org.apache.beam.sdk.runners.AppliedPTransform<?,?,?>,java.lang.String> transformStepNames)</pre> +<div class="block">Constructs the job.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>jobId</code> - the job id</dd> +<dd><code>dataflowOptions</code> - used to configure the client for the Dataflow Service</dd> +<dd><code>transformStepNames</code> - a mapping from AppliedPTransforms to Step Names</dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getJobId--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getJobId</h4> +<pre>public java.lang.String getJobId()</pre> +<div class="block">Get the id of this job.</div> +</li> +</ul> +<a name="getProjectId--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProjectId</h4> +<pre>public java.lang.String getProjectId()</pre> +<div class="block">Get the project this job exists in.</div> +</li> +</ul> +<a name="getReplacedByJob--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReplacedByJob</h4> +<pre>public <a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html" title="class in org.apache.beam.runners.dataflow">DataflowPipelineJob</a> getReplacedByJob()</pre> +<div class="block">Returns a new <a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html" title="class in org.apache.beam.runners.dataflow"><code>DataflowPipelineJob</code></a> for the job that replaced this one, if applicable.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if called before the job has terminated or if the job terminated + but was not updated</dd> +</dl> +</li> +</ul> +<a name="waitUntilFinish--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>waitUntilFinish</h4> +<pre>@Nullable +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>@Nullable +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="waitUntilFinish-org.joda.time.Duration-org.apache.beam.runners.dataflow.util.MonitoringUtil.JobMessagesHandler-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>waitUntilFinish</h4> +<pre>@Nullable +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, + <a href="../../../../../org/apache/beam/runners/dataflow/util/MonitoringUtil.JobMessagesHandler.html" title="interface in org.apache.beam.runners.dataflow.util">MonitoringUtil.JobMessagesHandler</a> messageHandler) + throws java.io.IOException, + java.lang.InterruptedException</pre> +<div class="block">Waits until the pipeline finishes and returns the final status.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>duration</code> - The time to wait for the job to finish. + Provide a value less than 1 ms for an infinite wait.</dd> +<dd><code>messageHandler</code> - If non null this handler will be invoked for each + batch of messages received.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The final state of the job or null on timeout or if the + thread is interrupted.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - If there is a persistent problem getting job + information.</dd> +<dd><code>java.lang.InterruptedException</code></dd> +</dl> +</li> +</ul> +<a name="cancel--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>cancel</h4> +<pre>public <a href="../../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a> cancel() + throws java.io.IOException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html#cancel--">PipelineResult</a></code></span></div> +<div class="block">Cancels the pipeline execution.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html#cancel--">cancel</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html" title="interface in org.apache.beam.sdk">PipelineResult</a></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if there is a problem executing the cancel request.</dd> +</dl> +</li> +</ul> +<a name="getState--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getState</h4> +<pre>public <a href="../../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a> getState()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html#getState--">PipelineResult</a></code></span></div> +<div class="block">Retrieves the current state of the pipeline execution.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html#getState--">getState</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html" title="interface in org.apache.beam.sdk">PipelineResult</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the <a href="../../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk"><code>PipelineResult.State</code></a> representing the state of this pipeline.</dd> +</dl> +</li> +</ul> +<a name="metrics--"> +<!-- --> +</a> +<ul class="blockListLast"> +<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> +</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/DataflowJobException.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/DataflowPipelineRegistrar.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/DataflowPipelineJob.html" target="_top">Frames</a></li> +<li><a href="DataflowPipelineJob.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>