Skip to content

Commit 18b5935

Browse files
committed
1 parent 978428c commit 18b5935

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+822
-985
lines changed

public/oxia-client-java/apidocs/latest/allclasses-index.html

Lines changed: 58 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -65,62 +65,69 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
6565
<div class="block">Asynchronous client for the Oxia service.</div>
6666
</div>
6767
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="io/oxia/client/api/Authentication.html" title="interface in io.oxia.client.api">Authentication</a></div>
68-
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
68+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
69+
<div class="block">Represents an interface for implementing authentication mechanisms.</div>
70+
</div>
6971
<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="io/oxia/client/api/AuthenticationType.html" title="enum class in io.oxia.client.api">AuthenticationType</a></div>
70-
<div class="col-last even-row-color all-classes-table all-classes-table-tab3">&nbsp;</div>
71-
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/oxia/client/internal/DefaultImplementation.html" title="class in io.oxia.client.internal">DefaultImplementation</a></div>
72-
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
73-
<div class="block">This class loads the implementation for <a href="io/oxia/client/api/OxiaClientBuilder.html" title="interface in io.oxia.client.api"><code>OxiaClientBuilder</code></a> and allows you to decouple the
74-
API from the actual implementation.</div>
72+
<div class="col-last even-row-color all-classes-table all-classes-table-tab3">
73+
<div class="block">Enum representing the type of authentication used for accessing resources.</div>
7574
</div>
76-
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="io/oxia/client/api/DeleteOption.html" title="interface in io.oxia.client.api">DeleteOption</a></div>
77-
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
78-
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="io/oxia/client/api/DeleteRangeOption.html" title="interface in io.oxia.client.api">DeleteRangeOption</a></div>
79-
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
80-
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="io/oxia/client/api/EncodedAuthenticationParameterSupport.html" title="interface in io.oxia.client.api">EncodedAuthenticationParameterSupport</a></div>
75+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="io/oxia/client/api/DeleteOption.html" title="interface in io.oxia.client.api">DeleteOption</a></div>
76+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
77+
<div class="block">Options for deleting a record.</div>
78+
</div>
79+
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="io/oxia/client/api/DeleteRangeOption.html" title="interface in io.oxia.client.api">DeleteRangeOption</a></div>
8180
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
81+
<div class="block">Options for deleting a range of records.</div>
82+
</div>
83+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="io/oxia/client/api/EncodedAuthenticationParameterSupport.html" title="interface in io.oxia.client.api">EncodedAuthenticationParameterSupport</a></div>
84+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
8285
<div class="block">Support for encoded authentication configuration parameters.</div>
8386
</div>
84-
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="io/oxia/client/api/GetOption.html" title="interface in io.oxia.client.api">GetOption</a></div>
85-
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
86-
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/oxia/client/api/GetResult.html" title="class in io.oxia.client.api">GetResult</a></div>
87-
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
87+
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="io/oxia/client/api/GetOption.html" title="interface in io.oxia.client.api">GetOption</a></div>
88+
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
89+
<div class="block">Options for getting a record.</div>
90+
</div>
91+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/oxia/client/api/GetResult.html" title="class in io.oxia.client.api">GetResult</a></div>
92+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
8893
<div class="block">The result of a client get request.</div>
8994
</div>
90-
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="io/oxia/client/api/GetSequenceUpdatesOption.html" title="interface in io.oxia.client.api">GetSequenceUpdatesOption</a></div>
91-
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
92-
<div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="io/oxia/client/api/exceptions/KeyAlreadyExistsException.html" title="class in io.oxia.client.api.exceptions">KeyAlreadyExistsException</a></div>
93-
<div class="col-last even-row-color all-classes-table all-classes-table-tab5">
95+
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="io/oxia/client/api/GetSequenceUpdatesOption.html" title="interface in io.oxia.client.api">GetSequenceUpdatesOption</a></div>
96+
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
97+
<div class="block">Options for getting sequence updates.</div>
98+
</div>
99+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="io/oxia/client/api/exceptions/KeyAlreadyExistsException.html" title="class in io.oxia.client.api.exceptions">KeyAlreadyExistsException</a></div>
100+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab5">
94101
<div class="block">The key already exists at the server.</div>
95102
</div>
96-
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="io/oxia/client/api/ListOption.html" title="interface in io.oxia.client.api">ListOption</a></div>
97-
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
98-
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="io/oxia/client/api/Notification.html" title="interface in io.oxia.client.api">Notification</a></div>
103+
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="io/oxia/client/api/ListOption.html" title="interface in io.oxia.client.api">ListOption</a></div>
99104
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
105+
<div class="block">Options for listing records.</div>
106+
</div>
107+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="io/oxia/client/api/Notification.html" title="interface in io.oxia.client.api">Notification</a></div>
108+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
100109
<div class="block">A notification from an Oxia server indicating a change to a record associated with a key.</div>
101110
</div>
102-
<div class="col-first odd-row-color all-classes-table all-classes-table-tab4"><a href="io/oxia/client/api/Notification.KeyCreated.html" title="class in io.oxia.client.api">Notification.KeyCreated</a></div>
103-
<div class="col-last odd-row-color all-classes-table all-classes-table-tab4">
111+
<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="io/oxia/client/api/Notification.KeyCreated.html" title="class in io.oxia.client.api">Notification.KeyCreated</a></div>
112+
<div class="col-last even-row-color all-classes-table all-classes-table-tab4">
104113
<div class="block">A record associated with the key has been created.</div>
105114
</div>
106-
<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="io/oxia/client/api/Notification.KeyDeleted.html" title="class in io.oxia.client.api">Notification.KeyDeleted</a></div>
107-
<div class="col-last even-row-color all-classes-table all-classes-table-tab4">
115+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab4"><a href="io/oxia/client/api/Notification.KeyDeleted.html" title="class in io.oxia.client.api">Notification.KeyDeleted</a></div>
116+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab4">
108117
<div class="block">The record associated with the key has been deleted.</div>
109118
</div>
110-
<div class="col-first odd-row-color all-classes-table all-classes-table-tab4"><a href="io/oxia/client/api/Notification.KeyModified.html" title="class in io.oxia.client.api">Notification.KeyModified</a></div>
111-
<div class="col-last odd-row-color all-classes-table all-classes-table-tab4">
119+
<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="io/oxia/client/api/Notification.KeyModified.html" title="class in io.oxia.client.api">Notification.KeyModified</a></div>
120+
<div class="col-last even-row-color all-classes-table all-classes-table-tab4">
112121
<div class="block">The record associated with the key has been modified (updated).</div>
113122
</div>
114-
<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="io/oxia/client/api/Notification.KeyRangeDelete.html" title="class in io.oxia.client.api">Notification.KeyRangeDelete</a></div>
115-
<div class="col-last even-row-color all-classes-table all-classes-table-tab4">
123+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab4"><a href="io/oxia/client/api/Notification.KeyRangeDelete.html" title="class in io.oxia.client.api">Notification.KeyRangeDelete</a></div>
124+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab4">
116125
<div class="block">The record associated with the key range has been deleted.</div>
117126
</div>
118-
<div class="col-first odd-row-color all-classes-table all-classes-table-tab4"><a href="io/oxia/client/api/OptionComparisonType.html" title="class in io.oxia.client.api">OptionComparisonType</a></div>
119-
<div class="col-last odd-row-color all-classes-table all-classes-table-tab4">&nbsp;</div>
120-
<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="io/oxia/client/api/OptionComparisonType.ComparisonType.html" title="enum class in io.oxia.client.api">OptionComparisonType.ComparisonType</a></div>
121-
<div class="col-last even-row-color all-classes-table all-classes-table-tab3">&nbsp;</div>
122-
<div class="col-first odd-row-color all-classes-table all-classes-table-tab4"><a href="io/oxia/client/api/OptionEphemeral.html" title="class in io.oxia.client.api">OptionEphemeral</a></div>
123-
<div class="col-last odd-row-color all-classes-table all-classes-table-tab4">&nbsp;</div>
127+
<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="io/oxia/client/api/OptionComparisonType.html" title="class in io.oxia.client.api">OptionComparisonType</a></div>
128+
<div class="col-last even-row-color all-classes-table all-classes-table-tab4">&nbsp;</div>
129+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="io/oxia/client/api/OptionComparisonType.ComparisonType.html" title="enum class in io.oxia.client.api">OptionComparisonType.ComparisonType</a></div>
130+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab3">&nbsp;</div>
124131
<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="io/oxia/client/api/OptionIncludeValue.html" title="class in io.oxia.client.api">OptionIncludeValue</a></div>
125132
<div class="col-last even-row-color all-classes-table all-classes-table-tab4">&nbsp;</div>
126133
<div class="col-first odd-row-color all-classes-table all-classes-table-tab4"><a href="io/oxia/client/api/OptionPartitionKey.html" title="class in io.oxia.client.api">OptionPartitionKey</a></div>
@@ -138,21 +145,32 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
138145
<div class="col-first odd-row-color all-classes-table all-classes-table-tab4"><a href="io/oxia/client/api/OptionVersionId.OptionVersionIdEqual.html" title="class in io.oxia.client.api">OptionVersionId.OptionVersionIdEqual</a></div>
139146
<div class="col-last odd-row-color all-classes-table all-classes-table-tab4">&nbsp;</div>
140147
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="io/oxia/client/api/OxiaClientBuilder.html" title="interface in io.oxia.client.api">OxiaClientBuilder</a></div>
141-
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
148+
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
149+
<div class="block">Builder for <a href="io/oxia/client/api/SyncOxiaClient.html" title="interface in io.oxia.client.api"><code>SyncOxiaClient</code></a> and <a href="io/oxia/client/api/AsyncOxiaClient.html" title="interface in io.oxia.client.api"><code>AsyncOxiaClient</code></a>.</div>
150+
</div>
142151
<div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="io/oxia/client/api/exceptions/OxiaException.html" title="class in io.oxia.client.api.exceptions">OxiaException</a></div>
143152
<div class="col-last odd-row-color all-classes-table all-classes-table-tab5">
144153
<div class="block">A super-class of exceptions describing errors that occurred on an Oxia server.</div>
145154
</div>
146155
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="io/oxia/client/api/PutOption.html" title="interface in io.oxia.client.api">PutOption</a></div>
147-
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
156+
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
157+
<div class="block">The PutOption interface defines a set of options for customizing the behavior of a "put"
158+
operation in a data store.</div>
159+
</div>
148160
<div class="col-first odd-row-color all-classes-table all-classes-table-tab4"><a href="io/oxia/client/api/PutResult.html" title="class in io.oxia.client.api">PutResult</a></div>
149161
<div class="col-last odd-row-color all-classes-table all-classes-table-tab4">
150162
<div class="block">The result of a client get request.</div>
151163
</div>
152164
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="io/oxia/client/api/RangeScanConsumer.html" title="interface in io.oxia.client.api">RangeScanConsumer</a></div>
153-
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
165+
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
166+
<div class="block">Interface defining a consumer for Range Scan operations, allowing handling of chunked results,
167+
errors, or completion signals for a range scan process.</div>
168+
</div>
154169
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="io/oxia/client/api/RangeScanOption.html" title="interface in io.oxia.client.api">RangeScanOption</a></div>
155-
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
170+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
171+
<div class="block">RangeScanOption is a sealed interface that represents options for controlling range scan
172+
operations.</div>
173+
</div>
156174
<div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="io/oxia/client/api/exceptions/SessionDoesNotExistException.html" title="class in io.oxia.client.api.exceptions">SessionDoesNotExistException</a></div>
157175
<div class="col-last even-row-color all-classes-table all-classes-table-tab5">
158176
<div class="block">The session does not exist on the server.</div>

public/oxia-client-java/apidocs/latest/allpackages-index.html

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,13 @@ <h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
5555
<div class="table-header col-first">Package</div>
5656
<div class="table-header col-last">Description</div>
5757
<div class="col-first even-row-color"><a href="io/oxia/client/api/package-summary.html">io.oxia.client.api</a></div>
58-
<div class="col-last even-row-color">&nbsp;</div>
58+
<div class="col-last even-row-color">
59+
<div class="block">The public API for interacting with Oxia.</div>
60+
</div>
5961
<div class="col-first odd-row-color"><a href="io/oxia/client/api/exceptions/package-summary.html">io.oxia.client.api.exceptions</a></div>
60-
<div class="col-last odd-row-color">&nbsp;</div>
61-
<div class="col-first even-row-color"><a href="io/oxia/client/internal/package-summary.html">io.oxia.client.internal</a></div>
62-
<div class="col-last even-row-color">&nbsp;</div>
62+
<div class="col-last odd-row-color">
63+
<div class="block">Defines the exceptions that can be thrown by the Oxia client.</div>
64+
</div>
6365
</div>
6466
</main>
6567
<footer role="contentinfo">
Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
11
io.oxia.client.api
22
io.oxia.client.api.exceptions
3-
io.oxia.client.internal

0 commit comments

Comments
 (0)