Skip to content

Commit 90b97bb

Browse files
swallezswallez
committed
Escape HTML in javadocs (needs more work to format API descriptions)
1 parent f095739 commit 90b97bb

File tree

71 files changed

+1414
-4210
lines changed

Some content is hidden

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

71 files changed

+1414
-4210
lines changed

‎java-client/src/main/java/co/elastic/clients/base/Endpoint.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ class Simple<RequestT, ResponseT> implements Endpoint<RequestT, ResponseT, Elast
8080
private static final Function<?, Map<String, String>> EMPTY_MAP = x -> Collections.emptyMap();
8181

8282
/**
83-
* Returns a function that always returns an empty String -> String map. Useful to avoid creating lots of
83+
* Returns a function that always returns an empty String to String map. Useful to avoid creating lots of
8484
* duplicate lambdas in endpoints that don't have headers or parameters.
8585
*/
8686
@SuppressWarnings("unchecked")

‎java-client/src/main/java/co/elastic/clients/elasticsearch/ElasticsearchAsyncClient.java

Lines changed: 74 additions & 222 deletions
Large diffs are not rendered by default.

‎java-client/src/main/java/co/elastic/clients/elasticsearch/ElasticsearchClient.java

Lines changed: 74 additions & 222 deletions
Large diffs are not rendered by default.

‎java-client/src/main/java/co/elastic/clients/elasticsearch/api/async_search/AsyncSearchAsyncClient.java

Lines changed: 8 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,7 @@ public AsyncSearchAsyncClient(Transport transport, RequestOptions options) {
5959
* Deletes an async search by ID. If the search is still running, the search
6060
* request will be cancelled. Otherwise, the saved search results are deleted.
6161
*
62-
* @see <a href=
63-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html">Documentation
64-
* on elastic.co</a>
62+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html"
6563
*/
6664

6765
public CompletableFuture<DeleteResponse> delete(DeleteRequest request) throws IOException {
@@ -72,9 +70,7 @@ public CompletableFuture<DeleteResponse> delete(DeleteRequest request) throws IO
7270
* Deletes an async search by ID. If the search is still running, the search
7371
* request will be cancelled. Otherwise, the saved search results are deleted.
7472
*
75-
* @see <a href=
76-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html">Documentation
77-
* on elastic.co</a>
73+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html"
7874
* @param fn
7975
* a function that initializes a freshly created builder. This
8076
* function can either return its builder argument after having set
@@ -92,9 +88,7 @@ public final CompletableFuture<DeleteResponse> delete(
9288
* Retrieves the results of a previously submitted async search request given
9389
* its ID.
9490
*
95-
* @see <a href=
96-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html">Documentation
97-
* on elastic.co</a>
91+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html"
9892
*/
9993

10094
public <TDocument> CompletableFuture<GetResponse<TDocument>> get(GetRequest request,
@@ -107,9 +101,7 @@ public <TDocument> CompletableFuture<GetResponse<TDocument>> get(GetRequest requ
107101
* Retrieves the results of a previously submitted async search request given
108102
* its ID.
109103
*
110-
* @see <a href=
111-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html">Documentation
112-
* on elastic.co</a>
104+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html"
113105
* @param fn
114106
* a function that initializes a freshly created builder. This
115107
* function can either return its builder argument after having set
@@ -128,9 +120,7 @@ public final <TDocument> CompletableFuture<GetResponse<TDocument>> get(
128120
* Retrieves the status of a previously submitted async search request given its
129121
* ID.
130122
*
131-
* @see <a href=
132-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html">Documentation
133-
* on elastic.co</a>
123+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html"
134124
*/
135125

136126
public <TDocument> CompletableFuture<StatusResponse<TDocument>> status(StatusRequest request,
@@ -143,9 +133,7 @@ public <TDocument> CompletableFuture<StatusResponse<TDocument>> status(StatusReq
143133
* Retrieves the status of a previously submitted async search request given its
144134
* ID.
145135
*
146-
* @see <a href=
147-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html">Documentation
148-
* on elastic.co</a>
136+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html"
149137
* @param fn
150138
* a function that initializes a freshly created builder. This
151139
* function can either return its builder argument after having set
@@ -163,9 +151,7 @@ public final <TDocument> CompletableFuture<StatusResponse<TDocument>> status(
163151
/**
164152
* Executes a search request asynchronously.
165153
*
166-
* @see <a href=
167-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html">Documentation
168-
* on elastic.co</a>
154+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html"
169155
*/
170156

171157
public <TDocument> CompletableFuture<SubmitResponse<TDocument>> submit(SubmitRequest request,
@@ -177,9 +163,7 @@ public <TDocument> CompletableFuture<SubmitResponse<TDocument>> submit(SubmitReq
177163
/**
178164
* Executes a search request asynchronously.
179165
*
180-
* @see <a href=
181-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html">Documentation
182-
* on elastic.co</a>
166+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html"
183167
* @param fn
184168
* a function that initializes a freshly created builder. This
185169
* function can either return its builder argument after having set

‎java-client/src/main/java/co/elastic/clients/elasticsearch/api/async_search/AsyncSearchClient.java

Lines changed: 8 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,7 @@ public AsyncSearchClient(Transport transport, RequestOptions options) {
5858
* Deletes an async search by ID. If the search is still running, the search
5959
* request will be cancelled. Otherwise, the saved search results are deleted.
6060
*
61-
* @see <a href=
62-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html">Documentation
63-
* on elastic.co</a>
61+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html"
6462
*/
6563

6664
public DeleteResponse delete(DeleteRequest request) throws IOException {
@@ -71,9 +69,7 @@ public DeleteResponse delete(DeleteRequest request) throws IOException {
7169
* Deletes an async search by ID. If the search is still running, the search
7270
* request will be cancelled. Otherwise, the saved search results are deleted.
7371
*
74-
* @see <a href=
75-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html">Documentation
76-
* on elastic.co</a>
72+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html"
7773
* @param fn
7874
* a function that initializes a freshly created builder. This
7975
* function can either return its builder argument after having set
@@ -91,9 +87,7 @@ public final DeleteResponse delete(Function<DeleteRequest.Builder, ObjectBuilder
9187
* Retrieves the results of a previously submitted async search request given
9288
* its ID.
9389
*
94-
* @see <a href=
95-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html">Documentation
96-
* on elastic.co</a>
90+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html"
9791
*/
9892

9993
public <TDocument> GetResponse<TDocument> get(GetRequest request, Class<TDocument> tDocumentClass)
@@ -106,9 +100,7 @@ public <TDocument> GetResponse<TDocument> get(GetRequest request, Class<TDocumen
106100
* Retrieves the results of a previously submitted async search request given
107101
* its ID.
108102
*
109-
* @see <a href=
110-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html">Documentation
111-
* on elastic.co</a>
103+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html"
112104
* @param fn
113105
* a function that initializes a freshly created builder. This
114106
* function can either return its builder argument after having set
@@ -126,9 +118,7 @@ public final <TDocument> GetResponse<TDocument> get(Function<GetRequest.Builder,
126118
* Retrieves the status of a previously submitted async search request given its
127119
* ID.
128120
*
129-
* @see <a href=
130-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html">Documentation
131-
* on elastic.co</a>
121+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html"
132122
*/
133123

134124
public <TDocument> StatusResponse<TDocument> status(StatusRequest request, Class<TDocument> tDocumentClass)
@@ -141,9 +131,7 @@ public <TDocument> StatusResponse<TDocument> status(StatusRequest request, Class
141131
* Retrieves the status of a previously submitted async search request given its
142132
* ID.
143133
*
144-
* @see <a href=
145-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html">Documentation
146-
* on elastic.co</a>
134+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html"
147135
* @param fn
148136
* a function that initializes a freshly created builder. This
149137
* function can either return its builder argument after having set
@@ -161,9 +149,7 @@ public final <TDocument> StatusResponse<TDocument> status(
161149
/**
162150
* Executes a search request asynchronously.
163151
*
164-
* @see <a href=
165-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html">Documentation
166-
* on elastic.co</a>
152+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html"
167153
*/
168154

169155
public <TDocument> SubmitResponse<TDocument> submit(SubmitRequest request, Class<TDocument> tDocumentClass)
@@ -175,9 +161,7 @@ public <TDocument> SubmitResponse<TDocument> submit(SubmitRequest request, Class
175161
/**
176162
* Executes a search request asynchronously.
177163
*
178-
* @see <a href=
179-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html">Documentation
180-
* on elastic.co</a>
164+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html"
181165
* @param fn
182166
* a function that initializes a freshly created builder. This
183167
* function can either return its builder argument after having set

‎java-client/src/main/java/co/elastic/clients/elasticsearch/api/autoscaling/AutoscalingAsyncClient.java

Lines changed: 8 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,7 @@ public AutoscalingAsyncClient(Transport transport, RequestOptions options) {
5959
* Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK.
6060
* Direct use is not supported.
6161
*
62-
* @see <a href=
63-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-delete-autoscaling-policy.html">Documentation
64-
* on elastic.co</a>
62+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-delete-autoscaling-policy.html"
6563
*/
6664

6765
public CompletableFuture<PolicyDeleteResponse> deleteAutoscalingPolicy(PolicyDeleteRequest request)
@@ -73,9 +71,7 @@ public CompletableFuture<PolicyDeleteResponse> deleteAutoscalingPolicy(PolicyDel
7371
* Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK.
7472
* Direct use is not supported.
7573
*
76-
* @see <a href=
77-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-delete-autoscaling-policy.html">Documentation
78-
* on elastic.co</a>
74+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-delete-autoscaling-policy.html"
7975
* @param fn
8076
* a function that initializes a freshly created builder. This
8177
* function can either return its builder argument after having set
@@ -94,9 +90,7 @@ public final CompletableFuture<PolicyDeleteResponse> deleteAutoscalingPolicy(
9490
* policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not
9591
* supported.
9692
*
97-
* @see <a href=
98-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-capacity.html">Documentation
99-
* on elastic.co</a>
93+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-capacity.html"
10094
*/
10195

10296
public CompletableFuture<CapacityGetResponse> getAutoscalingCapacity(CapacityGetRequest request)
@@ -109,9 +103,7 @@ public CompletableFuture<CapacityGetResponse> getAutoscalingCapacity(CapacityGet
109103
* policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not
110104
* supported.
111105
*
112-
* @see <a href=
113-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-capacity.html">Documentation
114-
* on elastic.co</a>
106+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-capacity.html"
115107
* @param fn
116108
* a function that initializes a freshly created builder. This
117109
* function can either return its builder argument after having set
@@ -129,9 +121,7 @@ public final CompletableFuture<CapacityGetResponse> getAutoscalingCapacity(
129121
* Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and
130122
* ECK. Direct use is not supported.
131123
*
132-
* @see <a href=
133-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-policy.html">Documentation
134-
* on elastic.co</a>
124+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-policy.html"
135125
*/
136126

137127
public CompletableFuture<PolicyGetResponse> getAutoscalingPolicy(PolicyGetRequest request) throws IOException {
@@ -142,9 +132,7 @@ public CompletableFuture<PolicyGetResponse> getAutoscalingPolicy(PolicyGetReques
142132
* Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and
143133
* ECK. Direct use is not supported.
144134
*
145-
* @see <a href=
146-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-policy.html">Documentation
147-
* on elastic.co</a>
135+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-policy.html"
148136
* @param fn
149137
* a function that initializes a freshly created builder. This
150138
* function can either return its builder argument after having set
@@ -162,9 +150,7 @@ public final CompletableFuture<PolicyGetResponse> getAutoscalingPolicy(
162150
* Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and
163151
* ECK. Direct use is not supported.
164152
*
165-
* @see <a href=
166-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-put-autoscaling-policy.html">Documentation
167-
* on elastic.co</a>
153+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-put-autoscaling-policy.html"
168154
*/
169155

170156
public CompletableFuture<PolicyPutResponse> putAutoscalingPolicy(PolicyPutRequest request) throws IOException {
@@ -175,9 +161,7 @@ public CompletableFuture<PolicyPutResponse> putAutoscalingPolicy(PolicyPutReques
175161
* Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and
176162
* ECK. Direct use is not supported.
177163
*
178-
* @see <a href=
179-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-put-autoscaling-policy.html">Documentation
180-
* on elastic.co</a>
164+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-put-autoscaling-policy.html"
181165
* @param fn
182166
* a function that initializes a freshly created builder. This
183167
* function can either return its builder argument after having set

‎java-client/src/main/java/co/elastic/clients/elasticsearch/api/autoscaling/AutoscalingClient.java

Lines changed: 8 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,7 @@ public AutoscalingClient(Transport transport, RequestOptions options) {
5858
* Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK.
5959
* Direct use is not supported.
6060
*
61-
* @see <a href=
62-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-delete-autoscaling-policy.html">Documentation
63-
* on elastic.co</a>
61+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-delete-autoscaling-policy.html"
6462
*/
6563

6664
public PolicyDeleteResponse deleteAutoscalingPolicy(PolicyDeleteRequest request) throws IOException {
@@ -71,9 +69,7 @@ public PolicyDeleteResponse deleteAutoscalingPolicy(PolicyDeleteRequest request)
7169
* Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK.
7270
* Direct use is not supported.
7371
*
74-
* @see <a href=
75-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-delete-autoscaling-policy.html">Documentation
76-
* on elastic.co</a>
72+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-delete-autoscaling-policy.html"
7773
* @param fn
7874
* a function that initializes a freshly created builder. This
7975
* function can either return its builder argument after having set
@@ -92,9 +88,7 @@ public final PolicyDeleteResponse deleteAutoscalingPolicy(
9288
* policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not
9389
* supported.
9490
*
95-
* @see <a href=
96-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-capacity.html">Documentation
97-
* on elastic.co</a>
91+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-capacity.html"
9892
*/
9993

10094
public CapacityGetResponse getAutoscalingCapacity(CapacityGetRequest request) throws IOException {
@@ -106,9 +100,7 @@ public CapacityGetResponse getAutoscalingCapacity(CapacityGetRequest request) th
106100
* policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not
107101
* supported.
108102
*
109-
* @see <a href=
110-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-capacity.html">Documentation
111-
* on elastic.co</a>
103+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-capacity.html"
112104
* @param fn
113105
* a function that initializes a freshly created builder. This
114106
* function can either return its builder argument after having set
@@ -126,9 +118,7 @@ public final CapacityGetResponse getAutoscalingCapacity(
126118
* Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and
127119
* ECK. Direct use is not supported.
128120
*
129-
* @see <a href=
130-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-policy.html">Documentation
131-
* on elastic.co</a>
121+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-policy.html"
132122
*/
133123

134124
public PolicyGetResponse getAutoscalingPolicy(PolicyGetRequest request) throws IOException {
@@ -139,9 +129,7 @@ public PolicyGetResponse getAutoscalingPolicy(PolicyGetRequest request) throws I
139129
* Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and
140130
* ECK. Direct use is not supported.
141131
*
142-
* @see <a href=
143-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-policy.html">Documentation
144-
* on elastic.co</a>
132+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-policy.html"
145133
* @param fn
146134
* a function that initializes a freshly created builder. This
147135
* function can either return its builder argument after having set
@@ -159,9 +147,7 @@ public final PolicyGetResponse getAutoscalingPolicy(
159147
* Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and
160148
* ECK. Direct use is not supported.
161149
*
162-
* @see <a href=
163-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-put-autoscaling-policy.html">Documentation
164-
* on elastic.co</a>
150+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-put-autoscaling-policy.html"
165151
*/
166152

167153
public PolicyPutResponse putAutoscalingPolicy(PolicyPutRequest request) throws IOException {
@@ -172,9 +158,7 @@ public PolicyPutResponse putAutoscalingPolicy(PolicyPutRequest request) throws I
172158
* Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and
173159
* ECK. Direct use is not supported.
174160
*
175-
* @see <a href=
176-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-put-autoscaling-policy.html">Documentation
177-
* on elastic.co</a>
161+
* @see "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-put-autoscaling-policy.html"
178162
* @param fn
179163
* a function that initializes a freshly created builder. This
180164
* function can either return its builder argument after having set

0 commit comments

Comments
 (0)