blob: 844eddeb397dc28a7b5c3c55f0366db8b51b9655 [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.extensions.sbe (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.extensions.sbe (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/extensions/protobuf/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/beam/sdk/extensions/schemaio/expansion/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/extensions/sbe/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><a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a>(<a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html#value--">value</a>=<a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.Kind.html#EXTENSION">EXTENSION</a>)
</p>
<h1 title="Package" class="title">Package&nbsp;org.apache.beam.sdk.extensions.sbe</h1>
<div class="docSummary">
<div class="block">Extension for working with SBE messages in Beam.</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="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/extensions/sbe/SbeLogicalTypes.html" title="class in org.apache.beam.sdk.extensions.sbe">SbeLogicalTypes</a></td>
<td class="colLast">
<div class="block">Classes that represent various SBE semantic types.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/SbeLogicalTypes.LocalMktDate.html" title="class in org.apache.beam.sdk.extensions.sbe">SbeLogicalTypes.LocalMktDate</a></td>
<td class="colLast">
<div class="block">Representation of SBE's LocalMktDate.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/SbeLogicalTypes.TZTimeOnly.html" title="class in org.apache.beam.sdk.extensions.sbe">SbeLogicalTypes.TZTimeOnly</a></td>
<td class="colLast">
<div class="block">Represents SBE's TimeOnly composite type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/SbeLogicalTypes.TZTimestamp.html" title="class in org.apache.beam.sdk.extensions.sbe">SbeLogicalTypes.TZTimestamp</a></td>
<td class="colLast">
<div class="block">Represents SBE's TZTimestamp composite type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/SbeLogicalTypes.Uint16.html" title="class in org.apache.beam.sdk.extensions.sbe">SbeLogicalTypes.Uint16</a></td>
<td class="colLast">
<div class="block">Represents SBE's uint16 type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/SbeLogicalTypes.Uint32.html" title="class in org.apache.beam.sdk.extensions.sbe">SbeLogicalTypes.Uint32</a></td>
<td class="colLast">
<div class="block">Represents SBE's uint32 type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/SbeLogicalTypes.Uint64.html" title="class in org.apache.beam.sdk.extensions.sbe">SbeLogicalTypes.Uint64</a></td>
<td class="colLast">
<div class="block">Represents SBE's uint64 type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/SbeLogicalTypes.Uint8.html" title="class in org.apache.beam.sdk.extensions.sbe">SbeLogicalTypes.Uint8</a></td>
<td class="colLast">
<div class="block">Represents SBE's uint8 type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/SbeLogicalTypes.UTCDateOnly.html" title="class in org.apache.beam.sdk.extensions.sbe">SbeLogicalTypes.UTCDateOnly</a></td>
<td class="colLast">
<div class="block">Representation of SBE's UTCDateOnly.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/SbeLogicalTypes.UTCTimeOnly.html" title="class in org.apache.beam.sdk.extensions.sbe">SbeLogicalTypes.UTCTimeOnly</a></td>
<td class="colLast">
<div class="block">Represents SBE's UTCTimeOnly composite type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/SbeLogicalTypes.UTCTimestamp.html" title="class in org.apache.beam.sdk.extensions.sbe">SbeLogicalTypes.UTCTimestamp</a></td>
<td class="colLast">
<div class="block">Represents SBE's UTCTimestamp composite type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/SbeSchema.html" title="class in org.apache.beam.sdk.extensions.sbe">SbeSchema</a></td>
<td class="colLast">
<div class="block">Represents an SBE schema.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/SbeSchema.IrOptions.html" title="class in org.apache.beam.sdk.extensions.sbe">SbeSchema.IrOptions</a></td>
<td class="colLast">
<div class="block">Options for configuring schema generation from an <a href="https://static.javadoc.io/uk.co.real-logic/sbe-tool/1.25.1/uk/co/real_logic/sbe/ir/Ir.html?is-external=true" title="class or interface in uk.co.real_logic.sbe.ir"><code>Ir</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/SbeSchema.IrOptions.Builder.html" title="class in org.apache.beam.sdk.extensions.sbe">SbeSchema.IrOptions.Builder</a></td>
<td class="colLast">
<div class="block">Builder for <a href="../../../../../../org/apache/beam/sdk/extensions/sbe/SbeSchema.IrOptions.html" title="class in org.apache.beam.sdk.extensions.sbe"><code>SbeSchema.IrOptions</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/SerializableIr.html" title="class in org.apache.beam.sdk.extensions.sbe">SerializableIr</a></td>
<td class="colLast">
<div class="block">A wrapper around <a href="https://static.javadoc.io/uk.co.real-logic/sbe-tool/1.25.1/uk/co/real_logic/sbe/ir/Ir.html?is-external=true" title="class or interface in uk.co.real_logic.sbe.ir"><code>Ir</code></a> that fulfils Java's <code>Serializable</code> contract.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.html" title="class in org.apache.beam.sdk.extensions.sbe">UnsignedOptions</a></td>
<td class="colLast">
<div class="block">Options for controlling what to do with unsigned types, specifically whether to use a higher bit
count or, in the case of uint64, a string.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.Builder.html" title="class in org.apache.beam.sdk.extensions.sbe">UnsignedOptions.Builder</a></td>
<td class="colLast">
<div class="block">Builder for <a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.html" title="class in org.apache.beam.sdk.extensions.sbe"><code>UnsignedOptions</code></a>.</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/extensions/sbe/UnsignedOptions.Behavior.html" title="enum in org.apache.beam.sdk.extensions.sbe">UnsignedOptions.Behavior</a></td>
<td class="colLast">
<div class="block">Defines the exact behavior for unsigned types.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.beam.sdk.extensions.sbe Description">Package org.apache.beam.sdk.extensions.sbe Description</h2>
<div class="block">Extension for working with SBE messages in Beam.</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/extensions/protobuf/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/beam/sdk/extensions/schemaio/expansion/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/extensions/sbe/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>