| <!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 (1.8.0_181-google-v7) on Wed Aug 14 17:37:14 PDT 2019 --> |
| <title>FieldAccessDescriptor (Apache Beam 2.15.0-SNAPSHOT)</title> |
| <meta name="date" content="2019-08-14"> |
| <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="FieldAccessDescriptor (Apache Beam 2.15.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":10,"i2":10,"i3":6,"i4":6,"i5":6,"i6":6,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":9,"i13":9,"i14":9,"i15":9,"i16":9,"i17":9,"i18":9,"i19":10,"i20":10,"i21":10,"i22":10}; |
| 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/schemas/Factory.html" title="interface in org.apache.beam.sdk.schemas"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.FieldDescriptor.html" title="class in org.apache.beam.sdk.schemas"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" target="_top">Frames</a></li> |
| <li><a href="FieldAccessDescriptor.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.schemas</div> |
| <h2 title="Class FieldAccessDescriptor" class="title">Class FieldAccessDescriptor</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.schemas.FieldAccessDescriptor</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 abstract class <span class="typeNameLabel">FieldAccessDescriptor</span> |
| extends java.lang.Object |
| implements java.io.Serializable</pre> |
| <div class="block">Used inside of a <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a> to describe which fields in a schema |
| type need to be accessed for processing. |
| |
| <p>This class always puts the selected fields in a deterministic order.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../serialized-form.html#org.apache.beam.sdk.schemas.FieldAccessDescriptor">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/schemas/FieldAccessDescriptor.FieldDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor.FieldDescriptor</a></span></code> |
| <div class="block">Description of a single field.</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"> </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/schemas/FieldAccessDescriptor.html#FieldAccessDescriptor--">FieldAccessDescriptor</a></span>()</code> </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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html#create--">create</a></span>()</code> |
| <div class="block">Return an empty <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas"><code>FieldAccessDescriptor</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<java.lang.Integer></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html#fieldIdsAccessed--">fieldIdsAccessed</a></span>()</code> |
| <div class="block">Return the field ids accessed.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.util.Set<java.lang.String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html#fieldNamesAccessed--">fieldNamesAccessed</a></span>()</code> |
| <div class="block">Return the field names accessed.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>abstract boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html#getAllFields--">getAllFields</a></span>()</code> |
| <div class="block">If true, all fields are being accessed.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>abstract boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html#getFieldInsertionOrder--">getFieldInsertionOrder</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>abstract java.util.List<<a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.FieldDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor.FieldDescriptor</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html#getFieldsAccessed--">getFieldsAccessed</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>abstract java.util.Map<<a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.FieldDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor.FieldDescriptor</a>,<a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html#getNestedFieldsAccessed--">getNestedFieldsAccessed</a></span>()</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.Integer,<a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html#nestedFieldsById--">nestedFieldsById</a></span>()</code> |
| <div class="block">Return the nested fields keyed by field ids.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,<a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html#nestedFieldsByName--">nestedFieldsByName</a></span>()</code> |
| <div class="block">Return the nested fields keyed by field name.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html#referencesSingleField--">referencesSingleField</a></span>()</code> |
| <div class="block">Returns true if this descriptor references only a single, non-wildcard field.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html#resolve-org.apache.beam.sdk.schemas.Schema-">resolve</a></span>(<a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a> schema)</code> |
| <div class="block">Resolve the <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas"><code>FieldAccessDescriptor</code></a> against a schema.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html#toString--">toString</a></span>()</code> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html#withAllFields--">withAllFields</a></span>()</code> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html#withFieldIds-java.lang.Integer...-">withFieldIds</a></span>(java.lang.Integer... ids)</code> |
| <div class="block">Return a descriptor that access the specified fields.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html#withFieldIds-java.lang.Iterable-">withFieldIds</a></span>(java.lang.Iterable<java.lang.Integer> ids)</code> |
| <div class="block">Return a descriptor that access the specified fields.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html#withFieldNames-java.lang.Iterable-">withFieldNames</a></span>(java.lang.Iterable<java.lang.String> fieldNames)</code> |
| <div class="block">Return a descriptor that access the specified fields.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html#withFieldNames-java.lang.String...-">withFieldNames</a></span>(java.lang.String... names)</code> |
| <div class="block">Return a descriptor that access the specified fields.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html#withFields-org.apache.beam.sdk.schemas.FieldAccessDescriptor.FieldDescriptor...-">withFields</a></span>(<a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.FieldDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor.FieldDescriptor</a>... fields)</code> |
| <div class="block">Returns a <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas"><code>FieldAccessDescriptor</code></a> that accesses the specified fields.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html#withFields-java.lang.Iterable-">withFields</a></span>(java.lang.Iterable<<a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.FieldDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor.FieldDescriptor</a>> fields)</code> |
| <div class="block">Returns a <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas"><code>FieldAccessDescriptor</code></a> that accesses the specified fields.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html#withNestedField-org.apache.beam.sdk.schemas.FieldAccessDescriptor.FieldDescriptor-org.apache.beam.sdk.schemas.FieldAccessDescriptor-">withNestedField</a></span>(<a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.FieldDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor.FieldDescriptor</a> field, |
| <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a> fieldAccess)</code> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html#withNestedField-int-org.apache.beam.sdk.schemas.FieldAccessDescriptor-">withNestedField</a></span>(int nestedFieldId, |
| <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a> fieldAccess)</code> |
| <div class="block">Return a descriptor that access the specified nested field.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html#withNestedField-java.lang.String-org.apache.beam.sdk.schemas.FieldAccessDescriptor-">withNestedField</a></span>(java.lang.String nestedFieldName, |
| <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a> fieldAccess)</code> |
| <div class="block">Return a descriptor that access the specified nested field.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html#withOrderByFieldInsertionOrder--">withOrderByFieldInsertionOrder</a></span>()</code> |
| <div class="block">By default, fields are sorted by name.</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 java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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="FieldAccessDescriptor--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>FieldAccessDescriptor</h4> |
| <pre>public FieldAccessDescriptor()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getAllFields--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllFields</h4> |
| <pre>public abstract boolean getAllFields()</pre> |
| <div class="block">If true, all fields are being accessed.</div> |
| </li> |
| </ul> |
| <a name="getFieldsAccessed--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFieldsAccessed</h4> |
| <pre>public abstract java.util.List<<a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.FieldDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor.FieldDescriptor</a>> getFieldsAccessed()</pre> |
| </li> |
| </ul> |
| <a name="getNestedFieldsAccessed--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNestedFieldsAccessed</h4> |
| <pre>public abstract java.util.Map<<a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.FieldDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor.FieldDescriptor</a>,<a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a>> getNestedFieldsAccessed()</pre> |
| </li> |
| </ul> |
| <a name="getFieldInsertionOrder--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFieldInsertionOrder</h4> |
| <pre>public abstract boolean getFieldInsertionOrder()</pre> |
| </li> |
| </ul> |
| <a name="withAllFields--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withAllFields</h4> |
| <pre>public static <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a> withAllFields()</pre> |
| </li> |
| </ul> |
| <a name="withFieldNames-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withFieldNames</h4> |
| <pre>public static <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a> withFieldNames(java.lang.String... names)</pre> |
| <div class="block">Return a descriptor that access the specified fields. |
| |
| <p>By default, if the field is a nested row (or a container containing a row), all fields of |
| said rows are accessed. The syntax for a field name allows specifying nested fields and |
| wildcards, as specified in the file-level Javadoc. withNestedField can also be called to |
| specify recursive field access.</div> |
| </li> |
| </ul> |
| <a name="withFieldNames-java.lang.Iterable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withFieldNames</h4> |
| <pre>public static <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a> withFieldNames(java.lang.Iterable<java.lang.String> fieldNames)</pre> |
| <div class="block">Return a descriptor that access the specified fields. |
| |
| <p>By default, if the field is a nested row (or a container containing a row), all fields of |
| said rows are accessed. The syntax for a field name allows specifying nested fields and |
| wildcards, as specified in the file-level Javadoc. withNestedField can also be called to |
| specify recursive field access.</div> |
| </li> |
| </ul> |
| <a name="withFieldIds-java.lang.Integer...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withFieldIds</h4> |
| <pre>public static <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a> withFieldIds(java.lang.Integer... ids)</pre> |
| <div class="block">Return a descriptor that access the specified fields. |
| |
| <p>By default, if the field is a nested row (or a container containing a row), all fields of |
| said rows are accessed. For finer-grained acccess to nested rows, call withNestedField and pass |
| in a recursive <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas"><code>FieldAccessDescriptor</code></a>.</div> |
| </li> |
| </ul> |
| <a name="withFieldIds-java.lang.Iterable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withFieldIds</h4> |
| <pre>public static <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a> withFieldIds(java.lang.Iterable<java.lang.Integer> ids)</pre> |
| <div class="block">Return a descriptor that access the specified fields. |
| |
| <p>By default, if the field is a nested row (or a container containing a row), all fields of |
| said rows are accessed. For finer-grained acccess to nested rows, call withNestedField and pass |
| in a recursive <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas"><code>FieldAccessDescriptor</code></a>.</div> |
| </li> |
| </ul> |
| <a name="withFields-org.apache.beam.sdk.schemas.FieldAccessDescriptor.FieldDescriptor...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withFields</h4> |
| <pre>public static <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a> withFields(<a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.FieldDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor.FieldDescriptor</a>... fields)</pre> |
| <div class="block">Returns a <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas"><code>FieldAccessDescriptor</code></a> that accesses the specified fields.</div> |
| </li> |
| </ul> |
| <a name="withFields-java.lang.Iterable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withFields</h4> |
| <pre>public static <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a> withFields(java.lang.Iterable<<a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.FieldDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor.FieldDescriptor</a>> fields)</pre> |
| <div class="block">Returns a <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas"><code>FieldAccessDescriptor</code></a> that accesses the specified fields.</div> |
| </li> |
| </ul> |
| <a name="create--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>public static <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a> create()</pre> |
| <div class="block">Return an empty <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas"><code>FieldAccessDescriptor</code></a>.</div> |
| </li> |
| </ul> |
| <a name="withNestedField-int-org.apache.beam.sdk.schemas.FieldAccessDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withNestedField</h4> |
| <pre>public <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a> withNestedField(int nestedFieldId, |
| <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a> fieldAccess)</pre> |
| <div class="block">Return a descriptor that access the specified nested field. The nested field must be of type |
| <a href="../../../../../org/apache/beam/sdk/schemas/Schema.TypeName.html#ROW"><code>Schema.TypeName.ROW</code></a>, and the fieldAccess argument specifies what fields of the nested |
| type will be accessed.</div> |
| </li> |
| </ul> |
| <a name="withNestedField-java.lang.String-org.apache.beam.sdk.schemas.FieldAccessDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withNestedField</h4> |
| <pre>public <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a> withNestedField(java.lang.String nestedFieldName, |
| <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a> fieldAccess)</pre> |
| <div class="block">Return a descriptor that access the specified nested field. The nested field must be of type |
| <a href="../../../../../org/apache/beam/sdk/schemas/Schema.TypeName.html#ROW"><code>Schema.TypeName.ROW</code></a>, and the fieldAccess argument specifies what fields of the nested |
| type will be accessed.</div> |
| </li> |
| </ul> |
| <a name="withNestedField-org.apache.beam.sdk.schemas.FieldAccessDescriptor.FieldDescriptor-org.apache.beam.sdk.schemas.FieldAccessDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withNestedField</h4> |
| <pre>public <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a> withNestedField(<a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.FieldDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor.FieldDescriptor</a> field, |
| <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a> fieldAccess)</pre> |
| </li> |
| </ul> |
| <a name="withOrderByFieldInsertionOrder--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withOrderByFieldInsertionOrder</h4> |
| <pre>public <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a> withOrderByFieldInsertionOrder()</pre> |
| <div class="block">By default, fields are sorted by name. If this is set, they will instead be sorted by insertion |
| order. All sorting happens in the <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html#resolve-org.apache.beam.sdk.schemas.Schema-"><code>resolve(Schema)</code></a> method.</div> |
| </li> |
| </ul> |
| <a name="fieldIdsAccessed--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fieldIdsAccessed</h4> |
| <pre>public java.util.List<java.lang.Integer> fieldIdsAccessed()</pre> |
| <div class="block">Return the field ids accessed. Should not be called until after <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html#resolve-org.apache.beam.sdk.schemas.Schema-"><code>resolve(org.apache.beam.sdk.schemas.Schema)</code></a> is called. |
| Iteration order is consistent with <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html#getFieldsAccessed--"><code>getFieldsAccessed()</code></a>.</div> |
| </li> |
| </ul> |
| <a name="fieldNamesAccessed--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fieldNamesAccessed</h4> |
| <pre>public java.util.Set<java.lang.String> fieldNamesAccessed()</pre> |
| <div class="block">Return the field names accessed. Should not be called until after <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html#resolve-org.apache.beam.sdk.schemas.Schema-"><code>resolve(org.apache.beam.sdk.schemas.Schema)</code></a> is called.</div> |
| </li> |
| </ul> |
| <a name="nestedFieldsById--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nestedFieldsById</h4> |
| <pre>public java.util.Map<java.lang.Integer,<a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a>> nestedFieldsById()</pre> |
| <div class="block">Return the nested fields keyed by field ids. Should not be called until after <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html#resolve-org.apache.beam.sdk.schemas.Schema-"><code>resolve(org.apache.beam.sdk.schemas.Schema)</code></a> |
| is called.</div> |
| </li> |
| </ul> |
| <a name="nestedFieldsByName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nestedFieldsByName</h4> |
| <pre>public java.util.Map<java.lang.String,<a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a>> nestedFieldsByName()</pre> |
| <div class="block">Return the nested fields keyed by field name. Should not be called until after <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html#resolve-org.apache.beam.sdk.schemas.Schema-"><code>resolve(org.apache.beam.sdk.schemas.Schema)</code></a> |
| is called.</div> |
| </li> |
| </ul> |
| <a name="referencesSingleField--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>referencesSingleField</h4> |
| <pre>public boolean referencesSingleField()</pre> |
| <div class="block">Returns true if this descriptor references only a single, non-wildcard field.</div> |
| </li> |
| </ul> |
| <a name="resolve-org.apache.beam.sdk.schemas.Schema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolve</h4> |
| <pre>public <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a> resolve(<a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a> schema)</pre> |
| <div class="block">Resolve the <a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas"><code>FieldAccessDescriptor</code></a> against a schema. |
| |
| <p>Resolve will resolve all of the field names into field ids, validating that all field names |
| specified in the descriptor exist in the actual schema.</div> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public java.lang.String toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>toString</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </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/schemas/Factory.html" title="interface in org.apache.beam.sdk.schemas"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.FieldDescriptor.html" title="class in org.apache.beam.sdk.schemas"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" target="_top">Frames</a></li> |
| <li><a href="FieldAccessDescriptor.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |