Adding first 2.0 version

datastaxdevs · Dec 2, 2024 · 9f70f4a · 9f70f4a
1 parent fddf249
commit 9f70f4a
Show file tree

Hide file tree

Showing 625 changed files with 116,332 additions and 0 deletions.
diff --git a/astra-db-java/2.0.0-PREVIEW/allclasses-index.html b/astra-db-java/2.0.0-PREVIEW/allclasses-index.html
diff --git a/astra-db-java/2.0.0-PREVIEW/allpackages-index.html b/astra-db-java/2.0.0-PREVIEW/allpackages-index.html
diff --git a/astra-db-java/2.0.0-PREVIEW/com/datastax/astra/client/DataAPIClient.html b/astra-db-java/2.0.0-PREVIEW/com/datastax/astra/client/DataAPIClient.html
diff --git a/astra-db-java/2.0.0-PREVIEW/com/datastax/astra/client/DataAPIClients.html b/astra-db-java/2.0.0-PREVIEW/com/datastax/astra/client/DataAPIClients.html
diff --git a/astra-db-java/2.0.0-PREVIEW/com/datastax/astra/client/DataAPIDestination.html b/astra-db-java/2.0.0-PREVIEW/com/datastax/astra/client/DataAPIDestination.html
diff --git a/astra-db-java/2.0.0-PREVIEW/com/datastax/astra/client/admin/AdminOptions.html b/astra-db-java/2.0.0-PREVIEW/com/datastax/astra/client/admin/AdminOptions.html
@@ -0,0 +1,210 @@
+<!DOCTYPE HTML>
+<html lang>
+<head>
+<!-- Generated by javadoc (21) on Mon Dec 02 17:27:28 CET 2024 -->
+<title>AdminOptions (Java Client Library for Data API 2.0.0-SNAPSHOT API)</title>
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta name="dc.created" content="2024-12-02">
+<meta name="description" content="declaration: package: com.datastax.astra.client.admin, class: AdminOptions">
+<meta name="generator" content="javadoc/ClassWriterImpl">
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
+<script type="text/javascript" src="../../../../../script.js"></script>
+<script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script>
+<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
+</head>
+<body class="class-declaration-page">
+<script type="text/javascript">var pathtoroot = "../../../../../";
+loadScripts(document, 'script');</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<div class="flex-box">
+<header role="banner" class="flex-header">
+<nav role="navigation">
+<!-- ========= START OF TOP NAVBAR ======= -->
+<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>
+<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
+<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
+<li><a href="../../../../../index.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="nav-bar-cell1-rev">Class</li>
+<li><a href="class-use/AdminOptions.html">Use</a></li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../help-doc.html#class">Help</a></li>
+</ul>
+<ul class="sub-nav-list-small">
+<li>
+<p>Summary:</p>
+<ul>
+<li>Nested</li>
+<li><a href="#field-summary">Field</a></li>
+<li><a href="#constructor-summary">Constr</a></li>
+<li><a href="#method-summary">Method</a></li>
+</ul>
+</li>
+<li>
+<p>Detail:</p>
+<ul>
+<li>Field</li>
+<li><a href="#constructor-detail">Constr</a></li>
+<li>Method</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="sub-nav">
+<div id="navbar-sub-list">
+<ul class="sub-nav-list">
+<li>Summary:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
+<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method-summary">Method</a></li>
+</ul>
+<ul class="sub-nav-list">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
+<li>Method</li>
+</ul>
+</div>
+<div class="nav-list-search"><a href="../../../../../search.html">SEARCH</a>
+<input type="text" id="search-input" disabled placeholder="Search">
+<input type="reset" id="reset-button" disabled value="reset">
+</div>
+</div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<span class="skip-nav" id="skip-navbar-top"></span></nav>
+</header>
+<div class="flex-content">
+<main role="main">
+<!-- ======== START OF CLASS DATA ======== -->
+<div class="header">
+<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>
+<h1 title="Class AdminOptions" class="title">Class AdminOptions</h1>
+</div>
+<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>
+<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;
+<div class="inheritance">com.datastax.astra.client.admin.AdminOptions</div>
+</div>
+</div>
+<section class="class-description" id="class-description">
+<dl class="notes">
+<dt>All Implemented Interfaces:</dt>
+<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>
+</dl>
+<hr>
+<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">AdminOptions</span>
+<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>
+<div class="block">Represents the configuration options for administrative operations in the database API.
+ 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
+ and provides additional functionality specific to administrative commands.
+
+ <p>Example usage:</p>
+ <pre>
+ <code>
+ AdminOptions options = new AdminOptions()
+     .token("your-token-here")
+     .options(new DataAPIClientOptions())
+     .serializer(new CustomSerializer());
+ </code>
+ </pre>
+
+ <p>Key Features:</p>
+ <ul>
+   <li>Provides default serialization through <a href="../../internal/serdes/DatabaseSerializer.html" title="class in com.datastax.astra.internal.serdes"><code>DatabaseSerializer</code></a>.</li>
+   <li>Fluent and chainable setter methods for seamless configuration.</li>
+   <li>Supports administrative command types via <a href="../core/commands/CommandType.html#DATABASE_ADMIN"><code>CommandType.DATABASE_ADMIN</code></a>.</li>
+ </ul></div>
+</section>
+<section class="summary">
+<ul class="summary-list">
+<!-- =========== FIELD SUMMARY =========== -->
+<li>
+<section class="field-summary" id="field-summary">
+<h2>Field Summary</h2>
+<div class="inherited-list">
+<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>
+<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>
+</section>
+</li>
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+<li>
+<section class="constructor-summary" id="constructor-summary">
+<h2>Constructor Summary</h2>
+<div class="caption"><span>Constructors</span></div>
+<div class="summary-table two-column-summary">
+<div class="table-header col-first">Constructor</div>
+<div class="table-header col-last">Description</div>
+<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">AdminOptions</a>()</code></div>
+<div class="col-last even-row-color">
+<div class="block">Serializer for the collections.</div>
+</div>
+<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,
+ <a href="../core/options/DataAPIClientOptions.html" title="class in com.datastax.astra.client.core.options">DataAPIClientOptions</a>&nbsp;options)</code></div>
+<div class="col-last odd-row-color">
+<div class="block">Constructs an <code>AdminOptions</code> instance with the specified token and options.</div>
+</div>
+</div>
+</section>
+</li>
+<!-- ========== METHOD SUMMARY =========== -->
+<li>
+<section class="method-summary" id="method-summary">
+<h2>Method Summary</h2>
+<div class="inherited-list">
+<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>
+<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>
+<div class="inherited-list">
+<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>
+<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>
+</section>
+</li>
+</ul>
+</section>
+<section class="details">
+<ul class="details-list">
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<li>
+<section class="constructor-details" id="constructor-detail">
+<h2>Constructor Details</h2>
+<ul class="member-list">
+<li>
+<section class="detail" id="&lt;init&gt;()">
+<h3>AdminOptions</h3>
+<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">AdminOptions</span>()</div>
+<div class="block">Serializer for the collections.
+ Defaults to <a href="../../internal/serdes/DatabaseSerializer.html" title="class in com.datastax.astra.internal.serdes"><code>DatabaseSerializer</code></a>.</div>
+</section>
+</li>
+<li>
+<section class="detail" id="&lt;init&gt;(java.lang.String,com.datastax.astra.client.core.options.DataAPIClientOptions)">
+<h3>AdminOptions</h3>
+<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,
+ <a href="../core/options/DataAPIClientOptions.html" title="class in com.datastax.astra.client.core.options">DataAPIClientOptions</a>&nbsp;options)</span></div>
+<div class="block">Constructs an <code>AdminOptions</code> instance with the specified token and options.</div>
+<dl class="notes">
+<dt>Parameters:</dt>
+<dd><code>token</code> - the authentication token to use.</dd>
+<dd><code>options</code> - additional configuration options for the Data API client.</dd>
+</dl>
+</section>
+</li>
+</ul>
+</section>
+</li>
+</ul>
+</section>
+<!-- ========= END OF CLASS DATA ========= -->
+</main>
+<footer role="contentinfo">
+<hr>
+<p class="legal-copy"><small>Copyright &#169; 2024 <a href="https://www.datastax.com">DataStax</a>. All rights reserved.</small></p>
+</footer>
+</div>
+</div>
+</body>
+</html>