Google Git
Sign in
apache / beam-site / refs/heads/updates_release_2.8.0 / . / javadoc / 2.8.0 / org / apache / beam / sdk / testing / package-summary.html
blob: 3c5933c50eea28d2f0e62cfbed0bfa720d1749f3 [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_161-google-v7) on Thu Oct 18 16:14:38 PDT 2018 -->
<title>org.apache.beam.sdk.testing (Apache Beam 2.8.0-SNAPSHOT)</title>
<meta name="date" content="2018-10-18">
<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="org.apache.beam.sdk.testing (Apache Beam 2.8.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>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/state/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/beam/sdk/transforms/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/sdk/testing/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<p>@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)
</p>
<h1 title="Package" class="title">Package&nbsp;org.apache.beam.sdk.testing</h1>
<div class="docSummary">
<div class="block">Defines utilities for unit testing Apache Beam pipelines.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/FlattenWithHeterogeneousCoders.html" title="interface in org.apache.beam.sdk.testing">FlattenWithHeterogeneousCoders</a></td>
<td class="colLast">
<div class="block">Category tag for tests that use a <a href="../../../../../org/apache/beam/sdk/transforms/Flatten.html" title="class in org.apache.beam.sdk.transforms"><code>Flatten</code></a> where the input <a href="../../../../../org/apache/beam/sdk/values/PCollectionList.html" title="class in org.apache.beam.sdk.values"><code>PCollectionList</code></a>
contains <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollections</code></a> heterogeneous <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>coders</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/LargeKeys.html" title="interface in org.apache.beam.sdk.testing">LargeKeys</a></td>
<td class="colLast">
<div class="block">Category tags for tests which validate that a Beam runner can handle keys up to a given size.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/LargeKeys.Above100KB.html" title="interface in org.apache.beam.sdk.testing">LargeKeys.Above100KB</a></td>
<td class="colLast">
<div class="block">Tests if a runner supports 100KB keys.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/LargeKeys.Above100MB.html" title="interface in org.apache.beam.sdk.testing">LargeKeys.Above100MB</a></td>
<td class="colLast">
<div class="block">Tests if a runner supports 100MB keys.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/LargeKeys.Above10KB.html" title="interface in org.apache.beam.sdk.testing">LargeKeys.Above10KB</a></td>
<td class="colLast">
<div class="block">Tests if a runner supports 10KB keys.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/LargeKeys.Above10MB.html" title="interface in org.apache.beam.sdk.testing">LargeKeys.Above10MB</a></td>
<td class="colLast">
<div class="block">Tests if a runner supports 10MB keys.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/LargeKeys.Above1MB.html" title="interface in org.apache.beam.sdk.testing">LargeKeys.Above1MB</a></td>
<td class="colLast">
<div class="block">Tests if a runner supports 1MB keys.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/NeedsRunner.html" title="interface in org.apache.beam.sdk.testing">NeedsRunner</a></td>
<td class="colLast">
<div class="block">Category tag for validation tests which utilize <a href="../../../../../org/apache/beam/sdk/testing/TestPipeline.html" title="class in org.apache.beam.sdk.testing"><code>TestPipeline</code></a> for execution and expect to
be executed by a <a href="../../../../../org/apache/beam/sdk/PipelineRunner.html" title="class in org.apache.beam.sdk"><code>PipelineRunner</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/PAssert.IterableAssert.html" title="interface in org.apache.beam.sdk.testing">PAssert.IterableAssert</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Builder interface for assertions applicable to iterables and PCollection contents.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/PAssert.SingletonAssert.html" title="interface in org.apache.beam.sdk.testing">PAssert.SingletonAssert</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Builder interface for assertions applicable to a single value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/SerializableMatcher.html" title="interface in org.apache.beam.sdk.testing">SerializableMatcher</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A <a href="http://hamcrest.org/JavaHamcrest/javadoc/1.3/org/hamcrest/Matcher.html?is-external=true" title="class or interface in org.hamcrest"><code>Matcher</code></a> that is also <code>Serializable</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/SerializableMatchers.SerializableSupplier.html" title="interface in org.apache.beam.sdk.testing">SerializableMatchers.SerializableSupplier</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Supplies values of type <code>T</code>, and is serializable.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/StreamingIT.html" title="interface in org.apache.beam.sdk.testing">StreamingIT</a></td>
<td class="colLast">Deprecated
<div class="block"><span class="deprecationComment">tests which use unbounded PCollections should be in the category <a href="../../../../../org/apache/beam/sdk/testing/UsesUnboundedPCollections.html" title="interface in org.apache.beam.sdk.testing"><code>UsesUnboundedPCollections</code></a>.</span></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/TestPipeline.TestValueProviderOptions.html" title="interface in org.apache.beam.sdk.testing">TestPipeline.TestValueProviderOptions</a></td>
<td class="colLast">
<div class="block">Implementation detail of <a href="../../../../../org/apache/beam/sdk/testing/TestPipeline.html#newProvider-T-"><code>TestPipeline.newProvider(T)</code></a>, do not use.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/TestPipelineOptions.html" title="interface in org.apache.beam.sdk.testing">TestPipelineOptions</a></td>
<td class="colLast">
<div class="block"><a href="../../../../../org/apache/beam/sdk/testing/TestPipelineOptions.html" title="interface in org.apache.beam.sdk.testing"><code>TestPipelineOptions</code></a> is a set of options for test pipelines.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/TestStream.Event.html" title="interface in org.apache.beam.sdk.testing">TestStream.Event</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">An event in a <a href="../../../../../org/apache/beam/sdk/testing/TestStream.html" title="class in org.apache.beam.sdk.testing"><code>TestStream</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/UsesBoundedSplittableParDo.html" title="interface in org.apache.beam.sdk.testing">UsesBoundedSplittableParDo</a></td>
<td class="colLast">
<div class="block">Category tag for validation tests which utilize splittable <a href="../../../../../org/apache/beam/sdk/transforms/ParDo.html" title="class in org.apache.beam.sdk.transforms"><code>ParDo</code></a> with a <code>DoFn.BoundedPerElement</code> <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/UsesCommittedMetrics.html" title="interface in org.apache.beam.sdk.testing">UsesCommittedMetrics</a></td>
<td class="colLast">
<div class="block">Category tag for validation tests which utilize <a href="../../../../../org/apache/beam/sdk/metrics/Metrics.html" title="class in org.apache.beam.sdk.metrics"><code>Metrics</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/UsesCustomWindowMerging.html" title="interface in org.apache.beam.sdk.testing">UsesCustomWindowMerging</a></td>
<td class="colLast">
<div class="block">Category tag for validation tests which utilize custom window merging.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/UsesFailureMessage.html" title="interface in org.apache.beam.sdk.testing">UsesFailureMessage</a></td>
<td class="colLast">
<div class="block">Category tag for tests which validate that currect failure message is provided by failed
pipeline.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/UsesMapState.html" title="interface in org.apache.beam.sdk.testing">UsesMapState</a></td>
<td class="colLast">
<div class="block">Category tag for validation tests which utilize <a href="../../../../../org/apache/beam/sdk/state/MapState.html" title="interface in org.apache.beam.sdk.state"><code>MapState</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/UsesMetricsPusher.html" title="interface in org.apache.beam.sdk.testing">UsesMetricsPusher</a></td>
<td class="colLast">
<div class="block">Category tag for validation tests which utilize the metrics pusher feature.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/UsesParDoLifecycle.html" title="interface in org.apache.beam.sdk.testing">UsesParDoLifecycle</a></td>
<td class="colLast">
<div class="block">Category tag for the ParDoLifecycleTest for exclusion (BEAM-3241).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/UsesSchema.html" title="interface in org.apache.beam.sdk.testing">UsesSchema</a></td>
<td class="colLast">
<div class="block">Category tag for validation tests which utilize schemas.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/UsesSetState.html" title="interface in org.apache.beam.sdk.testing">UsesSetState</a></td>
<td class="colLast">
<div class="block">Category tag for validation tests which utilize <a href="../../../../../org/apache/beam/sdk/state/SetState.html" title="interface in org.apache.beam.sdk.state"><code>SetState</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/UsesSplittableParDoWithWindowedSideInputs.html" title="interface in org.apache.beam.sdk.testing">UsesSplittableParDoWithWindowedSideInputs</a></td>
<td class="colLast">
<div class="block">Category tag for validation tests which utilize splittable <a href="../../../../../org/apache/beam/sdk/transforms/ParDo.html" title="class in org.apache.beam.sdk.transforms"><code>ParDo</code></a> and use windowed side
inputs.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/UsesStatefulParDo.html" title="interface in org.apache.beam.sdk.testing">UsesStatefulParDo</a></td>
<td class="colLast">
<div class="block">Category tag for validation tests which utilize stateful <a href="../../../../../org/apache/beam/sdk/transforms/ParDo.html" title="class in org.apache.beam.sdk.transforms"><code>ParDo</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/UsesTestStream.html" title="interface in org.apache.beam.sdk.testing">UsesTestStream</a></td>
<td class="colLast">
<div class="block">Category tag for tests that use <a href="../../../../../org/apache/beam/sdk/testing/TestStream.html" title="class in org.apache.beam.sdk.testing"><code>TestStream</code></a>, which is not a part of the Beam model but a
special feature currently only implemented by the direct runner.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/UsesTimersInParDo.html" title="interface in org.apache.beam.sdk.testing">UsesTimersInParDo</a></td>
<td class="colLast">
<div class="block">Category tag for validation tests which utilize timers in <a href="../../../../../org/apache/beam/sdk/transforms/ParDo.html" title="class in org.apache.beam.sdk.transforms"><code>ParDo</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/UsesUnboundedPCollections.html" title="interface in org.apache.beam.sdk.testing">UsesUnboundedPCollections</a></td>
<td class="colLast">
<div class="block">Category tag for validation tests which utilize at least one unbounded <code>PCollection</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/UsesUnboundedSplittableParDo.html" title="interface in org.apache.beam.sdk.testing">UsesUnboundedSplittableParDo</a></td>
<td class="colLast">
<div class="block">Category tag for validation tests which utilize splittable <a href="../../../../../org/apache/beam/sdk/transforms/ParDo.html" title="class in org.apache.beam.sdk.transforms"><code>ParDo</code></a> with a <code>DoFn.UnboundedPerElement</code> <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/ValidatesRunner.html" title="interface in org.apache.beam.sdk.testing">ValidatesRunner</a></td>
<td class="colLast">
<div class="block">Category tag for tests which validate that a Beam runner is correctly implemented.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/CoderProperties.html" title="class in org.apache.beam.sdk.testing">CoderProperties</a></td>
<td class="colLast">
<div class="block">Properties for use in <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> tests.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/CoderProperties.TestElementByteSizeObserver.html" title="class in org.apache.beam.sdk.testing">CoderProperties.TestElementByteSizeObserver</a></td>
<td class="colLast">
<div class="block">An <code>ElementByteSizeObserver</code> that records the observed element sizes for testing
purposes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/CombineFnTester.html" title="class in org.apache.beam.sdk.testing">CombineFnTester</a></td>
<td class="colLast">
<div class="block">Utilities for testing <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms"><code>CombineFns</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/CrashingRunner.html" title="class in org.apache.beam.sdk.testing">CrashingRunner</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../org/apache/beam/sdk/PipelineRunner.html" title="class in org.apache.beam.sdk"><code>PipelineRunner</code></a> that applies no overrides and throws an exception on calls to <a href="../../../../../org/apache/beam/sdk/Pipeline.html#run--"><code>Pipeline.run()</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/FileChecksumMatcher.html" title="class in org.apache.beam.sdk.testing">FileChecksumMatcher</a></td>
<td class="colLast">
<div class="block">Matcher to verify file checksum in E2E test.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/PAssert.html" title="class in org.apache.beam.sdk.testing">PAssert</a></td>
<td class="colLast">
<div class="block">An assertion on the contents of a <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> incorporated into the pipeline.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/PAssert.DefaultConcludeTransform.html" title="class in org.apache.beam.sdk.testing">PAssert.DefaultConcludeTransform</a></td>
<td class="colLast">
<div class="block">Default transform to check that a PAssert was successful.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/PAssert.GroupThenAssert.html" title="class in org.apache.beam.sdk.testing">PAssert.GroupThenAssert</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A transform that applies an assertion-checking function over iterables of <code>ActualT</code> to
the entirety of the contents of its input.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/PAssert.GroupThenAssertForSingleton.html" title="class in org.apache.beam.sdk.testing">PAssert.GroupThenAssertForSingleton</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A transform that applies an assertion-checking function to a single iterable contained as the
sole element of a <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/PAssert.OneSideInputAssert.html" title="class in org.apache.beam.sdk.testing">PAssert.OneSideInputAssert</a>&lt;ActualT&gt;</td>
<td class="colLast">
<div class="block">An assertion checker that takes a single <a href="../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values"><code>PCollectionView&lt;ActualT&gt;</code></a>
and an assertion over <code>ActualT</code>, and checks it within a Beam pipeline.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/PAssert.PAssertionSite.html" title="class in org.apache.beam.sdk.testing">PAssert.PAssertionSite</a></td>
<td class="colLast">
<div class="block">Track the place where an assertion is defined.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/PAssert.PCollectionContentsAssert.html" title="class in org.apache.beam.sdk.testing">PAssert.PCollectionContentsAssert</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">An <a href="../../../../../org/apache/beam/sdk/testing/PAssert.IterableAssert.html" title="interface in org.apache.beam.sdk.testing"><code>PAssert.IterableAssert</code></a> about the contents of a <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/PAssert.PCollectionContentsAssert.MatcherCheckerFn.html" title="class in org.apache.beam.sdk.testing">PAssert.PCollectionContentsAssert.MatcherCheckerFn</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Check that the passed-in matchers match the existing data.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/RegexMatcher.html" title="class in org.apache.beam.sdk.testing">RegexMatcher</a></td>
<td class="colLast">
<div class="block">Hamcrest matcher to assert a string matches a pattern.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/SerializableMatchers.html" title="class in org.apache.beam.sdk.testing">SerializableMatchers</a></td>
<td class="colLast">
<div class="block">Static class for building and using <a href="../../../../../org/apache/beam/sdk/testing/SerializableMatcher.html" title="interface in org.apache.beam.sdk.testing"><code>SerializableMatcher</code></a> instances.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/SourceTestUtils.html" title="class in org.apache.beam.sdk.testing">SourceTestUtils</a></td>
<td class="colLast">
<div class="block">Helper functions and test harnesses for checking correctness of <a href="../../../../../org/apache/beam/sdk/io/Source.html" title="class in org.apache.beam.sdk.io"><code>Source</code></a> implementations.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/SuccessOrFailure.html" title="class in org.apache.beam.sdk.testing">SuccessOrFailure</a></td>
<td class="colLast">
<div class="block">Output of <a href="../../../../../org/apache/beam/sdk/testing/PAssert.html" title="class in org.apache.beam.sdk.testing"><code>PAssert</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/TestPipeline.html" title="class in org.apache.beam.sdk.testing">TestPipeline</a></td>
<td class="colLast">
<div class="block">A creator of test pipelines that can be used inside of tests that can be configured to run
locally or against a remote pipeline runner.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/TestPipelineOptions.AlwaysPassMatcher.html" title="class in org.apache.beam.sdk.testing">TestPipelineOptions.AlwaysPassMatcher</a></td>
<td class="colLast">
<div class="block">Matcher which will always pass.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/TestPipelineOptions.AlwaysPassMatcherFactory.html" title="class in org.apache.beam.sdk.testing">TestPipelineOptions.AlwaysPassMatcherFactory</a></td>
<td class="colLast">
<div class="block">Factory for <a href="../../../../../org/apache/beam/sdk/PipelineResult.html" title="interface in org.apache.beam.sdk"><code>PipelineResult</code></a> matchers which always pass.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/TestStream.html" title="class in org.apache.beam.sdk.testing">TestStream</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A testing input that generates an unbounded <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> of elements, advancing the
watermark and processing time as elements are emitted.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/TestStream.Builder.html" title="class in org.apache.beam.sdk.testing">TestStream.Builder</a>&lt;T&gt;</td>
<td class="colLast">
<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>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/TestStream.ElementEvent.html" title="class in org.apache.beam.sdk.testing">TestStream.ElementEvent</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A <a href="../../../../../org/apache/beam/sdk/testing/TestStream.Event.html" title="interface in org.apache.beam.sdk.testing"><code>TestStream.Event</code></a> that produces elements.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/TestStream.ProcessingTimeEvent.html" title="class in org.apache.beam.sdk.testing">TestStream.ProcessingTimeEvent</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A <a href="../../../../../org/apache/beam/sdk/testing/TestStream.Event.html" title="interface in org.apache.beam.sdk.testing"><code>TestStream.Event</code></a> that advances the processing time clock.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/TestStream.WatermarkEvent.html" title="class in org.apache.beam.sdk.testing">TestStream.WatermarkEvent</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A <a href="../../../../../org/apache/beam/sdk/testing/TestStream.Event.html" title="interface in org.apache.beam.sdk.testing"><code>TestStream.Event</code></a> that advances the watermark.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/UsesAttemptedMetrics.html" title="class in org.apache.beam.sdk.testing">UsesAttemptedMetrics</a></td>
<td class="colLast">
<div class="block">Category tag for validation tests which utilize <a href="../../../../../org/apache/beam/sdk/metrics/Metrics.html" title="class in org.apache.beam.sdk.metrics"><code>Metrics</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/UsesCounterMetrics.html" title="class in org.apache.beam.sdk.testing">UsesCounterMetrics</a></td>
<td class="colLast">
<div class="block">Category tag for validation tests which utilize <a href="../../../../../org/apache/beam/sdk/metrics/Counter.html" title="interface in org.apache.beam.sdk.metrics"><code>Counter</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/UsesDistributionMetrics.html" title="class in org.apache.beam.sdk.testing">UsesDistributionMetrics</a></td>
<td class="colLast">
<div class="block">Category tag for validation tests which utilize <a href="../../../../../org/apache/beam/sdk/metrics/Distribution.html" title="interface in org.apache.beam.sdk.metrics"><code>Distribution</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/UsesGaugeMetrics.html" title="class in org.apache.beam.sdk.testing">UsesGaugeMetrics</a></td>
<td class="colLast">
<div class="block">Category tag for validation tests which utilize <a href="../../../../../org/apache/beam/sdk/metrics/Gauge.html" title="interface in org.apache.beam.sdk.metrics"><code>Gauge</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/UsesImpulse.html" title="class in org.apache.beam.sdk.testing">UsesImpulse</a></td>
<td class="colLast">
<div class="block">Category for tests that use <a href="../../../../../org/apache/beam/sdk/transforms/Impulse.html" title="class in org.apache.beam.sdk.transforms"><code>Impulse</code></a> transformations.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/WindowFnTestUtils.html" title="class in org.apache.beam.sdk.testing">WindowFnTestUtils</a></td>
<td class="colLast">
<div class="block">A utility class for testing <a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>WindowFn</code></a>s.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/SourceTestUtils.ExpectedSplitOutcome.html" title="enum in org.apache.beam.sdk.testing">SourceTestUtils.ExpectedSplitOutcome</a></td>
<td class="colLast">
<div class="block">Expected outcome of <a href="../../../../../org/apache/beam/sdk/io/BoundedSource.BoundedReader.html#splitAtFraction-double-"><code>BoundedSource.BoundedReader.splitAtFraction(double)</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/TestStream.EventType.html" title="enum in org.apache.beam.sdk.testing">TestStream.EventType</a></td>
<td class="colLast">
<div class="block">The types of <a href="../../../../../org/apache/beam/sdk/testing/TestStream.Event.html" title="interface in org.apache.beam.sdk.testing"><code>TestStream.Event</code></a> that are supported by <a href="../../../../../org/apache/beam/sdk/testing/TestStream.html" title="class in org.apache.beam.sdk.testing"><code>TestStream</code></a>.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/TestPipeline.AbandonedNodeException.html" title="class in org.apache.beam.sdk.testing">TestPipeline.AbandonedNodeException</a></td>
<td class="colLast">
<div class="block">An exception thrown in case an abandoned <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> is
detected, that is, a <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> that has not been run.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/testing/TestPipeline.PipelineRunMissingException.html" title="class in org.apache.beam.sdk.testing">TestPipeline.PipelineRunMissingException</a></td>
<td class="colLast">
<div class="block">An exception thrown in case a test finishes without invoking <a href="../../../../../org/apache/beam/sdk/Pipeline.html#run--"><code>Pipeline.run()</code></a>.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.beam.sdk.testing Description">Package org.apache.beam.sdk.testing Description</h2>
<div class="block">Defines utilities for unit testing Apache Beam pipelines. The tests for the <code>PTransform</code>s
and examples included in the Apache Beam SDK provide examples of using these utilities.</div>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>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/state/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/beam/sdk/transforms/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/sdk/testing/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>