Skip to content

Commit c017e1a

Browse files
authored
Add deprecation headers to HLRC classes (#79754)
This commit adds the @deprecated annotation and Javadoc to HLRC classes.
1 parent bfd8e15 commit c017e1a

File tree

107 files changed

+233
-5
lines changed

Some content is hidden

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

107 files changed

+233
-5
lines changed

client/rest-high-level/qa/ssl-enabled/src/javaRestTest/java/org/elasticsearch/client/documentation/EnrollmentDocumentationIT.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828

2929
import static org.hamcrest.Matchers.startsWith;
3030

31+
@SuppressWarnings("removal")
3132
public class EnrollmentDocumentationIT extends ESRestHighLevelClientTestCase {
3233
static Path HTTP_TRUSTSTORE;
3334

client/rest-high-level/src/main/java/org/elasticsearch/client/AsyncSearchClient.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,13 @@
1919

2020
import static java.util.Collections.emptySet;
2121

22+
/**
23+
* @deprecated The High Level Rest Client is deprecated in favor of the
24+
* <a href="https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/introduction.html">
25+
* Elasticsearch Java API Client</a>
26+
*/
27+
@Deprecated(since = "7.16.0", forRemoval = true)
28+
@SuppressWarnings("removal")
2229
public class AsyncSearchClient {
2330
private final RestHighLevelClient restHighLevelClient;
2431

client/rest-high-level/src/main/java/org/elasticsearch/client/CcrClient.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,13 @@
3939
* <p>
4040
* See the <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-apis.html">
4141
* X-Pack Rollup APIs on elastic.co</a> for more information.
42+
*
43+
* @deprecated The High Level Rest Client is deprecated in favor of the
44+
* <a href="https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/introduction.html">
45+
* Elasticsearch Java API Client</a>
4246
*/
47+
@Deprecated(since = "7.16.0", forRemoval = true)
48+
@SuppressWarnings("removal")
4349
public final class CcrClient {
4450

4551
private final RestHighLevelClient restHighLevelClient;

client/rest-high-level/src/main/java/org/elasticsearch/client/ClusterClient.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,13 @@
3434
* A wrapper for the {@link RestHighLevelClient} that provides methods for accessing the Cluster API.
3535
* <p>
3636
* See <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html">Cluster API on elastic.co</a>
37+
*
38+
* @deprecated The High Level Rest Client is deprecated in favor of the
39+
* <a href="https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/introduction.html">
40+
* Elasticsearch Java API Client</a>
3741
*/
42+
@Deprecated(since = "7.16.0", forRemoval = true)
43+
@SuppressWarnings("removal")
3844
public final class ClusterClient {
3945
private final RestHighLevelClient restHighLevelClient;
4046

client/rest-high-level/src/main/java/org/elasticsearch/client/EnrichClient.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,13 @@
2727
* <p>
2828
* See the <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-apis.html">
2929
* X-Pack Enrich Policy APIs on elastic.co</a> for more information.
30+
*
31+
* @deprecated The High Level Rest Client is deprecated in favor of the
32+
* <a href="https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/introduction.html">
33+
* Elasticsearch Java API Client</a>
3034
*/
35+
@Deprecated(since = "7.16.0", forRemoval = true)
36+
@SuppressWarnings("removal")
3137
public final class EnrichClient {
3238

3339
private final RestHighLevelClient restHighLevelClient;

client/rest-high-level/src/main/java/org/elasticsearch/client/EqlClient.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,13 @@
2323
* <p>
2424
* See the <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html">
2525
* EQL APIs on elastic.co</a> for more information.
26+
*
27+
* @deprecated The High Level Rest Client is deprecated in favor of the
28+
* <a href="https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/introduction.html">
29+
* Elasticsearch Java API Client</a>
2630
*/
31+
@Deprecated(since = "7.16.0", forRemoval = true)
32+
@SuppressWarnings("removal")
2733
public final class EqlClient {
2834

2935
private final RestHighLevelClient restHighLevelClient;

client/rest-high-level/src/main/java/org/elasticsearch/client/FeaturesClient.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,13 @@
2222
* A wrapper for the {@link RestHighLevelClient} that provides methods for accessing the Snapshot API.
2323
* <p>
2424
* See <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/features-apis.html">Snapshot API on elastic.co</a>
25+
*
26+
* @deprecated The High Level Rest Client is deprecated in favor of the
27+
* <a href="https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/introduction.html">
28+
* Elasticsearch Java API Client</a>
2529
*/
30+
@Deprecated(since = "7.16.0", forRemoval = true)
31+
@SuppressWarnings("removal")
2632
public class FeaturesClient {
2733
private final RestHighLevelClient restHighLevelClient;
2834

client/rest-high-level/src/main/java/org/elasticsearch/client/GraphClient.java

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,13 @@
1616

1717
import static java.util.Collections.emptySet;
1818

19-
19+
/**
20+
* @deprecated The High Level Rest Client is deprecated in favor of the
21+
* <a href="https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/introduction.html">
22+
* Elasticsearch Java API Client</a>
23+
*/
24+
@Deprecated(since = "7.16.0", forRemoval = true)
25+
@SuppressWarnings("removal")
2026
public class GraphClient {
2127
private final RestHighLevelClient restHighLevelClient;
2228

client/rest-high-level/src/main/java/org/elasticsearch/client/IndexLifecycleClient.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,13 @@
4040

4141
import static java.util.Collections.emptySet;
4242

43+
/**
44+
* @deprecated The High Level Rest Client is deprecated in favor of the
45+
* <a href="https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/introduction.html">
46+
* Elasticsearch Java API Client</a>
47+
*/
48+
@Deprecated(since = "7.16.0", forRemoval = true)
49+
@SuppressWarnings("removal")
4350
public class IndexLifecycleClient {
4451
private final RestHighLevelClient restHighLevelClient;
4552

client/rest-high-level/src/main/java/org/elasticsearch/client/IndicesClient.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,13 @@
8181
* A wrapper for the {@link RestHighLevelClient} that provides methods for accessing the Indices API.
8282
* <p>
8383
* See <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/indices.html">Indices API on elastic.co</a>
84+
*
85+
* @deprecated The High Level Rest Client is deprecated in favor of the
86+
* <a href="https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/introduction.html">
87+
* Elasticsearch Java API Client</a>
8488
*/
89+
@Deprecated(since = "7.16.0", forRemoval = true)
90+
@SuppressWarnings("removal")
8591
public final class IndicesClient {
8692
private final RestHighLevelClient restHighLevelClient;
8793

0 commit comments

Comments
 (0)