@@ -1151,7 +1151,34 @@ public final <TDocument> CompletableFuture<GetSourceResponse<TDocument>> getSour
11511151 // ----- Endpoint: health_report
11521152
11531153 /**
1154- * Returns the health of the cluster.
1154+ * Get the cluster health. Get a report with the health status of an
1155+ * Elasticsearch cluster. The report contains a list of indicators that compose
1156+ * Elasticsearch functionality.
1157+ * <p>
1158+ * Each indicator has a health status of: green, unknown, yellow or red. The
1159+ * indicator will provide an explanation and metadata describing the reason for
1160+ * its current health status.
1161+ * <p>
1162+ * The cluster’s status is controlled by the worst indicator status.
1163+ * <p>
1164+ * In the event that an indicator’s status is non-green, a list of impacts may
1165+ * be present in the indicator result which detail the functionalities that are
1166+ * negatively affected by the health issue. Each impact carries with it a
1167+ * severity level, an area of the system that is affected, and a simple
1168+ * description of the impact on the system.
1169+ * <p>
1170+ * Some health indicators can determine the root cause of a health problem and
1171+ * prescribe a set of steps that can be performed in order to improve the health
1172+ * of the system. The root cause and remediation steps are encapsulated in a
1173+ * diagnosis. A diagnosis contains a cause detailing a root cause analysis, an
1174+ * action containing a brief description of the steps to take to fix the
1175+ * problem, the list of affected resources (if applicable), and a detailed
1176+ * step-by-step troubleshooting guide to fix the diagnosed problem.
1177+ * <p>
1178+ * NOTE: The health indicators perform root cause analysis of non-green health
1179+ * statuses. This can be computationally expensive when called frequently. When
1180+ * setting up automated polling of the API for health status, set verbose to
1181+ * false to disable the more expensive analysis logic.
11551182 *
11561183 * @see <a href=
11571184 * "https://www.elastic.co/guide/en/elasticsearch/reference/current/health-api.html">Documentation
@@ -1166,7 +1193,34 @@ public CompletableFuture<HealthReportResponse> healthReport(HealthReportRequest
11661193 }
11671194
11681195 /**
1169- * Returns the health of the cluster.
1196+ * Get the cluster health. Get a report with the health status of an
1197+ * Elasticsearch cluster. The report contains a list of indicators that compose
1198+ * Elasticsearch functionality.
1199+ * <p>
1200+ * Each indicator has a health status of: green, unknown, yellow or red. The
1201+ * indicator will provide an explanation and metadata describing the reason for
1202+ * its current health status.
1203+ * <p>
1204+ * The cluster’s status is controlled by the worst indicator status.
1205+ * <p>
1206+ * In the event that an indicator’s status is non-green, a list of impacts may
1207+ * be present in the indicator result which detail the functionalities that are
1208+ * negatively affected by the health issue. Each impact carries with it a
1209+ * severity level, an area of the system that is affected, and a simple
1210+ * description of the impact on the system.
1211+ * <p>
1212+ * Some health indicators can determine the root cause of a health problem and
1213+ * prescribe a set of steps that can be performed in order to improve the health
1214+ * of the system. The root cause and remediation steps are encapsulated in a
1215+ * diagnosis. A diagnosis contains a cause detailing a root cause analysis, an
1216+ * action containing a brief description of the steps to take to fix the
1217+ * problem, the list of affected resources (if applicable), and a detailed
1218+ * step-by-step troubleshooting guide to fix the diagnosed problem.
1219+ * <p>
1220+ * NOTE: The health indicators perform root cause analysis of non-green health
1221+ * statuses. This can be computationally expensive when called frequently. When
1222+ * setting up automated polling of the API for health status, set verbose to
1223+ * false to disable the more expensive analysis logic.
11701224 *
11711225 * @param fn
11721226 * a function that initializes a builder to create the
@@ -1182,7 +1236,34 @@ public final CompletableFuture<HealthReportResponse> healthReport(
11821236 }
11831237
11841238 /**
1185- * Returns the health of the cluster.
1239+ * Get the cluster health. Get a report with the health status of an
1240+ * Elasticsearch cluster. The report contains a list of indicators that compose
1241+ * Elasticsearch functionality.
1242+ * <p>
1243+ * Each indicator has a health status of: green, unknown, yellow or red. The
1244+ * indicator will provide an explanation and metadata describing the reason for
1245+ * its current health status.
1246+ * <p>
1247+ * The cluster’s status is controlled by the worst indicator status.
1248+ * <p>
1249+ * In the event that an indicator’s status is non-green, a list of impacts may
1250+ * be present in the indicator result which detail the functionalities that are
1251+ * negatively affected by the health issue. Each impact carries with it a
1252+ * severity level, an area of the system that is affected, and a simple
1253+ * description of the impact on the system.
1254+ * <p>
1255+ * Some health indicators can determine the root cause of a health problem and
1256+ * prescribe a set of steps that can be performed in order to improve the health
1257+ * of the system. The root cause and remediation steps are encapsulated in a
1258+ * diagnosis. A diagnosis contains a cause detailing a root cause analysis, an
1259+ * action containing a brief description of the steps to take to fix the
1260+ * problem, the list of affected resources (if applicable), and a detailed
1261+ * step-by-step troubleshooting guide to fix the diagnosed problem.
1262+ * <p>
1263+ * NOTE: The health indicators perform root cause analysis of non-green health
1264+ * statuses. This can be computationally expensive when called frequently. When
1265+ * setting up automated polling of the API for health status, set verbose to
1266+ * false to disable the more expensive analysis logic.
11861267 *
11871268 * @see <a href=
11881269 * "https://www.elastic.co/guide/en/elasticsearch/reference/current/health-api.html">Documentation
@@ -1814,7 +1895,7 @@ public final CompletableFuture<OpenPointInTimeResponse> openPointInTime(
18141895 // ----- Endpoint: ping
18151896
18161897 /**
1817- * Ping the cluster. Returns whether the cluster is running.
1898+ * Ping the cluster. Get information about whether the cluster is running.
18181899 *
18191900 * @see <a href=
18201901 * "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html">Documentation
0 commit comments