Skip to content

Commit 5e0e54f

Browse files
author
Hendrik Muhs
authored
[Transform] move root endpoint to _transform with BWC layer (#47127) (#47682)
move the main endpoint to /_transform/ from /_data_frame/transforms/ with providing backwards compatibility and deprecation warnings
1 parent 91988c7 commit 5e0e54f

File tree

94 files changed

+1580
-276
lines changed

Some content is hidden

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

94 files changed

+1580
-276
lines changed

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

+8-8
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ private TransformRequestConverters() {}
4848

4949
static Request putTransform(PutTransformRequest putRequest) throws IOException {
5050
String endpoint = new RequestConverters.EndpointBuilder()
51-
.addPathPartAsIs("_data_frame", "transforms")
51+
.addPathPartAsIs("_transform")
5252
.addPathPart(putRequest.getConfig().getId())
5353
.build();
5454
Request request = new Request(HttpPut.METHOD_NAME, endpoint);
@@ -61,7 +61,7 @@ static Request putTransform(PutTransformRequest putRequest) throws IOException {
6161

6262
static Request updateTransform(UpdateTransformRequest updateDataFrameTransformRequest) throws IOException {
6363
String endpoint = new RequestConverters.EndpointBuilder()
64-
.addPathPartAsIs("_data_frame", "transforms")
64+
.addPathPartAsIs("_transform")
6565
.addPathPart(updateDataFrameTransformRequest.getId())
6666
.addPathPart("_update")
6767
.build();
@@ -75,7 +75,7 @@ static Request updateTransform(UpdateTransformRequest updateDataFrameTransformRe
7575

7676
static Request getTransform(GetTransformRequest getRequest) {
7777
String endpoint = new RequestConverters.EndpointBuilder()
78-
.addPathPartAsIs("_data_frame", "transforms")
78+
.addPathPartAsIs("_transform")
7979
.addPathPart(Strings.collectionToCommaDelimitedString(getRequest.getId()))
8080
.build();
8181
Request request = new Request(HttpGet.METHOD_NAME, endpoint);
@@ -93,7 +93,7 @@ static Request getTransform(GetTransformRequest getRequest) {
9393

9494
static Request deleteTransform(DeleteTransformRequest deleteRequest) {
9595
String endpoint = new RequestConverters.EndpointBuilder()
96-
.addPathPartAsIs("_data_frame", "transforms")
96+
.addPathPartAsIs("_transform")
9797
.addPathPart(deleteRequest.getId())
9898
.build();
9999
Request request = new Request(HttpDelete.METHOD_NAME, endpoint);
@@ -105,7 +105,7 @@ static Request deleteTransform(DeleteTransformRequest deleteRequest) {
105105

106106
static Request startTransform(StartTransformRequest startRequest) {
107107
String endpoint = new RequestConverters.EndpointBuilder()
108-
.addPathPartAsIs("_data_frame", "transforms")
108+
.addPathPartAsIs("_transform")
109109
.addPathPart(startRequest.getId())
110110
.addPathPartAsIs("_start")
111111
.build();
@@ -120,7 +120,7 @@ static Request startTransform(StartTransformRequest startRequest) {
120120

121121
static Request stopTransform(StopTransformRequest stopRequest) {
122122
String endpoint = new RequestConverters.EndpointBuilder()
123-
.addPathPartAsIs("_data_frame", "transforms")
123+
.addPathPartAsIs("_transform")
124124
.addPathPart(stopRequest.getId())
125125
.addPathPartAsIs("_stop")
126126
.build();
@@ -141,7 +141,7 @@ static Request stopTransform(StopTransformRequest stopRequest) {
141141

142142
static Request previewTransform(PreviewTransformRequest previewRequest) throws IOException {
143143
String endpoint = new RequestConverters.EndpointBuilder()
144-
.addPathPartAsIs("_data_frame", "transforms", "_preview")
144+
.addPathPartAsIs("_transform", "_preview")
145145
.build();
146146
Request request = new Request(HttpPost.METHOD_NAME, endpoint);
147147
request.setEntity(createEntity(previewRequest, REQUEST_BODY_CONTENT_TYPE));
@@ -150,7 +150,7 @@ static Request previewTransform(PreviewTransformRequest previewRequest) throws I
150150

151151
static Request getTransformStats(GetTransformStatsRequest statsRequest) {
152152
String endpoint = new RequestConverters.EndpointBuilder()
153-
.addPathPartAsIs("_data_frame", "transforms")
153+
.addPathPartAsIs("_transform")
154154
.addPathPart(statsRequest.getId())
155155
.addPathPartAsIs("_stats")
156156
.build();

‎client/rest-high-level/src/test/java/org/elasticsearch/client/DataFrameRequestConvertersTests.java renamed to ‎client/rest-high-level/src/test/java/org/elasticsearch/client/TransformRequestConvertersTests.java

+11-11
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,14 @@
2424
import org.apache.http.client.methods.HttpPost;
2525
import org.apache.http.client.methods.HttpPut;
2626
import org.elasticsearch.client.core.PageParams;
27-
import org.elasticsearch.client.transform.TransformNamedXContentProvider;
2827
import org.elasticsearch.client.transform.DeleteTransformRequest;
2928
import org.elasticsearch.client.transform.GetTransformRequest;
3029
import org.elasticsearch.client.transform.GetTransformStatsRequest;
3130
import org.elasticsearch.client.transform.PreviewTransformRequest;
3231
import org.elasticsearch.client.transform.PutTransformRequest;
3332
import org.elasticsearch.client.transform.StartTransformRequest;
3433
import org.elasticsearch.client.transform.StopTransformRequest;
34+
import org.elasticsearch.client.transform.TransformNamedXContentProvider;
3535
import org.elasticsearch.client.transform.UpdateTransformRequest;
3636
import org.elasticsearch.client.transform.transforms.TransformConfig;
3737
import org.elasticsearch.client.transform.transforms.TransformConfigTests;
@@ -56,7 +56,7 @@
5656
import static org.hamcrest.Matchers.hasKey;
5757
import static org.hamcrest.Matchers.not;
5858

59-
public class DataFrameRequestConvertersTests extends ESTestCase {
59+
public class TransformRequestConvertersTests extends ESTestCase {
6060

6161
@Override
6262
protected NamedXContentRegistry xContentRegistry() {
@@ -72,7 +72,7 @@ public void testPutDataFrameTransform() throws IOException {
7272
Request request = TransformRequestConverters.putTransform(putRequest);
7373
assertThat(request.getParameters(), not(hasKey("defer_validation")));
7474
assertEquals(HttpPut.METHOD_NAME, request.getMethod());
75-
assertThat(request.getEndpoint(), equalTo("/_data_frame/transforms/" + putRequest.getConfig().getId()));
75+
assertThat(request.getEndpoint(), equalTo("/_transform/" + putRequest.getConfig().getId()));
7676

7777
try (XContentParser parser = createParser(JsonXContent.jsonXContent, request.getEntity().getContent())) {
7878
TransformConfig parsedConfig = TransformConfig.PARSER.apply(parser, null);
@@ -91,7 +91,7 @@ public void testUpdateDataFrameTransform() throws IOException {
9191
Request request = TransformRequestConverters.updateTransform(updateDataFrameTransformRequest);
9292
assertThat(request.getParameters(), not(hasKey("defer_validation")));
9393
assertEquals(HttpPost.METHOD_NAME, request.getMethod());
94-
assertThat(request.getEndpoint(), equalTo("/_data_frame/transforms/" + transformId + "/_update"));
94+
assertThat(request.getEndpoint(), equalTo("/_transform/" + transformId + "/_update"));
9595

9696
try (XContentParser parser = createParser(JsonXContent.jsonXContent, request.getEntity().getContent())) {
9797
TransformConfigUpdate parsedConfig = TransformConfigUpdate.fromXContent(parser);
@@ -108,7 +108,7 @@ public void testDeleteDataFrameTransform() {
108108
Request request = TransformRequestConverters.deleteTransform(deleteRequest);
109109

110110
assertEquals(HttpDelete.METHOD_NAME, request.getMethod());
111-
assertThat(request.getEndpoint(), equalTo("/_data_frame/transforms/foo"));
111+
assertThat(request.getEndpoint(), equalTo("/_transform/foo"));
112112

113113
assertThat(request.getParameters(), not(hasKey("force")));
114114

@@ -128,7 +128,7 @@ public void testStartDataFrameTransform() {
128128

129129
Request request = TransformRequestConverters.startTransform(startRequest);
130130
assertEquals(HttpPost.METHOD_NAME, request.getMethod());
131-
assertThat(request.getEndpoint(), equalTo("/_data_frame/transforms/" + startRequest.getId() + "/_start"));
131+
assertThat(request.getEndpoint(), equalTo("/_transform/" + startRequest.getId() + "/_start"));
132132

133133
if (timeValue != null) {
134134
assertTrue(request.getParameters().containsKey("timeout"));
@@ -152,7 +152,7 @@ public void testStopDataFrameTransform() {
152152

153153
Request request = TransformRequestConverters.stopTransform(stopRequest);
154154
assertEquals(HttpPost.METHOD_NAME, request.getMethod());
155-
assertThat(request.getEndpoint(), equalTo("/_data_frame/transforms/" + stopRequest.getId() + "/_stop"));
155+
assertThat(request.getEndpoint(), equalTo("/_transform/" + stopRequest.getId() + "/_stop"));
156156

157157
if (waitForCompletion != null) {
158158
assertTrue(request.getParameters().containsKey("wait_for_completion"));
@@ -180,7 +180,7 @@ public void testPreviewDataFrameTransform() throws IOException {
180180
Request request = TransformRequestConverters.previewTransform(previewRequest);
181181

182182
assertEquals(HttpPost.METHOD_NAME, request.getMethod());
183-
assertThat(request.getEndpoint(), equalTo("/_data_frame/transforms/_preview"));
183+
assertThat(request.getEndpoint(), equalTo("/_transform/_preview"));
184184

185185
try (XContentParser parser = createParser(JsonXContent.jsonXContent, request.getEntity().getContent())) {
186186
TransformConfig parsedConfig = TransformConfig.PARSER.apply(parser, null);
@@ -193,7 +193,7 @@ public void testGetDataFrameTransformStats() {
193193
Request request = TransformRequestConverters.getTransformStats(getStatsRequest);
194194

195195
assertEquals(HttpGet.METHOD_NAME, request.getMethod());
196-
assertThat(request.getEndpoint(), equalTo("/_data_frame/transforms/foo/_stats"));
196+
assertThat(request.getEndpoint(), equalTo("/_transform/foo/_stats"));
197197

198198
assertFalse(request.getParameters().containsKey("from"));
199199
assertFalse(request.getParameters().containsKey("size"));
@@ -223,7 +223,7 @@ public void testGetDataFrameTransform() {
223223
Request request = TransformRequestConverters.getTransform(getRequest);
224224

225225
assertEquals(HttpGet.METHOD_NAME, request.getMethod());
226-
assertThat(request.getEndpoint(), equalTo("/_data_frame/transforms/bar"));
226+
assertThat(request.getEndpoint(), equalTo("/_transform/bar"));
227227

228228
assertFalse(request.getParameters().containsKey("from"));
229229
assertFalse(request.getParameters().containsKey("size"));
@@ -253,6 +253,6 @@ public void testGetDataFrameTransform_givenMulitpleIds() {
253253
Request request = TransformRequestConverters.getTransform(getRequest);
254254

255255
assertEquals(HttpGet.METHOD_NAME, request.getMethod());
256-
assertThat(request.getEndpoint(), equalTo("/_data_frame/transforms/foo,bar,baz"));
256+
assertThat(request.getEndpoint(), equalTo("/_transform/foo,bar,baz"));
257257
}
258258
}

‎client/rest-high-level/src/test/java/org/elasticsearch/client/documentation/TransformDocumentationIT.java

+6-6
Original file line numberDiff line numberDiff line change
@@ -42,16 +42,16 @@
4242
import org.elasticsearch.client.transform.StopTransformResponse;
4343
import org.elasticsearch.client.transform.UpdateTransformRequest;
4444
import org.elasticsearch.client.transform.UpdateTransformResponse;
45-
import org.elasticsearch.client.transform.transforms.TransformIndexerStats;
46-
import org.elasticsearch.client.transform.transforms.TransformConfig;
47-
import org.elasticsearch.client.transform.transforms.TransformConfigUpdate;
48-
import org.elasticsearch.client.transform.transforms.TransformProgress;
49-
import org.elasticsearch.client.transform.transforms.TransformStats;
5045
import org.elasticsearch.client.transform.transforms.DestConfig;
5146
import org.elasticsearch.client.transform.transforms.NodeAttributes;
5247
import org.elasticsearch.client.transform.transforms.QueryConfig;
5348
import org.elasticsearch.client.transform.transforms.SourceConfig;
5449
import org.elasticsearch.client.transform.transforms.TimeSyncConfig;
50+
import org.elasticsearch.client.transform.transforms.TransformConfig;
51+
import org.elasticsearch.client.transform.transforms.TransformConfigUpdate;
52+
import org.elasticsearch.client.transform.transforms.TransformIndexerStats;
53+
import org.elasticsearch.client.transform.transforms.TransformProgress;
54+
import org.elasticsearch.client.transform.transforms.TransformStats;
5555
import org.elasticsearch.client.transform.transforms.pivot.AggregationConfig;
5656
import org.elasticsearch.client.transform.transforms.pivot.GroupConfig;
5757
import org.elasticsearch.client.transform.transforms.pivot.PivotConfig;
@@ -219,7 +219,7 @@ public void onFailure(Exception e) {
219219
}
220220
}
221221

222-
public void testUpdateDataFrameTransform() throws IOException, InterruptedException {
222+
public void testUpdateTransform() throws IOException, InterruptedException {
223223
createIndex("source-data");
224224

225225
RestHighLevelClient client = highLevelClient();

‎docs/build.gradle

+1-1
Original file line numberDiff line numberDiff line change
@@ -1189,7 +1189,7 @@ buildRestTests.setups['simple_kibana_continuous_pivot'] = buildRestTests.setups[
11891189
- do:
11901190
raw:
11911191
method: PUT
1192-
path: _data_frame/transforms/simple-kibana-ecomm-pivot
1192+
path: _transform/simple-kibana-ecomm-pivot
11931193
body: >
11941194
{
11951195
"source": {

‎docs/reference/transform/api-quickref.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ All {transform} endpoints have the following base:
66

77
[source,js]
88
----
9-
/_data_frame/transforms/
9+
_transform/
1010
----
1111
// NOTCONSOLE
1212

‎docs/reference/transform/apis/delete-transform.asciidoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ beta[]
1515
[[delete-transform-request]]
1616
==== {api-request-title}
1717

18-
`DELETE _data_frame/transforms/<transform_id>`
18+
`DELETE _transform/<transform_id>`
1919

2020
[[delete-transform-prereqs]]
2121
==== {api-prereq-title}
@@ -46,7 +46,7 @@ current state. The default value is `false`, meaning that the {transform} must b
4646

4747
[source,console]
4848
--------------------------------------------------
49-
DELETE _data_frame/transforms/ecommerce_transform
49+
DELETE _transform/ecommerce_transform
5050
--------------------------------------------------
5151
// TEST[skip:setup kibana sample data]
5252

‎docs/reference/transform/apis/get-transform-stats.asciidoc

+7-7
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ beta[]
1616
[[get-transform-stats-request]]
1717
==== {api-request-title}
1818

19-
`GET _data_frame/transforms/<transform_id>/_stats`
19+
`GET _transform/<transform_id>/_stats`
2020

21-
`GET _data_frame/transforms/<transform_id>,<transform_id>/_stats` +
21+
`GET _transform/<transform_id>,<transform_id>/_stats` +
2222

23-
`GET _data_frame/transforms/_stats` +
23+
`GET _transform/_stats` +
2424

25-
`GET _data_frame/transforms/_all/_stats` +
25+
`GET _transform/_all/_stats` +
2626

27-
`GET _data_frame/transforms/*/_stats` +
27+
`GET _transform/*/_stats` +
2828

2929

3030
[[get-transform-stats-prereqs]]
@@ -102,7 +102,7 @@ gets usage information for a maximum of ten results:
102102

103103
[source,console]
104104
--------------------------------------------------
105-
GET _data_frame/transforms/_stats?from=5&size=10
105+
GET _transform/_stats?from=5&size=10
106106
--------------------------------------------------
107107
// TEST[skip:todo]
108108

@@ -111,7 +111,7 @@ The following example gets usage information for the `ecommerce_transform`
111111

112112
[source,console]
113113
--------------------------------------------------
114-
GET _data_frame/transforms/ecommerce_transform/_stats
114+
GET _transform/ecommerce_transform/_stats
115115
--------------------------------------------------
116116
// TEST[skip:todo]
117117

‎docs/reference/transform/apis/get-transform.asciidoc

+7-7
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@ beta[]
1515
[[get-transform-request]]
1616
==== {api-request-title}
1717

18-
`GET _data_frame/transforms/<transform_id>` +
18+
`GET _transform/<transform_id>` +
1919

20-
`GET _data_frame/transforms/<transform_id>,<transform_id>` +
20+
`GET _transform/<transform_id>,<transform_id>` +
2121

22-
`GET _data_frame/transforms/` +
22+
`GET _transform/` +
2323

24-
`GET _data_frame/transforms/_all` +
24+
`GET _transform/_all` +
2525

26-
`GET _data_frame/transforms/*`
26+
`GET _transform/*`
2727

2828
[[get-transform-prereqs]]
2929
==== {api-prereq-title}
@@ -95,7 +95,7 @@ The following example retrieves information about a maximum of ten {transforms}:
9595

9696
[source,console]
9797
--------------------------------------------------
98-
GET _data_frame/transforms?size=10
98+
GET _transform?size=10
9999
--------------------------------------------------
100100
// TEST[skip:setup kibana sample data]
101101

@@ -104,7 +104,7 @@ The following example gets configuration information for the
104104

105105
[source,console]
106106
--------------------------------------------------
107-
GET _data_frame/transforms/ecommerce_transform
107+
GET _transform/ecommerce_transform
108108
--------------------------------------------------
109109
// TEST[skip:setup kibana sample data]
110110

‎docs/reference/transform/apis/preview-transform.asciidoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ beta[]
1515
[[preview-transform-request]]
1616
==== {api-request-title}
1717

18-
`POST _data_frame/transforms/_preview`
18+
`POST _transform/_preview`
1919

2020
[[preview-transform-prereq]]
2121
==== {api-prereq-title}
@@ -68,7 +68,7 @@ on all the current data in the source index.
6868

6969
[source,console]
7070
--------------------------------------------------
71-
POST _data_frame/transforms/_preview
71+
POST _transform/_preview
7272
{
7373
"source": {
7474
"index": "kibana_sample_data_ecommerce"

‎docs/reference/transform/apis/put-transform.asciidoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ beta[]
1515
[[put-transform-request]]
1616
==== {api-request-title}
1717

18-
`PUT _data_frame/transforms/<transform_id>`
18+
`PUT _transform/<transform_id>`
1919

2020
[[put-transform-prereqs]]
2121
==== {api-prereq-title}
@@ -139,7 +139,7 @@ delays.
139139

140140
[source,console]
141141
--------------------------------------------------
142-
PUT _data_frame/transforms/ecommerce_transform
142+
PUT _transform/ecommerce_transform
143143
{
144144
"source": {
145145
"index": "kibana_sample_data_ecommerce",

‎docs/reference/transform/apis/start-transform.asciidoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ beta[]
1515
[[start-transform-request]]
1616
==== {api-request-title}
1717

18-
`POST _data_frame/transforms/<transform_id>/_start`
18+
`POST _transform/<transform_id>/_start`
1919

2020
[[start-transform-prereqs]]
2121
==== {api-prereq-title}
@@ -62,7 +62,7 @@ required privileges on the source and destination indices, the
6262

6363
[source,console]
6464
--------------------------------------------------
65-
POST _data_frame/transforms/ecommerce_transform/_start
65+
POST _transform/ecommerce_transform/_start
6666
--------------------------------------------------
6767
// TEST[skip:set up kibana samples]
6868

‎docs/reference/transform/apis/stop-transform.asciidoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ beta[]
1616
[[stop-transform-request]]
1717
==== {api-request-title}
1818

19-
`POST _data_frame/transforms/<transform_id>/_stop` +
19+
`POST _transform/<transform_id>/_stop` +
2020

21-
`POST _data_frame/transforms/<transform_id1>,<transform_id2>/_stop` +
21+
`POST _transform/<transform_id1>,<transform_id2>/_stop` +
2222

23-
`POST _data_frame/transforms/_all/_stop`
23+
`POST _transform/_all/_stop`
2424

2525

2626
[[stop-transform-prereq]]
@@ -104,7 +104,7 @@ are no matches or only partial matches.
104104

105105
[source,console]
106106
--------------------------------------------------
107-
POST _data_frame/transforms/ecommerce_transform/_stop
107+
POST _transform/ecommerce_transform/_stop
108108
--------------------------------------------------
109109
// TEST[skip:set up kibana samples]
110110

0 commit comments

Comments
 (0)