Skip to content

Commit

Permalink
Update Javadoc.
Browse files Browse the repository at this point in the history
  • Loading branch information
@eventstore-bot
eventstore-bot committed May 23, 2024
1 parent 1a4817a commit 28f6d99
Show file tree
Hide file tree
Showing 629 changed files with 5,702 additions and 2,257 deletions.
1,208 changes: 623 additions & 585 deletions docs/allclasses-index.html
View file

Large diffs are not rendered by default.

11 changes: 10 additions & 1 deletion docs/allclasses.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>All Classes (db-client-java 5.3.2 API)</title>
<title>All Classes (db-client-java 5.4.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
Expand All @@ -27,6 +27,15 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="com/eventstore/dbclient/Acls.html" title="class in com.eventstore.dbclient">Acls</a></li>
<li><a href="com/eventstore/dbclient/AppendToStreamOptions.html" title="class in com.eventstore.dbclient">AppendToStreamOptions</a></li>
<li><a href="com/eventstore/dbclient/Checkpointer.html" title="interface in com.eventstore.dbclient"><span class="interfaceName">Checkpointer</span></a></li>
<li><a href="com/eventstore/dbclient/ClientCertificate.html" title="class in com.eventstore.dbclient">ClientCertificate</a></li>
<li><a href="com/eventstore/dbclient/ClientTelemetryAttributes.html" title="class in com.eventstore.dbclient">ClientTelemetryAttributes</a></li>
<li><a href="com/eventstore/dbclient/ClientTelemetryAttributes.Database.html" title="class in com.eventstore.dbclient">ClientTelemetryAttributes.Database</a></li>
<li><a href="com/eventstore/dbclient/ClientTelemetryAttributes.EventStore.html" title="class in com.eventstore.dbclient">ClientTelemetryAttributes.EventStore</a></li>
<li><a href="com/eventstore/dbclient/ClientTelemetryAttributes.Exceptions.html" title="class in com.eventstore.dbclient">ClientTelemetryAttributes.Exceptions</a></li>
<li><a href="com/eventstore/dbclient/ClientTelemetryAttributes.Server.html" title="class in com.eventstore.dbclient">ClientTelemetryAttributes.Server</a></li>
<li><a href="com/eventstore/dbclient/ClientTelemetryConstants.html" title="class in com.eventstore.dbclient">ClientTelemetryConstants</a></li>
<li><a href="com/eventstore/dbclient/ClientTelemetryConstants.Metadata.html" title="class in com.eventstore.dbclient">ClientTelemetryConstants.Metadata</a></li>
<li><a href="com/eventstore/dbclient/ClientTelemetryConstants.Operations.html" title="class in com.eventstore.dbclient">ClientTelemetryConstants.Operations</a></li>
<li><a href="com/eventstore/dbclient/ClusterInfo.html" title="class in com.eventstore.dbclient">ClusterInfo</a></li>
<li><a href="com/eventstore/dbclient/ClusterInfo.Member.html" title="class in com.eventstore.dbclient">ClusterInfo.Member</a></li>
<li><a href="com/eventstore/dbclient/ClusterInfo.MemberState.html" title="enum in com.eventstore.dbclient">ClusterInfo.MemberState</a></li>
Expand Down
4 changes: 2 additions & 2 deletions docs/allpackages-index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>All Packages (db-client-java 5.3.2 API)</title>
<title>All Packages (db-client-java 5.4.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
Expand All @@ -21,7 +21,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="All Packages (db-client-java 5.3.2 API)";
parent.document.title="All Packages (db-client-java 5.4.0 API)";
}
}
catch(err) {
Expand Down
16 changes: 8 additions & 8 deletions docs/com/eventstore/dbclient/AbortProjectionOptions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>AbortProjectionOptions (db-client-java 5.3.2 API)</title>
<title>AbortProjectionOptions (db-client-java 5.4.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.min.css" title="Style">
Expand All @@ -21,7 +21,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AbortProjectionOptions (db-client-java 5.3.2 API)";
parent.document.title="AbortProjectionOptions (db-client-java 5.4.0 API)";
}
}
catch(err) {
Expand Down Expand Up @@ -156,22 +156,22 @@ <h3>Method Summary</h3>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>T</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#authenticated(com.eventstore.dbclient.UserCredentials)">authenticated</a></span>&#8203;(<a href="UserCredentials.html" title="class in com.eventstore.dbclient">UserCredentials</a>&nbsp;credentials)</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink">authenticated</span>&#8203;(<a href="UserCredentials.html" title="class in com.eventstore.dbclient">UserCredentials</a>&nbsp;credentials)</code></th>
<td class="colLast">
<div class="block">Sets user credentials for the request</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>T</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#authenticated(java.lang.String,java.lang.String)">authenticated</a></span>&#8203;(java.lang.String&nbsp;login,
<th class="colSecond" scope="row"><code><span class="memberNameLink">authenticated</span>&#8203;(java.lang.String&nbsp;login,
java.lang.String&nbsp;password)</code></th>
<td class="colLast">
<div class="block">Sets user credentials for the request</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>T</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deadline(long)">deadline</a></span>&#8203;(long&nbsp;durationInMs)</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink">deadline</span>&#8203;(long&nbsp;durationInMs)</code></th>
<td class="colLast">
<div class="block">A length of time (in milliseconds) to use for gRPC deadlines.</div>
</td>
Expand All @@ -185,21 +185,21 @@ <h3>Method Summary</h3>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>T</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#notRequireLeader()">notRequireLeader</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink">notRequireLeader</span>()</code></th>
<td class="colLast">
<div class="block">Do not require the request to be performed by the leader of the cluster.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>T</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#requiresLeader()">requiresLeader</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink">requiresLeader</span>()</code></th>
<td class="colLast">
<div class="block">Requires the request to be performed by the leader of the cluster.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>T</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#requiresLeader(boolean)">requiresLeader</a></span>&#8203;(boolean&nbsp;value)</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink">requiresLeader</span>&#8203;(boolean&nbsp;value)</code></th>
<td class="colLast">
<div class="block">If true, requires the request to be performed by the leader of the cluster.</div>
</td>
Expand Down
4 changes: 2 additions & 2 deletions docs/com/eventstore/dbclient/Acl.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Acl (db-client-java 5.3.2 API)</title>
<title>Acl (db-client-java 5.4.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.min.css" title="Style">
Expand All @@ -21,7 +21,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Acl (db-client-java 5.3.2 API)";
parent.document.title="Acl (db-client-java 5.4.0 API)";
}
}
catch(err) {
Expand Down
4 changes: 2 additions & 2 deletions docs/com/eventstore/dbclient/Acls.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Acls (db-client-java 5.3.2 API)</title>
<title>Acls (db-client-java 5.4.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.min.css" title="Style">
Expand All @@ -21,7 +21,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Acls (db-client-java 5.3.2 API)";
parent.document.title="Acls (db-client-java 5.4.0 API)";
}
}
catch(err) {
Expand Down
20 changes: 10 additions & 10 deletions docs/com/eventstore/dbclient/AppendToStreamOptions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>AppendToStreamOptions (db-client-java 5.3.2 API)</title>
<title>AppendToStreamOptions (db-client-java 5.4.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.min.css" title="Style">
Expand All @@ -21,7 +21,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AppendToStreamOptions (db-client-java 5.3.2 API)";
parent.document.title="AppendToStreamOptions (db-client-java 5.4.0 API)";
}
}
catch(err) {
Expand Down Expand Up @@ -156,36 +156,36 @@ <h3>Method Summary</h3>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>T</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#authenticated(com.eventstore.dbclient.UserCredentials)">authenticated</a></span>&#8203;(<a href="UserCredentials.html" title="class in com.eventstore.dbclient">UserCredentials</a>&nbsp;credentials)</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink">authenticated</span>&#8203;(<a href="UserCredentials.html" title="class in com.eventstore.dbclient">UserCredentials</a>&nbsp;credentials)</code></th>
<td class="colLast">
<div class="block">Sets user credentials for the request</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>T</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#authenticated(java.lang.String,java.lang.String)">authenticated</a></span>&#8203;(java.lang.String&nbsp;login,
<th class="colSecond" scope="row"><code><span class="memberNameLink">authenticated</span>&#8203;(java.lang.String&nbsp;login,
java.lang.String&nbsp;password)</code></th>
<td class="colLast">
<div class="block">Sets user credentials for the request</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>T</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deadline(long)">deadline</a></span>&#8203;(long&nbsp;durationInMs)</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink">deadline</span>&#8203;(long&nbsp;durationInMs)</code></th>
<td class="colLast">
<div class="block">A length of time (in milliseconds) to use for gRPC deadlines.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>T</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#expectedRevision(long)">expectedRevision</a></span>&#8203;(long&nbsp;revision)</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink">expectedRevision</span>&#8203;(long&nbsp;revision)</code></th>
<td class="colLast">
<div class="block">Asks the server to check that the stream receiving is at the given expected version.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>T</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#expectedRevision(com.eventstore.dbclient.ExpectedRevision)">expectedRevision</a></span>&#8203;(<a href="ExpectedRevision.html" title="class in com.eventstore.dbclient">ExpectedRevision</a>&nbsp;revision)</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink">expectedRevision</span>&#8203;(<a href="ExpectedRevision.html" title="class in com.eventstore.dbclient">ExpectedRevision</a>&nbsp;revision)</code></th>
<td class="colLast">
<div class="block">Asks the server to check that the stream receiving is at the given expected version.</div>
</td>
Expand All @@ -199,21 +199,21 @@ <h3>Method Summary</h3>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>T</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#notRequireLeader()">notRequireLeader</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink">notRequireLeader</span>()</code></th>
<td class="colLast">
<div class="block">Do not require the request to be performed by the leader of the cluster.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>T</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#requiresLeader()">requiresLeader</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink">requiresLeader</span>()</code></th>
<td class="colLast">
<div class="block">Requires the request to be performed by the leader of the cluster.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>T</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#requiresLeader(boolean)">requiresLeader</a></span>&#8203;(boolean&nbsp;value)</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink">requiresLeader</span>&#8203;(boolean&nbsp;value)</code></th>
<td class="colLast">
<div class="block">If true, requires the request to be performed by the leader of the cluster.</div>
</td>
Expand Down
4 changes: 2 additions & 2 deletions docs/com/eventstore/dbclient/Checkpointer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Checkpointer (db-client-java 5.3.2 API)</title>
<title>Checkpointer (db-client-java 5.4.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.min.css" title="Style">
Expand All @@ -21,7 +21,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Checkpointer (db-client-java 5.3.2 API)";
parent.document.title="Checkpointer (db-client-java 5.4.0 API)";
}
}
catch(err) {
Expand Down
Loading

0 comments on commit 28f6d99

Please sign in to comment.