Merge branch 'main' into add.documentation

Author: szabosteve

java-client/src/main/java/co/elastic/clients/base/rest_client/RestClientTransport.java

@@ -22,7 +22,7 @@
 import co.elastic.clients.base.BooleanEndpoint;
 import co.elastic.clients.base.BooleanResponse;
 import co.elastic.clients.base.ElasticsearchCatRequest;
-import co.elastic.clients.elasticsearch.ElasticsearchException;
+import co.elastic.clients.elasticsearch._types.ElasticsearchException;
 import co.elastic.clients.base.Endpoint;
 import co.elastic.clients.base.Transport;
 import co.elastic.clients.elasticsearch._types.ErrorResponse;

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

@@ -17,44 +17,44 @@
  * under the License.
  */
 
-package co.elastic.clients.elasticsearch;
-
-import co.elastic.clients.elasticsearch._types.ErrorCause;
-import co.elastic.clients.elasticsearch._types.ErrorResponse;
+package co.elastic.clients.elasticsearch._types;
 
 /**
- * Exception thrown by API client methods when Elasticsearch could not accept or process a request.
+ * Exception thrown by API client methods when Elasticsearch could not accept or
+ * process a request.
  * <p>
- * The {@link #error()} contains the error's type and reason along with additional details that depend on the error type and
- * the API endpoint that was called.
+ * The {@link #error()} contains the error's type and reason along with
+ * additional details that depend on the error type and the API endpoint that
+ * was called.
  */
 public class ElasticsearchException extends RuntimeException {
 
-    private final ErrorResponse response;
-
-    public ElasticsearchException(ErrorResponse response) {
-        super(response.error().reason());
-        this.response = response;
-    }
-
-    /**
-     * The error response sent by Elasticsearch
-     */
-    public ErrorResponse response() {
-        return this.response;
-    }
-
-    /**
-     * The cause of the error. Shortcut for {@code response().error()}.
-     */
-    public ErrorCause error() {
-        return this.response.error();
-    }
-
-    /**
-     * Status code returned by Elasticsearch. Shortcut for {@code response().status()}.
-     */
-    public int status() {
-        return this.response.status();
-    }
+	private final ErrorResponse response;
+
+	public ElasticsearchException(ErrorResponse response) {
+		super(response.error().reason());
+		this.response = response;
+	}
+
+	/**
+	 * The error response sent by Elasticsearch
+	 */
+	public ErrorResponse response() {
+		return this.response;
+	}
+
+	/**
+	 * The cause of the error. Shortcut for {@code response().error()}.
+	 */
+	public ErrorCause error() {
+		return this.response.error();
+	}
+
+	/**
+	 * Status code returned by Elasticsearch. Shortcut for
+	 * {@code response().status()}.
+	 */
+	public int status() {
+		return this.response.status();
+	}
 }

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

@@ -25,7 +25,7 @@
 
 import co.elastic.clients.base.ApiClient;
 import co.elastic.clients.base.Transport;
-import co.elastic.clients.elasticsearch.ElasticsearchException;
+import co.elastic.clients.elasticsearch._types.ElasticsearchException;
 import co.elastic.clients.util.ObjectBuilder;
 import java.io.IOException;
 import java.util.concurrent.CompletableFuture;
@@ -52,7 +52,8 @@ public ElasticsearchAsyncSearchAsyncClient(Transport transport) {
 	 *      on elastic.co</a>
 	 */
 
-	public CompletableFuture<DeleteAsyncSearchResponse> delete(DeleteAsyncSearchRequest request) throws IOException {
+	public CompletableFuture<DeleteAsyncSearchResponse> delete(DeleteAsyncSearchRequest request)
+			throws IOException, ElasticsearchException {
 		return this.transport.performRequestAsync(request, DeleteAsyncSearchRequest.ENDPOINT);
 	}
 
@@ -61,16 +62,16 @@ public CompletableFuture<DeleteAsyncSearchResponse> delete(DeleteAsyncSearchRequ
 	 * request will be cancelled. Otherwise, the saved search results are deleted.
 	 * 
 	 * @param fn
-	 *            a function that initializes a freshly created builder. This
-	 *            function can either return its builder argument after having set
-	 *            its properties or return another builder.
+	 *            a function that initializes a builder to create the
+	 *            {@link DeleteAsyncSearchRequest}
 	 * @see <a href=
 	 *      "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html">Documentation
 	 *      on elastic.co</a>
 	 */
 
 	public final CompletableFuture<DeleteAsyncSearchResponse> delete(
-			Function<DeleteAsyncSearchRequest.Builder, ObjectBuilder<DeleteAsyncSearchRequest>> fn) throws IOException {
+			Function<DeleteAsyncSearchRequest.Builder, ObjectBuilder<DeleteAsyncSearchRequest>> fn)
+			throws IOException, ElasticsearchException {
 		return delete(fn.apply(new DeleteAsyncSearchRequest.Builder()).build());
 	}
 
@@ -86,7 +87,7 @@ public final CompletableFuture<DeleteAsyncSearchResponse> delete(
 	 */
 
 	public <TDocument> CompletableFuture<GetAsyncSearchResponse<TDocument>> get(GetAsyncSearchRequest request,
-			Class<TDocument> tDocumentClass) throws IOException {
+			Class<TDocument> tDocumentClass) throws IOException, ElasticsearchException {
 		return this.transport.performRequestAsync(request,
 				GetAsyncSearchRequest.createGetEndpoint(getDeserializer(tDocumentClass)));
 	}
@@ -96,17 +97,16 @@ public <TDocument> CompletableFuture<GetAsyncSearchResponse<TDocument>> get(GetA
 	 * its ID.
 	 * 
 	 * @param fn
-	 *            a function that initializes a freshly created builder. This
-	 *            function can either return its builder argument after having set
-	 *            its properties or return another builder.
+	 *            a function that initializes a builder to create the
+	 *            {@link GetAsyncSearchRequest}
 	 * @see <a href=
 	 *      "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html">Documentation
 	 *      on elastic.co</a>
 	 */
 
 	public final <TDocument> CompletableFuture<GetAsyncSearchResponse<TDocument>> get(
 			Function<GetAsyncSearchRequest.Builder, ObjectBuilder<GetAsyncSearchRequest>> fn,
-			Class<TDocument> tDocumentClass) throws IOException {
+			Class<TDocument> tDocumentClass) throws IOException, ElasticsearchException {
 		return get(fn.apply(new GetAsyncSearchRequest.Builder()).build(), tDocumentClass);
 	}
 
@@ -122,7 +122,7 @@ public final <TDocument> CompletableFuture<GetAsyncSearchResponse<TDocument>> ge
 	 */
 
 	public <TDocument> CompletableFuture<StatusResponse<TDocument>> status(StatusRequest request,
-			Class<TDocument> tDocumentClass) throws IOException {
+			Class<TDocument> tDocumentClass) throws IOException, ElasticsearchException {
 		return this.transport.performRequestAsync(request,
 				StatusRequest.createStatusEndpoint(getDeserializer(tDocumentClass)));
 	}
@@ -132,17 +132,16 @@ public <TDocument> CompletableFuture<StatusResponse<TDocument>> status(StatusReq
 	 * ID.
 	 * 
 	 * @param fn
-	 *            a function that initializes a freshly created builder. This
-	 *            function can either return its builder argument after having set
-	 *            its properties or return another builder.
+	 *            a function that initializes a builder to create the
+	 *            {@link StatusRequest}
 	 * @see <a href=
 	 *      "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html">Documentation
 	 *      on elastic.co</a>
 	 */
 
 	public final <TDocument> CompletableFuture<StatusResponse<TDocument>> status(
 			Function<StatusRequest.Builder, ObjectBuilder<StatusRequest>> fn, Class<TDocument> tDocumentClass)
-			throws IOException {
+			throws IOException, ElasticsearchException {
 		return status(fn.apply(new StatusRequest.Builder()).build(), tDocumentClass);
 	}
 
@@ -157,7 +156,7 @@ public final <TDocument> CompletableFuture<StatusResponse<TDocument>> status(
 	 */
 
 	public <TDocument> CompletableFuture<SubmitResponse<TDocument>> submit(SubmitRequest request,
-			Class<TDocument> tDocumentClass) throws IOException {
+			Class<TDocument> tDocumentClass) throws IOException, ElasticsearchException {
 		return this.transport.performRequestAsync(request,
 				SubmitRequest.createSubmitEndpoint(getDeserializer(tDocumentClass)));
 	}
@@ -166,17 +165,16 @@ public <TDocument> CompletableFuture<SubmitResponse<TDocument>> submit(SubmitReq
 	 * Executes a search request asynchronously.
 	 * 
 	 * @param fn
-	 *            a function that initializes a freshly created builder. This
-	 *            function can either return its builder argument after having set
-	 *            its properties or return another builder.
+	 *            a function that initializes a builder to create the
+	 *            {@link SubmitRequest}
 	 * @see <a href=
 	 *      "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html">Documentation
 	 *      on elastic.co</a>
 	 */
 
 	public final <TDocument> CompletableFuture<SubmitResponse<TDocument>> submit(
 			Function<SubmitRequest.Builder, ObjectBuilder<SubmitRequest>> fn, Class<TDocument> tDocumentClass)
-			throws IOException {
+			throws IOException, ElasticsearchException {
 		return submit(fn.apply(new SubmitRequest.Builder()).build(), tDocumentClass);
 	}
 

java-client/src/main/java/co/elastic/clients/elasticsearch/ElasticsearchException.java renamed to java-client/src/main/java/co/elastic/clients/elasticsearch/_types/ElasticsearchException.java

@@ -25,7 +25,7 @@
 
 import co.elastic.clients.base.ApiClient;
 import co.elastic.clients.base.Transport;
-import co.elastic.clients.elasticsearch.ElasticsearchException;
+import co.elastic.clients.elasticsearch._types.ElasticsearchException;
 import co.elastic.clients.util.ObjectBuilder;
 import java.io.IOException;
 import java.util.function.Function;
@@ -51,7 +51,8 @@ public ElasticsearchAsyncSearchClient(Transport transport) {
 	 *      on elastic.co</a>
 	 */
 
-	public DeleteAsyncSearchResponse delete(DeleteAsyncSearchRequest request) throws IOException {
+	public DeleteAsyncSearchResponse delete(DeleteAsyncSearchRequest request)
+			throws IOException, ElasticsearchException {
 		return this.transport.performRequest(request, DeleteAsyncSearchRequest.ENDPOINT);
 	}
 
@@ -60,16 +61,16 @@ public DeleteAsyncSearchResponse delete(DeleteAsyncSearchRequest request) throws
 	 * request will be cancelled. Otherwise, the saved search results are deleted.
 	 * 
 	 * @param fn
-	 *            a function that initializes a freshly created builder. This
-	 *            function can either return its builder argument after having set
-	 *            its properties or return another builder.
+	 *            a function that initializes a builder to create the
+	 *            {@link DeleteAsyncSearchRequest}
 	 * @see <a href=
 	 *      "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html">Documentation
 	 *      on elastic.co</a>
 	 */
 
 	public final DeleteAsyncSearchResponse delete(
-			Function<DeleteAsyncSearchRequest.Builder, ObjectBuilder<DeleteAsyncSearchRequest>> fn) throws IOException {
+			Function<DeleteAsyncSearchRequest.Builder, ObjectBuilder<DeleteAsyncSearchRequest>> fn)
+			throws IOException, ElasticsearchException {
 		return delete(fn.apply(new DeleteAsyncSearchRequest.Builder()).build());
 	}
 
@@ -85,7 +86,7 @@ public final DeleteAsyncSearchResponse delete(
 	 */
 
 	public <TDocument> GetAsyncSearchResponse<TDocument> get(GetAsyncSearchRequest request,
-			Class<TDocument> tDocumentClass) throws IOException {
+			Class<TDocument> tDocumentClass) throws IOException, ElasticsearchException {
 		return this.transport.performRequest(request,
 				GetAsyncSearchRequest.createGetEndpoint(getDeserializer(tDocumentClass)));
 	}
@@ -95,17 +96,16 @@ public <TDocument> GetAsyncSearchResponse<TDocument> get(GetAsyncSearchRequest r
 	 * its ID.
 	 * 
 	 * @param fn
-	 *            a function that initializes a freshly created builder. This
-	 *            function can either return its builder argument after having set
-	 *            its properties or return another builder.
+	 *            a function that initializes a builder to create the
+	 *            {@link GetAsyncSearchRequest}
 	 * @see <a href=
 	 *      "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html">Documentation
 	 *      on elastic.co</a>
 	 */
 
 	public final <TDocument> GetAsyncSearchResponse<TDocument> get(
 			Function<GetAsyncSearchRequest.Builder, ObjectBuilder<GetAsyncSearchRequest>> fn,
-			Class<TDocument> tDocumentClass) throws IOException {
+			Class<TDocument> tDocumentClass) throws IOException, ElasticsearchException {
 		return get(fn.apply(new GetAsyncSearchRequest.Builder()).build(), tDocumentClass);
 	}
 
@@ -121,7 +121,7 @@ public final <TDocument> GetAsyncSearchResponse<TDocument> get(
 	 */
 
 	public <TDocument> StatusResponse<TDocument> status(StatusRequest request, Class<TDocument> tDocumentClass)
-			throws IOException {
+			throws IOException, ElasticsearchException {
 		return this.transport.performRequest(request,
 				StatusRequest.createStatusEndpoint(getDeserializer(tDocumentClass)));
 	}
@@ -131,17 +131,16 @@ public <TDocument> StatusResponse<TDocument> status(StatusRequest request, Class
 	 * ID.
 	 * 
 	 * @param fn
-	 *            a function that initializes a freshly created builder. This
-	 *            function can either return its builder argument after having set
-	 *            its properties or return another builder.
+	 *            a function that initializes a builder to create the
+	 *            {@link StatusRequest}
 	 * @see <a href=
 	 *      "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html">Documentation
 	 *      on elastic.co</a>
 	 */
 
 	public final <TDocument> StatusResponse<TDocument> status(
 			Function<StatusRequest.Builder, ObjectBuilder<StatusRequest>> fn, Class<TDocument> tDocumentClass)
-			throws IOException {
+			throws IOException, ElasticsearchException {
 		return status(fn.apply(new StatusRequest.Builder()).build(), tDocumentClass);
 	}
 
@@ -156,7 +155,7 @@ public final <TDocument> StatusResponse<TDocument> status(
 	 */
 
 	public <TDocument> SubmitResponse<TDocument> submit(SubmitRequest request, Class<TDocument> tDocumentClass)
-			throws IOException {
+			throws IOException, ElasticsearchException {
 		return this.transport.performRequest(request,
 				SubmitRequest.createSubmitEndpoint(getDeserializer(tDocumentClass)));
 	}
@@ -165,17 +164,16 @@ public <TDocument> SubmitResponse<TDocument> submit(SubmitRequest request, Class
 	 * Executes a search request asynchronously.
 	 * 
 	 * @param fn
-	 *            a function that initializes a freshly created builder. This
-	 *            function can either return its builder argument after having set
-	 *            its properties or return another builder.
+	 *            a function that initializes a builder to create the
+	 *            {@link SubmitRequest}
 	 * @see <a href=
 	 *      "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html">Documentation
 	 *      on elastic.co</a>
 	 */
 
 	public final <TDocument> SubmitResponse<TDocument> submit(
 			Function<SubmitRequest.Builder, ObjectBuilder<SubmitRequest>> fn, Class<TDocument> tDocumentClass)
-			throws IOException {
+			throws IOException, ElasticsearchException {
 		return submit(fn.apply(new SubmitRequest.Builder()).build(), tDocumentClass);
 	}