diff --git a/client/rest-high-level/src/main/java/org/elasticsearch/client/DataFrameClient.java b/client/rest-high-level/src/main/java/org/elasticsearch/client/DataFrameClient.java index 8d7d3bc2ed497..5a032e77b938a 100644 --- a/client/rest-high-level/src/main/java/org/elasticsearch/client/DataFrameClient.java +++ b/client/rest-high-level/src/main/java/org/elasticsearch/client/DataFrameClient.java @@ -46,11 +46,11 @@ public final class DataFrameClient { } /** - * Creates a new Data Frame Transform + * Creates a new transform *

* For additional info - * see - * Create data frame transform documentation + * see + * Create transform documentation * * @param request The PutDataFrameTransformRequest containing the * {@link org.elasticsearch.client.dataframe.transforms.DataFrameTransformConfig}. @@ -67,11 +67,11 @@ public AcknowledgedResponse putDataFrameTransform(PutDataFrameTransformRequest r } /** - * Creates a new Data Frame Transform asynchronously and notifies listener on completion + * Creates a new transform asynchronously and notifies listener on completion *

* For additional info - * see - * Create data frame transform documentation + * see + * Create transform documentation * * @param request The PutDataFrameTransformRequest containing the * {@link org.elasticsearch.client.dataframe.transforms.DataFrameTransformConfig}. @@ -89,15 +89,15 @@ public void putDataFrameTransformAsync(PutDataFrameTransformRequest request, Req } /** - * Get the running statistics of a Data Frame Transform + * Get the running statistics of a transform *

* For additional info - * see - * Get data frame transform stats documentation + * see + * Get transform stats documentation * * @param request Specifies the which transforms to get the stats for * @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized - * @return The Data Frame Transform stats + * @return The transform stats * @throws IOException when there is a serialization issue sending the request or receiving the response */ public GetDataFrameTransformStatsResponse getDataFrameTransformStats(GetDataFrameTransformStatsRequest request, RequestOptions options) @@ -110,11 +110,11 @@ public GetDataFrameTransformStatsResponse getDataFrameTransformStats(GetDataFram } /** - * Get the running statistics of a Data Frame Transform asynchronously and notifies listener on completion + * Get the running statistics of a transform asynchronously and notifies listener on completion *

* For additional info - * see - * Get data frame transform stats documentation + * see + * Get transform stats documentation * * @param request Specifies the which transforms to get the stats for * @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized @@ -131,13 +131,13 @@ public void getDataFrameTransformStatsAsync(GetDataFrameTransformStatsRequest re } /** - * Delete a data frame transform + * Delete a transform *

* For additional info - * see - * Delete data frame transform documentation + * see + * Delete transform documentation * - * @param request The delete data frame transform request + * @param request The delete transform request * @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized * @return An AcknowledgedResponse object indicating request success * @throws IOException when there is a serialization issue sending the request or receiving the response @@ -152,13 +152,13 @@ public AcknowledgedResponse deleteDataFrameTransform(DeleteDataFrameTransformReq } /** - * Delete a data frame transform asynchronously and notifies listener on completion + * Delete a transform asynchronously and notifies listener on completion *

* For additional info - * see - * Delete data frame transform documentation + * see + * Delete transform documentation * - * @param request The delete data frame transform request + * @param request The delete transform request * @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized * @param listener Listener to be notified upon request completion */ @@ -173,13 +173,13 @@ public void deleteDataFrameTransformAsync(DeleteDataFrameTransformRequest reques } /** - * Preview the result of a data frame transform + * Preview the result of a transform *

* For additional info - * see - * Preview data frame transform documentation + * see + * Preview transform documentation * - * @param request The preview data frame transform request + * @param request The preview transform request * @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized * @return A response containing the results of the applied transform * @throws IOException when there is a serialization issue sending the request or receiving the response @@ -194,12 +194,12 @@ public PreviewDataFrameTransformResponse previewDataFrameTransform(PreviewDataFr } /** - * Preview the result of a data frame transform asynchronously and notifies listener on completion + * Preview the result of a transform asynchronously and notifies listener on completion *

- * see - * Preview data frame transform documentation + * see + * Preview transform documentation * - * @param request The preview data frame transform request + * @param request The preview transform request * @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized * @param listener Listener to be notified upon request completion */ @@ -214,13 +214,13 @@ public void previewDataFrameTransformAsync(PreviewDataFrameTransformRequest requ } /** - * Start a data frame transform + * Start a transform *

* For additional info - * see - * Start data frame transform documentation + * see + * Start transform documentation * - * @param request The start data frame transform request + * @param request The start transform request * @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized * @return A response object indicating request success * @throws IOException when there is a serialization issue sending the request or receiving the response @@ -235,13 +235,13 @@ public StartDataFrameTransformResponse startDataFrameTransform(StartDataFrameTra } /** - * Start a data frame transform asynchronously and notifies listener on completion + * Start a transform asynchronously and notifies listener on completion *

* For additional info - * see - * Start data frame transform documentation + * see + * Start transform documentation * - * @param request The start data frame transform request + * @param request The start transform request * @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized * @param listener Listener to be notified upon request completion */ @@ -256,13 +256,13 @@ public void startDataFrameTransformAsync(StartDataFrameTransformRequest request, } /** - * Stop a data frame transform + * Stop a transform *

* For additional info - * see - * Stop data frame transform documentation + * see + * Stop transform documentation * - * @param request The stop data frame transform request + * @param request The stop transform request * @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized * @return A response object indicating request success * @throws IOException when there is a serialization issue sending the request or receiving the response @@ -277,13 +277,13 @@ public StopDataFrameTransformResponse stopDataFrameTransform(StopDataFrameTransf } /** - * Stop a data frame transform asynchronously and notifies listener on completion + * Stop a transform asynchronously and notifies listener on completion *

* For additional info - * see - * Stop data frame transform documentation + * see + * Stop transform documentation * - * @param request The stop data frame transform request + * @param request The stop transform request * @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized * @param listener Listener to be notified upon request completion */ @@ -298,13 +298,13 @@ public void stopDataFrameTransformAsync(StopDataFrameTransformRequest request, R } /** - * Get one or more data frame transform configurations + * Get one or more transform configurations *

* For additional info - * see - * Get data frame transform documentation + * see + * Get transform documentation * - * @param request The get data frame transform request + * @param request The get transform request * @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized * @return An GetDataFrameTransformResponse containing the requested transforms * @throws IOException when there is a serialization issue sending the request or receiving the response @@ -319,13 +319,13 @@ public GetDataFrameTransformResponse getDataFrameTransform(GetDataFrameTransform } /** - * Get one or more data frame transform configurations asynchronously and notifies listener on completion + * Get one or more transform configurations asynchronously and notifies listener on completion *

* For additional info - * see - * Get data frame transform documentation + * see + * Get transform documentation * - * @param request The get data frame transform request + * @param request The get transform request * @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized * @param listener Listener to be notified upon request completion */ diff --git a/client/rest-high-level/src/main/java/org/elasticsearch/client/RestHighLevelClient.java b/client/rest-high-level/src/main/java/org/elasticsearch/client/RestHighLevelClient.java index 35abf5e85180f..7f37be31658e1 100644 --- a/client/rest-high-level/src/main/java/org/elasticsearch/client/RestHighLevelClient.java +++ b/client/rest-high-level/src/main/java/org/elasticsearch/client/RestHighLevelClient.java @@ -472,8 +472,8 @@ public SecurityClient security() { * are shipped with the Elastic Stack distribution of Elasticsearch. All of * these APIs will 404 if run against the OSS distribution of Elasticsearch. *

- * See the - * Data Frame APIs on elastic.co for more information. + * See the + * Transform APIs on elastic.co for more information. * * @return the client wrapper for making Data Frame API calls */ diff --git a/client/rest-high-level/src/test/java/org/elasticsearch/client/documentation/DataFrameTransformDocumentationIT.java b/client/rest-high-level/src/test/java/org/elasticsearch/client/documentation/DataFrameTransformDocumentationIT.java index c0013dfee1cb7..7b39b04b772bb 100644 --- a/client/rest-high-level/src/test/java/org/elasticsearch/client/documentation/DataFrameTransformDocumentationIT.java +++ b/client/rest-high-level/src/test/java/org/elasticsearch/client/documentation/DataFrameTransformDocumentationIT.java @@ -117,34 +117,34 @@ public void testPutDataFrameTransform() throws IOException, InterruptedException RestHighLevelClient client = highLevelClient(); - // tag::put-data-frame-transform-query-config + // tag::put-transform-query-config QueryConfig queryConfig = new QueryConfig(new MatchAllQueryBuilder()); - // end::put-data-frame-transform-query-config - // tag::put-data-frame-transform-source-config + // end::put-transform-query-config + // tag::put-transform-source-config SourceConfig sourceConfig = SourceConfig.builder() .setIndex("source-index") .setQueryConfig(queryConfig).build(); - // end::put-data-frame-transform-source-config - // tag::put-data-frame-transform-group-config + // end::put-transform-source-config + // tag::put-transform-group-config GroupConfig groupConfig = GroupConfig.builder() .groupBy("reviewer", // <1> TermsGroupSource.builder().setField("user_id").build()) // <2> .build(); - // end::put-data-frame-transform-group-config - // tag::put-data-frame-transform-agg-config + // end::put-transform-group-config + // tag::put-transform-agg-config AggregatorFactories.Builder aggBuilder = new AggregatorFactories.Builder(); aggBuilder.addAggregator( AggregationBuilders.avg("avg_rating").field("stars")); // <1> AggregationConfig aggConfig = new AggregationConfig(aggBuilder); - // end::put-data-frame-transform-agg-config - // tag::put-data-frame-transform-pivot-config + // end::put-transform-agg-config + // tag::put-transform-pivot-config PivotConfig pivotConfig = PivotConfig.builder() .setGroups(groupConfig) // <1> .setAggregationConfig(aggConfig) // <2> .setMaxPageSearchSize(1000) // <3> .build(); - // end::put-data-frame-transform-pivot-config - // tag::put-data-frame-transform-config + // end::put-transform-pivot-config + // tag::put-transform-config DataFrameTransformConfig transformConfig = DataFrameTransformConfig .builder() .setId("reviewer-avg-rating") // <1> @@ -153,19 +153,19 @@ public void testPutDataFrameTransform() throws IOException, InterruptedException .setPivotConfig(pivotConfig) // <4> .setDescription("This is my test transform") // <5> .build(); - // end::put-data-frame-transform-config + // end::put-transform-config { - // tag::put-data-frame-transform-request + // tag::put-transform-request PutDataFrameTransformRequest request = new PutDataFrameTransformRequest(transformConfig); // <1> - // end::put-data-frame-transform-request + // end::put-transform-request - // tag::put-data-frame-transform-execute + // tag::put-transform-execute AcknowledgedResponse response = client.dataFrame().putDataFrameTransform( request, RequestOptions.DEFAULT); - // end::put-data-frame-transform-execute + // end::put-transform-execute transformsToClean.add(request.getConfig().getId()); assertTrue(response.isAcknowledged()); @@ -179,7 +179,7 @@ public void testPutDataFrameTransform() throws IOException, InterruptedException .build(); PutDataFrameTransformRequest request = new PutDataFrameTransformRequest(configWithDifferentId); - // tag::put-data-frame-transform-execute-listener + // tag::put-transform-execute-listener ActionListener listener = new ActionListener() { @Override @@ -192,16 +192,16 @@ public void onFailure(Exception e) { // <2> } }; - // end::put-data-frame-transform-execute-listener + // end::put-transform-execute-listener // Replace the empty listener by a blocking listener in test final CountDownLatch latch = new CountDownLatch(1); listener = new LatchedActionListener<>(listener, latch); - // tag::put-data-frame-transform-execute-async + // tag::put-transform-execute-async client.dataFrame().putDataFrameTransformAsync( request, RequestOptions.DEFAULT, listener); // <1> - // end::put-data-frame-transform-execute-async + // end::put-transform-execute-async assertTrue(latch.await(30L, TimeUnit.SECONDS)); transformsToClean.add(request.getConfig().getId()); @@ -232,44 +232,44 @@ public void testStartStop() throws IOException, InterruptedException { transformsToClean.add(transformConfig.getId()); { - // tag::start-data-frame-transform-request + // tag::start-transform-request StartDataFrameTransformRequest request = new StartDataFrameTransformRequest("mega-transform"); // <1> - // end::start-data-frame-transform-request + // end::start-transform-request - // tag::start-data-frame-transform-request-options + // tag::start-transform-request-options request.setTimeout(TimeValue.timeValueSeconds(20)); // <1> - // end::start-data-frame-transform-request-options + // end::start-transform-request-options - // tag::start-data-frame-transform-execute + // tag::start-transform-execute StartDataFrameTransformResponse response = client.dataFrame().startDataFrameTransform( request, RequestOptions.DEFAULT); - // end::start-data-frame-transform-execute + // end::start-transform-execute assertTrue(response.isAcknowledged()); } { - // tag::stop-data-frame-transform-request + // tag::stop-transform-request StopDataFrameTransformRequest request = new StopDataFrameTransformRequest("mega-transform"); // <1> - // end::stop-data-frame-transform-request + // end::stop-transform-request - // tag::stop-data-frame-transform-request-options + // tag::stop-transform-request-options request.setWaitForCompletion(Boolean.TRUE); // <1> request.setTimeout(TimeValue.timeValueSeconds(30)); // <2> - // end::stop-data-frame-transform-request-options + // end::stop-transform-request-options - // tag::stop-data-frame-transform-execute + // tag::stop-transform-execute StopDataFrameTransformResponse response = client.dataFrame().stopDataFrameTransform( request, RequestOptions.DEFAULT); - // end::stop-data-frame-transform-execute + // end::stop-transform-execute assertTrue(response.isAcknowledged()); } { - // tag::start-data-frame-transform-execute-listener + // tag::start-transform-execute-listener ActionListener listener = new ActionListener() { @Override @@ -283,22 +283,22 @@ public void onFailure(Exception e) { // <2> } }; - // end::start-data-frame-transform-execute-listener + // end::start-transform-execute-listener // Replace the empty listener by a blocking listener in test final CountDownLatch latch = new CountDownLatch(1); listener = new LatchedActionListener<>(listener, latch); StartDataFrameTransformRequest request = new StartDataFrameTransformRequest("mega-transform"); - // tag::start-data-frame-transform-execute-async + // tag::start-transform-execute-async client.dataFrame().startDataFrameTransformAsync( request, RequestOptions.DEFAULT, listener); // <1> - // end::start-data-frame-transform-execute-async + // end::start-transform-execute-async assertTrue(latch.await(30L, TimeUnit.SECONDS)); } { - // tag::stop-data-frame-transform-execute-listener + // tag::stop-transform-execute-listener ActionListener listener = new ActionListener() { @Override @@ -312,17 +312,17 @@ public void onFailure(Exception e) { // <2> } }; - // end::stop-data-frame-transform-execute-listener + // end::stop-transform-execute-listener // Replace the empty listener by a blocking listener in test final CountDownLatch latch = new CountDownLatch(1); listener = new LatchedActionListener<>(listener, latch); StopDataFrameTransformRequest request = new StopDataFrameTransformRequest("mega-transform"); - // tag::stop-data-frame-transform-execute-async + // tag::stop-transform-execute-async client.dataFrame().stopDataFrameTransformAsync( request, RequestOptions.DEFAULT, listener); // <1> - // end::stop-data-frame-transform-execute-async + // end::stop-transform-execute-async assertTrue(latch.await(30L, TimeUnit.SECONDS)); } @@ -363,21 +363,21 @@ public void testDeleteDataFrameTransform() throws IOException, InterruptedExcept client.dataFrame().putDataFrameTransform(new PutDataFrameTransformRequest(transformConfig2), RequestOptions.DEFAULT); { - // tag::delete-data-frame-transform-request + // tag::delete-transform-request DeleteDataFrameTransformRequest request = new DeleteDataFrameTransformRequest("mega-transform"); // <1> - // end::delete-data-frame-transform-request + // end::delete-transform-request - // tag::delete-data-frame-transform-execute + // tag::delete-transform-execute AcknowledgedResponse response = client.dataFrame() .deleteDataFrameTransform(request, RequestOptions.DEFAULT); - // end::delete-data-frame-transform-execute + // end::delete-transform-execute assertTrue(response.isAcknowledged()); } { - // tag::delete-data-frame-transform-execute-listener + // tag::delete-transform-execute-listener ActionListener listener = new ActionListener() { @Override @@ -390,7 +390,7 @@ public void onFailure(Exception e) { // <2> } }; - // end::delete-data-frame-transform-execute-listener + // end::delete-transform-execute-listener // Replace the empty listener by a blocking listener in test final CountDownLatch latch = new CountDownLatch(1); @@ -398,10 +398,10 @@ public void onFailure(Exception e) { DeleteDataFrameTransformRequest request = new DeleteDataFrameTransformRequest("mega-transform2"); - // tag::delete-data-frame-transform-execute-async + // tag::delete-transform-execute-async client.dataFrame().deleteDataFrameTransformAsync( request, RequestOptions.DEFAULT, listener); // <1> - // end::delete-data-frame-transform-execute-async + // end::delete-transform-execute-async assertTrue(latch.await(30L, TimeUnit.SECONDS)); } @@ -420,7 +420,7 @@ public void testPreview() throws IOException, InterruptedException { AggregationConfig aggConfig = new AggregationConfig(aggBuilder); PivotConfig pivotConfig = PivotConfig.builder().setGroups(groupConfig).setAggregationConfig(aggConfig).build(); - // tag::preview-data-frame-transform-request + // tag::preview-transform-request DataFrameTransformConfig transformConfig = DataFrameTransformConfig.forPreview( SourceConfig.builder() @@ -430,19 +430,19 @@ public void testPreview() throws IOException, InterruptedException { pivotConfig); // <2> PreviewDataFrameTransformRequest request = new PreviewDataFrameTransformRequest(transformConfig); // <3> - // end::preview-data-frame-transform-request + // end::preview-transform-request { - // tag::preview-data-frame-transform-execute + // tag::preview-transform-execute PreviewDataFrameTransformResponse response = client.dataFrame() .previewDataFrameTransform(request, RequestOptions.DEFAULT); - // end::preview-data-frame-transform-execute + // end::preview-transform-execute assertNotNull(response.getDocs()); } { - // tag::preview-data-frame-transform-execute-listener + // tag::preview-transform-execute-listener ActionListener listener = new ActionListener() { @Override @@ -455,16 +455,16 @@ public void onFailure(Exception e) { // <2> } }; - // end::preview-data-frame-transform-execute-listener + // end::preview-transform-execute-listener // Replace the empty listener by a blocking listener in test final CountDownLatch latch = new CountDownLatch(1); listener = new LatchedActionListener<>(listener, latch); - // tag::preview-data-frame-transform-execute-async + // tag::preview-transform-execute-async client.dataFrame().previewDataFrameTransformAsync( request, RequestOptions.DEFAULT, listener); // <1> - // end::preview-data-frame-transform-execute-async + // end::preview-transform-execute-async assertTrue(latch.await(30L, TimeUnit.SECONDS)); } @@ -496,21 +496,21 @@ public void testGetStats() throws IOException, InterruptedException { client.dataFrame().putDataFrameTransform(new PutDataFrameTransformRequest(transformConfig), RequestOptions.DEFAULT); transformsToClean.add(id); - // tag::get-data-frame-transform-stats-request + // tag::get-transform-stats-request GetDataFrameTransformStatsRequest request = new GetDataFrameTransformStatsRequest(id); // <1> - // end::get-data-frame-transform-stats-request + // end::get-transform-stats-request { - // tag::get-data-frame-transform-stats-execute + // tag::get-transform-stats-execute GetDataFrameTransformStatsResponse response = client.dataFrame() .getDataFrameTransformStats(request, RequestOptions.DEFAULT); - // end::get-data-frame-transform-stats-execute + // end::get-transform-stats-execute assertThat(response.getTransformsStateAndStats(), hasSize(1)); - // tag::get-data-frame-transform-stats-response + // tag::get-transform-stats-response DataFrameTransformStateAndStats stateAndStats = response.getTransformsStateAndStats().get(0); // <1> DataFrameTransformTaskState taskState = @@ -521,7 +521,7 @@ public void testGetStats() throws IOException, InterruptedException { stateAndStats.getTransformStats(); // <4> DataFrameTransformProgress progress = stateAndStats.getTransformState().getProgress(); // <5> - // end::get-data-frame-transform-stats-response + // end::get-transform-stats-response assertEquals(IndexerState.STOPPED, indexerState); assertEquals(DataFrameTransformTaskState.STOPPED, taskState); @@ -529,7 +529,7 @@ public void testGetStats() throws IOException, InterruptedException { assertNull(progress); } { - // tag::get-data-frame-transform-stats-execute-listener + // tag::get-transform-stats-execute-listener ActionListener listener = new ActionListener() { @Override @@ -543,16 +543,16 @@ public void onFailure(Exception e) { // <2> } }; - // end::get-data-frame-transform-stats-execute-listener + // end::get-transform-stats-execute-listener // Replace the empty listener by a blocking listener in test final CountDownLatch latch = new CountDownLatch(1); listener = new LatchedActionListener<>(listener, latch); - // tag::get-data-frame-transform-stats-execute-async + // tag::get-transform-stats-execute-async client.dataFrame().getDataFrameTransformStatsAsync( request, RequestOptions.DEFAULT, listener); // <1> - // end::get-data-frame-transform-stats-execute-async + // end::get-transform-stats-execute-async assertTrue(latch.await(30L, TimeUnit.SECONDS)); } @@ -586,30 +586,30 @@ public void testGetDataFrameTransform() throws IOException, InterruptedException transformsToClean.add(putTransformConfig.getId()); { - // tag::get-data-frame-transform-request + // tag::get-transform-request GetDataFrameTransformRequest request = new GetDataFrameTransformRequest("mega-transform"); // <1> - // end::get-data-frame-transform-request + // end::get-transform-request - // tag::get-data-frame-transform-request-options + // tag::get-transform-request-options request.setPageParams(new PageParams(0, 100)); // <1> - // end::get-data-frame-transform-request-options + // end::get-transform-request-options - // tag::get-data-frame-transform-execute + // tag::get-transform-execute GetDataFrameTransformResponse response = client.dataFrame() .getDataFrameTransform(request, RequestOptions.DEFAULT); - // end::get-data-frame-transform-execute + // end::get-transform-execute - // tag::get-data-frame-transform-response + // tag::get-transform-response List transformConfigs = response.getTransformConfigurations(); - // end::get-data-frame-transform-response + // end::get-transform-response assertEquals(1, transformConfigs.size()); } { - // tag::get-data-frame-transform-execute-listener + // tag::get-transform-execute-listener ActionListener listener = new ActionListener() { @Override @@ -622,7 +622,7 @@ public void onFailure(Exception e) { // <2> } }; - // end::get-data-frame-transform-execute-listener + // end::get-transform-execute-listener // Replace the empty listener by a blocking listener in test final CountDownLatch latch = new CountDownLatch(1); @@ -630,10 +630,10 @@ public void onFailure(Exception e) { GetDataFrameTransformRequest request = new GetDataFrameTransformRequest("mega-transform"); - // tag::get-data-frame-transform-execute-async + // tag::get-transform-execute-async client.dataFrame().getDataFrameTransformAsync( request, RequestOptions.DEFAULT, listener); // <1> - // end::get-data-frame-transform-execute-async + // end::get-transform-execute-async assertTrue(latch.await(30L, TimeUnit.SECONDS)); } diff --git a/docs/java-rest/high-level/supported-apis.asciidoc b/docs/java-rest/high-level/supported-apis.asciidoc index 8467499350a00..10e136a2d3fbf 100644 --- a/docs/java-rest/high-level/supported-apis.asciidoc +++ b/docs/java-rest/high-level/supported-apis.asciidoc @@ -555,27 +555,27 @@ include::ilm/retry_lifecycle_policy.asciidoc[] include::ilm/remove_lifecycle_policy_from_index.asciidoc[] [role="xpack"] -[[_data_frame_transform_apis]] -== {dataframe-transform-cap} APIs +[[transform_apis]] +== {transform-cap} APIs -:upid: {mainid}-dataframe +:upid: {mainid} :doc-tests-file: {doc-tests}/DataFrameTransformDocumentationIT.java The Java High Level REST Client supports the following {dataframe-transform} APIs: -* <<{upid}-get-data-frame-transform>> -* <<{upid}-get-data-frame-transform-stats>> -* <<{upid}-put-data-frame-transform>> -* <<{upid}-delete-data-frame-transform>> -* <<{upid}-preview-data-frame-transform>> -* <<{upid}-start-data-frame-transform>> -* <<{upid}-stop-data-frame-transform>> - -include::dataframe/get_data_frame.asciidoc[] -include::dataframe/get_data_frame_stats.asciidoc[] -include::dataframe/put_data_frame.asciidoc[] -include::dataframe/delete_data_frame.asciidoc[] -include::dataframe/preview_data_frame.asciidoc[] -include::dataframe/start_data_frame.asciidoc[] -include::dataframe/stop_data_frame.asciidoc[] \ No newline at end of file +* <<{upid}-get-transform>> +* <<{upid}-get-transform-stats>> +* <<{upid}-put-transform>> +* <<{upid}-delete-transform>> +* <<{upid}-preview-transform>> +* <<{upid}-start-transform>> +* <<{upid}-stop-transform>> + +include::transform/get_transform.asciidoc[] +include::transform/get_transform_stats.asciidoc[] +include::transform/put_transform.asciidoc[] +include::transform/delete_transform.asciidoc[] +include::transform/preview_transform.asciidoc[] +include::transform/start_transform.asciidoc[] +include::transform/stop_transform.asciidoc[] diff --git a/docs/java-rest/high-level/dataframe/delete_data_frame.asciidoc b/docs/java-rest/high-level/transform/delete_transform.asciidoc similarity index 95% rename from docs/java-rest/high-level/dataframe/delete_data_frame.asciidoc rename to docs/java-rest/high-level/transform/delete_transform.asciidoc index 4fc46124e37a3..91230f65ec2f2 100644 --- a/docs/java-rest/high-level/dataframe/delete_data_frame.asciidoc +++ b/docs/java-rest/high-level/transform/delete_transform.asciidoc @@ -1,5 +1,5 @@ -- -:api: delete-data-frame-transform +:api: delete-transform :request: DeleteDataFrameTransformRequest :response: AcknowledgedResponse -- diff --git a/docs/java-rest/high-level/dataframe/get_data_frame.asciidoc b/docs/java-rest/high-level/transform/get_transform.asciidoc similarity index 98% rename from docs/java-rest/high-level/dataframe/get_data_frame.asciidoc rename to docs/java-rest/high-level/transform/get_transform.asciidoc index a267cd6f5869d..b7c9e40e644ae 100644 --- a/docs/java-rest/high-level/dataframe/get_data_frame.asciidoc +++ b/docs/java-rest/high-level/transform/get_transform.asciidoc @@ -1,5 +1,5 @@ -- -:api: get-data-frame-transform +:api: get-transform :request: GetDataFrameTransformRequest :response: GetDataFrameTransformResponse -- diff --git a/docs/java-rest/high-level/dataframe/get_data_frame_stats.asciidoc b/docs/java-rest/high-level/transform/get_transform_stats.asciidoc similarity index 97% rename from docs/java-rest/high-level/dataframe/get_data_frame_stats.asciidoc rename to docs/java-rest/high-level/transform/get_transform_stats.asciidoc index 3ea1b3b14f8e9..fcc2cd66181bd 100644 --- a/docs/java-rest/high-level/dataframe/get_data_frame_stats.asciidoc +++ b/docs/java-rest/high-level/transform/get_transform_stats.asciidoc @@ -1,5 +1,5 @@ -- -:api: get-data-frame-transform-stats +:api: get-transform-stats :request: GetDataFrameTransformStatsRequest :response: GetDataFrameTransformStatsResponse -- diff --git a/docs/java-rest/high-level/dataframe/preview_data_frame.asciidoc b/docs/java-rest/high-level/transform/preview_transform.asciidoc similarity index 96% rename from docs/java-rest/high-level/dataframe/preview_data_frame.asciidoc rename to docs/java-rest/high-level/transform/preview_transform.asciidoc index 057f38a19efb1..d1b0938d23110 100644 --- a/docs/java-rest/high-level/dataframe/preview_data_frame.asciidoc +++ b/docs/java-rest/high-level/transform/preview_transform.asciidoc @@ -1,5 +1,5 @@ -- -:api: preview-data-frame-transform +:api: preview-transform :request: PreviewDataFrameTransformRequest :response: PreviewDataFrameTransformResponse -- diff --git a/docs/java-rest/high-level/dataframe/put_data_frame.asciidoc b/docs/java-rest/high-level/transform/put_transform.asciidoc similarity index 99% rename from docs/java-rest/high-level/dataframe/put_data_frame.asciidoc rename to docs/java-rest/high-level/transform/put_transform.asciidoc index 67413ba91cea8..62545df0ba1d9 100644 --- a/docs/java-rest/high-level/dataframe/put_data_frame.asciidoc +++ b/docs/java-rest/high-level/transform/put_transform.asciidoc @@ -1,5 +1,5 @@ -- -:api: put-data-frame-transform +:api: put-transform :request: PutDataFrameTransformRequest :response: AcknowledgedResponse -- diff --git a/docs/java-rest/high-level/dataframe/start_data_frame.asciidoc b/docs/java-rest/high-level/transform/start_transform.asciidoc similarity index 97% rename from docs/java-rest/high-level/dataframe/start_data_frame.asciidoc rename to docs/java-rest/high-level/transform/start_transform.asciidoc index 68f9c99b9b07a..c90bedeb40526 100644 --- a/docs/java-rest/high-level/dataframe/start_data_frame.asciidoc +++ b/docs/java-rest/high-level/transform/start_transform.asciidoc @@ -1,5 +1,5 @@ -- -:api: start-data-frame-transform +:api: start-transform :request: StartDataFrameTransformRequest :response: StartDataFrameTransformResponse -- diff --git a/docs/java-rest/high-level/dataframe/stop_data_frame.asciidoc b/docs/java-rest/high-level/transform/stop_transform.asciidoc similarity index 97% rename from docs/java-rest/high-level/dataframe/stop_data_frame.asciidoc rename to docs/java-rest/high-level/transform/stop_transform.asciidoc index f61d0aea8aa28..a9876fb33c163 100644 --- a/docs/java-rest/high-level/dataframe/stop_data_frame.asciidoc +++ b/docs/java-rest/high-level/transform/stop_transform.asciidoc @@ -1,5 +1,5 @@ -- -:api: stop-data-frame-transform +:api: stop-transform :request: StopDataFrameTransformRequest :response: StopDataFrameTransformResponse -- diff --git a/docs/java-rest/index.asciidoc b/docs/java-rest/index.asciidoc index d06e312bce7f3..212d34f663df6 100644 --- a/docs/java-rest/index.asciidoc +++ b/docs/java-rest/index.asciidoc @@ -8,3 +8,5 @@ include::overview.asciidoc[] include::low-level/index.asciidoc[] include::high-level/index.asciidoc[] + +include::redirects.asciidoc[] \ No newline at end of file diff --git a/docs/java-rest/redirects.asciidoc b/docs/java-rest/redirects.asciidoc new file mode 100644 index 0000000000000..baee66eeaf60c --- /dev/null +++ b/docs/java-rest/redirects.asciidoc @@ -0,0 +1,44 @@ +["appendix",role="exclude",id="redirects"] += Deleted pages + +The following pages have moved or been deleted. + +[role="exclude",id="_data_frame_transform_apis"] +=== {transform-cap} APIs + +See <>. + +[role="exclude",id="java-rest-high-dataframe-get-data-frame-transform"] +=== Get {transform} API + +See <>. + +[role="exclude",id="java-rest-high-dataframe-get-data-frame-transform-stats"] +=== Get {transform} stats API + +See <>. + +[role="exclude",id="java-rest-high-dataframe-put-data-frame-transform"] +=== Put {transform} API + +See <>. + +[role="exclude",id="java-rest-high-dataframe-delete-data-frame-transform"] +=== Delete {transform} API + +See <>. + +[role="exclude",id="java-rest-high-dataframe-preview-data-frame-transform"] +=== Preview {transform} API + +See <>. + +[role="exclude",id="java-rest-high-dataframe-start-data-frame-transform"] +=== Start {transform} API + +See <>. + +[role="exclude",id="java-rest-high-dataframe-stop-data-frame-transform"] +=== Stop {transform} API + +See <>. diff --git a/docs/reference/redirects.asciidoc b/docs/reference/redirects.asciidoc index 12bdfe6480a5d..1af4dd80dc1b1 100644 --- a/docs/reference/redirects.asciidoc +++ b/docs/reference/redirects.asciidoc @@ -649,4 +649,64 @@ See <>. [role="exclude",id="ccs-reduction"] === {ccs-cap} reduction -See <>. \ No newline at end of file +See <>. + +[role="exclude",id="delete-data-frame-transform"] +=== Delete {transforms} API + +See <>. + +[role="exclude",id="get-data-frame-transform-stats"] +=== Get {transform} statistics API + +See <>. + +[role="exclude",id="get-data-frame-transform"] +=== Get {transforms} API + +See <>. + +[role="exclude",id="preview-data-frame-transform"] +=== Preview {transforms} API + +See <>. + +[role="exclude",id="put-data-frame-transform"] +=== Create {transforms} API + +See <>. + +[role="exclude",id="start-data-frame-transform"] +=== Start {transforms} API + +See <>. + +[role="exclude",id="stop-data-frame-transform"] +=== Stop {transforms} API + +See <>. + +[role="exclude",id="data-frame-apis"] +=== {transform-cap} APIs + +See <>. + +[role="exclude",id="data-frame-transform-resource"] +=== {transform-cap} resources + +See <>. + +[role="exclude",id="data-frame-transform-dest"] +=== Dest objects + +See <>. + +[role="exclude",id="data-frame-transform-source"] +==== Source objects + +See <>. + +[role="exclude",id="data-frame-transform-pivot"] +==== Pivot objects + +See <>. diff --git a/docs/reference/rest-api/defs.asciidoc b/docs/reference/rest-api/defs.asciidoc index 9af8d585771b3..5eca10f405bdb 100644 --- a/docs/reference/rest-api/defs.asciidoc +++ b/docs/reference/rest-api/defs.asciidoc @@ -14,8 +14,8 @@ These resource definitions are used in APIs related to {ml-features} and * <> * <> * <> -* <> -* <> +* <> +* <> include::{es-repo-dir}/ml/anomaly-detection/apis/calendarresource.asciidoc[] include::{es-repo-dir}/ml/anomaly-detection/apis/datafeedresource.asciidoc[] diff --git a/docs/reference/rest-api/index.asciidoc b/docs/reference/rest-api/index.asciidoc index c20e40b6c847d..6a9ab77d3fae3 100644 --- a/docs/reference/rest-api/index.asciidoc +++ b/docs/reference/rest-api/index.asciidoc @@ -17,7 +17,7 @@ directly to configure and access {xpack} features. * <> * <> * <> -* <> +* <> * <> -- diff --git a/docs/reference/transform/api-quickref.asciidoc b/docs/reference/transform/api-quickref.asciidoc index 7750331a0273d..016aae48fc9d4 100644 --- a/docs/reference/transform/api-quickref.asciidoc +++ b/docs/reference/transform/api-quickref.asciidoc @@ -2,7 +2,7 @@ [[df-api-quickref]] == API quick reference -All {dataframe-transform} endpoints have the following base: +All {transform} endpoints have the following base: [source,js] ---- @@ -10,12 +10,12 @@ All {dataframe-transform} endpoints have the following base: ---- // NOTCONSOLE -* {ref}/put-data-frame-transform.html[Create {dataframe-transforms}] -* {ref}/delete-data-frame-transform.html[Delete {dataframe-transforms}] -* {ref}/get-data-frame-transform.html[Get {dataframe-transforms}] -* {ref}/get-data-frame-transform-stats.html[Get {dataframe-transforms} statistics] -* {ref}/preview-data-frame-transform.html[Preview {dataframe-transforms}] -* {ref}/start-data-frame-transform.html[Start {dataframe-transforms}] -* {ref}/stop-data-frame-transform.html[Stop {dataframe-transforms}] +* {ref}/put-transform.html[Create {transforms}] +* {ref}/delete-transform.html[Delete {transforms}] +* {ref}/get-transform.html[Get {transforms}] +* {ref}/get-transform-stats.html[Get {transforms} statistics] +* {ref}/preview-transform.html[Preview {transforms}] +* {ref}/start-transform.html[Start {transforms}] +* {ref}/stop-transform.html[Stop {transforms}] -For the full list, see {ref}/data-frame-apis.html[{dataframe-transform-cap} APIs]. +For the full list, see {ref}/transform-apis.html[{transform-cap} APIs]. diff --git a/docs/reference/transform/apis/delete-transform.asciidoc b/docs/reference/transform/apis/delete-transform.asciidoc index b23bacf8bc7b5..a17379bc9bc81 100644 --- a/docs/reference/transform/apis/delete-transform.asciidoc +++ b/docs/reference/transform/apis/delete-transform.asciidoc @@ -1,26 +1,26 @@ [role="xpack"] [testenv="basic"] -[[delete-data-frame-transform]] -=== Delete {dataframe-transforms} API +[[delete-transform]] +=== Delete {transforms} API [subs="attributes"] ++++ -Delete {dataframe-transforms} +Delete {transforms} ++++ -Deletes an existing {dataframe-transform}. +Deletes an existing {transform}. beta[] -[[delete-data-frame-transform-request]] +[[delete-transform-request]] ==== {api-request-title} -`DELETE _data_frame/transforms/` +`DELETE _data_frame/transforms/` -[[delete-data-frame-transform-prereqs]] +[[delete-transform-prereqs]] ==== {api-prereq-title} -* Before you can delete the {dataframe-transform}, you must stop it. +* Before you can delete the {transform}, you must stop it. * If the {es} {security-features} are enabled, you must have `manage_data_frame_transforms` cluster privileges to use this API. The built-in `data_frame_transforms_admin` role has these privileges. For more information, @@ -28,14 +28,14 @@ see {stack-ov}/security-privileges.html[Security privileges] and {stack-ov}/built-in-roles.html[Built-in roles]. -[[delete-data-frame-transform-path-parms]] +[[delete-transform-path-parms]] ==== {api-path-parms-title} -``:: - (string) Required. Identifier for the {dataframe-transform}. +``:: + (string) Required. Identifier for the {transform}. -[[delete-data-frame-transform-examples]] +[[delete-transform-examples]] ==== {api-examples-title} [source,js] @@ -45,7 +45,7 @@ DELETE _data_frame/transforms/ecommerce_transform // CONSOLE // TEST[skip:setup kibana sample data] -When the {dataframe-transform} is deleted, you receive the following results: +When the {transform} is deleted, you receive the following results: [source,js] ---- { diff --git a/docs/reference/transform/apis/get-transform-stats.asciidoc b/docs/reference/transform/apis/get-transform-stats.asciidoc index 93ad55f2f15d3..eac5fc6ad1c22 100644 --- a/docs/reference/transform/apis/get-transform-stats.asciidoc +++ b/docs/reference/transform/apis/get-transform-stats.asciidoc @@ -1,24 +1,24 @@ [role="xpack"] [testenv="basic"] -[[get-data-frame-transform-stats]] -=== Get {dataframe-transform} statistics API +[[get-transform-stats]] +=== Get {transform} statistics API [subs="attributes"] ++++ -Get {dataframe-transform} statistics +Get {transform} statistics ++++ -Retrieves usage information for {dataframe-transforms}. +Retrieves usage information for {transforms}. beta[] -[[get-data-frame-transform-stats-request]] +[[get-transform-stats-request]] ==== {api-request-title} -`GET _data_frame/transforms//_stats` +`GET _data_frame/transforms//_stats` -`GET _data_frame/transforms/,/_stats` + +`GET _data_frame/transforms/,/_stats` + `GET _data_frame/transforms/_stats` + @@ -27,7 +27,7 @@ beta[] `GET _data_frame/transforms/*/_stats` + -[[get-data-frame-transform-stats-prereqs]] +[[get-transform-stats-prereqs]] ==== {api-prereq-title} * If the {es} {security-features} are enabled, you must have @@ -37,48 +37,48 @@ see {stack-ov}/security-privileges.html[Security privileges] and {stack-ov}/built-in-roles.html[Built-in roles]. -[[get-data-frame-transform-stats-desc]] +[[get-transform-stats-desc]] ==== {api-description-title} -You can get statistics for multiple {dataframe-transforms} in a single API +You can get statistics for multiple {transforms} in a single API request by using a comma-separated list of identifiers or a wildcard expression. -You can get statistics for all {dataframe-transforms} by using `_all`, by -specifying `*` as the ``, or by omitting the -``. +You can get statistics for all {transforms} by using `_all`, by +specifying `*` as the ``, or by omitting the +``. -[[get-data-frame-transform-stats-path-parms]] +[[get-transform-stats-path-parms]] ==== {api-path-parms-title} -``:: - (string) Optional. Identifier for the {dataframe-transform}. It can be a - {dataframe-transform} identifier or a wildcard expression. If you do not +``:: + (string) Optional. Identifier for the {transform}. It can be a + {transform} identifier or a wildcard expression. If you do not specify one of these options, the API returns information for all - {dataframe-transforms}. + {transforms}. -[[get-data-frame-transform-stats-query-parms]] +[[get-transform-stats-query-parms]] ==== {api-query-parms-title} `from`:: - (integer) Optional. Skips the specified number of {dataframe-transforms}. + (integer) Optional. Skips the specified number of {transforms}. The default value is `0`. `size`:: - (integer) Optional. Specifies the maximum number of {dataframe-transforms} + (integer) Optional. Specifies the maximum number of {transforms} to obtain. The default value is `100`. -[[get-data-frame-transform-stats-response]] +[[get-transform-stats-response]] ==== {api-response-body-title} `transforms`:: - (array) An array of statistics objects for {dataframe-transforms}, which are + (array) An array of statistics objects for {transforms}, which are sorted by the `id` value in ascending order. -[[get-data-frame-transform-stats-example]] +[[get-transform-stats-example]] ==== Examples -The following example skips for the first five {dataframe-transforms} and +The following example skips for the first five {transforms} and gets usage information for a maximum of ten results: [source,js] @@ -89,7 +89,7 @@ GET _data_frame/transforms/_stats?from=5&size=10 // TEST[skip:todo] The following example gets usage information for the `ecommerce_transform` -{dataframe-transform}: +{transform}: [source,js] -------------------------------------------------- diff --git a/docs/reference/transform/apis/get-transform.asciidoc b/docs/reference/transform/apis/get-transform.asciidoc index dd14a45eb9464..7da814177cba8 100644 --- a/docs/reference/transform/apis/get-transform.asciidoc +++ b/docs/reference/transform/apis/get-transform.asciidoc @@ -1,23 +1,23 @@ [role="xpack"] [testenv="basic"] -[[get-data-frame-transform]] -=== Get {dataframe-transforms} API +[[get-transform]] +=== Get {transforms} API [subs="attributes"] ++++ -Get {dataframe-transforms} +Get {transforms} ++++ -Retrieves configuration information for {dataframe-transforms}. +Retrieves configuration information for {transforms}. beta[] -[[get-data-frame-transform-request]] +[[get-transform-request]] ==== {api-request-title} -`GET _data_frame/transforms/` + +`GET _data_frame/transforms/` + -`GET _data_frame/transforms/,` + +`GET _data_frame/transforms/,` + `GET _data_frame/transforms/` + @@ -25,7 +25,7 @@ beta[] `GET _data_frame/transforms/*` -[[get-data-frame-transform-prereqs]] +[[get-transform-prereqs]] ==== {api-prereq-title} * If the {es} {security-features} are enabled, you must have @@ -34,43 +34,43 @@ beta[] see {stack-ov}/security-privileges.html[Security privileges] and {stack-ov}/built-in-roles.html[Built-in roles]. -[[get-data-frame-transform-desc]] +[[get-transform-desc]] ==== {api-description-title} -You can get information for multiple {dataframe-transforms} in a single API +You can get information for multiple {transforms} in a single API request by using a comma-separated list of identifiers or a wildcard expression. -You can get information for all {dataframe-transforms} by using `_all`, by -specifying `*` as the ``, or by omitting the -``. +You can get information for all {transforms} by using `_all`, by +specifying `*` as the ``, or by omitting the +``. -[[get-data-frame-transform-path-parms]] +[[get-transform-path-parms]] ==== {api-path-parms-title} -``:: - (string) Optional. Identifier for the {dataframe-transform}. It can be a - {dataframe-transform} identifier or a wildcard expression. If you do not +``:: + (string) Optional. Identifier for the {transform}. It can be a + {transform} identifier or a wildcard expression. If you do not specify one of these options, the API returns information for all - {dataframe-transforms}. + {transforms}. -[[get-data-frame-transform-query-parms]] +[[get-transform-query-parms]] ==== {api-query-parms-title} `from`:: - (integer) Optional. Skips the specified number of {dataframe-transforms}. + (integer) Optional. Skips the specified number of {transforms}. The default value is `0`. `size`:: - (integer) Optional. Specifies the maximum number of {dataframe-transforms} + (integer) Optional. Specifies the maximum number of {transforms} to obtain. The default value is `100`. -[[get-data-frame-transform-response]] +[[get-transform-response]] ==== {api-response-body-title} `transforms`:: (array) An array of transform resources, which are sorted by the `id` value in ascending order. -[[get-data-frame-transform-example]] +[[get-transform-example]] ==== {api-examples-title} The following example retrieves information about a maximum of ten transforms: @@ -83,7 +83,7 @@ GET _data_frame/transforms?size=10 // TEST[skip:setup kibana sample data] The following example gets configuration information for the -`ecommerce_transform` {dataframe-transform}: +`ecommerce_transform` {transform}: [source,js] -------------------------------------------------- diff --git a/docs/reference/transform/apis/index.asciidoc b/docs/reference/transform/apis/index.asciidoc index 3a40948bd667b..1eee27a7bd146 100644 --- a/docs/reference/transform/apis/index.asciidoc +++ b/docs/reference/transform/apis/index.asciidoc @@ -1,17 +1,17 @@ [role="xpack"] [testenv="basic"] -[[data-frame-apis]] -== {dataframe-transform-cap} APIs +[[transform-apis]] +== {transform-cap} APIs -See also {stack-ov}/ml-dataframes.html[{dataframe-transforms-cap}]. +See also {stack-ov}/ml-dataframes.html[{transforms-cap}]. -* <> -* <> -* <> -* <> -* <> -* <> -* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> //CREATE include::put-transform.asciidoc[] diff --git a/docs/reference/transform/apis/preview-transform.asciidoc b/docs/reference/transform/apis/preview-transform.asciidoc index 7daeb3996839a..bef67080b94c5 100644 --- a/docs/reference/transform/apis/preview-transform.asciidoc +++ b/docs/reference/transform/apis/preview-transform.asciidoc @@ -1,42 +1,42 @@ [role="xpack"] [testenv="basic"] -[[preview-data-frame-transform]] -=== Preview {dataframe-transforms} API +[[preview-transform]] +=== Preview {transforms} API [subs="attributes"] ++++ -Preview {dataframe-transforms} +Preview {transforms} ++++ -Previews a {dataframe-transform}. +Previews a {transform}. beta[] -[[preview-data-frame-transform-request]] +[[preview-transform-request]] ==== {api-request-title} `POST _data_frame/transforms/_preview` -[[preview-data-frame-transform-prereq]] +[[preview-transform-prereq]] ==== {api-prereq-title} * If the {es} {security-features} are enabled, you must have `manage_data_frame_transforms` cluster privileges to use this API. The built-in `data_frame_transforms_admin` role has these privileges. You must also have `read` and `view_index_metadata` privileges on the source index for the -{dataframe-transform}. For more information, see +{transform}. For more information, see {stack-ov}/security-privileges.html[Security privileges] and {stack-ov}/built-in-roles.html[Built-in roles]. -[[preview-data-frame-transform-desc]] +[[preview-transform-desc]] ==== {api-description-title} This API generates a preview of the results that you will get when you run the -<> with the same +<> with the same configuration. It returns a maximum of 100 results. The calculations are based on all the current data in the source index. -[[preview-data-frame-transform-request-body]] +[[preview-transform-request-body]] ==== {api-request-body-title} `source`:: @@ -45,7 +45,7 @@ on all the current data in the source index. `index`::: (Required, string or array) The _source indices_ for the - {dataframe-transform}. It can be a single index, an index pattern (for + {transform}. It can be a single index, an index pattern (for example, `"myindex*"`), or an array of indices (for example, `["index1", "index2"]`). @@ -55,15 +55,15 @@ on all the current data in the source index. `pivot`:: (object) Required. Defines the pivot function `group by` fields and the - aggregation to reduce the data. See <>. + aggregation to reduce the data. See <>. -[[preview-data-frame-transform-response]] +[[preview-transform-response]] ==== {api-response-body-title} `preview`:: (array) An array of documents. In particular, they are the JSON representation of the documents that would be created in the destination index - by the {dataframe-transform}. + by the {transform}. ==== {api-examples-title} diff --git a/docs/reference/transform/apis/put-transform.asciidoc b/docs/reference/transform/apis/put-transform.asciidoc index 5831c801fb8b0..fd0acf40bff3c 100644 --- a/docs/reference/transform/apis/put-transform.asciidoc +++ b/docs/reference/transform/apis/put-transform.asciidoc @@ -1,23 +1,23 @@ [role="xpack"] [testenv="basic"] -[[put-data-frame-transform]] -=== Create {dataframe-transforms} API +[[put-transform]] +=== Create {transforms} API [subs="attributes"] ++++ -Create {dataframe-transforms} +Create {transforms} ++++ -Instantiates a {dataframe-transform}. +Instantiates a {transform}. beta[] -[[put-data-frame-transform-request]] +[[put-transform-request]] ==== {api-request-title} -`PUT _data_frame/transforms/` +`PUT _data_frame/transforms/` -[[put-data-frame-transform-prereqs]] +[[put-transform-prereqs]] ==== {api-prereq-title} * If the {es} {security-features} are enabled, you must have @@ -28,53 +28,53 @@ have `read` and `view_index_metadata` privileges on the source index and `read`, information, see {stack-ov}/security-privileges.html[Security privileges] and {stack-ov}/built-in-roles.html[Built-in roles]. -[[put-data-frame-transform-desc]] +[[put-transform-desc]] ==== {api-description-title} -This API defines a {dataframe-transform}, which copies data from source indices, +This API defines a {transform}, which copies data from source indices, transforms it, and persists it into an entity-centric destination index. The entities are defined by the set of `group_by` fields in the `pivot` object. You can also think of the destination index as a two-dimensional tabular data structure (known as a {dataframe}). The ID for each document in the {dataframe} is generated from a hash of the entity, so there is a unique row per entity. For more information, see -{stack-ov}/ml-dataframes.html[{dataframe-transforms-cap}]. +{stack-ov}/ml-dataframes.html[{transforms-cap}]. -When the {dataframe-transform} is created, a series of validations occur to +When the {transform} is created, a series of validations occur to ensure its success. For example, there is a check for the existence of the source indices and a check that the destination index is not part of the source index pattern. -IMPORTANT: You must use {kib} or this API to create a {dataframe-transform}. - Do not put a {dataframe-transform} directly into any +IMPORTANT: You must use {kib} or this API to create a {transform}. + Do not put a {transform} directly into any `.data-frame-internal*` indices using the Elasticsearch index API. If {es} {security-features} are enabled, do not give users any privileges on `.data-frame-internal*` indices. -[[put-data-frame-transform-path-parms]] +[[put-transform-path-parms]] ==== {api-path-parms-title} -``:: - (Required, string) Identifier for the {dataframe-transform}. This identifier +``:: + (Required, string) Identifier for the {transform}. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. -[[put-data-frame-transform-request-body]] +[[put-transform-request-body]] ==== {api-request-body-title} `description`:: - (Optional, string) Free text description of the {dataframe-transform}. + (Optional, string) Free text description of the {transform}. `dest`:: (Required, object) Required. The destination configuration, which has the following properties: `index`::: - (Required, string) The _destination index_ for the {dataframe-transform}. + (Required, string) The _destination index_ for the {transform}. `pivot`:: (Required, object) Defines the pivot function `group by` fields and the - aggregation to reduce the data. See <>. + aggregation to reduce the data. See <>. `source`:: (Required, object) The source configuration, which has the following @@ -82,7 +82,7 @@ IMPORTANT: You must use {kib} or this API to create a {dataframe-transform}. `index`::: (Required, string or array) The _source indices_ for the - {dataframe-transform}. It can be a single index, an index pattern (for + {transform}. It can be a single index, an index pattern (for example, `"myindex*"`), or an array of indices (for example, `["index1", "index2"]`). @@ -90,7 +90,7 @@ IMPORTANT: You must use {kib} or this API to create a {dataframe-transform}. (Optional, object) A query clause that retrieves a subset of data from the source index. See <>. -[[put-data-frame-transform-example]] +[[put-transform-example]] ==== {api-examples-title} [source,js] diff --git a/docs/reference/transform/apis/start-transform.asciidoc b/docs/reference/transform/apis/start-transform.asciidoc index 1bed507f83a63..2becfe38d8145 100644 --- a/docs/reference/transform/apis/start-transform.asciidoc +++ b/docs/reference/transform/apis/start-transform.asciidoc @@ -1,36 +1,36 @@ [role="xpack"] [testenv="basic"] -[[start-data-frame-transform]] -=== Start {dataframe-transforms} API +[[start-transform]] +=== Start {transforms} API [subs="attributes"] ++++ -Start {dataframe-transforms} +Start {transforms} ++++ -Starts one or more {dataframe-transforms}. +Starts one or more {transforms}. beta[] -[[start-data-frame-transform-request]] +[[start-transform-request]] ==== {api-request-title} -`POST _data_frame/transforms//_start` +`POST _data_frame/transforms//_start` -[[start-data-frame-transform-prereqs]] +[[start-transform-prereqs]] ==== {api-prereq-title} * If the {es} {security-features} are enabled, you must have `manage_data_frame_transforms` cluster privileges to use this API. You must also have `view_index_metadata` privileges on the source index for the -{dataframe-transform}. For more information, see +{transform}. For more information, see {stack-ov}/security-privileges.html[Security privileges] and {stack-ov}/built-in-roles.html[Built-in roles]. -[[start-data-frame-transform-desc]] +[[start-transform-desc]] ==== {api-description-title} -When you start a {dataframe-transform}, it creates the destination index if it +When you start a {transform}, it creates the destination index if it does not already exist. The `number_of_shards` is set to `1` and the `auto_expand_replicas` is set to `0-1`. @@ -41,22 +41,22 @@ aggregations, the transform uses dynamic mappings unless a template exists or the destination index already exists. Mapping definitions in the destination index take precedence over dynamic mappings and templates. -When a {dataframe-transform} starts, a series of validations occur to ensure its +When a {transform} starts, a series of validations occur to ensure its success. However, there are no initial privilege checks. When {es} -{security-features} are enabled, the {dataframe-transform} remembers which roles +{security-features} are enabled, the {transform} remembers which roles the user that created it had at the time of creation and uses those same roles. If those roles do not have the required privileges on the source and destination -indices, the {dataframe-transform} fails when it attempts unauthorized operations. +indices, the {transform} fails when it attempts unauthorized operations. -[[start-data-frame-transform-path-parms]] +[[start-transform-path-parms]] ==== {api-path-parms-title} -``:: - (string) Required. Identifier for the {dataframe-transform}. This identifier +``:: + (string) Required. Identifier for the {transform}. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. -[[start-data-frame-transform-example]] +[[start-transform-example]] ==== {api-examples-title} [source,js] @@ -66,7 +66,7 @@ POST _data_frame/transforms/ecommerce_transform/_start // CONSOLE // TEST[skip:set up kibana samples] -When the {dataframe-transform} starts, you receive the following results: +When the {transform} starts, you receive the following results: [source,js] ---- { diff --git a/docs/reference/transform/apis/stop-transform.asciidoc b/docs/reference/transform/apis/stop-transform.asciidoc index 9da565dd6f66f..1c1c2e9be4a05 100644 --- a/docs/reference/transform/apis/stop-transform.asciidoc +++ b/docs/reference/transform/apis/stop-transform.asciidoc @@ -1,27 +1,29 @@ [role="xpack"] [testenv="basic"] -[[stop-data-frame-transform]] -=== Stop {dataframe-transforms} API +[[stop-transform]] +=== Stop {transforms} API [subs="attributes"] ++++ -Stop {dataframe-transforms} +Stop {transforms} ++++ -Stops one or more {dataframe-transforms}. +Stops one or more {transforms}. beta[] -[[stop-data-frame-transform-request]] + +[[stop-transform-request]] ==== {api-request-title} -`POST _data_frame/transforms//_stop` + +`POST _data_frame/transforms//_stop` + -`POST _data_frame/transforms/,/_stop` + +`POST _data_frame/transforms/,/_stop` + `POST _data_frame/transforms/_all/_stop` -[[stop-data-frame-transform-prereq]] + +[[stop-transform-prereq]] ==== {api-prereq-title} * If the {es} {security-features} are enabled, you must have @@ -30,23 +32,23 @@ beta[] see {stack-ov}/security-privileges.html[Security privileges] and {stack-ov}/built-in-roles.html[Built-in roles]. -[[stop-data-frame-transform-desc]] +[[stop-transform-desc]] ==== {api-description-title} -You can stop multiple {dataframe-transforms} in a single API request by using a -comma-separated list of {dataframe-transforms} or a wildcard expression. -All {dataframe-transforms} can be stopped by using `_all` or `*` as the +You can stop multiple {transforms} in a single API request by using a +comma-separated list of {transforms} or a wildcard expression. +All {transforms} can be stopped by using `_all` or `*` as the ``. -[[stop-data-frame-transform-path-parms]] +[[stop-transform-path-parms]] ==== {api-path-parms-title} -``:: - (string) Required. Identifier for the {dataframe-transform}. This identifier +``:: + (string) Required. Identifier for the {transform}. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. -[[stop-data-frame-transform-query-parms]] +[[stop-transform-query-parms]] ==== {api-query-parms-title} `timeout`:: @@ -62,7 +64,7 @@ All {dataframe-transforms} can be stopped by using `_all` or `*` as the state completely stops. If set to `false`, the API returns immediately and the indexer will be stopped asynchronously in the background. Defaults to `false`. -[[stop-data-frame-transform-example]] +[[stop-transform-example]] ==== {api-examples-title} [source,js] @@ -72,7 +74,7 @@ POST _data_frame/transforms/ecommerce_transform/_stop // CONSOLE // TEST[skip:set up kibana samples] -When the {dataframe-transform} stops, you receive the following results: +When the {transform} stops, you receive the following results: [source,js] ---- { diff --git a/docs/reference/transform/apis/transformresource.asciidoc b/docs/reference/transform/apis/transformresource.asciidoc index 6d12b33ea56e5..2a10b076cca2c 100644 --- a/docs/reference/transform/apis/transformresource.asciidoc +++ b/docs/reference/transform/apis/transformresource.asciidoc @@ -1,60 +1,60 @@ [role="xpack"] [testenv="basic"] -[[data-frame-transform-resource]] -=== {dataframe-transform-cap} resources +[[transform-resource]] +=== {transform-cap} resources -{dataframe-transform-cap} resources relate to the <>. +{transform-cap} resources relate to the <>. For more information, see {stack-ov}/ecommerce-dataframes.html[Transforming your data with {dataframes}]. [discrete] -[[data-frame-transform-properties]] +[[transform-properties]] ==== {api-definitions-title} `description`:: - (string) A description of the {dataframe-transform}. + (string) A description of the {transform}. `dest`:: - (object) The destination for the {dataframe-transform}. See - <>. + (object) The destination for the {transform}. See + <>. `id`:: - (string) A unique identifier for the {dataframe-transform}. + (string) A unique identifier for the {transform}. `pivot`:: (object) The method for transforming the data. See - <>. + <>. `source`:: - (object) The source of the data for the {dataframe-transform}. See - <>. + (object) The source of the data for the {transform}. See + <>. -[[data-frame-transform-dest]] +[[transform-dest]] ==== Dest objects -{dataframe-transform-cap} resources contain `dest` objects. For example, when -you create a {dataframe-transform}, you must define its destination. +{transform-cap} resources contain `dest` objects. For example, when +you create a {transform}, you must define its destination. [discrete] -[[data-frame-transform-dest-properties]] +[[transform-dest-properties]] ===== {api-definitions-title} `index`:: - (string) The _destination index_ for the {dataframe-transform}. + (string) The _destination index_ for the {transform}. -[[data-frame-transform-source]] +[[transform-source]] ==== Source objects -{dataframe-transform-cap} resources contain `source` objects. For example, when -you create a {dataframe-transform}, you must define its source. +{transform-cap} resources contain `source` objects. For example, when +you create a {transform}, you must define its source. [discrete] -[[data-frame-transform-source-properties]] +[[transform-source-properties]] ===== {api-definitions-title} `index`:: - (string or array) The _source indices_ for the {dataframe-transform}. It can + (string or array) The _source indices_ for the {transform}. It can be a single index, an index pattern (for example, `"myindex*"`), or an array of indices (for example, `["index1", "index2"]`). @@ -62,14 +62,14 @@ you create a {dataframe-transform}, you must define its source. (object) A query clause that retrieves a subset of data from the source index. See <>. -[[data-frame-transform-pivot]] +[[transform-pivot]] ==== Pivot objects -{dataframe-transform-cap} resources contain `pivot` objects, which define the +{transform-cap} resources contain `pivot` objects, which define the pivot function `group by` fields and the aggregation to reduce the data. [discrete] -[[data-frame-transform-pivot-properties]] +[[transform-pivot-properties]] ===== {api-definitions-title} `aggregations` or `aggs`:: @@ -88,7 +88,7 @@ pivot function `group by` fields and the aggregation to reduce the data. * {ref}/search-aggregations-metrics-valuecount-aggregation.html[Value Count] * {ref}/search-aggregations-pipeline-bucket-script-aggregation.html[Bucket Script] -IMPORTANT: {dataframe-transforms-cap} support a subset of the functionality in +IMPORTANT: {transforms-cap} support a subset of the functionality in composite aggregations. See {stack-ov}/dataframe-limitations.html[{dataframe-cap} limitations]. @@ -110,8 +110,8 @@ composite aggregations. See dynamically adjusted to a lower value. The minimum value is `10` and the maximum is `10,000`. The default value is `500`. -[[data-frame-transform-example]] +[[transform-example]] ==== {api-examples-title} See the -<>. \ No newline at end of file +<>. diff --git a/docs/reference/transform/ecommerce-example.asciidoc b/docs/reference/transform/ecommerce-example.asciidoc index 9f2c659e45d9a..5ca315205d807 100644 --- a/docs/reference/transform/ecommerce-example.asciidoc +++ b/docs/reference/transform/ecommerce-example.asciidoc @@ -5,10 +5,10 @@ beta[] -<> enable you to retrieve information +<> enable you to retrieve information from an {es} index, transform it, and store it in another index. Let's use the {kibana-ref}/add-sample-data.html[{kib} sample data] to demonstrate how you can -pivot and summarize your data with {dataframe-transforms}. +pivot and summarize your data with {transforms}. . If the {es} {security-features} are enabled, obtain a user ID with sufficient @@ -16,7 +16,7 @@ privileges to complete these steps. + -- You need `manage_data_frame_transforms` cluster privileges to preview and create -{dataframe-transforms}. Members of the built-in `data_frame_transforms_admin` +{transforms}. Members of the built-in `data_frame_transforms_admin` role have these privileges. You also need `read` and `view_index_metadata` index privileges on the source @@ -81,7 +81,7 @@ more complex queries, you can create your {dataframe} from a {kibana-ref}/save-open-search.html[saved search]. If you prefer, you can use the -{ref}/preview-data-frame-transform.html[preview {dataframe-transforms} API]: +{ref}/preview-transform.html[preview {transforms} API]: [source,js] -------------------------------------------------- @@ -135,7 +135,7 @@ POST _data_frame/transforms/_preview -- . When you are satisfied with what you see in the preview, create the -{dataframe-transform}. +{transform}. + -- Supply a job ID and the name of the target (or _destination_) index. If the @@ -144,7 +144,7 @@ you can choose to create and start the job, create it, or copy it to the clipboard. If you prefer, you can use the -{ref}/put-data-frame-transform.html[create {dataframe-transforms} API]. For +{ref}/put-transform.html[create {transforms} API]. For example: [source,js] @@ -205,12 +205,12 @@ PUT _data_frame/transforms/ecommerce-customer-transform // TEST[skip:setup kibana sample data] -- -. Start the {dataframe-transform}. +. Start the {transform}. + -- TIP: Even though resource utilization is automatically adjusted based on the -cluster load, a {dataframe-transform} increases search and indexing load on your +cluster load, a {transform} increases search and indexing load on your cluster while it runs. When it reaches the end of the data in your index, it stops automatically. If you're experiencing an excessive load, however, you can stop it sooner. @@ -221,8 +221,8 @@ You can start, stop, and manage {dataframe} jobs in {kib}: image::images/dataframe-jobs.jpg["Managing {dataframe} jobs in {kib}"] Alternatively, you can use the -{ref}/start-data-frame-transform.html[start {dataframe-transforms}] and -{ref}/stop-data-frame-transform.html[stop {dataframe-transforms}] APIs. For +{ref}/start-transform.html[start {transforms}] and +{ref}/stop-transform.html[stop {transforms}] APIs. For example: [source,js] @@ -244,7 +244,7 @@ image::images/ecommerce-results.jpg["Exploring the new index in {kib}"] -- -TIP: If you do not want to keep the {dataframe-transform}, you can delete it in +TIP: If you do not want to keep the {transform}, you can delete it in {kib} or use the -{ref}/delete-data-frame-transform.html[delete {dataframe-transform} API]. When -you delete a {dataframe-transform}, its destination index remains. +{ref}/delete-transform.html[delete {transform} API]. When +you delete a {transform}, its destination index remains. diff --git a/docs/reference/transform/limitations.asciidoc b/docs/reference/transform/limitations.asciidoc index cc00fe24878dc..0f1b673e35204 100644 --- a/docs/reference/transform/limitations.asciidoc +++ b/docs/reference/transform/limitations.asciidoc @@ -19,15 +19,15 @@ the API. If you try to create one, the UI will fail to show the source index tab [[df-ccs-limitations]] === {ccs-cap} limitation -{ccs-cap} is not supported in 7.2 for {dataframe-transforms}. +{ccs-cap} is not supported in 7.2 for {transforms}. [float] [[df-kibana-limitations]] === {kib} only displays up to 100 {dataframe-transforms} The {kib} *Machine Learning* > *Data Frames* page lists up to 100 -{dataframe-transforms}. You can work-around this limitation by calling the -{ref}/get-data-frame-transform.html[GET {dataframe-transforms} API] +{transforms}. You can work-around this limitation by calling the +{ref}/get-transform.html[GET {transforms} API] with the `size` parameter. [float] @@ -35,7 +35,7 @@ with the `size` parameter. === Date histogram limitation If you use a {ref}/search-aggregations-bucket-datehistogram-aggregation.html[date -histogram] in the `group_by` object in the create or preview {dataframe-transform} +histogram] in the `group_by` object in the create or preview {transform} APIs, the defined interval and time format must have the same time fidelity. Otherwise, it might cause issues in the {dataframe}. @@ -44,14 +44,14 @@ For example, if you set the `calendar_interval` of the date histogram to one min `yyyy-MM-dd HH:00`. [float] -=== Date format limitation in {dataframe-transform} destination index +=== Date format limitation in {transform} destination index -When you create a {dataframe-transform} that uses a `date_histogram` as a `group-by` +When you create a {transform} that uses a `date_histogram` as a `group-by` and set the `interval` to `1y`, the date could be interpreted incorrectly in the generated date field of the destination index. The reason is that the `yyyy` value can be identified incorrectly as `epoch_millis`. As a workaround, using the API, you may define a custom destination index data format mapping prior to starting -the {dataframe-transform}. For example: +the {transform}. For example: [source,js] ------------------------------------------------------------ @@ -76,4 +76,4 @@ mappings set for the destination index. For example "NaN", "Infinity" or possibl a numeric overflow. Where possible, a null response has been substituted. Please, check {es} logs if you think this may have occurred. As a workaround, using the API, you may define custom destination index mappings prior to starting -the {dataframe-transform}. +the {transform}. diff --git a/docs/reference/transform/overview.asciidoc b/docs/reference/transform/overview.asciidoc index ff16f6c32c217..051aae8f8a239 100644 --- a/docs/reference/transform/overview.asciidoc +++ b/docs/reference/transform/overview.asciidoc @@ -19,8 +19,8 @@ you to summarize this data, bringing it into an organized, more analysis-friendly format. For example, you can summarize all the purchases of a single customer. -You can create {dataframes} by using {dataframe-transforms}. -{dataframe-transforms-cap} enable you to define a pivot, which is a set of +You can create {dataframes} by using {transforms}. +{transforms-cap} enable you to define a pivot, which is a set of features that transform the index into a different, more digestible format. Pivoting results in a summary of your data, which is the {dataframe}. @@ -33,7 +33,7 @@ The second step is deciding how you want to aggregate the grouped data. When using aggregations, you practically ask questions about the index. There are different types of aggregations, each with its own purpose and output. To learn more about the supported aggregations and group-by fields, see -{ref}/data-frame-transform-resource.html[{dataframe-transform-cap} resources]. +{ref}/transform-resource.html[{transform-cap} resources]. As an optional step, you can also add a query to further limit the scope of the aggregation. @@ -51,7 +51,7 @@ information (name, gender, location, etc). Your dataset contains all the transac from last year. If you want to check the sales in the different categories in your last fiscal -year, define a {dataframe-transform} that groups the data by the product +year, define a {transform} that groups the data by the product categories (women's shoes, men's clothing, etc.) and the order date. Use the last year as the interval for the order date. Then add a sum aggregation on the ordered quantity. The result is a {dataframe} that shows the number of sold @@ -60,6 +60,6 @@ items in every product category in the last year. [role="screenshot"] image::images/ml-dataframepivot.jpg["Example of a data frame pivot in {kib}"] -IMPORTANT: The {dataframe-transform} leaves your source index intact. It +IMPORTANT: The {transform} leaves your source index intact. It creates a new index that is dedicated to the {dataframe}. diff --git a/docs/reference/transform/troubleshooting.asciidoc b/docs/reference/transform/troubleshooting.asciidoc index 342aea3839030..6bda42790a336 100644 --- a/docs/reference/transform/troubleshooting.asciidoc +++ b/docs/reference/transform/troubleshooting.asciidoc @@ -1,7 +1,7 @@ [role="xpack"] [testenv="basic"] [[dataframe-troubleshooting]] -== Troubleshooting {dataframe-transforms} +== Troubleshooting {transforms} [subs="attributes"] ++++ Troubleshooting @@ -11,21 +11,21 @@ Use the information in this section to troubleshoot common problems. include::{stack-repo-dir}/help.asciidoc[tag=get-help] -If you encounter problems with your {dataframe-transforms}, you can gather more +If you encounter problems with your {transforms}, you can gather more information from the following files and APIs: * Lightweight audit messages are stored in `.data-frame-notifications-*`. Search by your `transform_id`. * The -{ref}/get-data-frame-transform-stats.html[get {dataframe-transform} statistics API] +{ref}/get-transform-stats.html[get {transform} statistics API] provides information about the transform status and failures. -* If the {dataframe-transform} exists as a task, you can use the +* If the {transform} exists as a task, you can use the {ref}/tasks.html[task management API] to gather task information. For example: `GET _tasks?actions=data_frame/transforms*&detailed`. Typically, the task exists when the transform is in a started or failed state. -* The {es} logs from the node that was running the {dataframe-transform} might +* The {es} logs from the node that was running the {transform} might also contain useful information. You can identify the node from the notification messages. Alternatively, if the task still exists, you can get that information -from the get {dataframe-transform} statistics API. For more information, see +from the get {transform} statistics API. For more information, see {ref}/logging.html[Logging configuration]. diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.delete_data_frame_transform.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.delete_data_frame_transform.json index 30da72491df11..f078a049a109d 100644 --- a/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.delete_data_frame_transform.json +++ b/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.delete_data_frame_transform.json @@ -1,6 +1,6 @@ { "data_frame.delete_data_frame_transform": { - "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-data-frame-transform.html", + "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html", "stability": "beta", "methods": [ "DELETE" ], "url": { diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.get_data_frame_transform.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.get_data_frame_transform.json index 10769a780da55..4f619b51f5c13 100644 --- a/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.get_data_frame_transform.json +++ b/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.get_data_frame_transform.json @@ -1,6 +1,6 @@ { "data_frame.get_data_frame_transform": { - "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-data-frame-transform.html", + "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html", "stability": "beta", "methods": [ "GET" ], "url": { diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.get_data_frame_transform_stats.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.get_data_frame_transform_stats.json index cfbe22d703b7f..f86348f62a2ee 100644 --- a/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.get_data_frame_transform_stats.json +++ b/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.get_data_frame_transform_stats.json @@ -1,6 +1,6 @@ { "data_frame.get_data_frame_transform_stats": { - "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-data-frame-transform-stats.html", + "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html", "stability": "beta", "methods": [ "GET" ], "url": { diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.preview_data_frame_transform.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.preview_data_frame_transform.json index bbfcf61640c43..4a28787af87c9 100644 --- a/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.preview_data_frame_transform.json +++ b/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.preview_data_frame_transform.json @@ -1,6 +1,6 @@ { "data_frame.preview_data_frame_transform": { - "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-data-frame-transform.html", + "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html", "stability": "beta", "methods": [ "POST" ], "url": { diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.put_data_frame_transform.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.put_data_frame_transform.json index 919682676da3c..92752ed2fec8c 100644 --- a/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.put_data_frame_transform.json +++ b/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.put_data_frame_transform.json @@ -1,6 +1,6 @@ { "data_frame.put_data_frame_transform": { - "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-data-frame-transform.html", + "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html", "stability": "beta", "methods": [ "PUT" ], "url": { diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.start_data_frame_transform.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.start_data_frame_transform.json index 0a1368514f1f8..ab6635ce7bd43 100644 --- a/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.start_data_frame_transform.json +++ b/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.start_data_frame_transform.json @@ -1,6 +1,6 @@ { "data_frame.start_data_frame_transform": { - "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-data-frame-transform.html", + "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html", "stability": "beta", "methods": [ "POST" ], "url": { diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.stop_data_frame_transform.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.stop_data_frame_transform.json index 7c102bdb5a56a..51e229ea8d2e7 100644 --- a/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.stop_data_frame_transform.json +++ b/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.stop_data_frame_transform.json @@ -1,6 +1,6 @@ { "data_frame.stop_data_frame_transform": { - "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-data-frame-transform.html", + "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html", "stability": "beta", "methods": [ "POST" ], "url": {