Skip to content

Commit 6b455f7

Browse files
clunclun
committed
documentation
1 parent a8c3cd7 commit 6b455f7

File tree

293 files changed

+11968
-8592
lines changed

Some content is hidden

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

293 files changed

+11968
-8592
lines changed

‎astra-db-java/latest/allclasses-index.html

+141-121
Large diffs are not rendered by default.

‎astra-db-java/latest/allpackages-index.html

+24-8
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!DOCTYPE HTML>
22
<html lang="en">
33
<head>
4-
<!-- Generated by javadoc (21) on Thu Mar 28 11:19:13 CET 2024 -->
4+
<!-- Generated by javadoc (21) on Wed Apr 03 14:50:16 CEST 2024 -->
55
<title>All Packages (Java Client Library for Data API 1.0.0-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2024-03-28">
8+
<meta name="dc.created" content="2024-04-03">
99
<meta name="description" content="package index">
1010
<meta name="generator" content="javadoc/AllPackagesIndexWriter">
1111
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -57,27 +57,43 @@ <h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
5757
<div class="table-header col-last">Description</div>
5858
<div class="col-first even-row-color"><a href="com/datastax/astra/client/package-summary.html">com.datastax.astra.client</a></div>
5959
<div class="col-last even-row-color">
60-
<div class="block">Core Data API Client Classes.</div>
60+
<div class="block">Entrypoint and core classes for the client.</div>
6161
</div>
6262
<div class="col-first odd-row-color"><a href="com/datastax/astra/client/admin/package-summary.html">com.datastax.astra.client.admin</a></div>
6363
<div class="col-last odd-row-color">
64-
<div class="block">Admin Data API Client Classes (ddl on databases and namespaces).</div>
64+
<div class="block">Administration classes to manage Databases and Namespaces.</div>
6565
</div>
6666
<div class="col-first even-row-color"><a href="com/datastax/astra/client/exception/package-summary.html">com.datastax.astra.client.exception</a></div>
6767
<div class="col-last even-row-color">
68-
<div class="block">Specialized exceptions thrown by the Client.</div>
68+
<div class="block">Exceptions specialized checked and unchecked thrown by the client.</div>
6969
</div>
7070
<div class="col-first odd-row-color"><a href="com/datastax/astra/client/model/package-summary.html">com.datastax.astra.client.model</a></div>
7171
<div class="col-last odd-row-color">
72-
<div class="block">Dto Used in public interfaces: types, documents `*Options``*Resuult`</div>
72+
<div class="block">Domain model classes with <code>Requests</code>, <code>Results</code>, <code>Options</code> and <code>Iterables</code>.</div>
7373
</div>
7474
<div class="col-first even-row-color"><a href="com/datastax/astra/internal/package-summary.html">com.datastax.astra.internal</a></div>
7575
<div class="col-last even-row-color">
76-
<div class="block">Internal low-level classes implementation for Data API integration</div>
76+
<div class="block">Internal technical classes</div>
77+
</div>
78+
<div class="col-first odd-row-color"><a href="com/datastax/astra/internal/api/package-summary.html">com.datastax.astra.internal.api</a></div>
79+
<div class="col-last odd-row-color">
80+
<div class="block">Internal technical classes to marshall API responses</div>
81+
</div>
82+
<div class="col-first even-row-color"><a href="com/datastax/astra/internal/auth/package-summary.html">com.datastax.astra.internal.auth</a></div>
83+
<div class="col-last even-row-color">
84+
<div class="block">Internal technical classes to authenticate against API endpoint.</div>
85+
</div>
86+
<div class="col-first odd-row-color"><a href="com/datastax/astra/internal/command/package-summary.html">com.datastax.astra.internal.command</a></div>
87+
<div class="col-last odd-row-color">
88+
<div class="block">Internal technical classes to run commands against the API.</div>
89+
</div>
90+
<div class="col-first even-row-color"><a href="com/datastax/astra/internal/http/package-summary.html">com.datastax.astra.internal.http</a></div>
91+
<div class="col-last even-row-color">
92+
<div class="block">Internal technical classes to execute HTTP requests.</div>
7793
</div>
7894
<div class="col-first odd-row-color"><a href="com/datastax/astra/internal/utils/package-summary.html">com.datastax.astra.internal.utils</a></div>
7995
<div class="col-last odd-row-color">
80-
<div class="block">Utilities for low-level classes implementation.</div>
96+
<div class="block">Internal technical classes for low-level utilities</div>
8197
</div>
8298
</div>
8399
</main>

‎astra-db-java/latest/com/datastax/astra/client/Collection.html

+341-239
Large diffs are not rendered by default.

‎astra-db-java/latest/com/datastax/astra/client/DataAPIClient.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!DOCTYPE HTML>
22
<html lang="en">
33
<head>
4-
<!-- Generated by javadoc (21) on Thu Mar 28 11:19:13 CET 2024 -->
4+
<!-- Generated by javadoc (21) on Wed Apr 03 14:50:16 CEST 2024 -->
55
<title>DataAPIClient (Java Client Library for Data API 1.0.0-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2024-03-28">
8+
<meta name="dc.created" content="2024-04-03">
99
<meta name="description" content="declaration: package: com.datastax.astra.client, class: DataAPIClient">
1010
<meta name="generator" content="javadoc/ClassWriterImpl">
1111
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

‎astra-db-java/latest/com/datastax/astra/client/DataAPIClients.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!DOCTYPE HTML>
22
<html lang="en">
33
<head>
4-
<!-- Generated by javadoc (21) on Thu Mar 28 11:19:13 CET 2024 -->
4+
<!-- Generated by javadoc (21) on Wed Apr 03 14:50:16 CEST 2024 -->
55
<title>DataAPIClients (Java Client Library for Data API 1.0.0-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2024-03-28">
8+
<meta name="dc.created" content="2024-04-03">
99
<meta name="description" content="declaration: package: com.datastax.astra.client, class: DataAPIClients">
1010
<meta name="generator" content="javadoc/ClassWriterImpl">
1111
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

‎astra-db-java/latest/com/datastax/astra/client/DataAPIOptions.DataAPIClientOptionsBuilder.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!DOCTYPE HTML>
22
<html lang="en">
33
<head>
4-
<!-- Generated by javadoc (21) on Thu Mar 28 11:19:13 CET 2024 -->
4+
<!-- Generated by javadoc (21) on Wed Apr 03 14:50:16 CEST 2024 -->
55
<title>DataAPIOptions.DataAPIClientOptionsBuilder (Java Client Library for Data API 1.0.0-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2024-03-28">
8+
<meta name="dc.created" content="2024-04-03">
99
<meta name="description" content="declaration: package: com.datastax.astra.client, class: DataAPIOptions, class: DataAPIClientOptionsBuilder">
1010
<meta name="generator" content="javadoc/ClassWriterImpl">
1111
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

‎astra-db-java/latest/com/datastax/astra/client/DataAPIOptions.DataAPIDestination.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!DOCTYPE HTML>
22
<html lang="en">
33
<head>
4-
<!-- Generated by javadoc (21) on Thu Mar 28 11:19:13 CET 2024 -->
4+
<!-- Generated by javadoc (21) on Wed Apr 03 14:50:16 CEST 2024 -->
55
<title>DataAPIOptions.DataAPIDestination (Java Client Library for Data API 1.0.0-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2024-03-28">
8+
<meta name="dc.created" content="2024-04-03">
99
<meta name="description" content="declaration: package: com.datastax.astra.client, class: DataAPIOptions, enum: DataAPIDestination">
1010
<meta name="generator" content="javadoc/ClassWriterImpl">
1111
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

‎astra-db-java/latest/com/datastax/astra/client/DataAPIOptions.HttpClientOptions.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!DOCTYPE HTML>
22
<html lang="en">
33
<head>
4-
<!-- Generated by javadoc (21) on Thu Mar 28 11:19:13 CET 2024 -->
4+
<!-- Generated by javadoc (21) on Wed Apr 03 14:50:16 CEST 2024 -->
55
<title>DataAPIOptions.HttpClientOptions (Java Client Library for Data API 1.0.0-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2024-03-28">
8+
<meta name="dc.created" content="2024-04-03">
99
<meta name="description" content="declaration: package: com.datastax.astra.client, class: DataAPIOptions, class: HttpClientOptions">
1010
<meta name="generator" content="javadoc/ClassWriterImpl">
1111
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

‎astra-db-java/latest/com/datastax/astra/client/DataAPIOptions.HttpProxy.html

+12-5
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!DOCTYPE HTML>
22
<html lang="en">
33
<head>
4-
<!-- Generated by javadoc (21) on Thu Mar 28 11:19:13 CET 2024 -->
4+
<!-- Generated by javadoc (21) on Wed Apr 03 14:50:16 CEST 2024 -->
55
<title>DataAPIOptions.HttpProxy (Java Client Library for Data API 1.0.0-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2024-03-28">
8+
<meta name="dc.created" content="2024-04-03">
99
<meta name="description" content="declaration: package: com.datastax.astra.client, class: DataAPIOptions, class: HttpProxy">
1010
<meta name="generator" content="javadoc/ClassWriterImpl">
1111
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
@@ -109,7 +109,8 @@ <h2>Constructor Summary</h2>
109109
<div class="summary-table two-column-summary">
110110
<div class="table-header col-first">Constructor</div>
111111
<div class="table-header col-last">Description</div>
112-
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">HttpProxy</a>()</code></div>
112+
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,int)" class="member-name-link">HttpProxy</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;hostname,
113+
int&nbsp;port)</code></div>
113114
<div class="col-last even-row-color">
114115
<div class="block">Default constructor.</div>
115116
</div>
@@ -135,10 +136,16 @@ <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from cl
135136
<h2>Constructor Details</h2>
136137
<ul class="member-list">
137138
<li>
138-
<section class="detail" id="&lt;init&gt;()">
139+
<section class="detail" id="&lt;init&gt;(java.lang.String,int)">
139140
<h3>HttpProxy</h3>
140-
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">HttpProxy</span>()</div>
141+
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">HttpProxy</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;hostname,
142+
int&nbsp;port)</span></div>
141143
<div class="block">Default constructor.</div>
144+
<dl class="notes">
145+
<dt>Parameters:</dt>
146+
<dd><code>hostname</code> - host name</dd>
147+
<dd><code>port</code> - roxy port</dd>
148+
</dl>
142149
</section>
143150
</li>
144151
</ul>

‎astra-db-java/latest/com/datastax/astra/client/DataAPIOptions.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!DOCTYPE HTML>
22
<html lang="en">
33
<head>
4-
<!-- Generated by javadoc (21) on Thu Mar 28 11:19:13 CET 2024 -->
4+
<!-- Generated by javadoc (21) on Wed Apr 03 14:50:16 CEST 2024 -->
55
<title>DataAPIOptions (Java Client Library for Data API 1.0.0-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2024-03-28">
8+
<meta name="dc.created" content="2024-04-03">
99
<meta name="description" content="declaration: package: com.datastax.astra.client, class: DataAPIOptions">
1010
<meta name="generator" content="javadoc/ClassWriterImpl">
1111
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

0 commit comments

Comments
 (0)