Skip to content

Commit 5c44c85

Browse files
committed
[codegen] update to latest spec
1 parent dae1f43 commit 5c44c85

File tree

135 files changed

+6370
-1744
lines changed

Some content is hidden

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

135 files changed

+6370
-1744
lines changed

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

Lines changed: 88 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -502,7 +502,7 @@ public final CompletableFuture<ClosePointInTimeResponse> closePointInTime(
502502
// ----- Endpoint: count
503503

504504
/**
505-
* Returns number of documents matching a query.
505+
* Count search results. Get the number of documents matching a query.
506506
*
507507
* @see <a href=
508508
* "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html">Documentation
@@ -517,7 +517,7 @@ public CompletableFuture<CountResponse> count(CountRequest request) {
517517
}
518518

519519
/**
520-
* Returns number of documents matching a query.
520+
* Count search results. Get the number of documents matching a query.
521521
*
522522
* @param fn
523523
* a function that initializes a builder to create the
@@ -533,7 +533,7 @@ public final CompletableFuture<CountResponse> count(
533533
}
534534

535535
/**
536-
* Returns number of documents matching a query.
536+
* Count search results. Get the number of documents matching a query.
537537
*
538538
* @see <a href=
539539
* "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html">Documentation
@@ -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

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

Lines changed: 88 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -507,7 +507,7 @@ public final ClosePointInTimeResponse closePointInTime(
507507
// ----- Endpoint: count
508508

509509
/**
510-
* Returns number of documents matching a query.
510+
* Count search results. Get the number of documents matching a query.
511511
*
512512
* @see <a href=
513513
* "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
522522
}
523523

524524
/**
525-
* Returns number of documents matching a query.
525+
* Count search results. Get the number of documents matching a query.
526526
*
527527
* @param fn
528528
* a function that initializes a builder to create the
@@ -538,7 +538,7 @@ public final CountResponse count(Function<CountRequest.Builder, ObjectBuilder<Co
538538
}
539539

540540
/**
541-
* Returns number of documents matching a query.
541+
* Count search results. Get the number of documents matching a query.
542542
*
543543
* @see <a href=
544544
* "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html">Documentation
@@ -1168,7 +1168,34 @@ public final <TDocument> GetSourceResponse<TDocument> getSource(
11681168
// ----- Endpoint: health_report
11691169

11701170
/**
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.
11721199
*
11731200
* @see <a href=
11741201
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/health-api.html">Documentation
@@ -1183,7 +1210,34 @@ public HealthReportResponse healthReport(HealthReportRequest request) throws IOE
11831210
}
11841211

11851212
/**
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.
11871241
*
11881242
* @param fn
11891243
* a function that initializes a builder to create the
@@ -1200,7 +1254,34 @@ public final HealthReportResponse healthReport(
12001254
}
12011255

12021256
/**
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.
12041285
*
12051286
* @see <a href=
12061287
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/health-api.html">Documentation
@@ -1842,7 +1923,7 @@ public final OpenPointInTimeResponse openPointInTime(
18421923
// ----- Endpoint: ping
18431924

18441925
/**
1845-
* Ping the cluster. Returns whether the cluster is running.
1926+
* Ping the cluster. Get information about whether the cluster is running.
18461927
*
18471928
* @see <a href=
18481929
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html">Documentation

java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/AllocationExplainRequest.java

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,13 @@
5959
// typedef: cluster.allocation_explain.Request
6060

6161
/**
62-
* Provides explanations for shard allocations in the cluster.
62+
* Explain the shard allocations. Get explanations for shard allocations in the
63+
* cluster. For unassigned shards, it provides an explanation for why the shard
64+
* is unassigned. For assigned shards, it provides an explanation for why the
65+
* shard is remaining on its current node and has not moved or rebalanced to
66+
* another node. This API can be very useful when attempting to diagnose why a
67+
* shard is unassigned or why a shard continues to remain on its current node
68+
* when you might expect otherwise.
6369
*
6470
* @see <a href=
6571
* "../doc-files/api-spec.html#cluster.allocation_explain.Request">API

java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ClusterStatsRequest.java

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,10 +59,9 @@
5959
// typedef: cluster.stats.Request
6060

6161
/**
62-
* Returns cluster statistics. It returns basic index metrics (shard numbers,
63-
* store size, memory usage) and information about the current nodes that form
64-
* the cluster (number, roles, os, jvm versions, memory usage, cpu and installed
65-
* plugins).
62+
* Get cluster statistics. Get basic index metrics (shard numbers, store size,
63+
* memory usage) and information about the current nodes that form the cluster
64+
* (number, roles, os, jvm versions, memory usage, cpu and installed plugins).
6665
*
6766
* @see <a href="../doc-files/api-spec.html#cluster.stats.Request">API
6867
* specification</a>

java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/DeleteVotingConfigExclusionsRequest.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,8 @@
5757
// typedef: cluster.delete_voting_config_exclusions.Request
5858

5959
/**
60-
* Clears cluster voting config exclusions.
60+
* Clear cluster voting config exclusions. Remove master-eligible nodes from the
61+
* voting configuration exclusion list.
6162
*
6263
* @see <a href=
6364
* "../doc-files/api-spec.html#cluster.delete_voting_config_exclusions.Request">API

0 commit comments

Comments
 (0)