Skip to content

Commit 562261c

Browse files
Publish documentation (92fece1)
1 parent 1a5e3da commit 562261c

26 files changed

+2648
-1924
lines changed

main/reference/allclasses-index.html

Lines changed: 1762 additions & 1758 deletions
Large diffs are not rendered by default.

main/reference/index-all.html

Lines changed: 68 additions & 0 deletions
Large diffs are not rendered by default.

main/reference/member-search-index.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

main/reference/org.apache.arrow.flight.core/org/apache/arrow/flight/impl/FlightServiceGrpc.FlightServiceBlockingStub.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ <h1 title="Class FlightServiceGrpc.FlightServiceBlockingStub" class="title">Clas
8989
<hr>
9090
<div class="type-signature"><span class="modifiers">public static final class </span><span class="element-name type-name-label">FlightServiceGrpc.FlightServiceBlockingStub</span>
9191
<span class="extends-implements">extends io.grpc.stub.AbstractBlockingStub&lt;<a href="FlightServiceGrpc.FlightServiceBlockingStub.html" title="class in org.apache.arrow.flight.impl">FlightServiceGrpc.FlightServiceBlockingStub</a>&gt;</span></div>
92-
<div class="block">A stub to allow clients to do synchronous rpc calls to service FlightService.
92+
<div class="block">A stub to allow clients to do limited synchronous rpc calls to service FlightService.
9393
<pre>
9494
A flight service is an endpoint for retrieving or storing Arrow data. A
9595
flight service can expose one or more predefined endpoints that can be

main/reference/org.apache.arrow.flight.core/org/apache/arrow/flight/impl/FlightServiceGrpc.FlightServiceBlockingV2Stub.html

Lines changed: 395 additions & 0 deletions
Large diffs are not rendered by default.

main/reference/org.apache.arrow.flight.core/org/apache/arrow/flight/impl/FlightServiceGrpc.html

Lines changed: 30 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -108,21 +108,26 @@ <h2>Nested Class Summary</h2>
108108
<div class="col-first odd-row-color"><code>static final class&nbsp;</code></div>
109109
<div class="col-second odd-row-color"><code><a href="FlightServiceGrpc.FlightServiceBlockingStub.html" class="type-name-link" title="class in org.apache.arrow.flight.impl">FlightServiceGrpc.FlightServiceBlockingStub</a></code></div>
110110
<div class="col-last odd-row-color">
111-
<div class="block">A stub to allow clients to do synchronous rpc calls to service FlightService.</div>
111+
<div class="block">A stub to allow clients to do limited synchronous rpc calls to service FlightService.</div>
112112
</div>
113113
<div class="col-first even-row-color"><code>static final class&nbsp;</code></div>
114-
<div class="col-second even-row-color"><code><a href="FlightServiceGrpc.FlightServiceFutureStub.html" class="type-name-link" title="class in org.apache.arrow.flight.impl">FlightServiceGrpc.FlightServiceFutureStub</a></code></div>
114+
<div class="col-second even-row-color"><code><a href="FlightServiceGrpc.FlightServiceBlockingV2Stub.html" class="type-name-link" title="class in org.apache.arrow.flight.impl">FlightServiceGrpc.FlightServiceBlockingV2Stub</a></code></div>
115115
<div class="col-last even-row-color">
116-
<div class="block">A stub to allow clients to do ListenableFuture-style rpc calls to service FlightService.</div>
116+
<div class="block">A stub to allow clients to do synchronous rpc calls to service FlightService.</div>
117117
</div>
118-
<div class="col-first odd-row-color"><code>static class&nbsp;</code></div>
119-
<div class="col-second odd-row-color"><code><a href="FlightServiceGrpc.FlightServiceImplBase.html" class="type-name-link" title="class in org.apache.arrow.flight.impl">FlightServiceGrpc.FlightServiceImplBase</a></code></div>
118+
<div class="col-first odd-row-color"><code>static final class&nbsp;</code></div>
119+
<div class="col-second odd-row-color"><code><a href="FlightServiceGrpc.FlightServiceFutureStub.html" class="type-name-link" title="class in org.apache.arrow.flight.impl">FlightServiceGrpc.FlightServiceFutureStub</a></code></div>
120120
<div class="col-last odd-row-color">
121-
<div class="block">Base class for the server implementation of the service FlightService.</div>
121+
<div class="block">A stub to allow clients to do ListenableFuture-style rpc calls to service FlightService.</div>
122122
</div>
123-
<div class="col-first even-row-color"><code>static final class&nbsp;</code></div>
124-
<div class="col-second even-row-color"><code><a href="FlightServiceGrpc.FlightServiceStub.html" class="type-name-link" title="class in org.apache.arrow.flight.impl">FlightServiceGrpc.FlightServiceStub</a></code></div>
123+
<div class="col-first even-row-color"><code>static class&nbsp;</code></div>
124+
<div class="col-second even-row-color"><code><a href="FlightServiceGrpc.FlightServiceImplBase.html" class="type-name-link" title="class in org.apache.arrow.flight.impl">FlightServiceGrpc.FlightServiceImplBase</a></code></div>
125125
<div class="col-last even-row-color">
126+
<div class="block">Base class for the server implementation of the service FlightService.</div>
127+
</div>
128+
<div class="col-first odd-row-color"><code>static final class&nbsp;</code></div>
129+
<div class="col-second odd-row-color"><code><a href="FlightServiceGrpc.FlightServiceStub.html" class="type-name-link" title="class in org.apache.arrow.flight.impl">FlightServiceGrpc.FlightServiceStub</a></code></div>
130+
<div class="col-last odd-row-color">
126131
<div class="block">A stub to allow clients to do asynchronous rpc calls to service FlightService.</div>
127132
</div>
128133
</div>
@@ -195,14 +200,19 @@ <h2>Method Summary</h2>
195200
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
196201
<div class="block">Creates a new blocking-style stub that supports unary and streaming output calls on the service</div>
197202
</div>
198-
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="FlightServiceGrpc.FlightServiceFutureStub.html" title="class in org.apache.arrow.flight.impl">FlightServiceGrpc.FlightServiceFutureStub</a></code></div>
199-
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newFutureStub(io.grpc.Channel)" class="member-name-link">newFutureStub</a><wbr>(io.grpc.Channel&nbsp;channel)</code></div>
203+
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="FlightServiceGrpc.FlightServiceBlockingV2Stub.html" title="class in org.apache.arrow.flight.impl">FlightServiceGrpc.FlightServiceBlockingV2Stub</a></code></div>
204+
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newBlockingV2Stub(io.grpc.Channel)" class="member-name-link">newBlockingV2Stub</a><wbr>(io.grpc.Channel&nbsp;channel)</code></div>
200205
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
201-
<div class="block">Creates a new ListenableFuture-style stub that supports unary calls on the service</div>
206+
<div class="block">Creates a new blocking-style stub that supports all types of calls on the service</div>
202207
</div>
203-
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="FlightServiceGrpc.FlightServiceStub.html" title="class in org.apache.arrow.flight.impl">FlightServiceGrpc.FlightServiceStub</a></code></div>
204-
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newStub(io.grpc.Channel)" class="member-name-link">newStub</a><wbr>(io.grpc.Channel&nbsp;channel)</code></div>
208+
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="FlightServiceGrpc.FlightServiceFutureStub.html" title="class in org.apache.arrow.flight.impl">FlightServiceGrpc.FlightServiceFutureStub</a></code></div>
209+
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newFutureStub(io.grpc.Channel)" class="member-name-link">newFutureStub</a><wbr>(io.grpc.Channel&nbsp;channel)</code></div>
205210
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
211+
<div class="block">Creates a new ListenableFuture-style stub that supports unary calls on the service</div>
212+
</div>
213+
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="FlightServiceGrpc.FlightServiceStub.html" title="class in org.apache.arrow.flight.impl">FlightServiceGrpc.FlightServiceStub</a></code></div>
214+
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newStub(io.grpc.Channel)" class="member-name-link">newStub</a><wbr>(io.grpc.Channel&nbsp;channel)</code></div>
215+
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
206216
<div class="block">Creates a new async stub that supports all call types for the service</div>
207217
</div>
208218
</div>
@@ -312,6 +322,13 @@ <h3>newStub</h3>
312322
</section>
313323
</li>
314324
<li>
325+
<section class="detail" id="newBlockingV2Stub(io.grpc.Channel)">
326+
<h3>newBlockingV2Stub</h3>
327+
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="FlightServiceGrpc.FlightServiceBlockingV2Stub.html" title="class in org.apache.arrow.flight.impl">FlightServiceGrpc.FlightServiceBlockingV2Stub</a></span>&nbsp;<span class="element-name">newBlockingV2Stub</span><wbr><span class="parameters">(io.grpc.Channel&nbsp;channel)</span></div>
328+
<div class="block">Creates a new blocking-style stub that supports all types of calls on the service</div>
329+
</section>
330+
</li>
331+
<li>
315332
<section class="detail" id="newBlockingStub(io.grpc.Channel)">
316333
<h3>newBlockingStub</h3>
317334
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="FlightServiceGrpc.FlightServiceBlockingStub.html" title="class in org.apache.arrow.flight.impl">FlightServiceGrpc.FlightServiceBlockingStub</a></span>&nbsp;<span class="element-name">newBlockingStub</span><wbr><span class="parameters">(io.grpc.Channel&nbsp;channel)</span></div>

main/reference/org.apache.arrow.flight.core/org/apache/arrow/flight/impl/class-use/Flight.Action.html

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -164,21 +164,29 @@ <h2>Uses of <a href="../Flight.Action.html" title="class in org.apache.arrow.fli
164164
addition to the possible ListFlights, GetFlightInfo, DoGet, DoPut
165165
operations that are potentially available.</div>
166166
</div>
167-
<div class="col-first even-row-color"><code>void</code></div>
168-
<div class="col-second even-row-color"><span class="type-name-label">FlightServiceGrpc.FlightServiceStub.</span><code><a href="../FlightServiceGrpc.FlightServiceStub.html#doAction(org.apache.arrow.flight.impl.Flight.Action,io.grpc.stub.StreamObserver)" class="member-name-link">doAction</a><wbr>(<a href="../Flight.Action.html" title="class in org.apache.arrow.flight.impl">Flight.Action</a>&nbsp;request,
169-
io.grpc.stub.StreamObserver&lt;<a href="../Flight.Result.html" title="class in org.apache.arrow.flight.impl">Flight.Result</a>&gt;&nbsp;responseObserver)</code></div>
167+
<div class="col-first even-row-color"><code>io.grpc.stub.BlockingClientCall&lt;?,<wbr><a href="../Flight.Result.html" title="class in org.apache.arrow.flight.impl">Flight.Result</a>&gt;</code></div>
168+
<div class="col-second even-row-color"><span class="type-name-label">FlightServiceGrpc.FlightServiceBlockingV2Stub.</span><code><a href="../FlightServiceGrpc.FlightServiceBlockingV2Stub.html#doAction(org.apache.arrow.flight.impl.Flight.Action)" class="member-name-link">doAction</a><wbr>(<a href="../Flight.Action.html" title="class in org.apache.arrow.flight.impl">Flight.Action</a>&nbsp;request)</code></div>
170169
<div class="col-last even-row-color">
171170
<div class="block">
172171
Flight services can support an arbitrary number of simple actions in
173172
addition to the possible ListFlights, GetFlightInfo, DoGet, DoPut
174173
operations that are potentially available.</div>
175174
</div>
176-
<div class="col-first odd-row-color"><code><a href="../Flight.Action.Builder.html" title="class in org.apache.arrow.flight.impl">Flight.Action.Builder</a></code></div>
177-
<div class="col-second odd-row-color"><span class="type-name-label">Flight.Action.Builder.</span><code><a href="../Flight.Action.Builder.html#mergeFrom(org.apache.arrow.flight.impl.Flight.Action)" class="member-name-link">mergeFrom</a><wbr>(<a href="../Flight.Action.html" title="class in org.apache.arrow.flight.impl">Flight.Action</a>&nbsp;other)</code></div>
178-
<div class="col-last odd-row-color">&nbsp;</div>
179-
<div class="col-first even-row-color"><code>static <a href="../Flight.Action.Builder.html" title="class in org.apache.arrow.flight.impl">Flight.Action.Builder</a></code></div>
180-
<div class="col-second even-row-color"><span class="type-name-label">Flight.Action.</span><code><a href="../Flight.Action.html#newBuilder(org.apache.arrow.flight.impl.Flight.Action)" class="member-name-link">newBuilder</a><wbr>(<a href="../Flight.Action.html" title="class in org.apache.arrow.flight.impl">Flight.Action</a>&nbsp;prototype)</code></div>
175+
<div class="col-first odd-row-color"><code>void</code></div>
176+
<div class="col-second odd-row-color"><span class="type-name-label">FlightServiceGrpc.FlightServiceStub.</span><code><a href="../FlightServiceGrpc.FlightServiceStub.html#doAction(org.apache.arrow.flight.impl.Flight.Action,io.grpc.stub.StreamObserver)" class="member-name-link">doAction</a><wbr>(<a href="../Flight.Action.html" title="class in org.apache.arrow.flight.impl">Flight.Action</a>&nbsp;request,
177+
io.grpc.stub.StreamObserver&lt;<a href="../Flight.Result.html" title="class in org.apache.arrow.flight.impl">Flight.Result</a>&gt;&nbsp;responseObserver)</code></div>
178+
<div class="col-last odd-row-color">
179+
<div class="block">
180+
Flight services can support an arbitrary number of simple actions in
181+
addition to the possible ListFlights, GetFlightInfo, DoGet, DoPut
182+
operations that are potentially available.</div>
183+
</div>
184+
<div class="col-first even-row-color"><code><a href="../Flight.Action.Builder.html" title="class in org.apache.arrow.flight.impl">Flight.Action.Builder</a></code></div>
185+
<div class="col-second even-row-color"><span class="type-name-label">Flight.Action.Builder.</span><code><a href="../Flight.Action.Builder.html#mergeFrom(org.apache.arrow.flight.impl.Flight.Action)" class="member-name-link">mergeFrom</a><wbr>(<a href="../Flight.Action.html" title="class in org.apache.arrow.flight.impl">Flight.Action</a>&nbsp;other)</code></div>
181186
<div class="col-last even-row-color">&nbsp;</div>
187+
<div class="col-first odd-row-color"><code>static <a href="../Flight.Action.Builder.html" title="class in org.apache.arrow.flight.impl">Flight.Action.Builder</a></code></div>
188+
<div class="col-second odd-row-color"><span class="type-name-label">Flight.Action.</span><code><a href="../Flight.Action.html#newBuilder(org.apache.arrow.flight.impl.Flight.Action)" class="member-name-link">newBuilder</a><wbr>(<a href="../Flight.Action.html" title="class in org.apache.arrow.flight.impl">Flight.Action</a>&nbsp;prototype)</code></div>
189+
<div class="col-last odd-row-color">&nbsp;</div>
182190
</div>
183191
</section>
184192
</li>

main/reference/org.apache.arrow.flight.core/org/apache/arrow/flight/impl/class-use/Flight.ActionType.html

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -145,9 +145,16 @@ <h2>Uses of <a href="../Flight.ActionType.html" title="class in org.apache.arrow
145145
A flight service exposes all of the available action types that it has
146146
along with descriptions.</div>
147147
</div>
148-
<div class="col-first odd-row-color"><code>static com.google.protobuf.Parser&lt;<a href="../Flight.ActionType.html" title="class in org.apache.arrow.flight.impl">Flight.ActionType</a>&gt;</code></div>
149-
<div class="col-second odd-row-color"><span class="type-name-label">Flight.ActionType.</span><code><a href="../Flight.ActionType.html#parser()" class="member-name-link">parser</a>()</code></div>
150-
<div class="col-last odd-row-color">&nbsp;</div>
148+
<div class="col-first odd-row-color"><code>io.grpc.stub.BlockingClientCall&lt;?,<wbr><a href="../Flight.ActionType.html" title="class in org.apache.arrow.flight.impl">Flight.ActionType</a>&gt;</code></div>
149+
<div class="col-second odd-row-color"><span class="type-name-label">FlightServiceGrpc.FlightServiceBlockingV2Stub.</span><code><a href="../FlightServiceGrpc.FlightServiceBlockingV2Stub.html#listActions(org.apache.arrow.flight.impl.Flight.Empty)" class="member-name-link">listActions</a><wbr>(<a href="../Flight.Empty.html" title="class in org.apache.arrow.flight.impl">Flight.Empty</a>&nbsp;request)</code></div>
150+
<div class="col-last odd-row-color">
151+
<div class="block">
152+
A flight service exposes all of the available action types that it has
153+
along with descriptions.</div>
154+
</div>
155+
<div class="col-first even-row-color"><code>static com.google.protobuf.Parser&lt;<a href="../Flight.ActionType.html" title="class in org.apache.arrow.flight.impl">Flight.ActionType</a>&gt;</code></div>
156+
<div class="col-second even-row-color"><span class="type-name-label">Flight.ActionType.</span><code><a href="../Flight.ActionType.html#parser()" class="member-name-link">parser</a>()</code></div>
157+
<div class="col-last even-row-color">&nbsp;</div>
151158
</div>
152159
<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.arrow.flight.impl</a> with parameters of type <a href="../Flight.ActionType.html" title="class in org.apache.arrow.flight.impl">Flight.ActionType</a></span></div>
153160
<div class="summary-table three-column-summary">

0 commit comments

Comments
 (0)