Google Git
Sign in
apache / beam-site / aa4899384bfb3460196adf6331c744cb480b96df / . / javadoc / 2.38.0 / org / apache / beam / sdk / schemas / transforms / package-summary.html
blob: 0b084a0df3b27ba560732a00bb5d15d2f29cd3b3 [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 -->
<title>org.apache.beam.sdk.schemas.transforms (Apache Beam 2.38.0-SNAPSHOT)</title>
<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.schemas.transforms (Apache Beam 2.38.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/schemas/parser/generated/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/beam/sdk/schemas/utils/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/schemas/transforms/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=<a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.10.0/org/checkerframework/checker/nullness/qual/NonNull.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">org.checkerframework.checker.nullness.qual.NonNull.class</a>)
</p>
<h1 title="Package" class="title">Package&nbsp;org.apache.beam.sdk.schemas.transforms</h1>
<div class="docSummary">
<div class="block">Defines transforms that work on PCollections with schemas..</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/schemas/transforms/Cast.Validator.html" title="interface in org.apache.beam.sdk.schemas.transforms">Cast.Validator</a></td>
<td class="colLast">
<div class="block">Interface for statically validating casts.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/SchemaTransform.html" title="interface in org.apache.beam.sdk.schemas.transforms">SchemaTransform</a></td>
<td class="colLast">
<div class="block">An abstraction to create schema capable and aware transforms.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/SchemaTransformProvider.html" title="interface in org.apache.beam.sdk.schemas.transforms">SchemaTransformProvider</a></td>
<td class="colLast">
<div class="block">Provider to create <a href="../../../../../../org/apache/beam/sdk/schemas/transforms/SchemaTransform.html" title="interface in org.apache.beam.sdk.schemas.transforms"><code>SchemaTransform</code></a> instances for use in Beam SQL and other SDKs.</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/schemas/transforms/AddFields.html" title="class in org.apache.beam.sdk.schemas.transforms">AddFields</a></td>
<td class="colLast">
<div class="block">A transform to add new nullable fields to a PCollection's schema.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/AddFields.Inner.html" title="class in org.apache.beam.sdk.schemas.transforms">AddFields.Inner</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Inner PTransform for AddFields.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/Cast.html" title="class in org.apache.beam.sdk.schemas.transforms">Cast</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Set of utilities for casting rows between schemas.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/Cast.CompatibilityError.html" title="class in org.apache.beam.sdk.schemas.transforms">Cast.CompatibilityError</a></td>
<td class="colLast">
<div class="block">Describes compatibility errors during casting.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/Cast.Narrowing.html" title="class in org.apache.beam.sdk.schemas.transforms">Cast.Narrowing</a></td>
<td class="colLast">
<div class="block">Narrowing changes type without guarantee to preserve data.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/Cast.Widening.html" title="class in org.apache.beam.sdk.schemas.transforms">Cast.Widening</a></td>
<td class="colLast">
<div class="block">Widening changes to type that can represent any possible value of the original type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/CoGroup.html" title="class in org.apache.beam.sdk.schemas.transforms">CoGroup</a></td>
<td class="colLast">
<div class="block">A transform that performs equijoins across multiple schema <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a>s.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/CoGroup.By.html" title="class in org.apache.beam.sdk.schemas.transforms">CoGroup.By</a></td>
<td class="colLast">
<div class="block">Defines the set of fields to extract for the join key, as well as other per-input join options.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/CoGroup.ExpandCrossProduct.html" title="class in org.apache.beam.sdk.schemas.transforms">CoGroup.ExpandCrossProduct</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> that calculates the cross-product join.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/CoGroup.Impl.html" title="class in org.apache.beam.sdk.schemas.transforms">CoGroup.Impl</a></td>
<td class="colLast">
<div class="block">The implementing PTransform.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/CoGroup.Result.html" title="class in org.apache.beam.sdk.schemas.transforms">CoGroup.Result</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/Convert.html" title="class in org.apache.beam.sdk.schemas.transforms">Convert</a></td>
<td class="colLast">
<div class="block">A set of utilities for converting between different objects supporting schemas.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/DropFields.html" title="class in org.apache.beam.sdk.schemas.transforms">DropFields</a></td>
<td class="colLast">
<div class="block">A transform to drop fields from a schema.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/DropFields.Inner.html" title="class in org.apache.beam.sdk.schemas.transforms">DropFields.Inner</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Implementation class for DropFields.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/Filter.html" title="class in org.apache.beam.sdk.schemas.transforms">Filter</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> for filtering a collection of schema types.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/Filter.Inner.html" title="class in org.apache.beam.sdk.schemas.transforms">Filter.Inner</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Implementation of the filter.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/Group.html" title="class in org.apache.beam.sdk.schemas.transforms">Group</a></td>
<td class="colLast">
<div class="block">A generic grouping transform for schema <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a>s.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/Group.AggregateCombiner.html" title="class in org.apache.beam.sdk.schemas.transforms">Group.AggregateCombiner</a>&lt;InputT&gt;</td>
<td class="colLast">
<div class="block">a <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> that does a combine using an aggregation built up by calls to
aggregateField and aggregateFields.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/Group.ByFields.html" title="class in org.apache.beam.sdk.schemas.transforms">Group.ByFields</a>&lt;InputT&gt;</td>
<td class="colLast">
<div class="block">a <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> that groups schema elements based on the given fields.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/Group.CombineFieldsByFields.html" title="class in org.apache.beam.sdk.schemas.transforms">Group.CombineFieldsByFields</a>&lt;InputT&gt;</td>
<td class="colLast">
<div class="block">a <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> that does a per-key combine using an aggregation built up by calls to
aggregateField and aggregateFields.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/Group.CombineFieldsGlobally.html" title="class in org.apache.beam.sdk.schemas.transforms">Group.CombineFieldsGlobally</a>&lt;InputT&gt;</td>
<td class="colLast">
<div class="block">a <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> that does a global combine using an aggregation built up by calls to
aggregateField and aggregateFields.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/Group.CombineGlobally.html" title="class in org.apache.beam.sdk.schemas.transforms">Group.CombineGlobally</a>&lt;InputT,OutputT&gt;</td>
<td class="colLast">
<div class="block">a <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> that does a global combine using a provider <a href="../../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms"><code>Combine.CombineFn</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/Group.Global.html" title="class in org.apache.beam.sdk.schemas.transforms">Group.Global</a>&lt;InputT&gt;</td>
<td class="colLast">
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> for doing global aggregations on schema PCollections.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/Join.html" title="class in org.apache.beam.sdk.schemas.transforms">Join</a></td>
<td class="colLast">
<div class="block">A transform that performs equijoins across two schema <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a>s.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/Join.FieldsEqual.html" title="class in org.apache.beam.sdk.schemas.transforms">Join.FieldsEqual</a></td>
<td class="colLast">
<div class="block">Predicate object to specify fields to compare when doing an equi-join.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/Join.FieldsEqual.Impl.html" title="class in org.apache.beam.sdk.schemas.transforms">Join.FieldsEqual.Impl</a></td>
<td class="colLast">
<div class="block">Implementation class for FieldsEqual.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/Join.Impl.html" title="class in org.apache.beam.sdk.schemas.transforms">Join.Impl</a>&lt;LhsT,RhsT&gt;</td>
<td class="colLast">
<div class="block">Implementation class .</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/RenameFields.html" title="class in org.apache.beam.sdk.schemas.transforms">RenameFields</a></td>
<td class="colLast">
<div class="block">A transform for renaming fields inside an existing schema.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/RenameFields.Inner.html" title="class in org.apache.beam.sdk.schemas.transforms">RenameFields.Inner</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">The class implementing the actual PTransform.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/Select.html" title="class in org.apache.beam.sdk.schemas.transforms">Select</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> for selecting a subset of fields from a schema type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/Select.Fields.html" title="class in org.apache.beam.sdk.schemas.transforms">Select.Fields</a>&lt;T&gt;</td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/Select.Flattened.html" title="class in org.apache.beam.sdk.schemas.transforms">Select.Flattened</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> representing a flattened schema.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/transforms/TypedSchemaTransformProvider.html" title="class in org.apache.beam.sdk.schemas.transforms">TypedSchemaTransformProvider</a>&lt;ConfigT&gt;</td>
<td class="colLast">
<div class="block">Like <a href="../../../../../../org/apache/beam/sdk/schemas/transforms/SchemaTransformProvider.html" title="interface in org.apache.beam.sdk.schemas.transforms"><code>SchemaTransformProvider</code></a> except uses a configuration object instead of Schema and
Row.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.beam.sdk.schemas.transforms Description">Package org.apache.beam.sdk.schemas.transforms Description</h2>
<div class="block">Defines transforms that work on PCollections with schemas..
<p>For further details, see the documentation for each class in this package.</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/schemas/parser/generated/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/beam/sdk/schemas/utils/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/schemas/transforms/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>