Google Git
Sign in
apache / beam-site / refs/heads/updates_release_2.53.0 / . / javadoc / 2.53.0 / org / apache / beam / sdk / extensions / sbe / UnsignedOptions.html
blob: fedca61c96d31dade5eb4443b069b5ac7ce13268 [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>
<!-- GitHub action javadoc-cleanup -->
<link rel="canonical" href="https://beam.apache.org/releases/javadoc/current/org/apache/beam/sdk/extensions/sbe/UnsignedOptions.html">
<meta name="viewport" content="width=device-width, initial-scale=1">
<!-- End javadoc-cleanup block -->
<!-- Generated by javadoc -->
<title>UnsignedOptions (Apache Beam 2.53.0)</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="UnsignedOptions (Apache Beam 2.53.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":9,"i7":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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/sbe/SerializableIr.html" title="class in org.apache.beam.sdk.extensions.sbe"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.Behavior.html" title="enum in org.apache.beam.sdk.extensions.sbe"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/extensions/sbe/UnsignedOptions.html" target="_top">Frames</a></li>
<li><a href="UnsignedOptions.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.beam.sdk.extensions.sbe</div>
<h2 title="Class UnsignedOptions" class="title">Class UnsignedOptions</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.extensions.sbe.UnsignedOptions</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">UnsignedOptions</span>
extends java.lang.Object
implements java.io.Serializable</pre>
<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>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../serialized-form.html#org.apache.beam.sdk.extensions.sbe.UnsignedOptions">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.Behavior.html" title="enum in org.apache.beam.sdk.extensions.sbe">UnsignedOptions.Behavior</a></span></code>
<div class="block">Defines the exact behavior for unsigned types.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.Builder.html" title="class in org.apache.beam.sdk.extensions.sbe">UnsignedOptions.Builder</a></span></code>
<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>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.html#UnsignedOptions--">UnsignedOptions</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.Builder.html" title="class in org.apache.beam.sdk.extensions.sbe">UnsignedOptions.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.html#builder--">builder</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.Builder.html" title="class in org.apache.beam.sdk.extensions.sbe">UnsignedOptions.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.html#toBuilder--">toBuilder</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>abstract <a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.Behavior.html" title="enum in org.apache.beam.sdk.extensions.sbe">UnsignedOptions.Behavior</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.html#uint16Behavior--">uint16Behavior</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.Behavior.html" title="enum in org.apache.beam.sdk.extensions.sbe">UnsignedOptions.Behavior</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.html#uint32Behavior--">uint32Behavior</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>abstract <a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.Behavior.html" title="enum in org.apache.beam.sdk.extensions.sbe">UnsignedOptions.Behavior</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.html#uint64Behavior--">uint64Behavior</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.Behavior.html" title="enum in org.apache.beam.sdk.extensions.sbe">UnsignedOptions.Behavior</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.html#uint8Behavior--">uint8Behavior</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.html" title="class in org.apache.beam.sdk.extensions.sbe">UnsignedOptions</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.html#usingHigherBitSize-org.apache.beam.sdk.extensions.sbe.UnsignedOptions.Behavior-">usingHigherBitSize</a></span>(<a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.Behavior.html" title="enum in org.apache.beam.sdk.extensions.sbe">UnsignedOptions.Behavior</a>&nbsp;uint64Behavior)</code>
<div class="block">Returns options for using a higher bit count for unsigned types.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.html" title="class in org.apache.beam.sdk.extensions.sbe">UnsignedOptions</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.html#usingSameBitSize--">usingSameBitSize</a></span>()</code>
<div class="block">Returns options for using the same bit size for all unsigned types.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="UnsignedOptions--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>UnsignedOptions</h4>
<pre>public&nbsp;UnsignedOptions()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="uint8Behavior--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>uint8Behavior</h4>
<pre>public abstract&nbsp;<a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.Behavior.html" title="enum in org.apache.beam.sdk.extensions.sbe">UnsignedOptions.Behavior</a>&nbsp;uint8Behavior()</pre>
</li>
</ul>
<a name="uint16Behavior--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>uint16Behavior</h4>
<pre>public abstract&nbsp;<a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.Behavior.html" title="enum in org.apache.beam.sdk.extensions.sbe">UnsignedOptions.Behavior</a>&nbsp;uint16Behavior()</pre>
</li>
</ul>
<a name="uint32Behavior--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>uint32Behavior</h4>
<pre>public abstract&nbsp;<a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.Behavior.html" title="enum in org.apache.beam.sdk.extensions.sbe">UnsignedOptions.Behavior</a>&nbsp;uint32Behavior()</pre>
</li>
</ul>
<a name="uint64Behavior--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>uint64Behavior</h4>
<pre>public abstract&nbsp;<a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.Behavior.html" title="enum in org.apache.beam.sdk.extensions.sbe">UnsignedOptions.Behavior</a>&nbsp;uint64Behavior()</pre>
</li>
</ul>
<a name="usingSameBitSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>usingSameBitSize</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.html" title="class in org.apache.beam.sdk.extensions.sbe">UnsignedOptions</a>&nbsp;usingSameBitSize()</pre>
<div class="block">Returns options for using the same bit size for all unsigned types.
<p>This means that if an unsigned value from SBE comes in with a value outside the signed
range, then the negative equivalent (in terms of bits) will be used.</div>
</li>
</ul>
<a name="usingHigherBitSize-org.apache.beam.sdk.extensions.sbe.UnsignedOptions.Behavior-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>usingHigherBitSize</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.html" title="class in org.apache.beam.sdk.extensions.sbe">UnsignedOptions</a>&nbsp;usingHigherBitSize(<a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.Behavior.html" title="enum in org.apache.beam.sdk.extensions.sbe">UnsignedOptions.Behavior</a>&nbsp;uint64Behavior)</pre>
<div class="block">Returns options for using a higher bit count for unsigned types.
<p>This means that if an unsigned value is encountered, it will always use the higher bit
count, even if that higher bit count is unnecessary. However, this means that if it is
necessary, then the proper value will be returned rather than the negative equivalent (in terms
of bits).
<p>The <code>uint64Behavior</code> controls the behavior of 64-bit values, since no properly
higher-bit-numeric type exists. This cannot be <a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.Behavior.html#HIGHER_BIT_SIGNED"><code>UnsignedOptions.Behavior.HIGHER_BIT_SIGNED</code></a> or else an
exception will be thrown.</div>
</li>
</ul>
<a name="builder--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>builder</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.Builder.html" title="class in org.apache.beam.sdk.extensions.sbe">UnsignedOptions.Builder</a>&nbsp;builder()</pre>
</li>
</ul>
<a name="toBuilder--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toBuilder</h4>
<pre>public abstract&nbsp;<a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.Builder.html" title="class in org.apache.beam.sdk.extensions.sbe">UnsignedOptions.Builder</a>&nbsp;toBuilder()</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= 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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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/sbe/SerializableIr.html" title="class in org.apache.beam.sdk.extensions.sbe"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/UnsignedOptions.Behavior.html" title="enum in org.apache.beam.sdk.extensions.sbe"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/extensions/sbe/UnsignedOptions.html" target="_top">Frames</a></li>
<li><a href="UnsignedOptions.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>