http://git-wip-us.apache.org/repos/asf/beam-site/blob/7b1f1576/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/ElementAndRestrictionCoder.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/ElementAndRestrictionCoder.html b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/ElementAndRestrictionCoder.html new file mode 100644 index 0000000..be59a2e --- /dev/null +++ b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/ElementAndRestrictionCoder.html @@ -0,0 +1,394 @@ +<!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_111) on Fri Jan 27 21:25:28 CET 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ElementAndRestrictionCoder (Apache Beam SDK for Java, version 0.5.0)</title> +<meta name="date" content="2017-01-27"> +<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="ElementAndRestrictionCoder (Apache Beam SDK for Java, version 0.5.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":9}; +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="class-use/ElementAndRestrictionCoder.html">Use</a></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/core/ElementAndRestriction.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/core/ElementByteSizeObservable.html" title="interface in org.apache.beam.runners.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/ElementAndRestrictionCoder.html" target="_top">Frames</a></li> +<li><a href="ElementAndRestrictionCoder.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.core</div> +<h2 title="Class ElementAndRestrictionCoder" class="title">Class ElementAndRestrictionCoder<ElementT,RestrictionT></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/beam/sdk/coders/StandardCoder.html" title="class in org.apache.beam.sdk.coders">org.apache.beam.sdk.coders.StandardCoder</a><T></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/beam/sdk/coders/DeterministicStandardCoder.html" title="class in org.apache.beam.sdk.coders">org.apache.beam.sdk.coders.DeterministicStandardCoder</a><T></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/beam/sdk/coders/AtomicCoder.html" title="class in org.apache.beam.sdk.coders">org.apache.beam.sdk.coders.AtomicCoder</a><T></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/beam/sdk/coders/CustomCoder.html" title="class in org.apache.beam.sdk.coders">org.apache.beam.sdk.coders.CustomCoder</a><<a href="../../../../../org/apache/beam/runners/core/ElementAndRestriction.html" title="class in org.apache.beam.runners.core">ElementAndRestriction</a><ElementT,RestrictionT>></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.core.ElementAndRestrictionCoder<ElementT,RestrictionT></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><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a>, <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><<a href="../../../../../org/apache/beam/runners/core/ElementAndRestriction.html" title="class in org.apache.beam.runners.core">ElementAndRestriction</a><ElementT,RestrictionT>></dd> +</dl> +<hr> +<br> +<pre><a href="../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a>(<a href="../../../../../org/apache/beam/sdk/annotations/Experimental.html#value--">value</a>=<a href="../../../../../org/apache/beam/sdk/annotations/Experimental.Kind.html#SPLITTABLE_DO_FN">SPLITTABLE_DO_FN</a>) +public class <span class="typeNameLabel">ElementAndRestrictionCoder<ElementT,RestrictionT></span> +extends <a href="../../../../../org/apache/beam/sdk/coders/CustomCoder.html" title="class in org.apache.beam.sdk.coders">CustomCoder</a><<a href="../../../../../org/apache/beam/runners/core/ElementAndRestriction.html" title="class in org.apache.beam.runners.core">ElementAndRestriction</a><ElementT,RestrictionT>></pre> +<div class="block">A <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders"><code>Coder</code></a> for <a href="../../../../../org/apache/beam/runners/core/ElementAndRestriction.html" title="class in org.apache.beam.runners.core"><code>ElementAndRestriction</code></a>.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../serialized-form.html#org.apache.beam.runners.core.ElementAndRestrictionCoder">Serialized Form</a></dd> +</dl> +</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.coders.Coder"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface org.apache.beam.sdk.coders.<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a></h3> +<code><a href="../../../../../org/apache/beam/sdk/coders/Coder.Context.html" title="class in org.apache.beam.sdk.coders">Coder.Context</a>, <a href="../../../../../org/apache/beam/sdk/coders/Coder.NonDeterministicException.html" title="class in org.apache.beam.sdk.coders">Coder.NonDeterministicException</a></code></li> +</ul> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="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/core/ElementAndRestriction.html" title="class in org.apache.beam.runners.core">ElementAndRestriction</a><<a href="../../../../../org/apache/beam/runners/core/ElementAndRestrictionCoder.html" title="type parameter in ElementAndRestrictionCoder">ElementT</a>,<a href="../../../../../org/apache/beam/runners/core/ElementAndRestrictionCoder.html" title="type parameter in ElementAndRestrictionCoder">RestrictionT</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/ElementAndRestrictionCoder.html#decode-java.io.InputStream-org.apache.beam.sdk.coders.Coder.Context-">decode</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io">InputStream</a> inStream, + <a href="../../../../../org/apache/beam/sdk/coders/Coder.Context.html" title="class in org.apache.beam.sdk.coders">Coder.Context</a> context)</code> +<div class="block">Decodes a value of type <code>T</code> from the given input stream in + the given context.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/ElementAndRestrictionCoder.html#encode-org.apache.beam.runners.core.ElementAndRestriction-java.io.OutputStream-org.apache.beam.sdk.coders.Coder.Context-">encode</a></span>(<a href="../../../../../org/apache/beam/runners/core/ElementAndRestriction.html" title="class in org.apache.beam.runners.core">ElementAndRestriction</a><<a href="../../../../../org/apache/beam/runners/core/ElementAndRestrictionCoder.html" title="type parameter in ElementAndRestrictionCoder">ElementT</a>,<a href="../../../../../org/apache/beam/runners/core/ElementAndRestrictionCoder.html" title="type parameter in ElementAndRestrictionCoder">RestrictionT</a>> value, + <a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true"; title="class or interface in java.io">OutputStream</a> outStream, + <a href="../../../../../org/apache/beam/sdk/coders/Coder.Context.html" title="class in org.apache.beam.sdk.coders">Coder.Context</a> context)</code> +<div class="block">Encodes the given value of type <code>T</code> onto the given output stream + in the given context.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><<a href="../../../../../org/apache/beam/runners/core/ElementAndRestrictionCoder.html" title="type parameter in ElementAndRestrictionCoder">ElementT</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/ElementAndRestrictionCoder.html#getElementCoder--">getElementCoder</a></span>()</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><<a href="../../../../../org/apache/beam/runners/core/ElementAndRestrictionCoder.html" title="type parameter in ElementAndRestrictionCoder">RestrictionT</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/ElementAndRestrictionCoder.html#getRestrictionCoder--">getRestrictionCoder</a></span>()</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>static <ElementT,RestrictionT><br><a href="../../../../../org/apache/beam/runners/core/ElementAndRestrictionCoder.html" title="class in org.apache.beam.runners.core">ElementAndRestrictionCoder</a><ElementT,RestrictionT></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/ElementAndRestrictionCoder.html#of-org.apache.beam.sdk.coders.Coder-org.apache.beam.sdk.coders.Coder-">of</a></span>(<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><ElementT> elementCoder, + <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><RestrictionT> restrictionCoder)</code> +<div class="block">Creates an <a href="../../../../../org/apache/beam/runners/core/ElementAndRestrictionCoder.html" title="class in org.apache.beam.runners.core"><code>ElementAndRestrictionCoder</code></a> from an element coder and a restriction coder.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.coders.CustomCoder"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.beam.sdk.coders.<a href="../../../../../org/apache/beam/sdk/coders/CustomCoder.html" title="class in org.apache.beam.sdk.coders">CustomCoder</a></h3> +<code><a href="../../../../../org/apache/beam/sdk/coders/CustomCoder.html#getEncodingId--">getEncodingId</a>, <a href="../../../../../org/apache/beam/sdk/coders/CustomCoder.html#initializeCloudObject--">initializeCloudObject</a>, <a href="../../../../../org/apache/beam/sdk/coders/CustomCoder.html#of-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">of</a>, <a href="../../../../../org/apache/beam/sdk/coders/CustomCoder.html#verifyDeterministic--">verifyDeterministic</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.coders.AtomicCoder"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.beam.sdk.coders.<a href="../../../../../org/apache/beam/sdk/coders/AtomicCoder.html" title="class in org.apache.beam.sdk.coders">AtomicCoder</a></h3> +<code><a href="../../../../../org/apache/beam/sdk/coders/AtomicCoder.html#getCoderArguments--">getCoderArguments</a>, <a href="../../../../../org/apache/beam/sdk/coders/AtomicCoder.html#getInstanceComponents-T-">getInstanceComponents</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.coders.StandardCoder"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.beam.sdk.coders.<a href="../../../../../org/apache/beam/sdk/coders/StandardCoder.html" title="class in org.apache.beam.sdk.coders">StandardCoder</a></h3> +<code><a href="../../../../../org/apache/beam/sdk/coders/StandardCoder.html#asCloudObject--">asCloudObject</a>, <a href="../../../../../org/apache/beam/sdk/coders/StandardCoder.html#consistentWithEquals--">consistentWithEquals</a>, <a href="../../../../../org/apache/beam/sdk/coders/StandardCoder.html#equals-java.lang.Object-">equals</a>, <a href="../../../../../org/apache/beam/sdk/coders/StandardCoder.html#getAllowedEncodings--">getAllowedEncodings</a>, <a href="../../../../../org/apache/beam/sdk/coders/StandardCoder.html#getComponents--">getComponents</a>, <a href="../../../../../org/apache/beam/sdk/coders/StandardCoder.html#getEncodedElementByteSize-T-org.apache.beam.sdk.coders.Coder.Context-">getEncodedElementByteSize</a>, <a href="../../../../../org/apache/beam/sdk/coders/StandardCoder.html#getEncodedTypeDescriptor--">getEncodedTypeDescriptor</a>, <a href="../../../../../org/apache/beam/sdk/coders/StandardCoder.html#hashCode--">hashCode</a>, <a href="../../../../../org/apache/be am/sdk/coders/StandardCoder.html#isRegisterByteSizeObserverCheap-T-org.apache.beam.sdk.coders.Coder.Context-">isRegisterByteSizeObserverCheap</a>, <a href="../../../../../org/apache/beam/sdk/coders/StandardCoder.html#registerByteSizeObserver-T-org.apache.beam.sdk.util.common.ElementByteSizeObserver-org.apache.beam.sdk.coders.Coder.Context-">registerByteSizeObserver</a>, <a href="../../../../../org/apache/beam/sdk/coders/StandardCoder.html#structuralValue-T-">structuralValue</a>, <a href="../../../../../org/apache/beam/sdk/coders/StandardCoder.html#toString--">toString</a>, <a href="../../../../../org/apache/beam/sdk/coders/StandardCoder.html#verifyDeterministic-java.lang.String-org.apache.beam.sdk.coders.Coder...-">verifyDeterministic</a>, <a href="../../../../../org/apache/beam/sdk/coders/StandardCoder.html#verifyDeterministic-java.lang.String-java.lang.Iterable-">verifyDeterministic</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.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--"; title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-ex ternal=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="of-org.apache.beam.sdk.coders.Coder-org.apache.beam.sdk.coders.Coder-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>of</h4> +<pre>public static <ElementT,RestrictionT> <a href="../../../../../org/apache/beam/runners/core/ElementAndRestrictionCoder.html" title="class in org.apache.beam.runners.core">ElementAndRestrictionCoder</a><ElementT,RestrictionT> of(<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><ElementT> elementCoder, + <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><RestrictionT> restrictionCoder)</pre> +<div class="block">Creates an <a href="../../../../../org/apache/beam/runners/core/ElementAndRestrictionCoder.html" title="class in org.apache.beam.runners.core"><code>ElementAndRestrictionCoder</code></a> from an element coder and a restriction coder.</div> +</li> +</ul> +<a name="encode-org.apache.beam.runners.core.ElementAndRestriction-java.io.OutputStream-org.apache.beam.sdk.coders.Coder.Context-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public void encode(<a href="../../../../../org/apache/beam/runners/core/ElementAndRestriction.html" title="class in org.apache.beam.runners.core">ElementAndRestriction</a><<a href="../../../../../org/apache/beam/runners/core/ElementAndRestrictionCoder.html" title="type parameter in ElementAndRestrictionCoder">ElementT</a>,<a href="../../../../../org/apache/beam/runners/core/ElementAndRestrictionCoder.html" title="type parameter in ElementAndRestrictionCoder">RestrictionT</a>> value, + <a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true"; title="class or interface in java.io">OutputStream</a> outStream, + <a href="../../../../../org/apache/beam/sdk/coders/Coder.Context.html" title="class in org.apache.beam.sdk.coders">Coder.Context</a> context) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html#encode-T-java.io.OutputStream-org.apache.beam.sdk.coders.Coder.Context-">Coder</a></code></span></div> +<div class="block">Encodes the given value of type <code>T</code> onto the given output stream + in the given context.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if writing to the <code>OutputStream</code> fails + for some reason</dd> +<dd><code><a href="../../../../../org/apache/beam/sdk/coders/CoderException.html" title="class in org.apache.beam.sdk.coders">CoderException</a></code> - if the value could not be encoded for some reason</dd> +</dl> +</li> +</ul> +<a name="decode-java.io.InputStream-org.apache.beam.sdk.coders.Coder.Context-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decode</h4> +<pre>public <a href="../../../../../org/apache/beam/runners/core/ElementAndRestriction.html" title="class in org.apache.beam.runners.core">ElementAndRestriction</a><<a href="../../../../../org/apache/beam/runners/core/ElementAndRestrictionCoder.html" title="type parameter in ElementAndRestrictionCoder">ElementT</a>,<a href="../../../../../org/apache/beam/runners/core/ElementAndRestrictionCoder.html" title="type parameter in ElementAndRestrictionCoder">RestrictionT</a>> decode(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io">InputStream</a> inStream, + <a href="../../../../../org/apache/beam/sdk/coders/Coder.Context.html" title="class in org.apache.beam.sdk.coders">Coder.Context</a> context) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html#decode-java.io.InputStream-org.apache.beam.sdk.coders.Coder.Context-">Coder</a></code></span></div> +<div class="block">Decodes a value of type <code>T</code> from the given input stream in + the given context. Returns the decoded value.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if reading from the <code>InputStream</code> fails + for some reason</dd> +<dd><code><a href="../../../../../org/apache/beam/sdk/coders/CoderException.html" title="class in org.apache.beam.sdk.coders">CoderException</a></code> - if the value could not be decoded for some reason</dd> +</dl> +</li> +</ul> +<a name="getElementCoder--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getElementCoder</h4> +<pre>public <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><<a href="../../../../../org/apache/beam/runners/core/ElementAndRestrictionCoder.html" title="type parameter in ElementAndRestrictionCoder">ElementT</a>> getElementCoder()</pre> +</li> +</ul> +<a name="getRestrictionCoder--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getRestrictionCoder</h4> +<pre>public <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><<a href="../../../../../org/apache/beam/runners/core/ElementAndRestrictionCoder.html" title="type parameter in ElementAndRestrictionCoder">RestrictionT</a>> getRestrictionCoder()</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="class-use/ElementAndRestrictionCoder.html">Use</a></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/core/ElementAndRestriction.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/core/ElementByteSizeObservable.html" title="interface in org.apache.beam.runners.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/ElementAndRestrictionCoder.html" target="_top">Frames</a></li> +<li><a href="ElementAndRestrictionCoder.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 ======= --> +<p class="legalCopy"><small>Copyright © 2016–2017 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/beam-site/blob/7b1f1576/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/ElementByteSizeObservable.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/ElementByteSizeObservable.html b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/ElementByteSizeObservable.html new file mode 100644 index 0000000..5723d7d --- /dev/null +++ b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/ElementByteSizeObservable.html @@ -0,0 +1,267 @@ +<!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_111) on Fri Jan 27 21:25:28 CET 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ElementByteSizeObservable (Apache Beam SDK for Java, version 0.5.0)</title> +<meta name="date" content="2017-01-27"> +<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="ElementByteSizeObservable (Apache Beam SDK for Java, version 0.5.0)"; + } + } + 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="class-use/ElementByteSizeObservable.html">Use</a></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/core/ElementAndRestrictionCoder.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/core/ExecutionContext.html" title="interface in org.apache.beam.runners.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/ElementByteSizeObservable.html" target="_top">Frames</a></li> +<li><a href="ElementByteSizeObservable.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.core</div> +<h2 title="Interface ElementByteSizeObservable" class="title">Interface ElementByteSizeObservable<T></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - the type of the values being observed</dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">ElementByteSizeObservable<T></span></pre> +<div class="block">An interface for things that allow observing the size in bytes of + encoded values of type <code>T</code>.</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>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/ElementByteSizeObservable.html#isRegisterByteSizeObserverCheap-T-">isRegisterByteSizeObserverCheap</a></span>(<a href="../../../../../org/apache/beam/runners/core/ElementByteSizeObservable.html" title="type parameter in ElementByteSizeObservable">T</a> value)</code> +<div class="block">Returns whether <a href="../../../../../org/apache/beam/runners/core/ElementByteSizeObservable.html#registerByteSizeObserver-T-org.apache.beam.sdk.util.common.ElementByteSizeObserver-"><code>registerByteSizeObserver(T, org.apache.beam.sdk.util.common.ElementByteSizeObserver)</code></a> is cheap enough + to call for every element, that is, if this + <code>ElementByteSizeObservable</code> can calculate the byte size of + the element to be coded in roughly constant time (or lazily).</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/ElementByteSizeObservable.html#registerByteSizeObserver-T-org.apache.beam.sdk.util.common.ElementByteSizeObserver-">registerByteSizeObserver</a></span>(<a href="../../../../../org/apache/beam/runners/core/ElementByteSizeObservable.html" title="type parameter in ElementByteSizeObservable">T</a> value, + <a href="../../../../../org/apache/beam/sdk/util/common/ElementByteSizeObserver.html" title="class in org.apache.beam.sdk.util.common">ElementByteSizeObserver</a> observer)</code> +<div class="block">Notifies the <code>ElementByteSizeObserver</code> about the byte size + of the encoded value using this <code>ElementByteSizeObservable</code>.</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="isRegisterByteSizeObserverCheap-java.lang.Object-"> +<!-- --> +</a><a name="isRegisterByteSizeObserverCheap-T-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isRegisterByteSizeObserverCheap</h4> +<pre>boolean isRegisterByteSizeObserverCheap(<a href="../../../../../org/apache/beam/runners/core/ElementByteSizeObservable.html" title="type parameter in ElementByteSizeObservable">T</a> value)</pre> +<div class="block">Returns whether <a href="../../../../../org/apache/beam/runners/core/ElementByteSizeObservable.html#registerByteSizeObserver-T-org.apache.beam.sdk.util.common.ElementByteSizeObserver-"><code>registerByteSizeObserver(T, org.apache.beam.sdk.util.common.ElementByteSizeObserver)</code></a> is cheap enough + to call for every element, that is, if this + <code>ElementByteSizeObservable</code> can calculate the byte size of + the element to be coded in roughly constant time (or lazily).</div> +</li> +</ul> +<a name="registerByteSizeObserver-java.lang.Object-org.apache.beam.sdk.util.common.ElementByteSizeObserver-"> +<!-- --> +</a><a name="registerByteSizeObserver-T-org.apache.beam.sdk.util.common.ElementByteSizeObserver-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>registerByteSizeObserver</h4> +<pre>void registerByteSizeObserver(<a href="../../../../../org/apache/beam/runners/core/ElementByteSizeObservable.html" title="type parameter in ElementByteSizeObservable">T</a> value, + <a href="../../../../../org/apache/beam/sdk/util/common/ElementByteSizeObserver.html" title="class in org.apache.beam.sdk.util.common">ElementByteSizeObserver</a> observer) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block">Notifies the <code>ElementByteSizeObserver</code> about the byte size + of the encoded value using this <code>ElementByteSizeObservable</code>.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</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="class-use/ElementByteSizeObservable.html">Use</a></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/core/ElementAndRestrictionCoder.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/core/ExecutionContext.html" title="interface in org.apache.beam.runners.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/ElementByteSizeObservable.html" target="_top">Frames</a></li> +<li><a href="ElementByteSizeObservable.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 ======= --> +<p class="legalCopy"><small>Copyright © 2016–2017 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/beam-site/blob/7b1f1576/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/ExecutionContext.StepContext.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/ExecutionContext.StepContext.html b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/ExecutionContext.StepContext.html new file mode 100644 index 0000000..0370ee8 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/ExecutionContext.StepContext.html @@ -0,0 +1,350 @@ +<!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_111) on Fri Jan 27 21:25:28 CET 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ExecutionContext.StepContext (Apache Beam SDK for Java, version 0.5.0)</title> +<meta name="date" content="2017-01-27"> +<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="ExecutionContext.StepContext (Apache Beam SDK for Java, version 0.5.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":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="class-use/ExecutionContext.StepContext.html">Use</a></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/core/ExecutionContext.html" title="interface in org.apache.beam.runners.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/core/GroupAlsoByWindowsDoFn.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/ExecutionContext.StepContext.html" target="_top">Frames</a></li> +<li><a href="ExecutionContext.StepContext.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.core</div> +<h2 title="Interface ExecutionContext.StepContext" class="title">Interface ExecutionContext.StepContext</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/core/BaseExecutionContext.StepContext.html" title="class in org.apache.beam.runners.core">BaseExecutionContext.StepContext</a></dd> +</dl> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../../../org/apache/beam/runners/core/ExecutionContext.html" title="interface in org.apache.beam.runners.core">ExecutionContext</a></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="typeNameLabel">ExecutionContext.StepContext</span></pre> +<div class="block">Per-step, per-key context used for retrieving state.</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><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/ExecutionContext.StepContext.html#getStepName--">getStepName</a></span>()</code> +<div class="block">The name of the step.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/ExecutionContext.StepContext.html#getTransformName--">getTransformName</a></span>()</code> +<div class="block">The name of the transform for the step.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/ExecutionContext.StepContext.html#noteOutput-org.apache.beam.sdk.util.WindowedValue-">noteOutput</a></span>(<a href="../../../../../org/apache/beam/sdk/util/WindowedValue.html" title="class in org.apache.beam.sdk.util">WindowedValue</a><?> output)</code> +<div class="block">Hook for subclasses to implement that will be called whenever + <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.Context.html#output-OutputT-"><code>DoFn.Context.output(OutputT)</code></a> + is called.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/ExecutionContext.StepContext.html#noteSideOutput-org.apache.beam.sdk.values.TupleTag-org.apache.beam.sdk.util.WindowedValue-">noteSideOutput</a></span>(<a href="../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><?> tag, + <a href="../../../../../org/apache/beam/sdk/util/WindowedValue.html" title="class in org.apache.beam.sdk.util">WindowedValue</a><?> output)</code> +<div class="block">Hook for subclasses to implement that will be called whenever + <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.Context.html#sideOutput-org.apache.beam.sdk.values.TupleTag-T-"><code>DoFn.Context.sideOutput(org.apache.beam.sdk.values.TupleTag<T>, T)</code></a> + is called.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/util/state/StateInternals.html" title="interface in org.apache.beam.sdk.util.state">StateInternals</a><?></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/ExecutionContext.StepContext.html#stateInternals--">stateInternals</a></span>()</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html" title="interface in org.apache.beam.sdk.util">TimerInternals</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/ExecutionContext.StepContext.html#timerInternals--">timerInternals</a></span>()</code> </td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><T,W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>><br>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/ExecutionContext.StepContext.html#writePCollectionViewData-org.apache.beam.sdk.values.TupleTag-java.lang.Iterable-org.apache.beam.sdk.coders.Coder-W-org.apache.beam.sdk.coders.Coder-">writePCollectionViewData</a></span>(<a href="../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><?> tag, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><<a href="../../../../../org/apache/beam/sdk/util/WindowedValue.html" title="class in org.apache.beam.sdk.util">WindowedValue</a><T>> data, + <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><<a href="../../../../../org/apache/beam/sdk/util/WindowedValue.html" title="class in org.apache.beam.sdk.util">WindowedValue</a><T>>> dataCoder, + W window, + <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><W> windowCoder)</code> +<div class="block">Writes the given <code>PCollectionView</code> data to a globally accessible location.</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="getStepName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStepName</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getStepName()</pre> +<div class="block">The name of the step.</div> +</li> +</ul> +<a name="getTransformName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTransformName</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getTransformName()</pre> +<div class="block">The name of the transform for the step.</div> +</li> +</ul> +<a name="noteOutput-org.apache.beam.sdk.util.WindowedValue-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>noteOutput</h4> +<pre>void noteOutput(<a href="../../../../../org/apache/beam/sdk/util/WindowedValue.html" title="class in org.apache.beam.sdk.util">WindowedValue</a><?> output)</pre> +<div class="block">Hook for subclasses to implement that will be called whenever + <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.Context.html#output-OutputT-"><code>DoFn.Context.output(OutputT)</code></a> + is called.</div> +</li> +</ul> +<a name="noteSideOutput-org.apache.beam.sdk.values.TupleTag-org.apache.beam.sdk.util.WindowedValue-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>noteSideOutput</h4> +<pre>void noteSideOutput(<a href="../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><?> tag, + <a href="../../../../../org/apache/beam/sdk/util/WindowedValue.html" title="class in org.apache.beam.sdk.util">WindowedValue</a><?> output)</pre> +<div class="block">Hook for subclasses to implement that will be called whenever + <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.Context.html#sideOutput-org.apache.beam.sdk.values.TupleTag-T-"><code>DoFn.Context.sideOutput(org.apache.beam.sdk.values.TupleTag<T>, T)</code></a> + is called.</div> +</li> +</ul> +<a name="writePCollectionViewData-org.apache.beam.sdk.values.TupleTag-java.lang.Iterable-org.apache.beam.sdk.coders.Coder-org.apache.beam.sdk.transforms.windowing.BoundedWindow-org.apache.beam.sdk.coders.Coder-"> +<!-- --> +</a><a name="writePCollectionViewData-org.apache.beam.sdk.values.TupleTag-java.lang.Iterable-org.apache.beam.sdk.coders.Coder-W-org.apache.beam.sdk.coders.Coder-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writePCollectionViewData</h4> +<pre><T,W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>> void writePCollectionViewData(<a href="../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><?> tag, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><<a href="../../../../../org/apache/beam/sdk/util/WindowedValue.html" title="class in org.apache.beam.sdk.util">WindowedValue</a><T>> data, + <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><<a href="../../../../../org/apache/beam/sdk/util/WindowedValue.html" title="class in org.apache.beam.sdk.util">WindowedValue</a><T>>> dataCoder, + W window, + <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><W> windowCoder) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Writes the given <code>PCollectionView</code> data to a globally accessible location.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd> +</dl> +</li> +</ul> +<a name="stateInternals--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>stateInternals</h4> +<pre><a href="../../../../../org/apache/beam/sdk/util/state/StateInternals.html" title="interface in org.apache.beam.sdk.util.state">StateInternals</a><?> stateInternals()</pre> +</li> +</ul> +<a name="timerInternals--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>timerInternals</h4> +<pre><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html" title="interface in org.apache.beam.sdk.util">TimerInternals</a> timerInternals()</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="class-use/ExecutionContext.StepContext.html">Use</a></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/core/ExecutionContext.html" title="interface in org.apache.beam.runners.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/core/GroupAlsoByWindowsDoFn.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/ExecutionContext.StepContext.html" target="_top">Frames</a></li> +<li><a href="ExecutionContext.StepContext.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 ======= --> +<p class="legalCopy"><small>Copyright © 2016–2017 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/beam-site/blob/7b1f1576/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/ExecutionContext.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/ExecutionContext.html b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/ExecutionContext.html new file mode 100644 index 0000000..a7f5615 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/ExecutionContext.html @@ -0,0 +1,313 @@ +<!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_111) on Fri Jan 27 21:25:28 CET 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ExecutionContext (Apache Beam SDK for Java, version 0.5.0)</title> +<meta name="date" content="2017-01-27"> +<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="ExecutionContext (Apache Beam SDK for Java, version 0.5.0)"; + } + } + 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="class-use/ExecutionContext.html">Use</a></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/core/ElementByteSizeObservable.html" title="interface in org.apache.beam.runners.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/core/ExecutionContext.StepContext.html" title="interface in org.apache.beam.runners.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/ExecutionContext.html" target="_top">Frames</a></li> +<li><a href="ExecutionContext.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.class.summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.beam.runners.core</div> +<h2 title="Interface ExecutionContext" class="title">Interface ExecutionContext</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/core/BaseExecutionContext.html" title="class in org.apache.beam.runners.core">BaseExecutionContext</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">ExecutionContext</span></pre> +<div class="block">Context for the current execution. This is guaranteed to exist during processing, + but does not necessarily persist between different batches of work.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/ExecutionContext.StepContext.html" title="interface in org.apache.beam.runners.core">ExecutionContext.StepContext</a></span></code> +<div class="block">Per-step, per-key context used for retrieving state.</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="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><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><? extends <a href="../../../../../org/apache/beam/runners/core/ExecutionContext.StepContext.html" title="interface in org.apache.beam.runners.core">ExecutionContext.StepContext</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/ExecutionContext.html#getAllStepContexts--">getAllStepContexts</a></span>()</code> +<div class="block">Returns a collection view of all of the <a href="../../../../../org/apache/beam/runners/core/ExecutionContext.StepContext.html" title="interface in org.apache.beam.runners.core"><code>ExecutionContext.StepContext</code></a>s.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/runners/core/ExecutionContext.StepContext.html" title="interface in org.apache.beam.runners.core">ExecutionContext.StepContext</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/ExecutionContext.html#getOrCreateStepContext-java.lang.String-java.lang.String-">getOrCreateStepContext</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> stepName, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> transformName)</code> +<div class="block">Returns the <a href="../../../../../org/apache/beam/runners/core/ExecutionContext.StepContext.html" title="interface in org.apache.beam.runners.core"><code>ExecutionContext.StepContext</code></a> associated with the given step.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/ExecutionContext.html#noteOutput-org.apache.beam.sdk.util.WindowedValue-">noteOutput</a></span>(<a href="../../../../../org/apache/beam/sdk/util/WindowedValue.html" title="class in org.apache.beam.sdk.util">WindowedValue</a><?> output)</code> +<div class="block">Hook for subclasses to implement that will be called whenever + <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.Context.html#output-OutputT-"><code>DoFn.Context.output(OutputT)</code></a> + is called.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/ExecutionContext.html#noteSideOutput-org.apache.beam.sdk.values.TupleTag-org.apache.beam.sdk.util.WindowedValue-">noteSideOutput</a></span>(<a href="../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><?> tag, + <a href="../../../../../org/apache/beam/sdk/util/WindowedValue.html" title="class in org.apache.beam.sdk.util">WindowedValue</a><?> output)</code> +<div class="block">Hook for subclasses to implement that will be called whenever + <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.Context.html#sideOutput-org.apache.beam.sdk.values.TupleTag-T-"><code>DoFn.Context.sideOutput(org.apache.beam.sdk.values.TupleTag<T>, T)</code></a> + is called.</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="getOrCreateStepContext-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrCreateStepContext</h4> +<pre><a href="../../../../../org/apache/beam/runners/core/ExecutionContext.StepContext.html" title="interface in org.apache.beam.runners.core">ExecutionContext.StepContext</a> getOrCreateStepContext(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> stepName, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> transformName)</pre> +<div class="block">Returns the <a href="../../../../../org/apache/beam/runners/core/ExecutionContext.StepContext.html" title="interface in org.apache.beam.runners.core"><code>ExecutionContext.StepContext</code></a> associated with the given step.</div> +</li> +</ul> +<a name="getAllStepContexts--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAllStepContexts</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><? extends <a href="../../../../../org/apache/beam/runners/core/ExecutionContext.StepContext.html" title="interface in org.apache.beam.runners.core">ExecutionContext.StepContext</a>> getAllStepContexts()</pre> +<div class="block">Returns a collection view of all of the <a href="../../../../../org/apache/beam/runners/core/ExecutionContext.StepContext.html" title="interface in org.apache.beam.runners.core"><code>ExecutionContext.StepContext</code></a>s.</div> +</li> +</ul> +<a name="noteOutput-org.apache.beam.sdk.util.WindowedValue-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>noteOutput</h4> +<pre>void noteOutput(<a href="../../../../../org/apache/beam/sdk/util/WindowedValue.html" title="class in org.apache.beam.sdk.util">WindowedValue</a><?> output)</pre> +<div class="block">Hook for subclasses to implement that will be called whenever + <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.Context.html#output-OutputT-"><code>DoFn.Context.output(OutputT)</code></a> + is called.</div> +</li> +</ul> +<a name="noteSideOutput-org.apache.beam.sdk.values.TupleTag-org.apache.beam.sdk.util.WindowedValue-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>noteSideOutput</h4> +<pre>void noteSideOutput(<a href="../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><?> tag, + <a href="../../../../../org/apache/beam/sdk/util/WindowedValue.html" title="class in org.apache.beam.sdk.util">WindowedValue</a><?> output)</pre> +<div class="block">Hook for subclasses to implement that will be called whenever + <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.Context.html#sideOutput-org.apache.beam.sdk.values.TupleTag-T-"><code>DoFn.Context.sideOutput(org.apache.beam.sdk.values.TupleTag<T>, T)</code></a> + is called.</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="class-use/ExecutionContext.html">Use</a></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/core/ElementByteSizeObservable.html" title="interface in org.apache.beam.runners.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/core/ExecutionContext.StepContext.html" title="interface in org.apache.beam.runners.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/ExecutionContext.html" target="_top">Frames</a></li> +<li><a href="ExecutionContext.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.class.summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2016–2017 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
