http://git-wip-us.apache.org/repos/asf/beam-site/blob/0c7c6b2a/src/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/KeyedWorkItemCoder.html ---------------------------------------------------------------------- diff --git a/src/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/KeyedWorkItemCoder.html b/src/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/KeyedWorkItemCoder.html new file mode 100644 index 0000000..46210fb --- /dev/null +++ b/src/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/KeyedWorkItemCoder.html @@ -0,0 +1,473 @@ +<!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 Thu Dec 29 08:19:09 CET 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>KeyedWorkItemCoder (Apache Beam SDK for Java, version 0.4.0)</title> +<meta name="date" content="2016-12-29"> +<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="KeyedWorkItemCoder (Apache Beam SDK for Java, version 0.4.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":9,"i7":9,"i8":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/KeyedWorkItemCoder.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/KeyedWorkItem.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/KeyedWorkItems.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/KeyedWorkItemCoder.html" target="_top">Frames</a></li> +<li><a href="KeyedWorkItemCoder.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 KeyedWorkItemCoder" class="title">Class KeyedWorkItemCoder<K,ElemT></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><<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core">KeyedWorkItem</a><K,ElemT>></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.core.KeyedWorkItemCoder<K,ElemT></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/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core">KeyedWorkItem</a><K,ElemT>></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">KeyedWorkItemCoder<K,ElemT></span> +extends <a href="../../../../../org/apache/beam/sdk/coders/StandardCoder.html" title="class in org.apache.beam.sdk.coders">StandardCoder</a><<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core">KeyedWorkItem</a><K,ElemT>></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/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core"><code>KeyedWorkItems</code></a>.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../serialized-form.html#org.apache.beam.runners.core.KeyedWorkItemCoder">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>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItemCoder.html#consistentWithEquals--">consistentWithEquals</a></span>()</code> +<div class="block">Returns <code>true</code> if this <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders"><code>Coder</code></a> is injective with respect to <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"><code>Object.equals(java.lang.Object)</code></a>.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core">KeyedWorkItem</a><<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItemCoder.html" title="type parameter in KeyedWorkItemCoder">K</a>,<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItemCoder.html" title="type parameter in KeyedWorkItemCoder">ElemT</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItemCoder.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="i2" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItemCoder.html#encode-org.apache.beam.runners.core.KeyedWorkItem-java.io.OutputStream-org.apache.beam.sdk.coders.Coder.Context-">encode</a></span>(<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core">KeyedWorkItem</a><<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItemCoder.html" title="type parameter in KeyedWorkItemCoder">K</a>,<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItemCoder.html" title="type parameter in KeyedWorkItemCoder">ElemT</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="i3" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><? extends <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><?>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItemCoder.html#getCoderArguments--">getCoderArguments</a></span>()</code> +<div class="block">If this is a <code>Coder</code> for a parameterized type, returns the + list of <code>Coder</code>s being used for each of the parameters, or + returns <code>null</code> if this cannot be done or this is not a + parameterized type.</div> +</td> +</tr> +<tr id="i4" 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/KeyedWorkItemCoder.html" title="type parameter in KeyedWorkItemCoder">ElemT</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItemCoder.html#getElementCoder--">getElementCoder</a></span>()</code> </td> +</tr> +<tr id="i5" 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/KeyedWorkItemCoder.html" title="type parameter in KeyedWorkItemCoder">K</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItemCoder.html#getKeyCoder--">getKeyCoder</a></span>()</code> </td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>static <K,ElemT> <a href="../../../../../org/apache/beam/runners/core/KeyedWorkItemCoder.html" title="class in org.apache.beam.runners.core">KeyedWorkItemCoder</a><K,ElemT></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItemCoder.html#of-org.apache.beam.sdk.coders.Coder-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><K> keyCoder, + <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><ElemT> elemCoder, + <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><? extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>> windowCoder)</code> +<div class="block">Create a new <a href="../../../../../org/apache/beam/runners/core/KeyedWorkItemCoder.html" title="class in org.apache.beam.runners.core"><code>KeyedWorkItemCoder</code></a> with the provided key coder, element coder, and window + coder.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>static <K,ElemT> <a href="../../../../../org/apache/beam/runners/core/KeyedWorkItemCoder.html" title="class in org.apache.beam.runners.core">KeyedWorkItemCoder</a><K,ElemT></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItemCoder.html#of-java.util.List-">of</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><?>> components)</code> </td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItemCoder.html#verifyDeterministic--">verifyDeterministic</a></span>()</code> +<div class="block">Throw <a href="../../../../../org/apache/beam/sdk/coders/Coder.NonDeterministicException.html" title="class in org.apache.beam.sdk.coders"><code>Coder.NonDeterministicException</code></a> if the coding is not deterministic.</div> +</td> +</tr> +</table> +<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#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#getEncodingId--">getEncodingId</a>, <a href="../../../../../org/apache/beam/sdk/coders/StandardCoder.html#hashCode--">hashCode</a>, <a href="../../../../../org/apache/beam/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-org.apache.beam.sdk.coders.Coder-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>of</h4> +<pre>public static <K,ElemT> <a href="../../../../../org/apache/beam/runners/core/KeyedWorkItemCoder.html" title="class in org.apache.beam.runners.core">KeyedWorkItemCoder</a><K,ElemT> of(<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><K> keyCoder, + <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><ElemT> elemCoder, + <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><? extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>> windowCoder)</pre> +<div class="block">Create a new <a href="../../../../../org/apache/beam/runners/core/KeyedWorkItemCoder.html" title="class in org.apache.beam.runners.core"><code>KeyedWorkItemCoder</code></a> with the provided key coder, element coder, and window + coder.</div> +</li> +</ul> +<a name="of-java.util.List-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>of</h4> +<pre>public static <K,ElemT> <a href="../../../../../org/apache/beam/runners/core/KeyedWorkItemCoder.html" title="class in org.apache.beam.runners.core">KeyedWorkItemCoder</a><K,ElemT> of(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><?>> components)</pre> +</li> +</ul> +<a name="getKeyCoder--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getKeyCoder</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/KeyedWorkItemCoder.html" title="type parameter in KeyedWorkItemCoder">K</a>> getKeyCoder()</pre> +</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/KeyedWorkItemCoder.html" title="type parameter in KeyedWorkItemCoder">ElemT</a>> getElementCoder()</pre> +</li> +</ul> +<a name="encode-org.apache.beam.runners.core.KeyedWorkItem-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/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core">KeyedWorkItem</a><<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItemCoder.html" title="type parameter in KeyedWorkItemCoder">K</a>,<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItemCoder.html" title="type parameter in KeyedWorkItemCoder">ElemT</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="../../../../../org/apache/beam/sdk/coders/CoderException.html" title="class in org.apache.beam.sdk.coders">CoderException</a>, + <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="../../../../../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> +<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> +</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/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core">KeyedWorkItem</a><<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItemCoder.html" title="type parameter in KeyedWorkItemCoder">K</a>,<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItemCoder.html" title="type parameter in KeyedWorkItemCoder">ElemT</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="../../../../../org/apache/beam/sdk/coders/CoderException.html" title="class in org.apache.beam.sdk.coders">CoderException</a>, + <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="../../../../../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> +<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> +</dl> +</li> +</ul> +<a name="getCoderArguments--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCoderArguments</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><? extends <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><?>> getCoderArguments()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html#getCoderArguments--">Coder</a></code></span></div> +<div class="block">If this is a <code>Coder</code> for a parameterized type, returns the + list of <code>Coder</code>s being used for each of the parameters, or + returns <code>null</code> if this cannot be done or this is not a + parameterized type.</div> +</li> +</ul> +<a name="verifyDeterministic--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>verifyDeterministic</h4> +<pre>public void verifyDeterministic() + throws <a href="../../../../../org/apache/beam/sdk/coders/Coder.NonDeterministicException.html" title="class in org.apache.beam.sdk.coders">Coder.NonDeterministicException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html#verifyDeterministic--">Coder</a></code></span></div> +<div class="block">Throw <a href="../../../../../org/apache/beam/sdk/coders/Coder.NonDeterministicException.html" title="class in org.apache.beam.sdk.coders"><code>Coder.NonDeterministicException</code></a> if the coding is not deterministic. + + <p>In order for a <code>Coder</code> to be considered deterministic, + the following must be true: + <ul> + <li>two values that compare as equal (via <code>Object.equals()</code> + or <code>Comparable.compareTo()</code>, if supported) have the same + encoding. + <li>the <code>Coder</code> always produces a canonical encoding, which is the + same for an instance of an object even if produced on different + computers at different times. + </ul></div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/coders/Coder.NonDeterministicException.html" title="class in org.apache.beam.sdk.coders">Coder.NonDeterministicException</a></code> - if this coder is not deterministic.</dd> +</dl> +</li> +</ul> +<a name="consistentWithEquals--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>consistentWithEquals</h4> +<pre>public boolean consistentWithEquals()</pre> +<div class="block">Returns <code>true</code> if this <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders"><code>Coder</code></a> is injective with respect to <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"><code>Object.equals(java.lang.Object)</code></a>. + + <p>Whenever the encoded bytes of two values are equal, then the original values are equal + according to <code>Objects.equals()</code>. Note that this is well-defined for <code>null</code>. + + <p>This condition is most notably false for arrays. More generally, this condition is false + whenever <code>equals()</code> compares object identity, rather than performing a + semantic/structural comparison.. + + <a href="../../../../../org/apache/beam/runners/core/KeyedWorkItemCoder.html" title="class in org.apache.beam.runners.core"><code>KeyedWorkItemCoder</code></a> is not consistent with equals as it can return a + <a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core"><code>KeyedWorkItem</code></a> of a type different from the originally encoded type.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html#consistentWithEquals--">consistentWithEquals</a></code> in interface <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/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core">KeyedWorkItem</a><<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItemCoder.html" title="type parameter in KeyedWorkItemCoder">K</a>,<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItemCoder.html" title="type parameter in KeyedWorkItemCoder">ElemT</a>>></code></dd> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/coders/StandardCoder.html#consistentWithEquals--">consistentWithEquals</a></code> in class <code><a href="../../../../../org/apache/beam/sdk/coders/StandardCoder.html" title="class in org.apache.beam.sdk.coders">StandardCoder</a><<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core">KeyedWorkItem</a><<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItemCoder.html" title="type parameter in KeyedWorkItemCoder">K</a>,<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItemCoder.html" title="type parameter in KeyedWorkItemCoder">ElemT</a>>></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><code>false</code> for <a href="../../../../../org/apache/beam/sdk/coders/StandardCoder.html" title="class in org.apache.beam.sdk.coders"><code>StandardCoder</code></a> unless overridden.</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/KeyedWorkItemCoder.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/KeyedWorkItem.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/KeyedWorkItems.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/KeyedWorkItemCoder.html" target="_top">Frames</a></li> +<li><a href="KeyedWorkItemCoder.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 <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/0c7c6b2a/src/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/KeyedWorkItems.ComposedKeyedWorkItem.html ---------------------------------------------------------------------- diff --git a/src/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/KeyedWorkItems.ComposedKeyedWorkItem.html b/src/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/KeyedWorkItems.ComposedKeyedWorkItem.html new file mode 100644 index 0000000..ed2c259 --- /dev/null +++ b/src/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/KeyedWorkItems.ComposedKeyedWorkItem.html @@ -0,0 +1,351 @@ +<!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 Thu Dec 29 08:19:09 CET 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>KeyedWorkItems.ComposedKeyedWorkItem (Apache Beam SDK for Java, version 0.4.0)</title> +<meta name="date" content="2016-12-29"> +<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="KeyedWorkItems.ComposedKeyedWorkItem (Apache Beam SDK for Java, version 0.4.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/KeyedWorkItems.ComposedKeyedWorkItem.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/KeyedWorkItems.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/LateDataDroppingDoFnRunner.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/KeyedWorkItems.ComposedKeyedWorkItem.html" target="_top">Frames</a></li> +<li><a href="KeyedWorkItems.ComposedKeyedWorkItem.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 KeyedWorkItems.ComposedKeyedWorkItem" class="title">Class KeyedWorkItems.ComposedKeyedWorkItem<K,ElemT></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.KeyedWorkItems.ComposedKeyedWorkItem<K,ElemT></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core">KeyedWorkItem</a><K,ElemT></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItems.html" title="class in org.apache.beam.runners.core">KeyedWorkItems</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="typeNameLabel">KeyedWorkItems.ComposedKeyedWorkItem<K,ElemT></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> +implements <a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core">KeyedWorkItem</a><K,ElemT></pre> +<div class="block">A <a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core"><code>KeyedWorkItem</code></a> composed of an underlying key, <a href="../../../../../org/apache/beam/sdk/util/TimerInternals.TimerData.html" title="class in org.apache.beam.sdk.util"><code>TimerInternals.TimerData</code></a> iterable, and element + iterable.</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="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="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><<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItems.ComposedKeyedWorkItem.html" title="type parameter in KeyedWorkItems.ComposedKeyedWorkItem">ElemT</a>>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItems.ComposedKeyedWorkItem.html#elementsIterable--">elementsIterable</a></span>()</code> +<div class="block">Returns an iterable containing the elements.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItems.ComposedKeyedWorkItem.html#equals-java.lang.Object-">equals</a></span>(<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> other)</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItems.ComposedKeyedWorkItem.html#hashCode--">hashCode</a></span>()</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItems.ComposedKeyedWorkItem.html" title="type parameter in KeyedWorkItems.ComposedKeyedWorkItem">K</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItems.ComposedKeyedWorkItem.html#key--">key</a></span>()</code> +<div class="block">Returns the key.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><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/TimerInternals.TimerData.html" title="class in org.apache.beam.sdk.util">TimerInternals.TimerData</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItems.ComposedKeyedWorkItem.html#timersIterable--">timersIterable</a></span>()</code> +<div class="block">Returns an iterable containing the timers.</div> +</td> +</tr> +<tr id="i5" 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/KeyedWorkItems.ComposedKeyedWorkItem.html#toString--">toString</a></span>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<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="key--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>key</h4> +<pre>public <a href="../../../../../org/apache/beam/runners/core/KeyedWorkItems.ComposedKeyedWorkItem.html" title="type parameter in KeyedWorkItems.ComposedKeyedWorkItem">K</a> key()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html#key--">KeyedWorkItem</a></code></span></div> +<div class="block">Returns the key.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html#key--">key</a></code> in interface <code><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core">KeyedWorkItem</a><<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItems.ComposedKeyedWorkItem.html" title="type parameter in KeyedWorkItems.ComposedKeyedWorkItem">K</a>,<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItems.ComposedKeyedWorkItem.html" title="type parameter in KeyedWorkItems.ComposedKeyedWorkItem">ElemT</a>></code></dd> +</dl> +</li> +</ul> +<a name="timersIterable--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>timersIterable</h4> +<pre>public <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/TimerInternals.TimerData.html" title="class in org.apache.beam.sdk.util">TimerInternals.TimerData</a>> timersIterable()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html#timersIterable--">KeyedWorkItem</a></code></span></div> +<div class="block">Returns an iterable containing the timers.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html#timersIterable--">timersIterable</a></code> in interface <code><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core">KeyedWorkItem</a><<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItems.ComposedKeyedWorkItem.html" title="type parameter in KeyedWorkItems.ComposedKeyedWorkItem">K</a>,<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItems.ComposedKeyedWorkItem.html" title="type parameter in KeyedWorkItems.ComposedKeyedWorkItem">ElemT</a>></code></dd> +</dl> +</li> +</ul> +<a name="elementsIterable--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>elementsIterable</h4> +<pre>public <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><<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItems.ComposedKeyedWorkItem.html" title="type parameter in KeyedWorkItems.ComposedKeyedWorkItem">ElemT</a>>> elementsIterable()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html#elementsIterable--">KeyedWorkItem</a></code></span></div> +<div class="block">Returns an iterable containing the elements.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html#elementsIterable--">elementsIterable</a></code> in interface <code><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core">KeyedWorkItem</a><<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItems.ComposedKeyedWorkItem.html" title="type parameter in KeyedWorkItems.ComposedKeyedWorkItem">K</a>,<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItems.ComposedKeyedWorkItem.html" title="type parameter in KeyedWorkItems.ComposedKeyedWorkItem">ElemT</a>></code></dd> +</dl> +</li> +</ul> +<a name="equals-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(<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> other)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><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></code> in class <code><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></code></dd> +</dl> +</li> +</ul> +<a name="hashCode--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><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></code> in class <code><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></code></dd> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public <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> toString()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><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></code> in class <code><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></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/KeyedWorkItems.ComposedKeyedWorkItem.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/KeyedWorkItems.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/LateDataDroppingDoFnRunner.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/KeyedWorkItems.ComposedKeyedWorkItem.html" target="_top">Frames</a></li> +<li><a href="KeyedWorkItems.ComposedKeyedWorkItem.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 <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/0c7c6b2a/src/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/KeyedWorkItems.html ---------------------------------------------------------------------- diff --git a/src/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/KeyedWorkItems.html b/src/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/KeyedWorkItems.html new file mode 100644 index 0000000..1aa9619 --- /dev/null +++ b/src/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/KeyedWorkItems.html @@ -0,0 +1,362 @@ +<!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 Thu Dec 29 08:19:09 CET 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>KeyedWorkItems (Apache Beam SDK for Java, version 0.4.0)</title> +<meta name="date" content="2016-12-29"> +<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="KeyedWorkItems (Apache Beam SDK for Java, version 0.4.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9,"i2":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/KeyedWorkItems.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/KeyedWorkItemCoder.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/KeyedWorkItems.ComposedKeyedWorkItem.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/KeyedWorkItems.html" target="_top">Frames</a></li> +<li><a href="KeyedWorkItems.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><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 KeyedWorkItems" class="title">Class KeyedWorkItems</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.KeyedWorkItems</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">KeyedWorkItems</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">Static utility methods that provide <a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core"><code>KeyedWorkItem</code></a> implementations.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItems.ComposedKeyedWorkItem.html" title="class in org.apache.beam.runners.core">KeyedWorkItems.ComposedKeyedWorkItem</a><<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItems.ComposedKeyedWorkItem.html" title="type parameter in KeyedWorkItems.ComposedKeyedWorkItem">K</a>,<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItems.ComposedKeyedWorkItem.html" title="type parameter in KeyedWorkItems.ComposedKeyedWorkItem">ElemT</a>></span></code> +<div class="block">A <a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core"><code>KeyedWorkItem</code></a> composed of an underlying key, <a href="../../../../../org/apache/beam/sdk/util/TimerInternals.TimerData.html" title="class in org.apache.beam.sdk.util"><code>TimerInternals.TimerData</code></a> iterable, and element + iterable.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="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/KeyedWorkItems.html#KeyedWorkItems--">KeyedWorkItems</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>static <K,ElemT> <a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core">KeyedWorkItem</a><K,ElemT></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItems.html#elementsWorkItem-K-java.lang.Iterable-">elementsWorkItem</a></span>(K key, + <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><ElemT>> elementsIterable)</code> +<div class="block">Returns an implementation of <a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core"><code>KeyedWorkItem</code></a> that wraps around an elements iterable.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <K,ElemT> <a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core">KeyedWorkItem</a><K,ElemT></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItems.html#timersWorkItem-K-java.lang.Iterable-">timersWorkItem</a></span>(K key, + <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/TimerInternals.TimerData.html" title="class in org.apache.beam.sdk.util">TimerInternals.TimerData</a>> timersIterable)</code> +<div class="block">Returns an implementation of <a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core"><code>KeyedWorkItem</code></a> that wraps around an timers iterable.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static <K,ElemT> <a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core">KeyedWorkItem</a><K,ElemT></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItems.html#workItem-K-java.lang.Iterable-java.lang.Iterable-">workItem</a></span>(K key, + <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/TimerInternals.TimerData.html" title="class in org.apache.beam.sdk.util">TimerInternals.TimerData</a>> timersIterable, + <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><ElemT>> elementsIterable)</code> +<div class="block">Returns an implementation of <a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core"><code>KeyedWorkItem</code></a> that wraps around + an timers iterable and an elements iterable.</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="KeyedWorkItems--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>KeyedWorkItems</h4> +<pre>public KeyedWorkItems()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="elementsWorkItem-java.lang.Object-java.lang.Iterable-"> +<!-- --> +</a><a name="elementsWorkItem-K-java.lang.Iterable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>elementsWorkItem</h4> +<pre>public static <K,ElemT> <a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core">KeyedWorkItem</a><K,ElemT> elementsWorkItem(K key, + <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><ElemT>> elementsIterable)</pre> +<div class="block">Returns an implementation of <a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core"><code>KeyedWorkItem</code></a> that wraps around an elements iterable.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>K</code> - the key type</dd> +<dd><code>ElemT</code> - the element type</dd> +</dl> +</li> +</ul> +<a name="timersWorkItem-java.lang.Object-java.lang.Iterable-"> +<!-- --> +</a><a name="timersWorkItem-K-java.lang.Iterable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>timersWorkItem</h4> +<pre>public static <K,ElemT> <a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core">KeyedWorkItem</a><K,ElemT> timersWorkItem(K key, + <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/TimerInternals.TimerData.html" title="class in org.apache.beam.sdk.util">TimerInternals.TimerData</a>> timersIterable)</pre> +<div class="block">Returns an implementation of <a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core"><code>KeyedWorkItem</code></a> that wraps around an timers iterable.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>K</code> - the key type</dd> +<dd><code>ElemT</code> - the element type</dd> +</dl> +</li> +</ul> +<a name="workItem-java.lang.Object-java.lang.Iterable-java.lang.Iterable-"> +<!-- --> +</a><a name="workItem-K-java.lang.Iterable-java.lang.Iterable-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>workItem</h4> +<pre>public static <K,ElemT> <a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core">KeyedWorkItem</a><K,ElemT> workItem(K key, + <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/TimerInternals.TimerData.html" title="class in org.apache.beam.sdk.util">TimerInternals.TimerData</a>> timersIterable, + <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><ElemT>> elementsIterable)</pre> +<div class="block">Returns an implementation of <a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core"><code>KeyedWorkItem</code></a> that wraps around + an timers iterable and an elements iterable.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>K</code> - the key type</dd> +<dd><code>ElemT</code> - the element type</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/KeyedWorkItems.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/KeyedWorkItemCoder.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/KeyedWorkItems.ComposedKeyedWorkItem.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/KeyedWorkItems.html" target="_top">Frames</a></li> +<li><a href="KeyedWorkItems.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><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 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
