http://git-wip-us.apache.org/repos/asf/beam-site/blob/7b1f1576/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/OldDoFn.Context.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/OldDoFn.Context.html b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/OldDoFn.Context.html new file mode 100644 index 0000000..73d3879 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/OldDoFn.Context.html @@ -0,0 +1,506 @@ +<!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>OldDoFn.Context (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="OldDoFn.Context (Apache Beam SDK for Java, version 0.5.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":10,"i5":6,"i6":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/OldDoFn.Context.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/OldDoFn.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/OldDoFn.ProcessContext.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/OldDoFn.Context.html" target="_top">Frames</a></li> +<li><a href="OldDoFn.Context.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.beam.runners.core</div> +<h2 title="Class OldDoFn.Context" class="title">Class OldDoFn.Context</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>org.apache.beam.runners.core.OldDoFn.Context</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../org/apache/beam/runners/core/OldDoFn.ProcessContext.html" title="class in org.apache.beam.runners.core">OldDoFn.ProcessContext</a></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="class in org.apache.beam.runners.core">OldDoFn</a><<a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="type parameter in OldDoFn">InputT</a>,<a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="type parameter in OldDoFn">OutputT</a>></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">OldDoFn.Context</span> +extends <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></pre> +<div class="block">Information accessible to all methods in this <code>OldDoFn</code>. + Used primarily to output elements.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/OldDoFn.Context.html#Context--">Context</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>abstract <AggInputT,AggOutputT><br><a href="../../../../../org/apache/beam/sdk/transforms/Aggregator.html" title="interface in org.apache.beam.sdk.transforms">Aggregator</a><AggInputT,AggOutputT></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/OldDoFn.Context.html#createAggregatorInternal-java.lang.String-org.apache.beam.sdk.transforms.Combine.CombineFn-">createAggregatorInternal</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> name, + <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms">Combine.CombineFn</a><AggInputT,?,AggOutputT> combiner)</code> +<div class="block">Creates an <a href="../../../../../org/apache/beam/sdk/transforms/Aggregator.html" title="interface in org.apache.beam.sdk.transforms"><code>Aggregator</code></a> in the <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="class in org.apache.beam.runners.core"><code>OldDoFn</code></a> context with the + specified name and aggregation logic specified by <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms"><code>Combine.CombineFn</code></a>.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>abstract <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/OldDoFn.Context.html#getPipelineOptions--">getPipelineOptions</a></span>()</code> +<div class="block">Returns the <code>PipelineOptions</code> specified with the + <a href="../../../../../org/apache/beam/sdk/runners/PipelineRunner.html" title="class in org.apache.beam.sdk.runners"><code>PipelineRunner</code></a> + invoking this <code>OldDoFn</code>.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/OldDoFn.Context.html#output-OutputT-">output</a></span>(<a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="type parameter in OldDoFn">OutputT</a> output)</code> +<div class="block">Adds the given element to the main output <code>PCollection</code>.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/OldDoFn.Context.html#outputWithTimestamp-OutputT-org.joda.time.Instant-">outputWithTimestamp</a></span>(<a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="type parameter in OldDoFn">OutputT</a> output, + org.joda.time.Instant timestamp)</code> +<div class="block">Adds the given element to the main output <code>PCollection</code>, + with the given timestamp.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/OldDoFn.Context.html#setupDelegateAggregators--">setupDelegateAggregators</a></span>()</code> +<div class="block">Sets up <a href="../../../../../org/apache/beam/sdk/transforms/Aggregator.html" title="interface in org.apache.beam.sdk.transforms"><code>Aggregator</code></a>s created by the <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="class in org.apache.beam.runners.core"><code>OldDoFn</code></a> so they are + usable within this context.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>abstract <T> void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/OldDoFn.Context.html#sideOutput-org.apache.beam.sdk.values.TupleTag-T-">sideOutput</a></span>(<a href="../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><T> tag, + T output)</code> +<div class="block">Adds the given element to the side output <code>PCollection</code> with the + given tag.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>abstract <T> void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/OldDoFn.Context.html#sideOutputWithTimestamp-org.apache.beam.sdk.values.TupleTag-T-org.joda.time.Instant-">sideOutputWithTimestamp</a></span>(<a href="../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><T> tag, + T output, + org.joda.time.Instant timestamp)</code> +<div class="block">Adds the given element to the specified side output <code>PCollection</code>, + with the given timestamp.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<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#equals-java.lang.Object-"; title="class or interface in java.lang">equals</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#hashCode--"; title="class or interface in java.lang">hashCode</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#toString--"; title="class or interface in java.lang">toString</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-external=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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Context--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Context</h4> +<pre>public Context()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getPipelineOptions--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPipelineOptions</h4> +<pre>public abstract <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a> getPipelineOptions()</pre> +<div class="block">Returns the <code>PipelineOptions</code> specified with the + <a href="../../../../../org/apache/beam/sdk/runners/PipelineRunner.html" title="class in org.apache.beam.sdk.runners"><code>PipelineRunner</code></a> + invoking this <code>OldDoFn</code>. The <code>PipelineOptions</code> will + be the default running via <a href="../../../../../org/apache/beam/sdk/transforms/DoFnTester.html" title="class in org.apache.beam.sdk.transforms"><code>DoFnTester</code></a>.</div> +</li> +</ul> +<a name="output-java.lang.Object-"> +<!-- --> +</a><a name="output-OutputT-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>output</h4> +<pre>public abstract void output(<a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="type parameter in OldDoFn">OutputT</a> output)</pre> +<div class="block">Adds the given element to the main output <code>PCollection</code>. + + <p>Once passed to <code>output</code> the element should be considered + immutable and not be modified in any way. It may be cached or retained + by a Beam runner or later steps in the pipeline, or used in + other unspecified ways. + + <p>If invoked from <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#processElement-org.apache.beam.runners.core.OldDoFn.ProcessContext-"><code>processElement</code></a>, the output + element will have the same timestamp and be in the same windows + as the input element passed to <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#processElement-org.apache.beam.runners.core.OldDoFn.ProcessContext-"><code>processElement</code></a>. + + <p>If invoked from <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#startBundle-org.apache.beam.runners.core.OldDoFn.Context-"><code>startBundle</code></a> or <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#finishBundle-org.apache.beam.runners.core.OldDoFn.Context-"><code>finishBundle</code></a>, + this will attempt to use the + <a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>WindowFn</code></a> + of the input <code>PCollection</code> to determine what windows the element + should be in, throwing an exception if the <code>WindowFn</code> attempts + to access any information about the input element. The output element + will have a timestamp of negative infinity.</div> +</li> +</ul> +<a name="outputWithTimestamp-java.lang.Object-org.joda.time.Instant-"> +<!-- --> +</a><a name="outputWithTimestamp-OutputT-org.joda.time.Instant-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>outputWithTimestamp</h4> +<pre>public abstract void outputWithTimestamp(<a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="type parameter in OldDoFn">OutputT</a> output, + org.joda.time.Instant timestamp)</pre> +<div class="block">Adds the given element to the main output <code>PCollection</code>, + with the given timestamp. + + <p>Once passed to <code>outputWithTimestamp</code> the element should not be + modified in any way. + + <p>If invoked from <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#processElement-org.apache.beam.runners.core.OldDoFn.ProcessContext-"><code>processElement</code></a>, the timestamp + must not be older than the input element's timestamp minus + <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#getAllowedTimestampSkew--"><code>getAllowedTimestampSkew</code></a>. The output element will + be in the same windows as the input element. + + <p>If invoked from <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#startBundle-org.apache.beam.runners.core.OldDoFn.Context-"><code>startBundle</code></a> or <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#finishBundle-org.apache.beam.runners.core.OldDoFn.Context-"><code>finishBundle</code></a>, + this will attempt to use the + <a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>WindowFn</code></a> + of the input <code>PCollection</code> to determine what windows the element + should be in, throwing an exception if the <code>WindowFn</code> attempts + to access any information about the input element except for the + timestamp.</div> +</li> +</ul> +<a name="sideOutput-org.apache.beam.sdk.values.TupleTag-java.lang.Object-"> +<!-- --> +</a><a name="sideOutput-org.apache.beam.sdk.values.TupleTag-T-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sideOutput</h4> +<pre>public abstract <T> void sideOutput(<a href="../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><T> tag, + T output)</pre> +<div class="block">Adds the given element to the side output <code>PCollection</code> with the + given tag. + + <p>Once passed to <code>sideOutput</code> the element should not be modified + in any way. + + <p>The caller of <code>ParDo</code> uses <a href="../../../../../org/apache/beam/sdk/transforms/ParDo.html#withOutputTags-org.apache.beam.sdk.values.TupleTag-org.apache.beam.sdk.values.TupleTagList-"><code>withOutputTags</code></a> to + specify the tags of side outputs that it consumes. Non-consumed side + outputs, e.g., outputs for monitoring purposes only, don't necessarily + need to be specified. + + <p>The output element will have the same timestamp and be in the same + windows as the input element passed to <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#processElement-org.apache.beam.runners.core.OldDoFn.ProcessContext-"><code>processElement</code></a>. + + <p>If invoked from <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#startBundle-org.apache.beam.runners.core.OldDoFn.Context-"><code>startBundle</code></a> or <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#finishBundle-org.apache.beam.runners.core.OldDoFn.Context-"><code>finishBundle</code></a>, + this will attempt to use the + <a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>WindowFn</code></a> + of the input <code>PCollection</code> to determine what windows the element + should be in, throwing an exception if the <code>WindowFn</code> attempts + to access any information about the input element. The output element + will have a timestamp of negative infinity.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/beam/sdk/transforms/ParDo.html#withOutputTags-org.apache.beam.sdk.values.TupleTag-org.apache.beam.sdk.values.TupleTagList-"><code>ParDo.withOutputTags(org.apache.beam.sdk.values.TupleTag<OutputT>, org.apache.beam.sdk.values.TupleTagList)</code></a></dd> +</dl> +</li> +</ul> +<a name="sideOutputWithTimestamp-org.apache.beam.sdk.values.TupleTag-java.lang.Object-org.joda.time.Instant-"> +<!-- --> +</a><a name="sideOutputWithTimestamp-org.apache.beam.sdk.values.TupleTag-T-org.joda.time.Instant-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sideOutputWithTimestamp</h4> +<pre>public abstract <T> void sideOutputWithTimestamp(<a href="../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><T> tag, + T output, + org.joda.time.Instant timestamp)</pre> +<div class="block">Adds the given element to the specified side output <code>PCollection</code>, + with the given timestamp. + + <p>Once passed to <code>sideOutputWithTimestamp</code> the element should not be + modified in any way. + + <p>If invoked from <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#processElement-org.apache.beam.runners.core.OldDoFn.ProcessContext-"><code>processElement</code></a>, the timestamp + must not be older than the input element's timestamp minus + <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#getAllowedTimestampSkew--"><code>getAllowedTimestampSkew</code></a>. The output element will + be in the same windows as the input element. + + <p>If invoked from <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#startBundle-org.apache.beam.runners.core.OldDoFn.Context-"><code>startBundle</code></a> or <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#finishBundle-org.apache.beam.runners.core.OldDoFn.Context-"><code>finishBundle</code></a>, + this will attempt to use the + <a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>WindowFn</code></a> + of the input <code>PCollection</code> to determine what windows the element + should be in, throwing an exception if the <code>WindowFn</code> attempts + to access any information about the input element except for the + timestamp.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/beam/sdk/transforms/ParDo.html#withOutputTags-org.apache.beam.sdk.values.TupleTag-org.apache.beam.sdk.values.TupleTagList-"><code>ParDo.withOutputTags(org.apache.beam.sdk.values.TupleTag<OutputT>, org.apache.beam.sdk.values.TupleTagList)</code></a></dd> +</dl> +</li> +</ul> +<a name="createAggregatorInternal-java.lang.String-org.apache.beam.sdk.transforms.Combine.CombineFn-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createAggregatorInternal</h4> +<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#AGGREGATOR">AGGREGATOR</a>) +public abstract <AggInputT,AggOutputT> <a href="../../../../../org/apache/beam/sdk/transforms/Aggregator.html" title="interface in org.apache.beam.sdk.transforms">Aggregator</a><AggInputT,AggOutputT> createAggregatorInternal(<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> name, + <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms">Combine.CombineFn</a><AggInputT,?,AggOutputT> combiner)</pre> +<div class="block">Creates an <a href="../../../../../org/apache/beam/sdk/transforms/Aggregator.html" title="interface in org.apache.beam.sdk.transforms"><code>Aggregator</code></a> in the <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="class in org.apache.beam.runners.core"><code>OldDoFn</code></a> context with the + specified name and aggregation logic specified by <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms"><code>Combine.CombineFn</code></a>. + + <p>For internal use only.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the name of the aggregator</dd> +<dd><code>combiner</code> - the <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms"><code>Combine.CombineFn</code></a> to use in the aggregator</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an aggregator for the provided name and <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms"><code>Combine.CombineFn</code></a> in this + context</dd> +</dl> +</li> +</ul> +<a name="setupDelegateAggregators--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setupDelegateAggregators</h4> +<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#AGGREGATOR">AGGREGATOR</a>) +protected final void setupDelegateAggregators()</pre> +<div class="block">Sets up <a href="../../../../../org/apache/beam/sdk/transforms/Aggregator.html" title="interface in org.apache.beam.sdk.transforms"><code>Aggregator</code></a>s created by the <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="class in org.apache.beam.runners.core"><code>OldDoFn</code></a> so they are + usable within this context. + + <p>This method should be called by runners before <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#startBundle-org.apache.beam.runners.core.OldDoFn.Context-"><code>OldDoFn.startBundle(org.apache.beam.runners.core.OldDoFn<InputT, OutputT>.Context)</code></a> + is executed.</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/OldDoFn.Context.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/OldDoFn.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/OldDoFn.ProcessContext.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/OldDoFn.Context.html" target="_top">Frames</a></li> +<li><a href="OldDoFn.Context.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<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/OldDoFn.ProcessContext.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/OldDoFn.ProcessContext.html b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/OldDoFn.ProcessContext.html new file mode 100644 index 0000000..70b2e31 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/OldDoFn.ProcessContext.html @@ -0,0 +1,409 @@ +<!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>OldDoFn.ProcessContext (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="OldDoFn.ProcessContext (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}; +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/OldDoFn.ProcessContext.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/OldDoFn.Context.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/OldDoFn.RequiresWindowAccess.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/OldDoFn.ProcessContext.html" target="_top">Frames</a></li> +<li><a href="OldDoFn.ProcessContext.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.beam.runners.core</div> +<h2 title="Class OldDoFn.ProcessContext" class="title">Class OldDoFn.ProcessContext</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/runners/core/OldDoFn.Context.html" title="class in org.apache.beam.runners.core">org.apache.beam.runners.core.OldDoFn.Context</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.core.OldDoFn.ProcessContext</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="class in org.apache.beam.runners.core">OldDoFn</a><<a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="type parameter in OldDoFn">InputT</a>,<a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="type parameter in OldDoFn">OutputT</a>></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">OldDoFn.ProcessContext</span> +extends <a href="../../../../../org/apache/beam/runners/core/OldDoFn.Context.html" title="class in org.apache.beam.runners.core">OldDoFn.Context</a></pre> +<div class="block">Information accessible when running <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#processElement-org.apache.beam.runners.core.OldDoFn.ProcessContext-"><code>OldDoFn.processElement(org.apache.beam.runners.core.OldDoFn<InputT, OutputT>.ProcessContext)</code></a>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/OldDoFn.ProcessContext.html#ProcessContext--">ProcessContext</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></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>abstract <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="type parameter in OldDoFn">InputT</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/OldDoFn.ProcessContext.html#element--">element</a></span>()</code> +<div class="block">Returns the input element to be processed.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>abstract <a href="../../../../../org/apache/beam/sdk/transforms/windowing/PaneInfo.html" title="class in org.apache.beam.sdk.transforms.windowing">PaneInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/OldDoFn.ProcessContext.html#pane--">pane</a></span>()</code> +<div class="block">Returns information about the pane within this window into which the + input element has been assigned.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>abstract <T> T</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/OldDoFn.ProcessContext.html#sideInput-org.apache.beam.sdk.values.PCollectionView-">sideInput</a></span>(<a href="../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a><T> view)</code> +<div class="block">Returns the value of the side input for the window corresponding to the + window of the main input element.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>abstract org.joda.time.Instant</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/OldDoFn.ProcessContext.html#timestamp--">timestamp</a></span>()</code> +<div class="block">Returns the timestamp of the input element.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>abstract <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/OldDoFn.ProcessContext.html#window--">window</a></span>()</code> +<div class="block">Returns the window into which the input element has been assigned.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>abstract <a href="../../../../../org/apache/beam/sdk/util/WindowingInternals.html" title="interface in org.apache.beam.sdk.util">WindowingInternals</a><<a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="type parameter in OldDoFn">InputT</a>,<a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="type parameter in OldDoFn">OutputT</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/OldDoFn.ProcessContext.html#windowingInternals--">windowingInternals</a></span>()</code> +<div class="block">Returns the process context to use for implementing windowing.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.runners.core.OldDoFn.Context"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.beam.runners.core.<a href="../../../../../org/apache/beam/runners/core/OldDoFn.Context.html" title="class in org.apache.beam.runners.core">OldDoFn.Context</a></h3> +<code><a href="../../../../../org/apache/beam/runners/core/OldDoFn.Context.html#createAggregatorInternal-java.lang.String-org.apache.beam.sdk.transforms.Combine.CombineFn-">createAggregatorInternal</a>, <a href="../../../../../org/apache/beam/runners/core/OldDoFn.Context.html#getPipelineOptions--">getPipelineOptions</a>, <a href="../../../../../org/apache/beam/runners/core/OldDoFn.Context.html#output-OutputT-">output</a>, <a href="../../../../../org/apache/beam/runners/core/OldDoFn.Context.html#outputWithTimestamp-OutputT-org.joda.time.Instant-">outputWithTimestamp</a>, <a href="../../../../../org/apache/beam/runners/core/OldDoFn.Context.html#setupDelegateAggregators--">setupDelegateAggregators</a>, <a href="../../../../../org/apache/beam/runners/core/OldDoFn.Context.html#sideOutput-org.apache.beam.sdk.values.TupleTag-T-">sideOutput</a>, <a href="../../../../../org/apache/beam/runners/core/OldDoFn.Context.html#sideOutputWithTimestamp-org.apache.beam.sdk.values.TupleTag-T-org.joda.ti me.Instant-">sideOutputWithTimestamp</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#equals-java.lang.Object-"; title="class or interface in java.lang">equals</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#hashCode--"; title="class or interface in java.lang">hashCode</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#toString--"; title="class or interface in java.lang">toString</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-external=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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ProcessContext--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ProcessContext</h4> +<pre>public ProcessContext()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="element--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>element</h4> +<pre>public abstract <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="type parameter in OldDoFn">InputT</a> element()</pre> +<div class="block">Returns the input element to be processed. + + <p>The element should be considered immutable. A Beam runner will not mutate the + element, so it is safe to cache, etc. The element should not be mutated by any of the + <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="class in org.apache.beam.runners.core"><code>OldDoFn</code></a> methods, because it may be cached elsewhere, retained by the runner + runtime, or used in other unspecified ways.</div> +</li> +</ul> +<a name="sideInput-org.apache.beam.sdk.values.PCollectionView-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sideInput</h4> +<pre>public abstract <T> T sideInput(<a href="../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a><T> view)</pre> +<div class="block">Returns the value of the side input for the window corresponding to the + window of the main input element. + + <p>See + <a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html#getSideInputWindow-org.apache.beam.sdk.transforms.windowing.BoundedWindow-"><code>WindowFn.getSideInputWindow(org.apache.beam.sdk.transforms.windowing.BoundedWindow)</code></a> + for how this corresponding window is determined.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if this is not a side input</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/beam/sdk/transforms/ParDo.html#withSideInputs-org.apache.beam.sdk.values.PCollectionView...-"><code>ParDo.withSideInputs(org.apache.beam.sdk.values.PCollectionView<?>...)</code></a></dd> +</dl> +</li> +</ul> +<a name="timestamp--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>timestamp</h4> +<pre>public abstract org.joda.time.Instant timestamp()</pre> +<div class="block">Returns the timestamp of the input element. + + <p>See <a href="../../../../../org/apache/beam/sdk/transforms/windowing/Window.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>Window</code></a> + for more information.</div> +</li> +</ul> +<a name="window--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>window</h4> +<pre>public abstract <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a> window()</pre> +<div class="block">Returns the window into which the input element has been assigned. + + <p>See <a href="../../../../../org/apache/beam/sdk/transforms/windowing/Window.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>Window</code></a> + for more information.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/UnsupportedOperationException.html?is-external=true"; title="class or interface in java.lang">UnsupportedOperationException</a></code> - if this <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="class in org.apache.beam.runners.core"><code>OldDoFn</code></a> does + not implement <a href="../../../../../org/apache/beam/runners/core/OldDoFn.RequiresWindowAccess.html" title="interface in org.apache.beam.runners.core"><code>OldDoFn.RequiresWindowAccess</code></a>.</dd> +</dl> +</li> +</ul> +<a name="pane--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>pane</h4> +<pre>public abstract <a href="../../../../../org/apache/beam/sdk/transforms/windowing/PaneInfo.html" title="class in org.apache.beam.sdk.transforms.windowing">PaneInfo</a> pane()</pre> +<div class="block">Returns information about the pane within this window into which the + input element has been assigned. + + <p>Generally all data is in a single, uninteresting pane unless custom + triggering and/or late data has been explicitly requested. + See <a href="../../../../../org/apache/beam/sdk/transforms/windowing/Window.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>Window</code></a> + for more information.</div> +</li> +</ul> +<a name="windowingInternals--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>windowingInternals</h4> +<pre><a href="../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a> +public abstract <a href="../../../../../org/apache/beam/sdk/util/WindowingInternals.html" title="interface in org.apache.beam.sdk.util">WindowingInternals</a><<a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="type parameter in OldDoFn">InputT</a>,<a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="type parameter in OldDoFn">OutputT</a>> windowingInternals()</pre> +<div class="block">Returns the process context to use for implementing windowing.</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/OldDoFn.ProcessContext.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/OldDoFn.Context.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/OldDoFn.RequiresWindowAccess.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/OldDoFn.ProcessContext.html" target="_top">Frames</a></li> +<li><a href="OldDoFn.ProcessContext.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<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/OldDoFn.RequiresWindowAccess.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/OldDoFn.RequiresWindowAccess.html b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/OldDoFn.RequiresWindowAccess.html new file mode 100644 index 0000000..1240de7 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/OldDoFn.RequiresWindowAccess.html @@ -0,0 +1,180 @@ +<!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>OldDoFn.RequiresWindowAccess (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="OldDoFn.RequiresWindowAccess (Apache Beam SDK for Java, version 0.5.0)"; + } + } + catch(err) { + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/OldDoFn.RequiresWindowAccess.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/OldDoFn.ProcessContext.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/OutputWindowedValue.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/OldDoFn.RequiresWindowAccess.html" target="_top">Frames</a></li> +<li><a href="OldDoFn.RequiresWindowAccess.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>Method</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.beam.runners.core</div> +<h2 title="Interface OldDoFn.RequiresWindowAccess" class="title">Interface OldDoFn.RequiresWindowAccess</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/AssignWindowsDoFn.html" title="class in org.apache.beam.runners.core">AssignWindowsDoFn</a></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="class in org.apache.beam.runners.core">OldDoFn</a><<a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="type parameter in OldDoFn">InputT</a>,<a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="type parameter in OldDoFn">OutputT</a>></dd> +</dl> +<hr> +<br> +<pre><a href="../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a> +public static interface <span class="typeNameLabel">OldDoFn.RequiresWindowAccess</span></pre> +<div class="block">Interface for signaling that a <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="class in org.apache.beam.runners.core"><code>OldDoFn</code></a> needs to access the window the + element is being processed in, via <a href="../../../../../org/apache/beam/runners/core/OldDoFn.ProcessContext.html#window--"><code>OldDoFn.ProcessContext.window()</code></a>.</div> +</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/OldDoFn.RequiresWindowAccess.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/OldDoFn.ProcessContext.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/OutputWindowedValue.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/OldDoFn.RequiresWindowAccess.html" target="_top">Frames</a></li> +<li><a href="OldDoFn.RequiresWindowAccess.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>Method</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<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>
