| <!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>SbeSchema (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="SbeSchema (Apache Beam 2.38.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":10,"i2":10,"i3":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance 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/SbeLogicalTypes.UTCTimestamp.html" title="class in org.apache.beam.sdk.extensions.sbe"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/SbeSchema.IrOptions.html" title="class in org.apache.beam.sdk.extensions.sbe"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/extensions/sbe/SbeSchema.html" target="_top">Frames</a></li> |
| <li><a href="SbeSchema.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 SbeSchema" class="title">Class SbeSchema</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.extensions.sbe.SbeSchema</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><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#SCHEMAS">SCHEMAS</a>) |
| public final class <span class="typeNameLabel">SbeSchema</span> |
| extends java.lang.Object |
| implements java.io.Serializable</pre> |
| <div class="block">Represents an SBE schema. |
| |
| <p>The schema represents a single SBE message. If the XML schema contains more than one message, |
| then a new instance must be created for each message that the pipeline will work with. |
| |
| <p>The currently supported ways of generating a schema are: |
| |
| <ul> |
| <li>Through an intermediate representation (<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>). |
| </ul> |
| |
| <h3>Intermediate Representation</h3> |
| |
| <p>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> allows for a reflection-less way of getting a very accurate representation of |
| the SBE schema, since it is a tokenized form of the original XML schema. To help deal with some |
| ambiguities, such as which message to base the schema around, passing <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> is |
| required.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../serialized-form.html#org.apache.beam.sdk.extensions.sbe.SbeSchema">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"> </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 </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/SbeSchema.IrOptions.html" title="class in org.apache.beam.sdk.extensions.sbe">SbeSchema.IrOptions</a></span></code> |
| <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> |
| </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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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/SbeSchema.html" title="class in org.apache.beam.sdk.extensions.sbe">SbeSchema</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/SbeSchema.html#fromIr-uk.co.real_logic.sbe.ir.Ir-org.apache.beam.sdk.extensions.sbe.SbeSchema.IrOptions-">fromIr</a></span>(<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">Ir</a> ir, |
| <a href="../../../../../../org/apache/beam/sdk/extensions/sbe/SbeSchema.IrOptions.html" title="class in org.apache.beam.sdk.extensions.sbe">SbeSchema.IrOptions</a> irOptions)</code> |
| <div class="block">Creates a new <a href="../../../../../../org/apache/beam/sdk/extensions/sbe/SbeSchema.html" title="class in org.apache.beam.sdk.extensions.sbe"><code>SbeSchema</code></a> from the given intermediate representation.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.10.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> <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">Ir</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/SbeSchema.html#getIr--">getIr</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.10.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> <a href="../../../../../../org/apache/beam/sdk/extensions/sbe/SbeSchema.IrOptions.html" title="class in org.apache.beam.sdk.extensions.sbe">SbeSchema.IrOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/SbeSchema.html#getIrOptions--">getIrOptions</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>org.apache.beam.vendor.guava.v26_0_jre.com.google.common.collect.ImmutableList<org.apache.beam.sdk.extensions.sbe.SbeField></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/SbeSchema.html#getSbeFields--">getSbeFields</a></span>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="fromIr-uk.co.real_logic.sbe.ir.Ir-org.apache.beam.sdk.extensions.sbe.SbeSchema.IrOptions-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fromIr</h4> |
| <pre>public static <a href="../../../../../../org/apache/beam/sdk/extensions/sbe/SbeSchema.html" title="class in org.apache.beam.sdk.extensions.sbe">SbeSchema</a> fromIr(<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">Ir</a> ir, |
| <a href="../../../../../../org/apache/beam/sdk/extensions/sbe/SbeSchema.IrOptions.html" title="class in org.apache.beam.sdk.extensions.sbe">SbeSchema.IrOptions</a> irOptions)</pre> |
| <div class="block">Creates a new <a href="../../../../../../org/apache/beam/sdk/extensions/sbe/SbeSchema.html" title="class in org.apache.beam.sdk.extensions.sbe"><code>SbeSchema</code></a> from the given intermediate representation. |
| |
| <p>This makes no guarantees about the state of the returned instance. That is, it may or may |
| not have the generated SBE schema representation, and it may or may not have translated the SBE |
| schema into a Beam schema.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ir</code> - the intermediate representation of the SBE schema. Modifications to the passed-in |
| value will not be reflected in the returned instance.</dd> |
| <dd><code>irOptions</code> - options for configuring how to deal with cases where the desired behavior is |
| ambiguous.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new <a href="../../../../../../org/apache/beam/sdk/extensions/sbe/SbeSchema.html" title="class in org.apache.beam.sdk.extensions.sbe"><code>SbeSchema</code></a> instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getIr--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIr</h4> |
| <pre>public <a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.10.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> <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">Ir</a> getIr()</pre> |
| </li> |
| </ul> |
| <a name="getIrOptions--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIrOptions</h4> |
| <pre>public <a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.10.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> <a href="../../../../../../org/apache/beam/sdk/extensions/sbe/SbeSchema.IrOptions.html" title="class in org.apache.beam.sdk.extensions.sbe">SbeSchema.IrOptions</a> getIrOptions()</pre> |
| </li> |
| </ul> |
| <a name="getSbeFields--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getSbeFields</h4> |
| <pre>public org.apache.beam.vendor.guava.v26_0_jre.com.google.common.collect.ImmutableList<org.apache.beam.sdk.extensions.sbe.SbeField> getSbeFields()</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/SbeLogicalTypes.UTCTimestamp.html" title="class in org.apache.beam.sdk.extensions.sbe"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/extensions/sbe/SbeSchema.IrOptions.html" title="class in org.apache.beam.sdk.extensions.sbe"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/extensions/sbe/SbeSchema.html" target="_top">Frames</a></li> |
| <li><a href="SbeSchema.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
