You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<dt><ahref="io/oxia/client/api/CancelableRangeScanConsumer.html" class="type-name-link" title="interface in io.oxia.client.api">CancelableRangeScanConsumer</a> - Interface in <ahref="io/oxia/client/api/package-summary.html">io.oxia.client.api</a></dt>
91
-
<dd>
92
-
<divclass="block">Callback used by <ahref="io/oxia/client/api/AsyncOxiaClient.html#rangeScanWithCancellation(java.lang.String,java.lang.String,io.oxia.client.api.CancelableRangeScanConsumer)"><code>AsyncOxiaClient.rangeScanWithCancellation(String, String, CancelableRangeScanConsumer)</code></a> to deliver records while allowing callers to stop a streaming range
93
-
scan early.</div>
94
-
</dd>
95
90
<dt><ahref="io/oxia/client/api/Version.html#clientIdentifier()" class="member-name-link">clientIdentifier()</a> - Method in record class <ahref="io/oxia/client/api/Version.html" title="class in io.oxia.client.api">Version</a></dt>
96
91
<dd>
97
92
<divclass="block">Returns the value of the <ahref="./io/oxia/client/api/Version.html#param-clientIdentifier"><code>clientIdentifier</code></a> record component.</div>
<dt><ahref="io/oxia/client/api/CancelableRangeScanConsumer.html#onCompleted()" class="member-name-link">onCompleted()</a> - Method in interface <ahref="io/oxia/client/api/CancelableRangeScanConsumer.html" title="interface in io.oxia.client.api">CancelableRangeScanConsumer</a></dt>
515
-
<dd>
516
-
<divclass="block">Invoked when the range scan operation completes.</div>
517
-
</dd>
518
509
<dt><ahref="io/oxia/client/api/RangeScanConsumer.html#onCompleted()" class="member-name-link">onCompleted()</a> - Method in interface <ahref="io/oxia/client/api/RangeScanConsumer.html" title="interface in io.oxia.client.api">RangeScanConsumer</a></dt>
519
510
<dd>
520
511
<divclass="block">Invoked when the range scan operation completes.</div>
521
512
</dd>
522
-
<dt><ahref="io/oxia/client/api/CancelableRangeScanConsumer.html#onError(java.lang.Throwable)" class="member-name-link">onError(Throwable)</a> - Method in interface <ahref="io/oxia/client/api/CancelableRangeScanConsumer.html" title="interface in io.oxia.client.api">CancelableRangeScanConsumer</a></dt>
523
-
<dd>
524
-
<divclass="block">Invoked when an error occurs during the range scan operation.</div>
525
-
</dd>
526
513
<dt><ahref="io/oxia/client/api/RangeScanConsumer.html#onError(java.lang.Throwable)" class="member-name-link">onError(Throwable)</a> - Method in interface <ahref="io/oxia/client/api/RangeScanConsumer.html" title="interface in io.oxia.client.api">RangeScanConsumer</a></dt>
527
514
<dd>
528
515
<divclass="block">Invoked when an error occurs during the range scan operation.</div>
529
516
</dd>
530
-
<dt><ahref="io/oxia/client/api/CancelableRangeScanConsumer.html#onNext(io.oxia.client.api.GetResult)" class="member-name-link">onNext(GetResult)</a> - Method in interface <ahref="io/oxia/client/api/CancelableRangeScanConsumer.html" title="interface in io.oxia.client.api">CancelableRangeScanConsumer</a></dt>
531
-
<dd>
532
-
<divclass="block">Invoked for each record returned by the range scan operation.</div>
533
-
</dd>
534
517
<dt><ahref="io/oxia/client/api/RangeScanConsumer.html#onNext(io.oxia.client.api.GetResult)" class="member-name-link">onNext(GetResult)</a> - Method in interface <ahref="io/oxia/client/api/RangeScanConsumer.html" title="interface in io.oxia.client.api">RangeScanConsumer</a></dt>
535
518
<dd>
536
519
<divclass="block">Invoked for each record returned by the range scan operation.</div>
<divclass="block">Scan any existing records within the specified range of keys.</div>
639
622
</dd>
640
-
<dt><ahref="io/oxia/client/api/SyncOxiaClient.html#rangeScanCloseable(java.lang.String,java.lang.String)" class="member-name-link">rangeScanCloseable(String, String)</a> - Method in interface <ahref="io/oxia/client/api/SyncOxiaClient.html" title="interface in io.oxia.client.api">SyncOxiaClient</a></dt>
641
-
<dd>
642
-
<divclass="block">Scan any existing records within the specified range of keys, returning an iterable that can be
643
-
closed when iteration is abandoned before completion.</div>
644
-
</dd>
645
-
<dt><ahref="io/oxia/client/api/SyncOxiaClient.html#rangeScanCloseable(java.lang.String,java.lang.String,java.util.Set)" class="member-name-link">rangeScanCloseable(String, String, Set<RangeScanOption>)</a> - Method in interface <ahref="io/oxia/client/api/SyncOxiaClient.html" title="interface in io.oxia.client.api">SyncOxiaClient</a></dt>
646
-
<dd>
647
-
<divclass="block">Scan any existing records within the specified range of keys, returning an iterable that can be
648
-
closed when iteration is abandoned before completion.</div>
649
-
</dd>
650
623
<dt><ahref="io/oxia/client/api/RangeScanConsumer.html" class="type-name-link" title="interface in io.oxia.client.api">RangeScanConsumer</a> - Interface in <ahref="io/oxia/client/api/package-summary.html">io.oxia.client.api</a></dt>
651
624
<dd>
652
625
<divclass="block">Callback used by <ahref="io/oxia/client/api/AsyncOxiaClient.html#rangeScan(java.lang.String,java.lang.String,io.oxia.client.api.RangeScanConsumer)"><code>AsyncOxiaClient.rangeScan(String, String, RangeScanConsumer)</code></a> to deliver
<divclass="block">RangeScanOption is a sealed interface that represents options for controlling range scan
658
631
operations.</div>
659
632
</dd>
660
-
<dt><ahref="io/oxia/client/api/AsyncOxiaClient.html#rangeScanWithCancellation(java.lang.String,java.lang.String,io.oxia.client.api.CancelableRangeScanConsumer)" class="member-name-link">rangeScanWithCancellation(String, String, CancelableRangeScanConsumer)</a> - Method in interface <ahref="io/oxia/client/api/AsyncOxiaClient.html" title="interface in io.oxia.client.api">AsyncOxiaClient</a></dt>
661
-
<dd>
662
-
<divclass="block">Scan any existing records within the specified range of keys, allowing the consumer to stop
663
-
iteration early.</div>
664
-
</dd>
665
-
<dt><ahref="io/oxia/client/api/AsyncOxiaClient.html#rangeScanWithCancellation(java.lang.String,java.lang.String,io.oxia.client.api.CancelableRangeScanConsumer,java.util.Set)" class="member-name-link">rangeScanWithCancellation(String, String, CancelableRangeScanConsumer, Set<RangeScanOption>)</a> - Method in interface <ahref="io/oxia/client/api/AsyncOxiaClient.html" title="interface in io.oxia.client.api">AsyncOxiaClient</a></dt>
666
-
<dd>
667
-
<divclass="block">Scan any existing records within the specified range of keys, allowing the consumer to stop
668
-
iteration early.</div>
669
-
</dd>
670
633
<dt><ahref="io/oxia/client/api/OxiaClientBuilder.html#requestTimeout(java.time.Duration)" class="member-name-link">requestTimeout(Duration)</a> - Method in interface <ahref="io/oxia/client/api/OxiaClientBuilder.html" title="interface in io.oxia.client.api">OxiaClientBuilder</a></dt>
671
634
<dd>
672
635
<divclass="block">Specify a custom timeout for all requests.</div>
<divclass="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><ahref="#rangeScanWithCancellation(java.lang.String,java.lang.String,io.oxia.client.api.CancelableRangeScanConsumer)" class="member-name-link">rangeScanWithCancellation</a><wbr>(<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> startKeyInclusive,
219
-
<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> endKeyExclusive,
220
-
<ahref="CancelableRangeScanConsumer.html" title="interface in io.oxia.client.api">CancelableRangeScanConsumer</a> consumer)</code></div>
<divclass="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><ahref="#rangeScanWithCancellation(java.lang.String,java.lang.String,io.oxia.client.api.CancelableRangeScanConsumer,java.util.Set)" class="member-name-link">rangeScanWithCancellation</a><wbr>(<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> startKeyInclusive,
227
-
<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> endKeyExclusive,
228
-
<ahref="CancelableRangeScanConsumer.html" title="interface in io.oxia.client.api">CancelableRangeScanConsumer</a> consumer,
229
-
<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<ahref="options/RangeScanOption.html" title="interface in io.oxia.client.api.options">RangeScanOption</a>> options)</code></div>
<divclass="member-signature"><spanclass="return-type">void</span> <spanclass="element-name">rangeScanWithCancellation</span><wbr><spanclass="parameters">(<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> startKeyInclusive,
477
-
<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> endKeyExclusive,
478
-
<ahref="CancelableRangeScanConsumer.html" title="interface in io.oxia.client.api">CancelableRangeScanConsumer</a> consumer)</span></div>
479
-
<divclass="block">Scan any existing records within the specified range of keys, allowing the consumer to stop
480
-
iteration early.</div>
481
-
<dlclass="notes">
482
-
<dt>Parameters:</dt>
483
-
<dd><code>startKeyInclusive</code> - The key that declares start of the range, and is <b>included</b> from
484
-
the range.</dd>
485
-
<dd><code>endKeyExclusive</code> - The key that declares the end of the range, and is <b>excluded</b> from
486
-
the range.</dd>
487
-
<dd><code>consumer</code> - A <ahref="CancelableRangeScanConsumer.html" title="interface in io.oxia.client.api"><code>CancelableRangeScanConsumer</code></a> that will be invoked with the records or
<divclass="member-signature"><spanclass="return-type">void</span> <spanclass="element-name">rangeScanWithCancellation</span><wbr><spanclass="parameters">(<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> startKeyInclusive,
496
-
<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> endKeyExclusive,
497
-
<ahref="CancelableRangeScanConsumer.html" title="interface in io.oxia.client.api">CancelableRangeScanConsumer</a> consumer,
498
-
<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<ahref="options/RangeScanOption.html" title="interface in io.oxia.client.api.options">RangeScanOption</a>> options)</span></div>
499
-
<divclass="block">Scan any existing records within the specified range of keys, allowing the consumer to stop
500
-
iteration early.</div>
501
-
<dlclass="notes">
502
-
<dt>Parameters:</dt>
503
-
<dd><code>startKeyInclusive</code> - The key that declares start of the range, and is <b>included</b> from
504
-
the range.</dd>
505
-
<dd><code>endKeyExclusive</code> - The key that declares the end of the range, and is <b>excluded</b> from
506
-
the range.</dd>
507
-
<dd><code>consumer</code> - A <ahref="CancelableRangeScanConsumer.html" title="interface in io.oxia.client.api"><code>CancelableRangeScanConsumer</code></a> that will be invoked with the records or
508
-
errors.</dd>
509
-
<dd><code>options</code> - the range scan options</dd>
<divclass="member-signature"><spanclass="return-type">void</span> <spanclass="element-name">notifications</span><wbr><spanclass="parameters">(<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Consumer.html" title="class or interface in java.util.function" class="external-link">Consumer</a><<ahref="Notification.html" title="interface in io.oxia.client.api">Notification</a>> notificationCallback)</span></div>
0 commit comments