Skip to content

Commit 9f70f4a

Browse files
clunclun
committed
Adding first 2.0 version
1 parent fddf249 commit 9f70f4a

File tree

625 files changed

+116332
-0
lines changed

Some content is hidden

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

625 files changed

+116332
-0
lines changed

Diff for: ‎astra-db-java/2.0.0-PREVIEW/allclasses-index.html

+882
Large diffs are not rendered by default.

Diff for: ‎astra-db-java/2.0.0-PREVIEW/allpackages-index.html

+263
Large diffs are not rendered by default.

Diff for: ‎astra-db-java/2.0.0-PREVIEW/com/datastax/astra/client/DataAPIClient.html

+616
Large diffs are not rendered by default.

Diff for: ‎astra-db-java/2.0.0-PREVIEW/com/datastax/astra/client/DataAPIClients.html

+419
Large diffs are not rendered by default.

Diff for: ‎astra-db-java/2.0.0-PREVIEW/com/datastax/astra/client/DataAPIDestination.html

+298
Large diffs are not rendered by default.

Diff for: ‎astra-db-java/2.0.0-PREVIEW/com/datastax/astra/client/admin/AdminOptions.html

+210
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,210 @@
1+
<!DOCTYPE HTML>
2+
<html lang>
3+
<head>
4+
<!-- Generated by javadoc (21) on Mon Dec 02 17:27:28 CET 2024 -->
5+
<title>AdminOptions (Java Client Library for Data API 2.0.0-SNAPSHOT API)</title>
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8+
<meta name="dc.created" content="2024-12-02">
9+
<meta name="description" content="declaration: package: com.datastax.astra.client.admin, class: AdminOptions">
10+
<meta name="generator" content="javadoc/ClassWriterImpl">
11+
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
12+
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
13+
<script type="text/javascript" src="../../../../../script.js"></script>
14+
<script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script>
15+
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
16+
</head>
17+
<body class="class-declaration-page">
18+
<script type="text/javascript">var pathtoroot = "../../../../../";
19+
loadScripts(document, 'script');</script>
20+
<noscript>
21+
<div>JavaScript is disabled on your browser.</div>
22+
</noscript>
23+
<div class="flex-box">
24+
<header role="banner" class="flex-header">
25+
<nav role="navigation">
26+
<!-- ========= START OF TOP NAVBAR ======= -->
27+
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
28+
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
29+
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
30+
<li><a href="../../../../../index.html">Overview</a></li>
31+
<li><a href="package-summary.html">Package</a></li>
32+
<li class="nav-bar-cell1-rev">Class</li>
33+
<li><a href="class-use/AdminOptions.html">Use</a></li>
34+
<li><a href="package-tree.html">Tree</a></li>
35+
<li><a href="../../../../../index-all.html">Index</a></li>
36+
<li><a href="../../../../../help-doc.html#class">Help</a></li>
37+
</ul>
38+
<ul class="sub-nav-list-small">
39+
<li>
40+
<p>Summary:</p>
41+
<ul>
42+
<li>Nested</li>
43+
<li><a href="#field-summary">Field</a></li>
44+
<li><a href="#constructor-summary">Constr</a></li>
45+
<li><a href="#method-summary">Method</a></li>
46+
</ul>
47+
</li>
48+
<li>
49+
<p>Detail:</p>
50+
<ul>
51+
<li>Field</li>
52+
<li><a href="#constructor-detail">Constr</a></li>
53+
<li>Method</li>
54+
</ul>
55+
</li>
56+
</ul>
57+
</div>
58+
<div class="sub-nav">
59+
<div id="navbar-sub-list">
60+
<ul class="sub-nav-list">
61+
<li>Summary:&nbsp;</li>
62+
<li>Nested&nbsp;|&nbsp;</li>
63+
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
64+
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
65+
<li><a href="#method-summary">Method</a></li>
66+
</ul>
67+
<ul class="sub-nav-list">
68+
<li>Detail:&nbsp;</li>
69+
<li>Field&nbsp;|&nbsp;</li>
70+
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
71+
<li>Method</li>
72+
</ul>
73+
</div>
74+
<div class="nav-list-search"><a href="../../../../../search.html">SEARCH</a>
75+
<input type="text" id="search-input" disabled placeholder="Search">
76+
<input type="reset" id="reset-button" disabled value="reset">
77+
</div>
78+
</div>
79+
<!-- ========= END OF TOP NAVBAR ========= -->
80+
<span class="skip-nav" id="skip-navbar-top"></span></nav>
81+
</header>
82+
<div class="flex-content">
83+
<main role="main">
84+
<!-- ======== START OF CLASS DATA ======== -->
85+
<div class="header">
86+
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">com.datastax.astra.client.admin</a></div>
87+
<h1 title="Class AdminOptions" class="title">Class AdminOptions</h1>
88+
</div>
89+
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
90+
<div class="inheritance"><a href="../core/options/BaseOptions.html" title="class in com.datastax.astra.client.core.options">com.datastax.astra.client.core.options.BaseOptions</a>&lt;<a href="AdminOptions.html" title="class in com.datastax.astra.client.admin">AdminOptions</a>&gt;
91+
<div class="inheritance">com.datastax.astra.client.admin.AdminOptions</div>
92+
</div>
93+
</div>
94+
<section class="class-description" id="class-description">
95+
<dl class="notes">
96+
<dt>All Implemented Interfaces:</dt>
97+
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></code></dd>
98+
</dl>
99+
<hr>
100+
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">AdminOptions</span>
101+
<span class="extends-implements">extends <a href="../core/options/BaseOptions.html" title="class in com.datastax.astra.client.core.options">BaseOptions</a>&lt;<a href="AdminOptions.html" title="class in com.datastax.astra.client.admin">AdminOptions</a>&gt;</span></div>
102+
<div class="block">Represents the configuration options for administrative operations in the database API.
103+
This class extends <a href="../core/options/BaseOptions.html" title="class in com.datastax.astra.client.core.options"><code>BaseOptions</code></a> to inherit common configuration options
104+
and provides additional functionality specific to administrative commands.
105+
106+
<p>Example usage:</p>
107+
<pre>
108+
<code>
109+
AdminOptions options = new AdminOptions()
110+
.token("your-token-here")
111+
.options(new DataAPIClientOptions())
112+
.serializer(new CustomSerializer());
113+
</code>
114+
</pre>
115+
116+
<p>Key Features:</p>
117+
<ul>
118+
<li>Provides default serialization through <a href="../../internal/serdes/DatabaseSerializer.html" title="class in com.datastax.astra.internal.serdes"><code>DatabaseSerializer</code></a>.</li>
119+
<li>Fluent and chainable setter methods for seamless configuration.</li>
120+
<li>Supports administrative command types via <a href="../core/commands/CommandType.html#DATABASE_ADMIN"><code>CommandType.DATABASE_ADMIN</code></a>.</li>
121+
</ul></div>
122+
</section>
123+
<section class="summary">
124+
<ul class="summary-list">
125+
<!-- =========== FIELD SUMMARY =========== -->
126+
<li>
127+
<section class="field-summary" id="field-summary">
128+
<h2>Field Summary</h2>
129+
<div class="inherited-list">
130+
<h3 id="fields-inherited-from-class-com.datastax.astra.client.core.options.BaseOptions">Fields inherited from class&nbsp;com.datastax.astra.client.core.options.<a href="../core/options/BaseOptions.html" title="class in com.datastax.astra.client.core.options">BaseOptions</a></h3>
131+
<code><a href="../core/options/BaseOptions.html#commandType">commandType</a>, <a href="../core/options/BaseOptions.html#dataAPIClientOptions">dataAPIClientOptions</a>, <a href="../core/options/BaseOptions.html#serializer">serializer</a>, <a href="../core/options/BaseOptions.html#token">token</a></code></div>
132+
</section>
133+
</li>
134+
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
135+
<li>
136+
<section class="constructor-summary" id="constructor-summary">
137+
<h2>Constructor Summary</h2>
138+
<div class="caption"><span>Constructors</span></div>
139+
<div class="summary-table two-column-summary">
140+
<div class="table-header col-first">Constructor</div>
141+
<div class="table-header col-last">Description</div>
142+
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">AdminOptions</a>()</code></div>
143+
<div class="col-last even-row-color">
144+
<div class="block">Serializer for the collections.</div>
145+
</div>
146+
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,com.datastax.astra.client.core.options.DataAPIClientOptions)" class="member-name-link">AdminOptions</a><wbr>(<a href="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>&nbsp;token,
147+
<a href="../core/options/DataAPIClientOptions.html" title="class in com.datastax.astra.client.core.options">DataAPIClientOptions</a>&nbsp;options)</code></div>
148+
<div class="col-last odd-row-color">
149+
<div class="block">Constructs an <code>AdminOptions</code> instance with the specified token and options.</div>
150+
</div>
151+
</div>
152+
</section>
153+
</li>
154+
<!-- ========== METHOD SUMMARY =========== -->
155+
<li>
156+
<section class="method-summary" id="method-summary">
157+
<h2>Method Summary</h2>
158+
<div class="inherited-list">
159+
<h3 id="methods-inherited-from-class-com.datastax.astra.client.core.options.BaseOptions">Methods inherited from class&nbsp;com.datastax.astra.client.core.options.<a href="../core/options/BaseOptions.html" title="class in com.datastax.astra.client.core.options">BaseOptions</a></h3>
160+
<code><a href="../core/options/BaseOptions.html#adminAdditionalHeaders(java.util.Map)">adminAdditionalHeaders</a>, <a href="../core/options/BaseOptions.html#clone()">clone</a>, <a href="../core/options/BaseOptions.html#commandType(com.datastax.astra.client.core.commands.CommandType)">commandType</a>, <a href="../core/options/BaseOptions.html#dataAPIClientOptions(com.datastax.astra.client.core.options.DataAPIClientOptions)">dataAPIClientOptions</a>, <a href="../core/options/BaseOptions.html#databaseAdditionalHeaders(java.util.Map)">databaseAdditionalHeaders</a>, <a href="../core/options/BaseOptions.html#embeddingApiKey(java.lang.String)">embeddingApiKey</a>, <a href="../core/options/BaseOptions.html#embeddingAuthProvider(com.datastax.astra.client.core.auth.EmbeddingHeadersProvider)">embeddingAuthProvider</a>, <a href="../core/options/BaseOptions.html#getCommandType()">getCommandType</a>, <a href="../core/options/BaseOptions.html#getDataAPIClientOptions()">getDataAPIClientOptions</a>, <a href="../core/options/BaseOptions.html#getRequestTimeout()">getRequestTimeout</a>, <a href="../core/options/BaseOptions.html#getRequestTimeout(com.datastax.astra.client.core.options.TimeoutOptions,com.datastax.astra.client.core.commands.CommandType)">getRequestTimeout</a>, <a href="../core/options/BaseOptions.html#getSerializer()">getSerializer</a>, <a href="../core/options/BaseOptions.html#getTimeout()">getTimeout</a>, <a href="../core/options/BaseOptions.html#getTimeout(com.datastax.astra.client.core.options.TimeoutOptions,com.datastax.astra.client.core.commands.CommandType)">getTimeout</a>, <a href="../core/options/BaseOptions.html#getToken()">getToken</a>, <a href="../core/options/BaseOptions.html#httpClientOptions(com.datastax.astra.client.core.http.HttpClientOptions)">httpClientOptions</a>, <a href="../core/options/BaseOptions.html#registerObserver(java.lang.String,com.datastax.astra.internal.command.CommandObserver)">registerObserver</a>, <a href="../core/options/BaseOptions.html#serializer(com.datastax.astra.internal.serdes.DataAPISerializer)">serializer</a>, <a href="../core/options/BaseOptions.html#timeout(long)">timeout</a>, <a href="../core/options/BaseOptions.html#timeout(long,com.datastax.astra.client.core.commands.CommandType)">timeout</a>, <a href="../core/options/BaseOptions.html#timeout(java.time.Duration)">timeout</a>, <a href="../core/options/BaseOptions.html#timeoutOptions(com.datastax.astra.client.core.options.TimeoutOptions)">timeoutOptions</a>, <a href="../core/options/BaseOptions.html#token(java.lang.String)">token</a>, <a href="../core/options/BaseOptions.html#toString()">toString</a>, <a href="../core/options/BaseOptions.html#unregisterObserver(java.lang.String)">unregisterObserver</a></code></div>
161+
<div class="inherited-list">
162+
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
163+
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
164+
</section>
165+
</li>
166+
</ul>
167+
</section>
168+
<section class="details">
169+
<ul class="details-list">
170+
<!-- ========= CONSTRUCTOR DETAIL ======== -->
171+
<li>
172+
<section class="constructor-details" id="constructor-detail">
173+
<h2>Constructor Details</h2>
174+
<ul class="member-list">
175+
<li>
176+
<section class="detail" id="&lt;init&gt;()">
177+
<h3>AdminOptions</h3>
178+
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">AdminOptions</span>()</div>
179+
<div class="block">Serializer for the collections.
180+
Defaults to <a href="../../internal/serdes/DatabaseSerializer.html" title="class in com.datastax.astra.internal.serdes"><code>DatabaseSerializer</code></a>.</div>
181+
</section>
182+
</li>
183+
<li>
184+
<section class="detail" id="&lt;init&gt;(java.lang.String,com.datastax.astra.client.core.options.DataAPIClientOptions)">
185+
<h3>AdminOptions</h3>
186+
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">AdminOptions</span><wbr><span class="parameters">(<a href="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>&nbsp;token,
187+
<a href="../core/options/DataAPIClientOptions.html" title="class in com.datastax.astra.client.core.options">DataAPIClientOptions</a>&nbsp;options)</span></div>
188+
<div class="block">Constructs an <code>AdminOptions</code> instance with the specified token and options.</div>
189+
<dl class="notes">
190+
<dt>Parameters:</dt>
191+
<dd><code>token</code> - the authentication token to use.</dd>
192+
<dd><code>options</code> - additional configuration options for the Data API client.</dd>
193+
</dl>
194+
</section>
195+
</li>
196+
</ul>
197+
</section>
198+
</li>
199+
</ul>
200+
</section>
201+
<!-- ========= END OF CLASS DATA ========= -->
202+
</main>
203+
<footer role="contentinfo">
204+
<hr>
205+
<p class="legal-copy"><small>Copyright &#169; 2024 <a href="https://www.datastax.com">DataStax</a>. All rights reserved.</small></p>
206+
</footer>
207+
</div>
208+
</div>
209+
</body>
210+
</html>

0 commit comments

Comments
 (0)