| <!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 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Flight.FlightInfoOrBuilder (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)</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="Flight.FlightInfoOrBuilder (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="class-use/Flight.FlightInfoOrBuilder.html">Use</a></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/arrow/flight/impl/Flight.FlightInfo.Builder.html" title="class in org.apache.arrow.flight.impl"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/arrow/flight/impl/Flight.GetSessionOptionsRequest.html" title="class in org.apache.arrow.flight.impl"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/arrow/flight/impl/Flight.FlightInfoOrBuilder.html" target="_top">Frames</a></li> |
| <li><a href="Flight.FlightInfoOrBuilder.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>Nested | </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.arrow.flight.impl</div> |
| <h2 title="Interface Flight.FlightInfoOrBuilder" class="title">Interface Flight.FlightInfoOrBuilder</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd>com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder</dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightInfo.html" title="class in org.apache.arrow.flight.impl">Flight.FlightInfo</a>, <a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightInfo.Builder.html" title="class in org.apache.arrow.flight.impl">Flight.FlightInfo.Builder</a></dd> |
| </dl> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../../org/apache/arrow/flight/impl/Flight.html" title="class in org.apache.arrow.flight.impl">Flight</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static interface <span class="typeNameLabel">Flight.FlightInfoOrBuilder</span> |
| extends com.google.protobuf.MessageOrBuilder</pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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="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></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>com.google.protobuf.ByteString</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightInfoOrBuilder.html#getAppMetadata--">getAppMetadata</a></span>()</code> |
| <div class="block"> |
| |
| Application-defined metadata.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightEndpoint.html" title="class in org.apache.arrow.flight.impl">Flight.FlightEndpoint</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightInfoOrBuilder.html#getEndpoint-int-">getEndpoint</a></span>(int index)</code> |
| <div class="block"> |
| |
| A list of endpoints associated with the flight.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightInfoOrBuilder.html#getEndpointCount--">getEndpointCount</a></span>()</code> |
| <div class="block"> |
| |
| A list of endpoints associated with the flight.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightEndpoint.html" title="class in org.apache.arrow.flight.impl">Flight.FlightEndpoint</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightInfoOrBuilder.html#getEndpointList--">getEndpointList</a></span>()</code> |
| <div class="block"> |
| |
| A list of endpoints associated with the flight.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightEndpointOrBuilder.html" title="interface in org.apache.arrow.flight.impl">Flight.FlightEndpointOrBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightInfoOrBuilder.html#getEndpointOrBuilder-int-">getEndpointOrBuilder</a></span>(int index)</code> |
| <div class="block"> |
| |
| A list of endpoints associated with the flight.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><? extends <a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightEndpointOrBuilder.html" title="interface in org.apache.arrow.flight.impl">Flight.FlightEndpointOrBuilder</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightInfoOrBuilder.html#getEndpointOrBuilderList--">getEndpointOrBuilderList</a></span>()</code> |
| <div class="block"> |
| |
| A list of endpoints associated with the flight.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightDescriptor.html" title="class in org.apache.arrow.flight.impl">Flight.FlightDescriptor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightInfoOrBuilder.html#getFlightDescriptor--">getFlightDescriptor</a></span>()</code> |
| <div class="block"> |
| |
| The descriptor associated with this info.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightDescriptorOrBuilder.html" title="interface in org.apache.arrow.flight.impl">Flight.FlightDescriptorOrBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightInfoOrBuilder.html#getFlightDescriptorOrBuilder--">getFlightDescriptorOrBuilder</a></span>()</code> |
| <div class="block"> |
| |
| The descriptor associated with this info.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightInfoOrBuilder.html#getOrdered--">getOrdered</a></span>()</code> |
| <div class="block"> |
| |
| FlightEndpoints are in the same order as the data.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>com.google.protobuf.ByteString</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightInfoOrBuilder.html#getSchema--">getSchema</a></span>()</code> |
| <div class="block"> |
| The schema of the dataset in its IPC form: |
| 4 bytes - an optional IPC_CONTINUATION_TOKEN prefix |
| 4 bytes - the byte length of the payload |
| a flatbuffer Message whose header is the Schema</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightInfoOrBuilder.html#getTotalBytes--">getTotalBytes</a></span>()</code> |
| <div class="block"><code>int64 total_bytes = 5;</code></div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightInfoOrBuilder.html#getTotalRecords--">getTotalRecords</a></span>()</code> |
| <div class="block"> |
| Set these to -1 if unknown.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightInfoOrBuilder.html#hasFlightDescriptor--">hasFlightDescriptor</a></span>()</code> |
| <div class="block"> |
| |
| The descriptor associated with this info.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.com.google.protobuf.MessageOrBuilder"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface com.google.protobuf.MessageOrBuilder</h3> |
| <code>findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.com.google.protobuf.MessageLiteOrBuilder"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder</h3> |
| <code>isInitialized</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="getSchema--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchema</h4> |
| <pre>com.google.protobuf.ByteString getSchema()</pre> |
| <div class="block"><pre> |
| The schema of the dataset in its IPC form: |
| 4 bytes - an optional IPC_CONTINUATION_TOKEN prefix |
| 4 bytes - the byte length of the payload |
| a flatbuffer Message whose header is the Schema |
| </pre> |
| |
| <code>bytes schema = 1;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The schema.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasFlightDescriptor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasFlightDescriptor</h4> |
| <pre>boolean hasFlightDescriptor()</pre> |
| <div class="block"><pre> |
| |
| The descriptor associated with this info. |
| </pre> |
| |
| <code>.arrow.flight.protocol.FlightDescriptor flight_descriptor = 2;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Whether the flightDescriptor field is set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFlightDescriptor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFlightDescriptor</h4> |
| <pre><a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightDescriptor.html" title="class in org.apache.arrow.flight.impl">Flight.FlightDescriptor</a> getFlightDescriptor()</pre> |
| <div class="block"><pre> |
| |
| The descriptor associated with this info. |
| </pre> |
| |
| <code>.arrow.flight.protocol.FlightDescriptor flight_descriptor = 2;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The flightDescriptor.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFlightDescriptorOrBuilder--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFlightDescriptorOrBuilder</h4> |
| <pre><a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightDescriptorOrBuilder.html" title="interface in org.apache.arrow.flight.impl">Flight.FlightDescriptorOrBuilder</a> getFlightDescriptorOrBuilder()</pre> |
| <div class="block"><pre> |
| |
| The descriptor associated with this info. |
| </pre> |
| |
| <code>.arrow.flight.protocol.FlightDescriptor flight_descriptor = 2;</code></div> |
| </li> |
| </ul> |
| <a name="getEndpointList--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEndpointList</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightEndpoint.html" title="class in org.apache.arrow.flight.impl">Flight.FlightEndpoint</a>> getEndpointList()</pre> |
| <div class="block"><pre> |
| |
| A list of endpoints associated with the flight. To consume the |
| whole flight, all endpoints (and hence all Tickets) must be |
| consumed. Endpoints can be consumed in any order. |
| |
| In other words, an application can use multiple endpoints to |
| represent partitioned data. |
| |
| If the returned data has an ordering, an application can use |
| "FlightInfo.ordered = true" or should return the all data in a |
| single endpoint. Otherwise, there is no ordering defined on |
| endpoints or the data within. |
| |
| A client can read ordered data by reading data from returned |
| endpoints, in order, from front to back. |
| |
| Note that a client may ignore "FlightInfo.ordered = true". If an |
| ordering is important for an application, an application must |
| choose one of them: |
| |
| * An application requires that all clients must read data in |
| returned endpoints order. |
| * An application must return the all data in a single endpoint. |
| </pre> |
| |
| <code>repeated .arrow.flight.protocol.FlightEndpoint endpoint = 3;</code></div> |
| </li> |
| </ul> |
| <a name="getEndpoint-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEndpoint</h4> |
| <pre><a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightEndpoint.html" title="class in org.apache.arrow.flight.impl">Flight.FlightEndpoint</a> getEndpoint(int index)</pre> |
| <div class="block"><pre> |
| |
| A list of endpoints associated with the flight. To consume the |
| whole flight, all endpoints (and hence all Tickets) must be |
| consumed. Endpoints can be consumed in any order. |
| |
| In other words, an application can use multiple endpoints to |
| represent partitioned data. |
| |
| If the returned data has an ordering, an application can use |
| "FlightInfo.ordered = true" or should return the all data in a |
| single endpoint. Otherwise, there is no ordering defined on |
| endpoints or the data within. |
| |
| A client can read ordered data by reading data from returned |
| endpoints, in order, from front to back. |
| |
| Note that a client may ignore "FlightInfo.ordered = true". If an |
| ordering is important for an application, an application must |
| choose one of them: |
| |
| * An application requires that all clients must read data in |
| returned endpoints order. |
| * An application must return the all data in a single endpoint. |
| </pre> |
| |
| <code>repeated .arrow.flight.protocol.FlightEndpoint endpoint = 3;</code></div> |
| </li> |
| </ul> |
| <a name="getEndpointCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEndpointCount</h4> |
| <pre>int getEndpointCount()</pre> |
| <div class="block"><pre> |
| |
| A list of endpoints associated with the flight. To consume the |
| whole flight, all endpoints (and hence all Tickets) must be |
| consumed. Endpoints can be consumed in any order. |
| |
| In other words, an application can use multiple endpoints to |
| represent partitioned data. |
| |
| If the returned data has an ordering, an application can use |
| "FlightInfo.ordered = true" or should return the all data in a |
| single endpoint. Otherwise, there is no ordering defined on |
| endpoints or the data within. |
| |
| A client can read ordered data by reading data from returned |
| endpoints, in order, from front to back. |
| |
| Note that a client may ignore "FlightInfo.ordered = true". If an |
| ordering is important for an application, an application must |
| choose one of them: |
| |
| * An application requires that all clients must read data in |
| returned endpoints order. |
| * An application must return the all data in a single endpoint. |
| </pre> |
| |
| <code>repeated .arrow.flight.protocol.FlightEndpoint endpoint = 3;</code></div> |
| </li> |
| </ul> |
| <a name="getEndpointOrBuilderList--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEndpointOrBuilderList</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><? extends <a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightEndpointOrBuilder.html" title="interface in org.apache.arrow.flight.impl">Flight.FlightEndpointOrBuilder</a>> getEndpointOrBuilderList()</pre> |
| <div class="block"><pre> |
| |
| A list of endpoints associated with the flight. To consume the |
| whole flight, all endpoints (and hence all Tickets) must be |
| consumed. Endpoints can be consumed in any order. |
| |
| In other words, an application can use multiple endpoints to |
| represent partitioned data. |
| |
| If the returned data has an ordering, an application can use |
| "FlightInfo.ordered = true" or should return the all data in a |
| single endpoint. Otherwise, there is no ordering defined on |
| endpoints or the data within. |
| |
| A client can read ordered data by reading data from returned |
| endpoints, in order, from front to back. |
| |
| Note that a client may ignore "FlightInfo.ordered = true". If an |
| ordering is important for an application, an application must |
| choose one of them: |
| |
| * An application requires that all clients must read data in |
| returned endpoints order. |
| * An application must return the all data in a single endpoint. |
| </pre> |
| |
| <code>repeated .arrow.flight.protocol.FlightEndpoint endpoint = 3;</code></div> |
| </li> |
| </ul> |
| <a name="getEndpointOrBuilder-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEndpointOrBuilder</h4> |
| <pre><a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightEndpointOrBuilder.html" title="interface in org.apache.arrow.flight.impl">Flight.FlightEndpointOrBuilder</a> getEndpointOrBuilder(int index)</pre> |
| <div class="block"><pre> |
| |
| A list of endpoints associated with the flight. To consume the |
| whole flight, all endpoints (and hence all Tickets) must be |
| consumed. Endpoints can be consumed in any order. |
| |
| In other words, an application can use multiple endpoints to |
| represent partitioned data. |
| |
| If the returned data has an ordering, an application can use |
| "FlightInfo.ordered = true" or should return the all data in a |
| single endpoint. Otherwise, there is no ordering defined on |
| endpoints or the data within. |
| |
| A client can read ordered data by reading data from returned |
| endpoints, in order, from front to back. |
| |
| Note that a client may ignore "FlightInfo.ordered = true". If an |
| ordering is important for an application, an application must |
| choose one of them: |
| |
| * An application requires that all clients must read data in |
| returned endpoints order. |
| * An application must return the all data in a single endpoint. |
| </pre> |
| |
| <code>repeated .arrow.flight.protocol.FlightEndpoint endpoint = 3;</code></div> |
| </li> |
| </ul> |
| <a name="getTotalRecords--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTotalRecords</h4> |
| <pre>long getTotalRecords()</pre> |
| <div class="block"><pre> |
| Set these to -1 if unknown. |
| </pre> |
| |
| <code>int64 total_records = 4;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The totalRecords.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTotalBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTotalBytes</h4> |
| <pre>long getTotalBytes()</pre> |
| <div class="block"><code>int64 total_bytes = 5;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The totalBytes.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOrdered--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOrdered</h4> |
| <pre>boolean getOrdered()</pre> |
| <div class="block"><pre> |
| |
| FlightEndpoints are in the same order as the data. |
| </pre> |
| |
| <code>bool ordered = 6;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The ordered.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAppMetadata--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getAppMetadata</h4> |
| <pre>com.google.protobuf.ByteString getAppMetadata()</pre> |
| <div class="block"><pre> |
| |
| Application-defined metadata. |
| |
| There is no inherent or required relationship between this |
| and the app_metadata fields in the FlightEndpoints or resulting |
| FlightData messages. Since this metadata is application-defined, |
| a given application could define there to be a relationship, |
| but there is none required by the spec. |
| </pre> |
| |
| <code>bytes app_metadata = 7;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The appMetadata.</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="class-use/Flight.FlightInfoOrBuilder.html">Use</a></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/arrow/flight/impl/Flight.FlightInfo.Builder.html" title="class in org.apache.arrow.flight.impl"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/arrow/flight/impl/Flight.GetSessionOptionsRequest.html" title="class in org.apache.arrow.flight.impl"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/arrow/flight/impl/Flight.FlightInfoOrBuilder.html" target="_top">Frames</a></li> |
| <li><a href="Flight.FlightInfoOrBuilder.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>Nested | </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 ======= --> |
| <p class="legalCopy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
