blob: 242efe0adf3a3d4c425de7b473f070ebe0775531 [file] [log] [blame]
<!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_181-google-v7) on Mon Jan 27 16:42:31 PST 2020 -->
<title>TestStream.Builder (Apache Beam 2.20.0-SNAPSHOT)</title>
<meta name="date" content="2020-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="TestStream.Builder (Apache Beam 2.20.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/beam/sdk/testing/TestStream.html" title="class in org.apache.beam.sdk.testing"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/beam/sdk/testing/TestStream.ElementEvent.html" title="class in org.apache.beam.sdk.testing"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/sdk/testing/TestStream.Builder.html" target="_top">Frames</a></li>
<li><a href="TestStream.Builder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.sdk.testing</div>
<h2 title="Class TestStream.Builder" class="title">Class TestStream.Builder&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.testing.TestStream.Builder&lt;T&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../../org/apache/beam/sdk/testing/TestStream.html" title="class in org.apache.beam.sdk.testing">TestStream</a>&lt;<a href="../../../../../org/apache/beam/sdk/testing/TestStream.html" title="type parameter in TestStream">T</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public static class <span class="typeNameLabel">TestStream.Builder&lt;T&gt;</span>
extends java.lang.Object</pre>
<div class="block">An incomplete <a href="../../../../../org/apache/beam/sdk/testing/TestStream.html" title="class in org.apache.beam.sdk.testing"><code>TestStream</code></a>. Elements added to this builder will be produced in sequence
when the pipeline created by the <a href="../../../../../org/apache/beam/sdk/testing/TestStream.html" title="class in org.apache.beam.sdk.testing"><code>TestStream</code></a> is run.</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html" title="class in org.apache.beam.sdk.testing">TestStream.Builder</a>&lt;<a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html" title="type parameter in TestStream.Builder">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html#addElements-org.apache.beam.sdk.values.TimestampedValue-org.apache.beam.sdk.values.TimestampedValue...-">addElements</a></span>(<a href="../../../../../org/apache/beam/sdk/values/TimestampedValue.html" title="class in org.apache.beam.sdk.values">TimestampedValue</a>&lt;<a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html" title="type parameter in TestStream.Builder">T</a>&gt;&nbsp;element,
<a href="../../../../../org/apache/beam/sdk/values/TimestampedValue.html" title="class in org.apache.beam.sdk.values">TimestampedValue</a>&lt;<a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html" title="type parameter in TestStream.Builder">T</a>&gt;...&nbsp;elements)</code>
<div class="block">Adds the specified elements to the source with the provided timestamps.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html" title="class in org.apache.beam.sdk.testing">TestStream.Builder</a>&lt;<a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html" title="type parameter in TestStream.Builder">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html#addElements-T-T...-">addElements</a></span>(<a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html" title="type parameter in TestStream.Builder">T</a>&nbsp;element,
<a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html" title="type parameter in TestStream.Builder">T</a>...&nbsp;elements)</code>
<div class="block">Adds the specified elements to the source with timestamp equal to the current watermark.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html" title="class in org.apache.beam.sdk.testing">TestStream.Builder</a>&lt;<a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html" title="type parameter in TestStream.Builder">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html#advanceProcessingTime-org.joda.time.Duration-">advanceProcessingTime</a></span>(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.3/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a>&nbsp;amount)</code>
<div class="block">Advance the processing time by the specified amount.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html" title="class in org.apache.beam.sdk.testing">TestStream.Builder</a>&lt;<a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html" title="type parameter in TestStream.Builder">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html#advanceWatermarkTo-org.joda.time.Instant-">advanceWatermarkTo</a></span>(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.3/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a>&nbsp;newWatermark)</code>
<div class="block">Advance the watermark of this source to the specified instant.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/testing/TestStream.html" title="class in org.apache.beam.sdk.testing">TestStream</a>&lt;<a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html" title="type parameter in TestStream.Builder">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html#advanceWatermarkToInfinity--">advanceWatermarkToInfinity</a></span>()</code>
<div class="block">Advance the watermark to infinity, completing this <a href="../../../../../org/apache/beam/sdk/testing/TestStream.html" title="class in org.apache.beam.sdk.testing"><code>TestStream</code></a>.</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&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="addElements-java.lang.Object-java.lang.Object:A-">
<!-- -->
</a><a name="addElements-T-T...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addElements</h4>
<pre>@SafeVarargs
public final&nbsp;<a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html" title="class in org.apache.beam.sdk.testing">TestStream.Builder</a>&lt;<a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html" title="type parameter in TestStream.Builder">T</a>&gt;&nbsp;addElements(<a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html" title="type parameter in TestStream.Builder">T</a>&nbsp;element,
<a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html" title="type parameter in TestStream.Builder">T</a>...&nbsp;elements)</pre>
<div class="block">Adds the specified elements to the source with timestamp equal to the current watermark.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A <a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html" title="class in org.apache.beam.sdk.testing"><code>TestStream.Builder</code></a> like this one that will add the provided elements after
all earlier events have completed.</dd>
</dl>
</li>
</ul>
<a name="addElements-org.apache.beam.sdk.values.TimestampedValue-org.apache.beam.sdk.values.TimestampedValue...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addElements</h4>
<pre>@SafeVarargs
public final&nbsp;<a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html" title="class in org.apache.beam.sdk.testing">TestStream.Builder</a>&lt;<a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html" title="type parameter in TestStream.Builder">T</a>&gt;&nbsp;addElements(<a href="../../../../../org/apache/beam/sdk/values/TimestampedValue.html" title="class in org.apache.beam.sdk.values">TimestampedValue</a>&lt;<a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html" title="type parameter in TestStream.Builder">T</a>&gt;&nbsp;element,
<a href="../../../../../org/apache/beam/sdk/values/TimestampedValue.html" title="class in org.apache.beam.sdk.values">TimestampedValue</a>&lt;<a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html" title="type parameter in TestStream.Builder">T</a>&gt;...&nbsp;elements)</pre>
<div class="block">Adds the specified elements to the source with the provided timestamps.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A <a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html" title="class in org.apache.beam.sdk.testing"><code>TestStream.Builder</code></a> like this one that will add the provided elements after
all earlier events have completed.</dd>
</dl>
</li>
</ul>
<a name="advanceWatermarkTo-org.joda.time.Instant-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>advanceWatermarkTo</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html" title="class in org.apache.beam.sdk.testing">TestStream.Builder</a>&lt;<a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html" title="type parameter in TestStream.Builder">T</a>&gt;&nbsp;advanceWatermarkTo(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.3/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a>&nbsp;newWatermark)</pre>
<div class="block">Advance the watermark of this source to the specified instant.
<p>The watermark must advance monotonically and cannot advance to <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html#TIMESTAMP_MAX_VALUE"><code>BoundedWindow.TIMESTAMP_MAX_VALUE</code></a> or beyond.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A <a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html" title="class in org.apache.beam.sdk.testing"><code>TestStream.Builder</code></a> like this one that will advance the watermark to the
specified point after all earlier events have completed.</dd>
</dl>
</li>
</ul>
<a name="advanceProcessingTime-org.joda.time.Duration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>advanceProcessingTime</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html" title="class in org.apache.beam.sdk.testing">TestStream.Builder</a>&lt;<a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html" title="type parameter in TestStream.Builder">T</a>&gt;&nbsp;advanceProcessingTime(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.3/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a>&nbsp;amount)</pre>
<div class="block">Advance the processing time by the specified amount.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A <a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html" title="class in org.apache.beam.sdk.testing"><code>TestStream.Builder</code></a> like this one that will advance the processing time by
the specified amount after all earlier events have completed.</dd>
</dl>
</li>
</ul>
<a name="advanceWatermarkToInfinity--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>advanceWatermarkToInfinity</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/beam/sdk/testing/TestStream.html" title="class in org.apache.beam.sdk.testing">TestStream</a>&lt;<a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html" title="type parameter in TestStream.Builder">T</a>&gt;&nbsp;advanceWatermarkToInfinity()</pre>
<div class="block">Advance the watermark to infinity, completing this <a href="../../../../../org/apache/beam/sdk/testing/TestStream.html" title="class in org.apache.beam.sdk.testing"><code>TestStream</code></a>. Future calls to the
same builder will not affect the returned <a href="../../../../../org/apache/beam/sdk/testing/TestStream.html" title="class in org.apache.beam.sdk.testing"><code>TestStream</code></a>.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/beam/sdk/testing/TestStream.html" title="class in org.apache.beam.sdk.testing"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/beam/sdk/testing/TestStream.ElementEvent.html" title="class in org.apache.beam.sdk.testing"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/sdk/testing/TestStream.Builder.html" target="_top">Frames</a></li>
<li><a href="TestStream.Builder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>