blob: 03f78cafece84624cd043926109ed988e6af18dd [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.utils (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.utils (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/transforms/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/beam/sdk/state/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/schemas/utils/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.utils</h1>
<div class="docSummary">
<div class="block">Defines utilities for deailing 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/utils/ByteBuddyUtils.TypeConversionsFactory.html" title="interface in org.apache.beam.sdk.schemas.utils">ByteBuddyUtils.TypeConversionsFactory</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/utils/FieldValueTypeSupplier.html" title="interface in org.apache.beam.sdk.schemas.utils">FieldValueTypeSupplier</a></td>
<td class="colLast">
<div class="block">A naming policy for schema fields.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/utils/RowSelector.html" title="interface in org.apache.beam.sdk.schemas.utils">RowSelector</a></td>
<td class="colLast">
<div class="block">A selector interface for extracting fields from a row.</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/utils/AutoValueUtils.html" title="class in org.apache.beam.sdk.schemas.utils">AutoValueUtils</a></td>
<td class="colLast">
<div class="block">Utilities for managing AutoValue schemas.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/utils/AvroUtils.html" title="class in org.apache.beam.sdk.schemas.utils">AvroUtils</a></td>
<td class="colLast">
<div class="block">Utils to convert AVRO records to Beam rows.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/utils/AvroUtils.AvroConvertType.html" title="class in org.apache.beam.sdk.schemas.utils">AvroUtils.AvroConvertType</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/utils/AvroUtils.AvroConvertValueForGetter.html" title="class in org.apache.beam.sdk.schemas.utils">AvroUtils.AvroConvertValueForGetter</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/utils/AvroUtils.AvroConvertValueForSetter.html" title="class in org.apache.beam.sdk.schemas.utils">AvroUtils.AvroConvertValueForSetter</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/utils/AvroUtils.FixedBytesField.html" title="class in org.apache.beam.sdk.schemas.utils">AvroUtils.FixedBytesField</a></td>
<td class="colLast">
<div class="block">Wrapper for fixed byte fields.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/utils/ByteBuddyUtils.html" title="class in org.apache.beam.sdk.schemas.utils">ByteBuddyUtils</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/utils/ByteBuddyUtils.ConvertType.html" title="class in org.apache.beam.sdk.schemas.utils">ByteBuddyUtils.ConvertType</a></td>
<td class="colLast">
<div class="block">Give a Java type, returns the Java type expected for use with Row.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/utils/ByteBuddyUtils.ConvertValueForGetter.html" title="class in org.apache.beam.sdk.schemas.utils">ByteBuddyUtils.ConvertValueForGetter</a></td>
<td class="colLast">
<div class="block">Takes a <code>StackManipulation</code> that returns a value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/utils/ByteBuddyUtils.ConvertValueForSetter.html" title="class in org.apache.beam.sdk.schemas.utils">ByteBuddyUtils.ConvertValueForSetter</a></td>
<td class="colLast">
<div class="block">Row is going to call the setter with its internal Java type, however the user object being set
might have a different type internally.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/utils/ByteBuddyUtils.DefaultTypeConversionsFactory.html" title="class in org.apache.beam.sdk.schemas.utils">ByteBuddyUtils.DefaultTypeConversionsFactory</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/utils/ByteBuddyUtils.InjectPackageStrategy.html" title="class in org.apache.beam.sdk.schemas.utils">ByteBuddyUtils.InjectPackageStrategy</a></td>
<td class="colLast">
<div class="block">A naming strategy for ByteBuddy classes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/utils/ByteBuddyUtils.TransformingMap.html" title="class in org.apache.beam.sdk.schemas.utils">ByteBuddyUtils.TransformingMap</a>&lt;K1,V1,K2,V2&gt;</td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/utils/ByteBuddyUtils.TypeConversion.html" title="class in org.apache.beam.sdk.schemas.utils">ByteBuddyUtils.TypeConversion</a>&lt;T&gt;</td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/utils/ConvertHelpers.html" title="class in org.apache.beam.sdk.schemas.utils">ConvertHelpers</a></td>
<td class="colLast">
<div class="block">Helper functions for converting between equivalent schema types.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/utils/ConvertHelpers.ConvertedSchemaInformation.html" title="class in org.apache.beam.sdk.schemas.utils">ConvertHelpers.ConvertedSchemaInformation</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Return value after converting a schema.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/utils/JavaBeanUtils.html" title="class in org.apache.beam.sdk.schemas.utils">JavaBeanUtils</a></td>
<td class="colLast">
<div class="block">A set of utilities to generate getter and setter classes for JavaBean objects.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/utils/POJOUtils.html" title="class in org.apache.beam.sdk.schemas.utils">POJOUtils</a></td>
<td class="colLast">
<div class="block">A set of utilities to generate getter and setter classes for POJOs.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/utils/ReflectUtils.html" title="class in org.apache.beam.sdk.schemas.utils">ReflectUtils</a></td>
<td class="colLast">
<div class="block">A set of reflection helper methods.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/utils/ReflectUtils.ClassWithSchema.html" title="class in org.apache.beam.sdk.schemas.utils">ReflectUtils.ClassWithSchema</a></td>
<td class="colLast">
<div class="block">Represents a class and a schema.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/utils/SchemaZipFold.html" title="class in org.apache.beam.sdk.schemas.utils">SchemaZipFold</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Visitor that zips schemas, and accepts pairs of fields and their types.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/utils/SchemaZipFold.Context.html" title="class in org.apache.beam.sdk.schemas.utils">SchemaZipFold.Context</a></td>
<td class="colLast">
<div class="block">Context referring to a current position in a schema.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/utils/SelectHelpers.html" title="class in org.apache.beam.sdk.schemas.utils">SelectHelpers</a></td>
<td class="colLast">
<div class="block">Helper methods to select subrows out of rows.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/utils/SelectHelpers.RowSelectorContainer.html" title="class in org.apache.beam.sdk.schemas.utils">SelectHelpers.RowSelectorContainer</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/utils/StaticSchemaInference.html" title="class in org.apache.beam.sdk.schemas.utils">StaticSchemaInference</a></td>
<td class="colLast">
<div class="block">A set of utilities for inferring a Beam <a href="../../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas"><code>Schema</code></a> from static Java types.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.beam.sdk.schemas.utils Description">Package org.apache.beam.sdk.schemas.utils Description</h2>
<div class="block">Defines utilities for deailing 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/transforms/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/beam/sdk/state/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/schemas/utils/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>