blob: 0bbd5cc9061e11c99c8a3e06087ee56b31f7ca87 [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.logicaltypes (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.logicaltypes (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/io/payloads/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/beam/sdk/schemas/parser/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/schemas/logicaltypes/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.logicaltypes</h1>
<div class="docSummary">
<div class="block">A set of common LogicalTypes for use 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="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/logicaltypes/Date.html" title="class in org.apache.beam.sdk.schemas.logicaltypes">Date</a></td>
<td class="colLast">
<div class="block">A date without a time-zone.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/logicaltypes/DateTime.html" title="class in org.apache.beam.sdk.schemas.logicaltypes">DateTime</a></td>
<td class="colLast">
<div class="block">A datetime without a time-zone.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/logicaltypes/EnumerationType.html" title="class in org.apache.beam.sdk.schemas.logicaltypes">EnumerationType</a></td>
<td class="colLast">
<div class="block">This <a href="../../../../../../org/apache/beam/sdk/schemas/Schema.LogicalType.html" title="interface in org.apache.beam.sdk.schemas"><code>Schema.LogicalType</code></a> represent an enumeration over a fixed set of values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/logicaltypes/EnumerationType.Value.html" title="class in org.apache.beam.sdk.schemas.logicaltypes">EnumerationType.Value</a></td>
<td class="colLast">
<div class="block">This class represents a single enum value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/logicaltypes/FixedBytes.html" title="class in org.apache.beam.sdk.schemas.logicaltypes">FixedBytes</a></td>
<td class="colLast">
<div class="block">A LogicalType representing a fixed-size byte array.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/logicaltypes/MicrosInstant.html" title="class in org.apache.beam.sdk.schemas.logicaltypes">MicrosInstant</a></td>
<td class="colLast">
<div class="block">A timestamp represented as microseconds since the epoch.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/logicaltypes/NanosDuration.html" title="class in org.apache.beam.sdk.schemas.logicaltypes">NanosDuration</a></td>
<td class="colLast">
<div class="block">A duration represented in nanoseconds.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/logicaltypes/NanosInstant.html" title="class in org.apache.beam.sdk.schemas.logicaltypes">NanosInstant</a></td>
<td class="colLast">
<div class="block">A timestamp represented as nanoseconds since the epoch.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/logicaltypes/OneOfType.html" title="class in org.apache.beam.sdk.schemas.logicaltypes">OneOfType</a></td>
<td class="colLast">
<div class="block">A logical type representing a union of fields.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/logicaltypes/OneOfType.Value.html" title="class in org.apache.beam.sdk.schemas.logicaltypes">OneOfType.Value</a></td>
<td class="colLast">
<div class="block">Represents a single OneOf value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/logicaltypes/PassThroughLogicalType.html" title="class in org.apache.beam.sdk.schemas.logicaltypes">PassThroughLogicalType</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A base class for LogicalTypes that use the same Java type as the underlying base type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/logicaltypes/SchemaLogicalType.html" title="class in org.apache.beam.sdk.schemas.logicaltypes">SchemaLogicalType</a></td>
<td class="colLast">
<div class="block">A schema represented as a serialized proto bytes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/logicaltypes/SqlTypes.html" title="class in org.apache.beam.sdk.schemas.logicaltypes">SqlTypes</a></td>
<td class="colLast">
<div class="block">Beam <a href="../../../../../../org/apache/beam/sdk/schemas/Schema.LogicalType.html" title="interface in org.apache.beam.sdk.schemas"><code>Schema.LogicalType</code></a>s corresponding to SQL data types.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/logicaltypes/Time.html" title="class in org.apache.beam.sdk.schemas.logicaltypes">Time</a></td>
<td class="colLast">
<div class="block">A time without a time-zone.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/logicaltypes/UnknownLogicalType.html" title="class in org.apache.beam.sdk.schemas.logicaltypes">UnknownLogicalType</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A base class for logical types that are not understood by the Java SDK.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/logicaltypes/UuidLogicalType.html" title="class in org.apache.beam.sdk.schemas.logicaltypes">UuidLogicalType</a></td>
<td class="colLast">
<div class="block">Base class for types representing UUID as two long values.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.beam.sdk.schemas.logicaltypes Description">Package org.apache.beam.sdk.schemas.logicaltypes Description</h2>
<div class="block">A set of common LogicalTypes for use 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/io/payloads/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/beam/sdk/schemas/parser/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/schemas/logicaltypes/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>