@@ -507,7 +507,7 @@ public final ClosePointInTimeResponse closePointInTime(
507
507
// ----- Endpoint: count
508
508
509
509
/**
510
- * Returns number of documents matching a query.
510
+ * Count search results. Get the number of documents matching a query.
511
511
*
512
512
* @see <a href=
513
513
* "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html">Documentation
@@ -522,7 +522,7 @@ public CountResponse count(CountRequest request) throws IOException, Elasticsear
522
522
}
523
523
524
524
/**
525
- * Returns number of documents matching a query.
525
+ * Count search results. Get the number of documents matching a query.
526
526
*
527
527
* @param fn
528
528
* a function that initializes a builder to create the
@@ -538,7 +538,7 @@ public final CountResponse count(Function<CountRequest.Builder, ObjectBuilder<Co
538
538
}
539
539
540
540
/**
541
- * Returns number of documents matching a query.
541
+ * Count search results. Get the number of documents matching a query.
542
542
*
543
543
* @see <a href=
544
544
* "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html">Documentation
@@ -1168,7 +1168,34 @@ public final <TDocument> GetSourceResponse<TDocument> getSource(
1168
1168
// ----- Endpoint: health_report
1169
1169
1170
1170
/**
1171
- * Returns the health of the cluster.
1171
+ * Get the cluster health. Get a report with the health status of an
1172
+ * Elasticsearch cluster. The report contains a list of indicators that compose
1173
+ * Elasticsearch functionality.
1174
+ * <p>
1175
+ * Each indicator has a health status of: green, unknown, yellow or red. The
1176
+ * indicator will provide an explanation and metadata describing the reason for
1177
+ * its current health status.
1178
+ * <p>
1179
+ * The cluster’s status is controlled by the worst indicator status.
1180
+ * <p>
1181
+ * In the event that an indicator’s status is non-green, a list of impacts may
1182
+ * be present in the indicator result which detail the functionalities that are
1183
+ * negatively affected by the health issue. Each impact carries with it a
1184
+ * severity level, an area of the system that is affected, and a simple
1185
+ * description of the impact on the system.
1186
+ * <p>
1187
+ * Some health indicators can determine the root cause of a health problem and
1188
+ * prescribe a set of steps that can be performed in order to improve the health
1189
+ * of the system. The root cause and remediation steps are encapsulated in a
1190
+ * diagnosis. A diagnosis contains a cause detailing a root cause analysis, an
1191
+ * action containing a brief description of the steps to take to fix the
1192
+ * problem, the list of affected resources (if applicable), and a detailed
1193
+ * step-by-step troubleshooting guide to fix the diagnosed problem.
1194
+ * <p>
1195
+ * NOTE: The health indicators perform root cause analysis of non-green health
1196
+ * statuses. This can be computationally expensive when called frequently. When
1197
+ * setting up automated polling of the API for health status, set verbose to
1198
+ * false to disable the more expensive analysis logic.
1172
1199
*
1173
1200
* @see <a href=
1174
1201
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/health-api.html">Documentation
@@ -1183,7 +1210,34 @@ public HealthReportResponse healthReport(HealthReportRequest request) throws IOE
1183
1210
}
1184
1211
1185
1212
/**
1186
- * Returns the health of the cluster.
1213
+ * Get the cluster health. Get a report with the health status of an
1214
+ * Elasticsearch cluster. The report contains a list of indicators that compose
1215
+ * Elasticsearch functionality.
1216
+ * <p>
1217
+ * Each indicator has a health status of: green, unknown, yellow or red. The
1218
+ * indicator will provide an explanation and metadata describing the reason for
1219
+ * its current health status.
1220
+ * <p>
1221
+ * The cluster’s status is controlled by the worst indicator status.
1222
+ * <p>
1223
+ * In the event that an indicator’s status is non-green, a list of impacts may
1224
+ * be present in the indicator result which detail the functionalities that are
1225
+ * negatively affected by the health issue. Each impact carries with it a
1226
+ * severity level, an area of the system that is affected, and a simple
1227
+ * description of the impact on the system.
1228
+ * <p>
1229
+ * Some health indicators can determine the root cause of a health problem and
1230
+ * prescribe a set of steps that can be performed in order to improve the health
1231
+ * of the system. The root cause and remediation steps are encapsulated in a
1232
+ * diagnosis. A diagnosis contains a cause detailing a root cause analysis, an
1233
+ * action containing a brief description of the steps to take to fix the
1234
+ * problem, the list of affected resources (if applicable), and a detailed
1235
+ * step-by-step troubleshooting guide to fix the diagnosed problem.
1236
+ * <p>
1237
+ * NOTE: The health indicators perform root cause analysis of non-green health
1238
+ * statuses. This can be computationally expensive when called frequently. When
1239
+ * setting up automated polling of the API for health status, set verbose to
1240
+ * false to disable the more expensive analysis logic.
1187
1241
*
1188
1242
* @param fn
1189
1243
* a function that initializes a builder to create the
@@ -1200,7 +1254,34 @@ public final HealthReportResponse healthReport(
1200
1254
}
1201
1255
1202
1256
/**
1203
- * Returns the health of the cluster.
1257
+ * Get the cluster health. Get a report with the health status of an
1258
+ * Elasticsearch cluster. The report contains a list of indicators that compose
1259
+ * Elasticsearch functionality.
1260
+ * <p>
1261
+ * Each indicator has a health status of: green, unknown, yellow or red. The
1262
+ * indicator will provide an explanation and metadata describing the reason for
1263
+ * its current health status.
1264
+ * <p>
1265
+ * The cluster’s status is controlled by the worst indicator status.
1266
+ * <p>
1267
+ * In the event that an indicator’s status is non-green, a list of impacts may
1268
+ * be present in the indicator result which detail the functionalities that are
1269
+ * negatively affected by the health issue. Each impact carries with it a
1270
+ * severity level, an area of the system that is affected, and a simple
1271
+ * description of the impact on the system.
1272
+ * <p>
1273
+ * Some health indicators can determine the root cause of a health problem and
1274
+ * prescribe a set of steps that can be performed in order to improve the health
1275
+ * of the system. The root cause and remediation steps are encapsulated in a
1276
+ * diagnosis. A diagnosis contains a cause detailing a root cause analysis, an
1277
+ * action containing a brief description of the steps to take to fix the
1278
+ * problem, the list of affected resources (if applicable), and a detailed
1279
+ * step-by-step troubleshooting guide to fix the diagnosed problem.
1280
+ * <p>
1281
+ * NOTE: The health indicators perform root cause analysis of non-green health
1282
+ * statuses. This can be computationally expensive when called frequently. When
1283
+ * setting up automated polling of the API for health status, set verbose to
1284
+ * false to disable the more expensive analysis logic.
1204
1285
*
1205
1286
* @see <a href=
1206
1287
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/health-api.html">Documentation
@@ -1842,7 +1923,7 @@ public final OpenPointInTimeResponse openPointInTime(
1842
1923
// ----- Endpoint: ping
1843
1924
1844
1925
/**
1845
- * Ping the cluster. Returns whether the cluster is running.
1926
+ * Ping the cluster. Get information about whether the cluster is running.
1846
1927
*
1847
1928
* @see <a href=
1848
1929
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html">Documentation
0 commit comments