From 5a6df1b0d6f634afbca6f48488be85caa2ce0cec Mon Sep 17 00:00:00 2001 From: ketkee-aryamane Date: Wed, 17 Sep 2025 18:09:22 +0200 Subject: [PATCH 01/11] changed H1s per SEO suggestions, added frontmatter where necessary --- docs/reference/getting-started.md | 3 ++- .../transport/rest-client/config/basic_authentication.md | 3 ++- docs/reference/transport/rest-client/config/index.md | 3 ++- docs/reference/transport/rest-client/sniffer/javadoc.md | 3 ++- .../transport/rest-client/sniffer/maven_repository.md | 3 ++- docs/reference/transport/rest-client/sniffer/usage.md | 5 +++-- docs/reference/transport/rest-client/usage/index.md | 3 ++- .../transport/rest-client/usage/initialization.md | 3 ++- docs/reference/transport/rest-client/usage/javadoc.md | 3 ++- docs/reference/transport/rest-client/usage/logging.md | 3 ++- docs/reference/transport/rest-client/usage/maven.md | 3 ++- .../transport/rest5-client/config/basic_authentication.md | 7 ++++++- docs/reference/transport/rest5-client/config/index.md | 7 ++++++- docs/reference/transport/rest5-client/usage/index.md | 7 ++++++- .../transport/rest5-client/usage/initialization.md | 7 ++++++- docs/reference/transport/rest5-client/usage/logging.md | 8 +++++++- 16 files changed, 54 insertions(+), 17 deletions(-) diff --git a/docs/reference/getting-started.md b/docs/reference/getting-started.md index 8339c1f0d..437d639e3 100644 --- a/docs/reference/getting-started.md +++ b/docs/reference/getting-started.md @@ -1,9 +1,10 @@ --- mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/getting-started-java.html +navigation_title: Getting started --- -# Getting started +# Getting started with the {{es}} Java client This page guides you through the installation process of the Java client, shows you how to instantiate the client, and how to perform basic Elasticsearch operations with it. diff --git a/docs/reference/transport/rest-client/config/basic_authentication.md b/docs/reference/transport/rest-client/config/basic_authentication.md index 9fb1a35ac..e85325311 100644 --- a/docs/reference/transport/rest-client/config/basic_authentication.md +++ b/docs/reference/transport/rest-client/config/basic_authentication.md @@ -1,9 +1,10 @@ --- mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/_basic_authentication.html +navigation_title: Basic authentication --- -# Basic authentication [_basic_authentication] +# Basic authentication setup for {{es}} Java REST client [_basic_authentication] :::{include} /reference/_snippets/legacy-rest-client.md ::: diff --git a/docs/reference/transport/rest-client/config/index.md b/docs/reference/transport/rest-client/config/index.md index d2ddf09f1..1069874d2 100644 --- a/docs/reference/transport/rest-client/config/index.md +++ b/docs/reference/transport/rest-client/config/index.md @@ -1,9 +1,10 @@ --- mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/java-rest-low-config.html +navigation_title: Common configuration --- -# Common configuration [java-rest-low-config] +# {{es}} Java REST client configuration [java-rest-low-config] :::{include} /reference/_snippets/legacy-rest-client.md ::: diff --git a/docs/reference/transport/rest-client/sniffer/javadoc.md b/docs/reference/transport/rest-client/sniffer/javadoc.md index 3a1f9b5e9..f5c2d75b7 100644 --- a/docs/reference/transport/rest-client/sniffer/javadoc.md +++ b/docs/reference/transport/rest-client/sniffer/javadoc.md @@ -1,9 +1,10 @@ --- mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/java-rest-sniffer-javadoc.html +navigation_title: Javadoc --- -# Javadoc [java-rest-sniffer-javadoc] +# Javadoc for the {{es}} Java REST client sniffer [java-rest-sniffer-javadoc] :::{include} /reference/_snippets/legacy-rest-client.md ::: diff --git a/docs/reference/transport/rest-client/sniffer/maven_repository.md b/docs/reference/transport/rest-client/sniffer/maven_repository.md index 7fc23890d..7511a1a97 100644 --- a/docs/reference/transport/rest-client/sniffer/maven_repository.md +++ b/docs/reference/transport/rest-client/sniffer/maven_repository.md @@ -1,9 +1,10 @@ --- mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/_maven_repository.html +navigation_title: Maven Repository --- -# Maven Repository [_maven_repository] +# Maven repository for {{es}} Java REST client sniffer [_maven_repository] :::{include} /reference/_snippets/legacy-rest-client.md ::: diff --git a/docs/reference/transport/rest-client/sniffer/usage.md b/docs/reference/transport/rest-client/sniffer/usage.md index 73dbd58f3..b116df650 100644 --- a/docs/reference/transport/rest-client/sniffer/usage.md +++ b/docs/reference/transport/rest-client/sniffer/usage.md @@ -1,9 +1,10 @@ --- mapped_pages: - - https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/_usage.html + - https://www.elastic.co/docs/reference/elasticsearch/clients/java/transport/rest-client/usage.html +navigation_title: Usage --- -# Usage [_usage] +# Getting started with the {{es}} Java REST client [_usage] :::{include} /reference/_snippets/legacy-rest-client.md ::: diff --git a/docs/reference/transport/rest-client/usage/index.md b/docs/reference/transport/rest-client/usage/index.md index dd5897ca4..c1e494f9f 100644 --- a/docs/reference/transport/rest-client/usage/index.md +++ b/docs/reference/transport/rest-client/usage/index.md @@ -1,9 +1,10 @@ --- mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/java-rest-low-usage.html +navigation_title: Getting started --- -# Getting started [java-rest-low-usage] +# Getting started with the {{es}} Java REST client [java-rest-low-usage] :::{include} /reference/_snippets/legacy-rest-client.md ::: diff --git a/docs/reference/transport/rest-client/usage/initialization.md b/docs/reference/transport/rest-client/usage/initialization.md index dae72fdd9..a21956e94 100644 --- a/docs/reference/transport/rest-client/usage/initialization.md +++ b/docs/reference/transport/rest-client/usage/initialization.md @@ -1,9 +1,10 @@ --- mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/java-rest-low-usage-initialization.html +navigation_title: Initialization --- -# Initialization [java-rest-low-usage-initialization] +# Initializing the {{es}} Java REST client [java-rest-low-usage-initialization] :::{include} /reference/_snippets/legacy-rest-client.md ::: diff --git a/docs/reference/transport/rest-client/usage/javadoc.md b/docs/reference/transport/rest-client/usage/javadoc.md index a427a05b4..f5a26859a 100644 --- a/docs/reference/transport/rest-client/usage/javadoc.md +++ b/docs/reference/transport/rest-client/usage/javadoc.md @@ -1,9 +1,10 @@ --- mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/java-rest-low-javadoc.html +navigation_title: Javadoc --- -# Javadoc [java-rest-low-javadoc] +# Javadoc for the {{es}} Java REST client [java-rest-low-javadoc] :::{include} /reference/_snippets/legacy-rest-client.md ::: diff --git a/docs/reference/transport/rest-client/usage/logging.md b/docs/reference/transport/rest-client/usage/logging.md index bd6dcd80d..026f53855 100644 --- a/docs/reference/transport/rest-client/usage/logging.md +++ b/docs/reference/transport/rest-client/usage/logging.md @@ -1,9 +1,10 @@ --- mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/java-rest-low-usage-logging.html +navigation_title: Logging --- -# Logging [java-rest-low-usage-logging] +# Logging in the {{es}} Java REST client [java-rest-low-usage-logging] :::{include} /reference/_snippets/legacy-rest-client.md ::: diff --git a/docs/reference/transport/rest-client/usage/maven.md b/docs/reference/transport/rest-client/usage/maven.md index 0586e4a8e..ee444f168 100644 --- a/docs/reference/transport/rest-client/usage/maven.md +++ b/docs/reference/transport/rest-client/usage/maven.md @@ -1,9 +1,10 @@ --- mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/java-rest-low-usage-maven.html +navigation_title: Maven repository --- -# Maven Repository [java-rest-low-usage-maven] +# Maven repository for {{es}} Java REST client [java-rest-low-usage-maven] :::{include} /reference/_snippets/legacy-rest-client.md ::: diff --git a/docs/reference/transport/rest5-client/config/basic_authentication.md b/docs/reference/transport/rest5-client/config/basic_authentication.md index 661143580..5a0e0c22e 100644 --- a/docs/reference/transport/rest5-client/config/basic_authentication.md +++ b/docs/reference/transport/rest5-client/config/basic_authentication.md @@ -1,5 +1,10 @@ +--- +mapped_pages: + - https://www.elastic.co/docs/reference/elasticsearch/clients/java/transport/rest5-client/config/basic_authentication.html +navigation_title: Basic authentication +--- -# Basic authentication +# Basic authentication setup for {{es}} Java REST 5 client To use basic authentication in the REST 5 client, set a default authorization header: diff --git a/docs/reference/transport/rest5-client/config/index.md b/docs/reference/transport/rest5-client/config/index.md index 0e9b5f77d..89ade5199 100644 --- a/docs/reference/transport/rest5-client/config/index.md +++ b/docs/reference/transport/rest5-client/config/index.md @@ -1,5 +1,10 @@ +--- +mapped_pages: + - https://www.elastic.co/docs/reference/elasticsearch/clients/java/transport/rest5-client/config.html +navigation_title: Common configuration +--- -# Common configuration +# {{es}} Java REST 5 client configuration As explained in [Initialization](../usage/initialization.md), the `RestClientBuilder` supports providing both a `RequestConfigCallback` and an `HttpClientConfigCallback` which allow for any customization that the Apache Async Http Client exposes. Those callbacks make it possible to modify some specific behaviour of the client without overriding every other default configuration that the `Rest5Client` is initialized with. This section describes some common scenarios that require additional configuration for the low-level Java REST Client. diff --git a/docs/reference/transport/rest5-client/usage/index.md b/docs/reference/transport/rest5-client/usage/index.md index aa1bb6631..9fe7dde85 100644 --- a/docs/reference/transport/rest5-client/usage/index.md +++ b/docs/reference/transport/rest5-client/usage/index.md @@ -1,5 +1,10 @@ +--- +mapped_pages: + - https://www.elastic.co/docs/reference/elasticsearch/clients/java/transport/rest5-client/usage.html +navigation_title: Getting started +--- -# Getting started +# Getting started with the {{es}} Java Rest 5 client This section describes how to get started with the low-level REST client from getting the artifact to using it in an application. diff --git a/docs/reference/transport/rest5-client/usage/initialization.md b/docs/reference/transport/rest5-client/usage/initialization.md index 363e9e21d..4da4f056c 100644 --- a/docs/reference/transport/rest5-client/usage/initialization.md +++ b/docs/reference/transport/rest5-client/usage/initialization.md @@ -1,5 +1,10 @@ +--- +mapped_pages: + - https://www.elastic.co/docs/reference/elasticsearch/clients/java/transport/rest5-client/usage/initialization.html +navigation_title: Initialization +--- -# Initialization +# Initializing the {{es}} Java REST 5 client A `Rest5Client` instance can be built through the corresponding `Rest5ClientBuilder` class, created via `Rest5Client#builder(...)` static method. The only required argument is one or more URLs or `HttpHost` that the client will communicate with as follows: diff --git a/docs/reference/transport/rest5-client/usage/logging.md b/docs/reference/transport/rest5-client/usage/logging.md index 1ba48d569..931d434ab 100644 --- a/docs/reference/transport/rest5-client/usage/logging.md +++ b/docs/reference/transport/rest5-client/usage/logging.md @@ -1,4 +1,10 @@ -# Logging +--- +mapped_pages: + - https://www.elastic.co/docs/reference/elasticsearch/clients/java/transport/rest5-client/usage/logging.html +navigation_title: Logging +--- + +# Logging in the {{es}} Java REST 5 client The Java REST 5 client uses the same logging library that the Apache Async Http Client uses: [Apache Commons Logging](https://commons.apache.org/proper/commons-logging/), which comes with support for a number of popular logging implementations. The java packages to enable logging for is `co.elastic.clients.transport.rest5_client`. From ace9e922b2c32d348ddee95da8a1ad98f4213b58 Mon Sep 17 00:00:00 2001 From: ketkee-aryamane Date: Thu, 18 Sep 2025 11:07:36 +0200 Subject: [PATCH 02/11] add suggested seo H1s to more files --- .../rest-client/config/encrypted_communication.md | 3 ++- docs/reference/transport/rest-client/sniffer/index.md | 3 ++- .../rest5-client/config/encrypted_communication.md | 7 ++++++- docs/reference/transport/rest5-client/sniffer/index.md | 8 ++++++-- 4 files changed, 16 insertions(+), 5 deletions(-) diff --git a/docs/reference/transport/rest-client/config/encrypted_communication.md b/docs/reference/transport/rest-client/config/encrypted_communication.md index ac18c4b69..ef6e0f06a 100644 --- a/docs/reference/transport/rest-client/config/encrypted_communication.md +++ b/docs/reference/transport/rest-client/config/encrypted_communication.md @@ -1,9 +1,10 @@ --- mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/_encrypted_communication.html +navigation_title: Encrypted communication --- -# Encrypted communication [_encrypted_communication] +# Encrypted communication and TLS setup in Java REST client [_encrypted_communication] :::{include} /reference/_snippets/legacy-rest-client.md ::: diff --git a/docs/reference/transport/rest-client/sniffer/index.md b/docs/reference/transport/rest-client/sniffer/index.md index 61ee38a3d..cd8ecb7ed 100644 --- a/docs/reference/transport/rest-client/sniffer/index.md +++ b/docs/reference/transport/rest-client/sniffer/index.md @@ -1,9 +1,10 @@ --- mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/sniffer.html +navigation_title: Sniffer --- -# Sniffer [sniffer] +# Sniffer in the {{es}} Java REST client[sniffer] :::{include} /reference/_snippets/legacy-rest-client.md ::: diff --git a/docs/reference/transport/rest5-client/config/encrypted_communication.md b/docs/reference/transport/rest5-client/config/encrypted_communication.md index d978106dc..5fc8e3ae0 100644 --- a/docs/reference/transport/rest5-client/config/encrypted_communication.md +++ b/docs/reference/transport/rest5-client/config/encrypted_communication.md @@ -1,5 +1,10 @@ +--- +mapped_pages: + - https://www.elastic.co/docs/reference/elasticsearch/clients/java/transport/rest5-client/config/encrypted_communication.html +navigation_title: Encrypted communication +--- -# Encrypted communication +# Encrypted communication and TLS setup in Java REST 5 client Encrypted communication using TLS can also be configured through the `HttpClientConfigCallback`. The [`org.apache.http.impl.nio.client.HttpAsyncClientBuilder`](https://hc.apache.org/httpcomponents-asyncclient-4.1.x/current/httpasyncclient/apidocs/org/apache/http/impl/nio/client/HttpAsyncClientBuilder.html) received as an argument exposes multiple methods to configure encrypted communication: `setSSLContext`, `setSSLSessionStrategy` and `setConnectionManager`, in order of precedence from the least important. diff --git a/docs/reference/transport/rest5-client/sniffer/index.md b/docs/reference/transport/rest5-client/sniffer/index.md index 74b43e4d4..4497977cd 100644 --- a/docs/reference/transport/rest5-client/sniffer/index.md +++ b/docs/reference/transport/rest5-client/sniffer/index.md @@ -1,5 +1,9 @@ - -# Sniffer +--- +mapped_pages: + - https://www.elastic.co/docs/reference/elasticsearch/clients/java/transport/rest5-client/sniffer.html +navigation_title: Sniffer +--- +# Sniffer in the {{es}} Java REST 5 client Minimal library that allows to automatically discover nodes from a running Elasticsearch cluster and set them to an existing `RestClient` instance. It retrieves by default the nodes that belong to the cluster using the Nodes Info api and uses jackson to parse the obtained json response. From cb77a34d6371b4e73db9ca4b6c5c66c38f203ae9 Mon Sep 17 00:00:00 2001 From: ketkee-aryamane Date: Thu, 18 Sep 2025 17:34:33 +0200 Subject: [PATCH 03/11] add suggested seo H1s to more files --- .../transport/rest-client/config/node_selector.md | 3 ++- .../transport/rest-client/config/number_of_threads.md | 3 ++- .../rest-client/config/other_authentication_methods.md | 3 ++- docs/reference/transport/rest-client/config/others.md | 3 ++- docs/reference/transport/rest-client/config/timeouts.md | 3 ++- docs/reference/transport/rest-client/sniffer/usage.md | 4 ++-- docs/reference/transport/rest-client/usage/requests.md | 3 ++- docs/reference/transport/rest-client/usage/responses.md | 3 ++- .../transport/rest5-client/config/node_selector.md | 7 ++++++- .../transport/rest5-client/config/number_of_threads.md | 7 ++++++- .../rest5-client/config/other_authentication_methods.md | 7 ++++++- docs/reference/transport/rest5-client/config/others.md | 7 ++++++- docs/reference/transport/rest5-client/config/timeouts.md | 8 +++++++- docs/reference/transport/rest5-client/usage/requests.md | 7 ++++++- docs/reference/transport/rest5-client/usage/responses.md | 7 ++++++- 15 files changed, 59 insertions(+), 16 deletions(-) diff --git a/docs/reference/transport/rest-client/config/node_selector.md b/docs/reference/transport/rest-client/config/node_selector.md index 702dc3c55..b2f027f1c 100644 --- a/docs/reference/transport/rest-client/config/node_selector.md +++ b/docs/reference/transport/rest-client/config/node_selector.md @@ -1,9 +1,10 @@ --- mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/_node_selector.html +navigation_title: Node selector --- -# Node selector [_node_selector] +# Configuring node selector in the {{es}} Java REST client [_node_selector] :::{include} /reference/_snippets/legacy-rest-client.md ::: diff --git a/docs/reference/transport/rest-client/config/number_of_threads.md b/docs/reference/transport/rest-client/config/number_of_threads.md index 8589f2837..a9ec8146e 100644 --- a/docs/reference/transport/rest-client/config/number_of_threads.md +++ b/docs/reference/transport/rest-client/config/number_of_threads.md @@ -1,9 +1,10 @@ --- mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/_number_of_threads.html +navigation_title: Number of threads --- -# Number of threads [_number_of_threads] +# Setting number of threads in the {{es}} Java REST client [_number_of_threads] :::{include} /reference/_snippets/legacy-rest-client.md ::: diff --git a/docs/reference/transport/rest-client/config/other_authentication_methods.md b/docs/reference/transport/rest-client/config/other_authentication_methods.md index a03984c8e..a792dc879 100644 --- a/docs/reference/transport/rest-client/config/other_authentication_methods.md +++ b/docs/reference/transport/rest-client/config/other_authentication_methods.md @@ -1,9 +1,10 @@ --- mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/_other_authentication_methods.html +navigation_title: Other authentication methods --- -# Other authentication methods [_other_authentication_methods] +# Other authentication methods in the {{es}} Java REST client [_other_authentication_methods] :::{include} /reference/_snippets/legacy-rest-client.md ::: diff --git a/docs/reference/transport/rest-client/config/others.md b/docs/reference/transport/rest-client/config/others.md index 61eafa1df..f61a9562b 100644 --- a/docs/reference/transport/rest-client/config/others.md +++ b/docs/reference/transport/rest-client/config/others.md @@ -1,9 +1,10 @@ --- mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/_others.html +navigation_title: Others --- -# Others [_others] +# Other configuration options in the {{es}} Java REST client [_others] :::{include} /reference/_snippets/legacy-rest-client.md ::: diff --git a/docs/reference/transport/rest-client/config/timeouts.md b/docs/reference/transport/rest-client/config/timeouts.md index b62e8901e..1b0b42565 100644 --- a/docs/reference/transport/rest-client/config/timeouts.md +++ b/docs/reference/transport/rest-client/config/timeouts.md @@ -1,9 +1,10 @@ --- mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/_timeouts.html +navigation_title: Timeouts --- -# Timeouts [_timeouts] +# Configuring Timeouts in the {{es}} Java REST client [_timeouts] :::{include} /reference/_snippets/legacy-rest-client.md ::: diff --git a/docs/reference/transport/rest-client/sniffer/usage.md b/docs/reference/transport/rest-client/sniffer/usage.md index b116df650..15b30769b 100644 --- a/docs/reference/transport/rest-client/sniffer/usage.md +++ b/docs/reference/transport/rest-client/sniffer/usage.md @@ -1,10 +1,10 @@ --- mapped_pages: - - https://www.elastic.co/docs/reference/elasticsearch/clients/java/transport/rest-client/usage.html + - https://www.elastic.co/docs/reference/elasticsearch/clients/java/transport/rest-client/sniffer/usage.html navigation_title: Usage --- -# Getting started with the {{es}} Java REST client [_usage] +# Usage [_usage] :::{include} /reference/_snippets/legacy-rest-client.md ::: diff --git a/docs/reference/transport/rest-client/usage/requests.md b/docs/reference/transport/rest-client/usage/requests.md index 2d43ba9f3..f05708009 100644 --- a/docs/reference/transport/rest-client/usage/requests.md +++ b/docs/reference/transport/rest-client/usage/requests.md @@ -1,9 +1,10 @@ --- mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/java-rest-low-usage-requests.html +navigation_title: Performing requests --- -# Performing requests [java-rest-low-usage-requests] +# Performing requests with the {{es}} Java REST client [java-rest-low-usage-requests] :::{include} /reference/_snippets/legacy-rest-client.md ::: diff --git a/docs/reference/transport/rest-client/usage/responses.md b/docs/reference/transport/rest-client/usage/responses.md index 5ac4ee9dd..154235dbc 100644 --- a/docs/reference/transport/rest-client/usage/responses.md +++ b/docs/reference/transport/rest-client/usage/responses.md @@ -1,9 +1,10 @@ --- mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/java-rest-low-usage-responses.html +navigation_title: Reading responses --- -# Reading responses [java-rest-low-usage-responses] +# Reading responses with the {{es}} Java REST client [java-rest-low-usage-responses] :::{include} /reference/_snippets/legacy-rest-client.md ::: diff --git a/docs/reference/transport/rest5-client/config/node_selector.md b/docs/reference/transport/rest5-client/config/node_selector.md index e06f9f1b1..e05d09821 100644 --- a/docs/reference/transport/rest5-client/config/node_selector.md +++ b/docs/reference/transport/rest5-client/config/node_selector.md @@ -1,5 +1,10 @@ +--- +mapped_pages: + - https://www.elastic.co/docs/reference/elasticsearch/clients/java/transport/rest5-client/config/node_selector.html +navigation_title: Node selector +--- -# Node selector +# Configuring node selector in the {{es}} Java REST 5 client The client sends each request to one of the configured nodes in round-robin fashion. Nodes can optionally be filtered through a node selector that needs to be provided when initializing the client. This is useful when sniffing is enabled, in case no dedicated master nodes should be hit by HTTP requests. For each request the client will run the eventually configured node selector to filter the node candidates, then select the next one in the list out of the remaining ones. diff --git a/docs/reference/transport/rest5-client/config/number_of_threads.md b/docs/reference/transport/rest5-client/config/number_of_threads.md index 8825e6448..a5fd70e96 100644 --- a/docs/reference/transport/rest5-client/config/number_of_threads.md +++ b/docs/reference/transport/rest5-client/config/number_of_threads.md @@ -1,5 +1,10 @@ +--- +mapped_pages: + - https://www.elastic.co/docs/reference/elasticsearch/clients/java/transport/rest5-client/config/number_of_threads.html +navigation_title: Number of threads +--- -# Number of threads +# Setting number of threads in the {{es}} Java REST 5 client The Apache Http Async Client starts by default one dispatcher thread, and a number of worker threads used by the connection manager, as many as the number of locally detected processors (depending on what `Runtime.getRuntime().availableProcessors()` returns). The number of threads can be modified as follows: diff --git a/docs/reference/transport/rest5-client/config/other_authentication_methods.md b/docs/reference/transport/rest5-client/config/other_authentication_methods.md index 584cc1b6a..68f5bfdba 100644 --- a/docs/reference/transport/rest5-client/config/other_authentication_methods.md +++ b/docs/reference/transport/rest5-client/config/other_authentication_methods.md @@ -1,5 +1,10 @@ +--- +mapped_pages: + - https://www.elastic.co/docs/reference/elasticsearch/clients/java/transport/rest5-client/config/other_authentication_methods.html +navigation_title: Other authentication methods +--- -# Other authentication methods +# Other authentication methods in the {{es}} Java REST 5 client ## Elasticsearch Token Service tokens diff --git a/docs/reference/transport/rest5-client/config/others.md b/docs/reference/transport/rest5-client/config/others.md index e99b6870f..d25410811 100644 --- a/docs/reference/transport/rest5-client/config/others.md +++ b/docs/reference/transport/rest5-client/config/others.md @@ -1,5 +1,10 @@ +--- +mapped_pages: + - https://www.elastic.co/docs/reference/elasticsearch/clients/java/transport/rest5-client/config/others.html +navigation_title: Others +--- -# Others +# Other configuration options in the {{es}} Java REST 5 client For any other required configuration needed, the Apache HttpAsyncClient docs should be consulted: [https://hc.apache.org/httpcomponents-asyncclient-4.1.x/](https://hc.apache.org/httpcomponents-asyncclient-4.1.x/) . diff --git a/docs/reference/transport/rest5-client/config/timeouts.md b/docs/reference/transport/rest5-client/config/timeouts.md index e80dde9ee..e7f21b550 100644 --- a/docs/reference/transport/rest5-client/config/timeouts.md +++ b/docs/reference/transport/rest5-client/config/timeouts.md @@ -1,4 +1,10 @@ -# Timeouts +--- +mapped_pages: + - https://www.elastic.co/docs/reference/elasticsearch/clients/java/transport/rest5-client/config/timeouts.html +navigation_title: Timeouts +--- + +# Configuring Timeouts in the {{es}} Java REST 5 client You can set timeouts when building the `Rest5Client`: diff --git a/docs/reference/transport/rest5-client/usage/requests.md b/docs/reference/transport/rest5-client/usage/requests.md index a7ba8a3d3..335e39fcc 100644 --- a/docs/reference/transport/rest5-client/usage/requests.md +++ b/docs/reference/transport/rest5-client/usage/requests.md @@ -1,5 +1,10 @@ +--- +mapped_pages: + - https://www.elastic.co/docs/reference/elasticsearch/clients/java/transport/rest5-client/usage/requests.html +navigation_title: Performing requests +--- -# Performing requests +# Performing requests with the {{es}} Java REST 5 client Once the `RestClient` has been created, requests can be sent by calling either `performRequest` or `performRequestAsync`. `performRequest` is synchronous and will block the calling thread and return the `Response` when the request is successful or throw an exception if it fails. `performRequestAsync` is asynchronous and accepts a `ResponseListener` argument that it calls with a `Response` when the request is successful or with an `Exception` if it fails. diff --git a/docs/reference/transport/rest5-client/usage/responses.md b/docs/reference/transport/rest5-client/usage/responses.md index 566dc63b6..5d7feab37 100644 --- a/docs/reference/transport/rest5-client/usage/responses.md +++ b/docs/reference/transport/rest5-client/usage/responses.md @@ -1,5 +1,10 @@ +--- +mapped_pages: + - https://www.elastic.co/docs/reference/elasticsearch/clients/java/transport/rest5-client/usage/responses.html +navigation_title: Reading responses +--- -# Reading responses +# Reading responses with the {{es}} Java REST 5 client The `Response` object, either returned by the synchronous `performRequest` methods or received as an argument in `ResponseListener#onSuccess(Response)`, wraps the response object returned by the http client and exposes some additional information. From a649beaf3c5d9fd0f176065a0fa25614e07cdd0e Mon Sep 17 00:00:00 2001 From: ketkee-aryamane Date: Thu, 18 Sep 2025 17:36:28 +0200 Subject: [PATCH 04/11] change H1 to sentence case --- docs/reference/transport/rest-client/config/timeouts.md | 2 +- docs/reference/transport/rest5-client/config/timeouts.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference/transport/rest-client/config/timeouts.md b/docs/reference/transport/rest-client/config/timeouts.md index 1b0b42565..79f2a706a 100644 --- a/docs/reference/transport/rest-client/config/timeouts.md +++ b/docs/reference/transport/rest-client/config/timeouts.md @@ -4,7 +4,7 @@ mapped_pages: navigation_title: Timeouts --- -# Configuring Timeouts in the {{es}} Java REST client [_timeouts] +# Configuring timeouts in the {{es}} Java REST client [_timeouts] :::{include} /reference/_snippets/legacy-rest-client.md ::: diff --git a/docs/reference/transport/rest5-client/config/timeouts.md b/docs/reference/transport/rest5-client/config/timeouts.md index e7f21b550..c972a0faa 100644 --- a/docs/reference/transport/rest5-client/config/timeouts.md +++ b/docs/reference/transport/rest5-client/config/timeouts.md @@ -4,7 +4,7 @@ mapped_pages: navigation_title: Timeouts --- -# Configuring Timeouts in the {{es}} Java REST 5 client +# Configuring timeouts in the {{es}} Java REST 5 client You can set timeouts when building the `Rest5Client`: From 6b48b5335a8947eb1e6f9bd0ca73a0fac24ccb13 Mon Sep 17 00:00:00 2001 From: ketkee-aryamane Date: Fri, 19 Sep 2025 09:35:13 +0200 Subject: [PATCH 05/11] Update docs/reference/transport/rest5-client/config/encrypted_communication.md Co-authored-by: Marci W <333176+marciw@users.noreply.github.com> --- .../transport/rest5-client/config/encrypted_communication.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/transport/rest5-client/config/encrypted_communication.md b/docs/reference/transport/rest5-client/config/encrypted_communication.md index 5fc8e3ae0..19fae8f03 100644 --- a/docs/reference/transport/rest5-client/config/encrypted_communication.md +++ b/docs/reference/transport/rest5-client/config/encrypted_communication.md @@ -4,7 +4,7 @@ mapped_pages: navigation_title: Encrypted communication --- -# Encrypted communication and TLS setup in Java REST 5 client +# Encrypted communication and TLS setup in the {{es}} Java REST 5 client Encrypted communication using TLS can also be configured through the `HttpClientConfigCallback`. The [`org.apache.http.impl.nio.client.HttpAsyncClientBuilder`](https://hc.apache.org/httpcomponents-asyncclient-4.1.x/current/httpasyncclient/apidocs/org/apache/http/impl/nio/client/HttpAsyncClientBuilder.html) received as an argument exposes multiple methods to configure encrypted communication: `setSSLContext`, `setSSLSessionStrategy` and `setConnectionManager`, in order of precedence from the least important. From e9e76af8e8cfe9cc068b95a785329e456e099311 Mon Sep 17 00:00:00 2001 From: ketkee-aryamane Date: Fri, 19 Sep 2025 09:35:28 +0200 Subject: [PATCH 06/11] Update docs/reference/transport/rest5-client/config/node_selector.md Co-authored-by: Marci W <333176+marciw@users.noreply.github.com> --- docs/reference/transport/rest5-client/config/node_selector.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/transport/rest5-client/config/node_selector.md b/docs/reference/transport/rest5-client/config/node_selector.md index e05d09821..256643569 100644 --- a/docs/reference/transport/rest5-client/config/node_selector.md +++ b/docs/reference/transport/rest5-client/config/node_selector.md @@ -4,7 +4,7 @@ mapped_pages: navigation_title: Node selector --- -# Configuring node selector in the {{es}} Java REST 5 client +# Configuring node selectors in the {{es}} Java REST 5 client The client sends each request to one of the configured nodes in round-robin fashion. Nodes can optionally be filtered through a node selector that needs to be provided when initializing the client. This is useful when sniffing is enabled, in case no dedicated master nodes should be hit by HTTP requests. For each request the client will run the eventually configured node selector to filter the node candidates, then select the next one in the list out of the remaining ones. From e68483e4f72dde4974a1ca7965f4f3bb582297bc Mon Sep 17 00:00:00 2001 From: ketkee-aryamane Date: Fri, 19 Sep 2025 09:41:39 +0200 Subject: [PATCH 07/11] Update docs/reference/transport/rest-client/config/basic_authentication.md Co-authored-by: Marci W <333176+marciw@users.noreply.github.com> --- .../transport/rest-client/config/basic_authentication.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/transport/rest-client/config/basic_authentication.md b/docs/reference/transport/rest-client/config/basic_authentication.md index e85325311..88e72204e 100644 --- a/docs/reference/transport/rest-client/config/basic_authentication.md +++ b/docs/reference/transport/rest-client/config/basic_authentication.md @@ -4,7 +4,7 @@ mapped_pages: navigation_title: Basic authentication --- -# Basic authentication setup for {{es}} Java REST client [_basic_authentication] +# Basic authentication setup for the {{es}} Java REST client [_basic_authentication] :::{include} /reference/_snippets/legacy-rest-client.md ::: From cd2baf7aedc7b82180ac1b2017ee9fbf688381ce Mon Sep 17 00:00:00 2001 From: ketkee-aryamane Date: Fri, 19 Sep 2025 09:41:50 +0200 Subject: [PATCH 08/11] Update docs/reference/transport/rest-client/config/encrypted_communication.md Co-authored-by: Marci W <333176+marciw@users.noreply.github.com> --- .../transport/rest-client/config/encrypted_communication.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/transport/rest-client/config/encrypted_communication.md b/docs/reference/transport/rest-client/config/encrypted_communication.md index ef6e0f06a..8bb42c022 100644 --- a/docs/reference/transport/rest-client/config/encrypted_communication.md +++ b/docs/reference/transport/rest-client/config/encrypted_communication.md @@ -4,7 +4,7 @@ mapped_pages: navigation_title: Encrypted communication --- -# Encrypted communication and TLS setup in Java REST client [_encrypted_communication] +# Encrypted communication and TLS setup in the {{es}} Java REST client [_encrypted_communication] :::{include} /reference/_snippets/legacy-rest-client.md ::: From a6205e6855222a5ce4d1d04733366dbae498134a Mon Sep 17 00:00:00 2001 From: ketkee-aryamane Date: Fri, 19 Sep 2025 09:41:59 +0200 Subject: [PATCH 09/11] Update docs/reference/transport/rest-client/config/node_selector.md Co-authored-by: Marci W <333176+marciw@users.noreply.github.com> --- docs/reference/transport/rest-client/config/node_selector.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/transport/rest-client/config/node_selector.md b/docs/reference/transport/rest-client/config/node_selector.md index b2f027f1c..1c9951054 100644 --- a/docs/reference/transport/rest-client/config/node_selector.md +++ b/docs/reference/transport/rest-client/config/node_selector.md @@ -4,7 +4,7 @@ mapped_pages: navigation_title: Node selector --- -# Configuring node selector in the {{es}} Java REST client [_node_selector] +# Configuring node selectors in the {{es}} Java REST client [_node_selector] :::{include} /reference/_snippets/legacy-rest-client.md ::: From 5b96ca0d6d3bb55cfac75f6398f68dfd5bc954e0 Mon Sep 17 00:00:00 2001 From: ketkee-aryamane Date: Fri, 19 Sep 2025 15:18:11 +0200 Subject: [PATCH 10/11] change Others nav title to Other configuration options --- docs/reference/transport/rest-client/config/others.md | 2 +- docs/reference/transport/rest5-client/config/others.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference/transport/rest-client/config/others.md b/docs/reference/transport/rest-client/config/others.md index f61a9562b..9811392f0 100644 --- a/docs/reference/transport/rest-client/config/others.md +++ b/docs/reference/transport/rest-client/config/others.md @@ -1,7 +1,7 @@ --- mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/_others.html -navigation_title: Others +navigation_title: Other configuration options --- # Other configuration options in the {{es}} Java REST client [_others] diff --git a/docs/reference/transport/rest5-client/config/others.md b/docs/reference/transport/rest5-client/config/others.md index d25410811..c38cc9e58 100644 --- a/docs/reference/transport/rest5-client/config/others.md +++ b/docs/reference/transport/rest5-client/config/others.md @@ -1,7 +1,7 @@ --- mapped_pages: - https://www.elastic.co/docs/reference/elasticsearch/clients/java/transport/rest5-client/config/others.html -navigation_title: Others +navigation_title: Other configuration options --- # Other configuration options in the {{es}} Java REST 5 client From f66cb7b5a2ce89a3226c7e643ab593582d398903 Mon Sep 17 00:00:00 2001 From: ketkee-aryamane Date: Fri, 19 Sep 2025 15:25:49 +0200 Subject: [PATCH 11/11] update Others nav title to More config options --- docs/reference/transport/rest-client/config/others.md | 2 +- docs/reference/transport/rest5-client/config/others.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference/transport/rest-client/config/others.md b/docs/reference/transport/rest-client/config/others.md index 9811392f0..3737c95dd 100644 --- a/docs/reference/transport/rest-client/config/others.md +++ b/docs/reference/transport/rest-client/config/others.md @@ -1,7 +1,7 @@ --- mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/_others.html -navigation_title: Other configuration options +navigation_title: More config options --- # Other configuration options in the {{es}} Java REST client [_others] diff --git a/docs/reference/transport/rest5-client/config/others.md b/docs/reference/transport/rest5-client/config/others.md index c38cc9e58..096ca2ecc 100644 --- a/docs/reference/transport/rest5-client/config/others.md +++ b/docs/reference/transport/rest5-client/config/others.md @@ -1,7 +1,7 @@ --- mapped_pages: - https://www.elastic.co/docs/reference/elasticsearch/clients/java/transport/rest5-client/config/others.html -navigation_title: Other configuration options +navigation_title: More config options --- # Other configuration options in the {{es}} Java REST 5 client