http://git-wip-us.apache.org/repos/asf/beam-site/blob/c196579f/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/util/CloudObject.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/util/CloudObject.html b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/util/CloudObject.html new file mode 100644 index 0000000..08e7134 --- /dev/null +++ b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/util/CloudObject.html @@ -0,0 +1,564 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_112-google-v7) on Fri May 12 16:50:04 PDT 2017 --> +<title>CloudObject</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="CloudObject"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":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>Prev Class</li> +<li><a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObjects.html" title="class in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/dataflow/util/CloudObject.html" target="_top">Frames</a></li> +<li><a href="CloudObject.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.classes.inherited.from.class.com.google.api.client.util.GenericData">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.beam.runners.dataflow.util</div> +<h2 title="Class CloudObject" class="title">Class CloudObject</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.util.AbstractMap<java.lang.String,java.lang.Object></li> +<li> +<ul class="inheritance"> +<li>com.google.api.client.util.GenericData</li> +<li> +<ul class="inheritance"> +<li>com.google.api.client.json.GenericJson</li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.dataflow.util.CloudObject</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.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object></dd> +</dl> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">CloudObject</span> +extends com.google.api.client.json.GenericJson</pre> +<div class="block">A representation of an arbitrary Java object to be instantiated by Dataflow + workers. + + <p>Typically, an object to be written by the SDK to the Dataflow service will + implement a method (typically called <code>asCloudObject()</code>) that returns a + <code>CloudObject</code> to represent the object in the protocol. Once the + <code>CloudObject</code> is constructed, the method should explicitly add + additional properties to be presented during deserialization, representing + child objects by building additional <code>CloudObject</code>s.</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.com.google.api.client.util.GenericData"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class com.google.api.client.util.GenericData</h3> +<code>com.google.api.client.util.GenericData.Flags</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="nested.classes.inherited.from.class.java.util.AbstractMap"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class java.util.AbstractMap</h3> +<code>java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="nested.classes.inherited.from.class.java.util.Map"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface java.util.Map</h3> +<code>java.util.Map.Entry<K,V></code></li> +</ul> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="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><a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util">CloudObject</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html#clone--">clone</a></span>()</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util">CloudObject</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html#forBoolean-java.lang.Boolean-">forBoolean</a></span>(java.lang.Boolean value)</code> +<div class="block">Constructs a <code>CloudObject</code> representing the given value.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util">CloudObject</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html#forClass-java.lang.Class-">forClass</a></span>(java.lang.Class<?> cls)</code> +<div class="block">Constructs a <code>CloudObject</code> to be used for serializing an instance of + the supplied class for transport via the Dataflow API.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util">CloudObject</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html#forClassName-java.lang.String-">forClassName</a></span>(java.lang.String className)</code> +<div class="block">Constructs a <code>CloudObject</code> to be used for serializing data to be + deserialized using the supplied class name the supplied class name for + transport via the Dataflow API.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util">CloudObject</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html#forFloat-java.lang.Double-">forFloat</a></span>(java.lang.Double value)</code> +<div class="block">Constructs a <code>CloudObject</code> representing the given value.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util">CloudObject</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html#forFloat-java.lang.Float-">forFloat</a></span>(java.lang.Float value)</code> +<div class="block">Constructs a <code>CloudObject</code> representing the given value.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util">CloudObject</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html#forInteger-java.lang.Integer-">forInteger</a></span>(java.lang.Integer value)</code> +<div class="block">Constructs a <code>CloudObject</code> representing the given value.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util">CloudObject</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html#forInteger-java.lang.Long-">forInteger</a></span>(java.lang.Long value)</code> +<div class="block">Constructs a <code>CloudObject</code> representing the given value.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util">CloudObject</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html#forKnownType-java.lang.Object-">forKnownType</a></span>(java.lang.Object value)</code> +<div class="block">Constructs a <code>CloudObject</code> representing the given value of a + well-known cloud object type.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util">CloudObject</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html#forString-java.lang.String-">forString</a></span>(java.lang.String value)</code> +<div class="block">Constructs a <code>CloudObject</code> representing the given value.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util">CloudObject</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html#fromSpec-java.util.Map-">fromSpec</a></span>(java.util.Map<java.lang.String,java.lang.Object> spec)</code> +<div class="block">Constructs a <code>CloudObject</code> by copying the supplied serialized object + spec, which must represent an SDK object serialized for transport via the + Dataflow API.</div> +</td> +</tr> +<tr id="i11" 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/util/CloudObject.html#getClassName--">getClassName</a></span>()</code> +<div class="block">Gets the name of the Java class that this CloudObject represents.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.com.google.api.client.json.GenericJson"> +<!-- --> +</a> +<h3>Methods inherited from class com.google.api.client.json.GenericJson</h3> +<code>getFactory, set, setFactory, toPrettyString, toString</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.com.google.api.client.util.GenericData"> +<!-- --> +</a> +<h3>Methods inherited from class com.google.api.client.util.GenericData</h3> +<code>entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.util.AbstractMap"> +<!-- --> +</a> +<h3>Methods inherited from class java.util.AbstractMap</h3> +<code>clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values</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>finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.util.Map"> +<!-- --> +</a> +<h3>Methods inherited from interface java.util.Map</h3> +<code>compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll</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="fromSpec-java.util.Map-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fromSpec</h4> +<pre>public static <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util">CloudObject</a> fromSpec(java.util.Map<java.lang.String,java.lang.Object> spec)</pre> +<div class="block">Constructs a <code>CloudObject</code> by copying the supplied serialized object + spec, which must represent an SDK object serialized for transport via the + Dataflow API. + + <p>The most common use of this method is during deserialization on the worker, + where it's used as a binding type during instance construction.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>spec</code> - supplies the serialized form of the object as a nested map</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.RuntimeException</code> - if the supplied map does not represent an SDK object</dd> +</dl> +</li> +</ul> +<a name="forClass-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>forClass</h4> +<pre>public static <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util">CloudObject</a> forClass(java.lang.Class<?> cls)</pre> +<div class="block">Constructs a <code>CloudObject</code> to be used for serializing an instance of + the supplied class for transport via the Dataflow API. The instance + parameters to be serialized must be supplied explicitly after the + <code>CloudObject</code> is created, by using <code>GenericData.put(java.lang.String, java.lang.Object)</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>cls</code> - the class to use when deserializing the object on the worker</dd> +</dl> +</li> +</ul> +<a name="forClassName-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>forClassName</h4> +<pre>public static <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util">CloudObject</a> forClassName(java.lang.String className)</pre> +<div class="block">Constructs a <code>CloudObject</code> to be used for serializing data to be + deserialized using the supplied class name the supplied class name for + transport via the Dataflow API. The instance parameters to be serialized + must be supplied explicitly after the <code>CloudObject</code> is created, by + using <code>GenericData.put(java.lang.String, java.lang.Object)</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>className</code> - the class to use when deserializing the object on the worker</dd> +</dl> +</li> +</ul> +<a name="forString-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>forString</h4> +<pre>public static <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util">CloudObject</a> forString(java.lang.String value)</pre> +<div class="block">Constructs a <code>CloudObject</code> representing the given value.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - the scalar value to represent.</dd> +</dl> +</li> +</ul> +<a name="forBoolean-java.lang.Boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>forBoolean</h4> +<pre>public static <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util">CloudObject</a> forBoolean(java.lang.Boolean value)</pre> +<div class="block">Constructs a <code>CloudObject</code> representing the given value.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - the scalar value to represent.</dd> +</dl> +</li> +</ul> +<a name="forInteger-java.lang.Long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>forInteger</h4> +<pre>public static <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util">CloudObject</a> forInteger(java.lang.Long value)</pre> +<div class="block">Constructs a <code>CloudObject</code> representing the given value.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - the scalar value to represent.</dd> +</dl> +</li> +</ul> +<a name="forInteger-java.lang.Integer-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>forInteger</h4> +<pre>public static <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util">CloudObject</a> forInteger(java.lang.Integer value)</pre> +<div class="block">Constructs a <code>CloudObject</code> representing the given value.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - the scalar value to represent.</dd> +</dl> +</li> +</ul> +<a name="forFloat-java.lang.Float-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>forFloat</h4> +<pre>public static <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util">CloudObject</a> forFloat(java.lang.Float value)</pre> +<div class="block">Constructs a <code>CloudObject</code> representing the given value.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - the scalar value to represent.</dd> +</dl> +</li> +</ul> +<a name="forFloat-java.lang.Double-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>forFloat</h4> +<pre>public static <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util">CloudObject</a> forFloat(java.lang.Double value)</pre> +<div class="block">Constructs a <code>CloudObject</code> representing the given value.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - the scalar value to represent.</dd> +</dl> +</li> +</ul> +<a name="forKnownType-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>forKnownType</h4> +<pre>public static <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util">CloudObject</a> forKnownType(java.lang.Object value)</pre> +<div class="block">Constructs a <code>CloudObject</code> representing the given value of a + well-known cloud object type.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - the scalar value to represent.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.RuntimeException</code> - if the value does not have a + <code>CloudKnownType</code> mapping</dd> +</dl> +</li> +</ul> +<a name="getClassName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getClassName</h4> +<pre>public java.lang.String getClassName()</pre> +<div class="block">Gets the name of the Java class that this CloudObject represents.</div> +</li> +</ul> +<a name="clone--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>clone</h4> +<pre>public <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util">CloudObject</a> clone()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>clone</code> in class <code>com.google.api.client.json.GenericJson</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>Prev Class</li> +<li><a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObjects.html" title="class in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/dataflow/util/CloudObject.html" target="_top">Frames</a></li> +<li><a href="CloudObject.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.classes.inherited.from.class.com.google.api.client.util.GenericData">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/beam-site/blob/c196579f/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/util/CloudObjectTranslator.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/util/CloudObjectTranslator.html b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/util/CloudObjectTranslator.html new file mode 100644 index 0000000..751399e --- /dev/null +++ b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/util/CloudObjectTranslator.html @@ -0,0 +1,274 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_112-google-v7) on Fri May 12 16:50:04 PDT 2017 --> +<title>CloudObjectTranslator</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="CloudObjectTranslator"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObjects.html" title="class in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/dataflow/util/CoderCloudObjectTranslatorRegistrar.html" title="interface in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/dataflow/util/CloudObjectTranslator.html" target="_top">Frames</a></li> +<li><a href="CloudObjectTranslator.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.util</div> +<h2 title="Interface CloudObjectTranslator" class="title">Interface CloudObjectTranslator<T></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">CloudObjectTranslator<T></span></pre> +<div class="block">A translator that takes an object and creates a <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util"><code>CloudObject</code></a> which can be converted back + to the original object.</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>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObjectTranslator.html#cloudObjectClassName--">cloudObjectClassName</a></span>()</code> +<div class="block">Gets the class name that will represent the <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util"><code>CloudObject</code></a> created by this <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObjectTranslator.html" title="interface in org.apache.beam.runners.dataflow.util"><code>CloudObjectTranslator</code></a>.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObjectTranslator.html" title="type parameter in CloudObjectTranslator">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObjectTranslator.html#fromCloudObject-org.apache.beam.runners.dataflow.util.CloudObject-">fromCloudObject</a></span>(<a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util">CloudObject</a> cloudObject)</code> +<div class="block">Converts back into the original object from a provided <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util"><code>CloudObject</code></a>.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObjectTranslator.html" title="type parameter in CloudObjectTranslator">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObjectTranslator.html#getSupportedClass--">getSupportedClass</a></span>()</code> +<div class="block">Gets the class this <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObjectTranslator.html" title="interface in org.apache.beam.runners.dataflow.util"><code>CloudObjectTranslator</code></a> is capable of converting.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util">CloudObject</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObjectTranslator.html#toCloudObject-T-">toCloudObject</a></span>(<a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObjectTranslator.html" title="type parameter in CloudObjectTranslator">T</a> target)</code> +<div class="block">Converts the provided object into an equivalent <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util"><code>CloudObject</code></a>.</div> +</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="toCloudObject-java.lang.Object-"> +<!-- --> +</a><a name="toCloudObject-T-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toCloudObject</h4> +<pre><a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util">CloudObject</a> toCloudObject(<a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObjectTranslator.html" title="type parameter in CloudObjectTranslator">T</a> target)</pre> +<div class="block">Converts the provided object into an equivalent <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util"><code>CloudObject</code></a>.</div> +</li> +</ul> +<a name="fromCloudObject-org.apache.beam.runners.dataflow.util.CloudObject-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fromCloudObject</h4> +<pre><a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObjectTranslator.html" title="type parameter in CloudObjectTranslator">T</a> fromCloudObject(<a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util">CloudObject</a> cloudObject)</pre> +<div class="block">Converts back into the original object from a provided <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util"><code>CloudObject</code></a>.</div> +</li> +</ul> +<a name="getSupportedClass--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSupportedClass</h4> +<pre>java.lang.Class<? extends <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObjectTranslator.html" title="type parameter in CloudObjectTranslator">T</a>> getSupportedClass()</pre> +<div class="block">Gets the class this <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObjectTranslator.html" title="interface in org.apache.beam.runners.dataflow.util"><code>CloudObjectTranslator</code></a> is capable of converting.</div> +</li> +</ul> +<a name="cloudObjectClassName--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>cloudObjectClassName</h4> +<pre>java.lang.String cloudObjectClassName()</pre> +<div class="block">Gets the class name that will represent the <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util"><code>CloudObject</code></a> created by this <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObjectTranslator.html" title="interface in org.apache.beam.runners.dataflow.util"><code>CloudObjectTranslator</code></a>.</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/util/CloudObjects.html" title="class in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/dataflow/util/CoderCloudObjectTranslatorRegistrar.html" title="interface in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/dataflow/util/CloudObjectTranslator.html" target="_top">Frames</a></li> +<li><a href="CloudObjectTranslator.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/util/CloudObjects.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/util/CloudObjects.html b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/util/CloudObjects.html new file mode 100644 index 0000000..e678419 --- /dev/null +++ b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/util/CloudObjects.html @@ -0,0 +1,252 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_112-google-v7) on Fri May 12 16:50:04 PDT 2017 --> +<title>CloudObjects</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="CloudObjects"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObjectTranslator.html" title="interface in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/dataflow/util/CloudObjects.html" target="_top">Frames</a></li> +<li><a href="CloudObjects.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.util</div> +<h2 title="Class CloudObjects" class="title">Class CloudObjects</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.dataflow.util.CloudObjects</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">CloudObjects</span> +extends java.lang.Object</pre> +<div class="block">Utilities for converting an object to a <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util"><code>CloudObject</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="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/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util">CloudObject</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObjects.html#asCloudObject-org.apache.beam.sdk.coders.Coder-">asCloudObject</a></span>(<a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><?> coder)</code> +<div class="block">Convert the provided <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> into a <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util"><code>CloudObject</code></a>.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><?></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObjects.html#coderFromCloudObject-org.apache.beam.runners.dataflow.util.CloudObject-">coderFromCloudObject</a></span>(<a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util">CloudObject</a> cloudObject)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="asCloudObject-org.apache.beam.sdk.coders.Coder-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asCloudObject</h4> +<pre>public static <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util">CloudObject</a> asCloudObject(<a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><?> coder)</pre> +<div class="block">Convert the provided <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> into a <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util"><code>CloudObject</code></a>.</div> +</li> +</ul> +<a name="coderFromCloudObject-org.apache.beam.runners.dataflow.util.CloudObject-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>coderFromCloudObject</h4> +<pre>public static <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><?> coderFromCloudObject(<a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util">CloudObject</a> cloudObject)</pre> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html" title="class in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObjectTranslator.html" title="interface in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/dataflow/util/CloudObjects.html" target="_top">Frames</a></li> +<li><a href="CloudObjects.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/util/CoderCloudObjectTranslatorRegistrar.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/util/CoderCloudObjectTranslatorRegistrar.html b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/util/CoderCloudObjectTranslatorRegistrar.html new file mode 100644 index 0000000..69db3c5 --- /dev/null +++ b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/util/CoderCloudObjectTranslatorRegistrar.html @@ -0,0 +1,250 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_112-google-v7) on Fri May 12 16:50:04 PDT 2017 --> +<title>CoderCloudObjectTranslatorRegistrar</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="CoderCloudObjectTranslatorRegistrar"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObjectTranslator.html" title="interface in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/dataflow/util/DataflowTemplateJob.html" title="class in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/dataflow/util/CoderCloudObjectTranslatorRegistrar.html" target="_top">Frames</a></li> +<li><a href="CoderCloudObjectTranslatorRegistrar.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.util</div> +<h2 title="Interface CoderCloudObjectTranslatorRegistrar" class="title">Interface CoderCloudObjectTranslatorRegistrar</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../../org/apache/beam/runners/dataflow/util/DefaultCoderCloudObjectTranslatorRegistrar.html" title="class in org.apache.beam.runners.dataflow.util">DefaultCoderCloudObjectTranslatorRegistrar</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">CoderCloudObjectTranslatorRegistrar</span></pre> +<div class="block"><a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> authors have the ability to automatically have their <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> registered with + the Dataflow Runner by creating a <code>ServiceLoader</code> entry and a concrete implementation of + this interface. + + <p>It is optional but recommended to use one of the many build time tools such as + <code>AutoService</code> to generate the necessary META-INF files automatically.</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>java.util.Map<java.lang.Class<? extends <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>>,<a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObjectTranslator.html" title="interface in org.apache.beam.runners.dataflow.util">CloudObjectTranslator</a><? extends <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/CoderCloudObjectTranslatorRegistrar.html#classesToTranslators--">classesToTranslators</a></span>()</code> +<div class="block">Gets a map from <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> to a <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObjectTranslator.html" title="interface in org.apache.beam.runners.dataflow.util"><code>CloudObjectTranslator</code></a> that can translate that <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a>.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>java.util.Map<java.lang.String,<a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObjectTranslator.html" title="interface in org.apache.beam.runners.dataflow.util">CloudObjectTranslator</a><? extends <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/CoderCloudObjectTranslatorRegistrar.html#classNamesToTranslators--">classNamesToTranslators</a></span>()</code> +<div class="block">Gets a map from the name returned by <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html#getClassName--"><code>CloudObject.getClassName()</code></a> to a translator that + can convert into the equivalent <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a>.</div> +</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="classesToTranslators--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>classesToTranslators</h4> +<pre>java.util.Map<java.lang.Class<? extends <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>>,<a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObjectTranslator.html" title="interface in org.apache.beam.runners.dataflow.util">CloudObjectTranslator</a><? extends <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>>> classesToTranslators()</pre> +<div class="block">Gets a map from <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> to a <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObjectTranslator.html" title="interface in org.apache.beam.runners.dataflow.util"><code>CloudObjectTranslator</code></a> that can translate that <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a>.</div> +</li> +</ul> +<a name="classNamesToTranslators--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>classNamesToTranslators</h4> +<pre>java.util.Map<java.lang.String,<a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObjectTranslator.html" title="interface in org.apache.beam.runners.dataflow.util">CloudObjectTranslator</a><? extends <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>>> classNamesToTranslators()</pre> +<div class="block">Gets a map from the name returned by <a href="../../../../../../org/apache/beam/runners/dataflow/util/CloudObject.html#getClassName--"><code>CloudObject.getClassName()</code></a> to a translator that + can convert into the equivalent <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a>.</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/util/CloudObjectTranslator.html" title="interface in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/dataflow/util/DataflowTemplateJob.html" title="class in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/dataflow/util/CoderCloudObjectTranslatorRegistrar.html" target="_top">Frames</a></li> +<li><a href="CoderCloudObjectTranslatorRegistrar.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/util/DataflowTemplateJob.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/util/DataflowTemplateJob.html b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/util/DataflowTemplateJob.html new file mode 100644 index 0000000..a6ae221 --- /dev/null +++ b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/util/DataflowTemplateJob.html @@ -0,0 +1,414 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_112-google-v7) on Fri May 12 16:50:04 PDT 2017 --> +<title>DataflowTemplateJob</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="DataflowTemplateJob"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/beam/runners/dataflow/util/CoderCloudObjectTranslatorRegistrar.html" title="interface in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/dataflow/util/DataflowTransport.html" title="class in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/dataflow/util/DataflowTemplateJob.html" target="_top">Frames</a></li> +<li><a href="DataflowTemplateJob.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="#fields.inherited.from.class.org.apache.beam.runners.dataflow.DataflowPipelineJob">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>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.util</div> +<h2 title="Class DataflowTemplateJob" class="title">Class DataflowTemplateJob</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html" title="class in org.apache.beam.runners.dataflow">org.apache.beam.runners.dataflow.DataflowPipelineJob</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.dataflow.util.DataflowTemplateJob</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../../org/apache/beam/sdk/PipelineResult.html" title="interface in org.apache.beam.sdk">PipelineResult</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">DataflowTemplateJob</span> +extends <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/runners/dataflow/DataflowPipelineJob.html" title="class in org.apache.beam.runners.dataflow"><code>DataflowPipelineJob</code></a> that is returned when <code>--templateRunner</code> is set.</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> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.beam.runners.dataflow.DataflowPipelineJob"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.beam.runners.dataflow.<a href="../../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html" title="class in org.apache.beam.runners.dataflow">DataflowPipelineJob</a></h3> +<code><a href="../../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html#jobId">jobId</a>, <a href="../../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html#STATUS_BACKOFF_FACTORY">STATUS_BACKOFF_FACTORY</a>, <a href="../../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html#transformStepNames">transformStepNames</a></code></li> +</ul> +</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/util/DataflowTemplateJob.html#DataflowTemplateJob--">DataflowTemplateJob</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><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/util/DataflowTemplateJob.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/util/DataflowTemplateJob.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/util/DataflowTemplateJob.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/util/DataflowTemplateJob.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/util/DataflowTemplateJob.html#getState--">getState</a></span>()</code> +<div class="block">Retrieves the current state of the pipeline execution.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.runners.dataflow.DataflowPipelineJob"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.beam.runners.dataflow.<a href="../../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html" title="class in org.apache.beam.runners.dataflow">DataflowPipelineJob</a></h3> +<code><a href="../../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html#metrics--">metrics</a>, <a href="../../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html#waitUntilFinish--">waitUntilFinish</a>, <a href="../../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html#waitUntilFinish-org.joda.time.Duration-">waitUntilFinish</a>, <a href="../../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html#waitUntilFinish-org.joda.time.Duration-org.apache.beam.runners.dataflow.util.MonitoringUtil.JobMessagesHandler-">waitUntilFinish</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="DataflowTemplateJob--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DataflowTemplateJob</h4> +<pre>public DataflowTemplateJob()</pre> +</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"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html#getJobId--">DataflowPipelineJob</a></code></span></div> +<div class="block">Get the id of this job.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html#getJobId--">getJobId</a></code> in class <code><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="getProjectId--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProjectId</h4> +<pre>public java.lang.String getProjectId()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html#getProjectId--">DataflowPipelineJob</a></code></span></div> +<div class="block">Get the project this job exists in.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html#getProjectId--">getProjectId</a></code> in class <code><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="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"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html#getReplacedByJob--">DataflowPipelineJob</a></code></span></div> +<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="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html#getReplacedByJob--">getReplacedByJob</a></code> in class <code><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="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()</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="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html#cancel--">cancel</a></code> in class <code><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="getState--"> +<!-- --> +</a> +<ul class="blockListLast"> +<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="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html#getState--">getState</a></code> in class <code><a href="../../../../../../org/apache/beam/runners/dataflow/DataflowPipelineJob.html" title="class in org.apache.beam.runners.dataflow">DataflowPipelineJob</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> +</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/util/CoderCloudObjectTranslatorRegistrar.html" title="interface in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/dataflow/util/DataflowTransport.html" title="class in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/dataflow/util/DataflowTemplateJob.html" target="_top">Frames</a></li> +<li><a href="DataflowTemplateJob.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="#fields.inherited.from.class.org.apache.beam.runners.dataflow.DataflowPipelineJob">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>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>
