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 3dd0f35fcea24..e56bd44229286 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 @@ -48,11 +48,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.transform.transforms.DataFrameTransformConfig}. @@ -69,11 +69,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.transform.transforms.DataFrameTransformConfig}. * @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized @@ -91,11 +91,11 @@ public Cancellable putDataFrameTransformAsync(PutDataFrameTransformRequest reque } /** - * Updates an existing Data Frame Transform + * Updates an existing transform *

* For additional info - * see - * Create data frame transform documentation + * see + * Create transform documentation * * @param request The UpdateDataFrameTransformRequest containing the * {@link org.elasticsearch.client.transform.transforms.DataFrameTransformConfigUpdate}. @@ -113,11 +113,11 @@ public UpdateDataFrameTransformResponse updateDataFrameTransform(UpdateDataFrame } /** - * Updates an existing Data Frame Transform asynchronously and notifies listener on completion + * Updates an existing transform asynchronously and notifies listener on completion *

* For additional info - * see - * Create data frame transform documentation + * see + * Create transform documentation * @param request The UpdateDataFrameTransformRequest containing the * {@link org.elasticsearch.client.transform.transforms.DataFrameTransformConfigUpdate}. * @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized @@ -136,15 +136,15 @@ public Cancellable updateDataFrameTransformAsync(UpdateDataFrameTransformRequest } /** - * 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) @@ -157,11 +157,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 * @param listener Listener to be notified upon request completion @@ -178,13 +178,13 @@ public Cancellable getDataFrameTransformStatsAsync(GetDataFrameTransformStatsReq } /** - * 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 @@ -199,12 +199,12 @@ 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 - * @param request The delete data frame transform request + * see + * Delete transform documentation + * @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 * @return cancellable that may be used to cancel the request @@ -220,13 +220,13 @@ public Cancellable deleteDataFrameTransformAsync(DeleteDataFrameTransformRequest } /** - * 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 @@ -241,11 +241,11 @@ 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 - * @param request The preview data frame transform request + * see + * Preview transform documentation + * @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 * @return cancellable that may be used to cancel the request @@ -261,13 +261,13 @@ public Cancellable previewDataFrameTransformAsync(PreviewDataFrameTransformReque } /** - * 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 @@ -282,12 +282,12 @@ 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 - * @param request The start data frame transform request + * see + * Start transform documentation + * @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 * @return cancellable that may be used to cancel the request @@ -303,13 +303,13 @@ public Cancellable startDataFrameTransformAsync(StartDataFrameTransformRequest r } /** - * 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 @@ -324,12 +324,12 @@ 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 - * @param request The stop data frame transform request + * see + * Stop transform documentation + * @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 * @return cancellable that may be used to cancel the request @@ -345,13 +345,13 @@ public Cancellable stopDataFrameTransformAsync(StopDataFrameTransformRequest req } /** - * 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 @@ -366,12 +366,12 @@ 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 - * @param request The get data frame transform request + * see + * Get data transform documentation + * @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 * @return cancellable that may be used to cancel the request 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 d3c118ad0ae0c..0992edd936c29 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 d4cef221401d6..723594bf498e8 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 @@ -121,39 +121,39 @@ 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-dest-config + // end::put-transform-source-config + // tag::put-transform-dest-config DestConfig destConfig = DestConfig.builder() .setIndex("pivot-destination") .setPipeline("my-pipeline").build(); - // end::put-data-frame-transform-dest-config - // tag::put-data-frame-transform-group-config + // end::put-transform-dest-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> @@ -163,20 +163,20 @@ public void testPutDataFrameTransform() throws IOException, InterruptedException .setPivotConfig(pivotConfig) // <5> .setDescription("This is my test transform") // <6> .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> request.setDeferValidation(false); // <2> - // 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()); @@ -190,7 +190,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 @@ -203,16 +203,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()); @@ -242,7 +242,7 @@ public void testUpdateDataFrameTransform() throws IOException, InterruptedExcept client.dataFrame().putDataFrameTransform(new PutDataFrameTransformRequest(transformConfig), RequestOptions.DEFAULT); transformsToClean.add(transformConfig.getId()); - // tag::update-data-frame-transform-config + // tag::update-transform-config DataFrameTransformConfigUpdate update = DataFrameTransformConfigUpdate .builder() .setSource(SourceConfig.builder() @@ -256,24 +256,24 @@ public void testUpdateDataFrameTransform() throws IOException, InterruptedExcept TimeValue.timeValueSeconds(120))) // <4> .setDescription("This is my updated transform") // <5> .build(); - // end::update-data-frame-transform-config + // end::update-transform-config { - // tag::update-data-frame-transform-request + // tag::update-transform-request UpdateDataFrameTransformRequest request = new UpdateDataFrameTransformRequest( update, // <1> "my-transform-to-update"); // <2> request.setDeferValidation(false); // <3> - // end::update-data-frame-transform-request + // end::update-transform-request - // tag::update-data-frame-transform-execute + // tag::update-transform-execute UpdateDataFrameTransformResponse response = client.dataFrame().updateDataFrameTransform(request, RequestOptions.DEFAULT); DataFrameTransformConfig updatedConfig = response.getTransformConfiguration(); - // end::update-data-frame-transform-execute + // end::update-transform-execute assertThat(updatedConfig.getDescription(), equalTo("This is my updated transform")); } @@ -281,7 +281,7 @@ public void testUpdateDataFrameTransform() throws IOException, InterruptedExcept UpdateDataFrameTransformRequest request = new UpdateDataFrameTransformRequest(update, "my-transform-to-update"); - // tag::update-data-frame-transform-execute-listener + // tag::update-transform-execute-listener ActionListener listener = new ActionListener() { @Override @@ -294,16 +294,16 @@ public void onFailure(Exception e) { // <2> } }; - // end::update-data-frame-transform-execute-listener + // end::update-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::update-data-frame-transform-execute-async + // tag::update-transform-execute-async client.dataFrame().updateDataFrameTransformAsync( request, RequestOptions.DEFAULT, listener); // <1> - // end::update-data-frame-transform-execute-async + // end::update-transform-execute-async assertTrue(latch.await(30L, TimeUnit.SECONDS)); } @@ -333,45 +333,45 @@ 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> request.setAllowNoMatch(true); // <3> - // 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 @@ -385,22 +385,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 @@ -414,17 +414,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)); } @@ -465,22 +465,22 @@ 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> request.setForce(false); // <2> - // 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 @@ -493,7 +493,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); @@ -501,10 +501,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)); } @@ -523,7 +523,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() @@ -534,20 +534,20 @@ public void testPreview() throws IOException, InterruptedException { 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()); assertNotNull(response.getMappings()); } { - // tag::preview-data-frame-transform-execute-listener + // tag::preview-transform-execute-listener ActionListener listener = new ActionListener() { @Override @@ -560,16 +560,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)); } @@ -600,26 +600,26 @@ 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-request-options + // tag::get-transform-stats-request-options request.setPageParams(new PageParams(0, 100)); // <1> request.setAllowNoMatch(true); // <2> - // end::get-data-frame-transform-stats-request-options + // end::get-transform-stats-request-options { - // 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.getTransformsStats(), hasSize(1)); - // tag::get-data-frame-transform-stats-response + // tag::get-transform-stats-response DataFrameTransformStats stats = response.getTransformsStats().get(0); // <1> DataFrameTransformStats.State state = @@ -631,14 +631,14 @@ public void testGetStats() throws IOException, InterruptedException { .getNext().getCheckpointProgress(); // <4> NodeAttributes node = stats.getNode(); // <5> - // end::get-data-frame-transform-stats-response + // end::get-transform-stats-response assertEquals(DataFrameTransformStats.State.STOPPED, state); assertNotNull(indexerStats); assertNull(progress); } { - // tag::get-data-frame-transform-stats-execute-listener + // tag::get-transform-stats-execute-listener ActionListener listener = new ActionListener() { @Override @@ -652,16 +652,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)); } @@ -694,31 +694,31 @@ 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> request.setAllowNoMatch(true); // <2> - // 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 @@ -731,7 +731,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); @@ -739,10 +739,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 abc9469590dc0..9f3902d0b9fb5 100644 --- a/docs/java-rest/high-level/supported-apis.asciidoc +++ b/docs/java-rest/high-level/supported-apis.asciidoc @@ -576,29 +576,29 @@ include::ilm/retry_lifecycle_policy.asciidoc[] include::ilm/remove_lifecycle_policy_from_index.asciidoc[] [role="xpack"] -[[_data_frame_transform_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 {transform} APIs: -* <<{upid}-get-data-frame-transform>> -* <<{upid}-get-data-frame-transform-stats>> -* <<{upid}-put-data-frame-transform>> -* <<{upid}-update-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/update_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[] +* <<{upid}-get-transform>> +* <<{upid}-get-transform-stats>> +* <<{upid}-put-transform>> +* <<{upid}-update-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/update_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 96% rename from docs/java-rest/high-level/dataframe/delete_data_frame.asciidoc rename to docs/java-rest/high-level/transform/delete_transform.asciidoc index d4e2f93df1856..31a86dd80b4ed 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 e36ff37a2d248..f9c8c4a09809a 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 98% 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 76b06f99eb141..7674dab7b0a17 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 d2c1233dac09b..5de00f5891f25 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 c6983414484e5..b84ba1329cdab 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 ef7d83815e5aa..69aea67dc2b86 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 fe6dbee9c4276..36a1491615ecd 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/high-level/dataframe/update_data_frame.asciidoc b/docs/java-rest/high-level/transform/update_transform.asciidoc similarity index 98% rename from docs/java-rest/high-level/dataframe/update_data_frame.asciidoc rename to docs/java-rest/high-level/transform/update_transform.asciidoc index e1313e08a69af..37f60eacf4707 100644 --- a/docs/java-rest/high-level/dataframe/update_data_frame.asciidoc +++ b/docs/java-rest/high-level/transform/update_transform.asciidoc @@ -1,5 +1,5 @@ -- -:api: update-data-frame-transform +:api: update-transform :request: UpdateDataFrameTransformRequest :response: UpdateDataFrameTransformResponse -- 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..a077102b405d4 --- /dev/null +++ b/docs/java-rest/redirects.asciidoc @@ -0,0 +1,49 @@ +["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-update-data-frame-transform"] +=== Update {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 76bedbd489520..7899b6693cad4 100644 --- a/docs/reference/redirects.asciidoc +++ b/docs/reference/redirects.asciidoc @@ -837,4 +837,69 @@ See <>. [role="exclude",id="slm-api"] === Snapshot lifecycle management API -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="update-data-frame-transform"] +=== Update {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 <>. \ No newline at end of file diff --git a/docs/reference/rest-api/defs.asciidoc b/docs/reference/rest-api/defs.asciidoc index fcda35df664e4..75e496903f59d 100644 --- a/docs/reference/rest-api/defs.asciidoc +++ b/docs/reference/rest-api/defs.asciidoc @@ -14,7 +14,7 @@ These resource definitions are used in APIs related to {ml-features} and * <> * <> * <> -* <> +* <> include::{es-repo-dir}/ml/anomaly-detection/apis/datafeedresource.asciidoc[] include::{es-repo-dir}/ml/df-analytics/apis/dfanalyticsresources.asciidoc[] diff --git a/docs/reference/rest-api/index.asciidoc b/docs/reference/rest-api/index.asciidoc index 4b2acc675d813..c6a36b8e2ea43 100644 --- a/docs/reference/rest-api/index.asciidoc +++ b/docs/reference/rest-api/index.asciidoc @@ -29,7 +29,7 @@ not be included yet. * <> * <> * <> -* <> +* <> * <> -- diff --git a/docs/reference/transform/api-quickref.asciidoc b/docs/reference/transform/api-quickref.asciidoc index 31dabfa687a77..9d2590a1540ef 100644 --- a/docs/reference/transform/api-quickref.asciidoc +++ b/docs/reference/transform/api-quickref.asciidoc @@ -10,12 +10,13 @@ All {transform} endpoints have the following base: ---- // NOTCONSOLE -* {ref}/put-data-frame-transform.html[Create {transforms}] -* {ref}/delete-data-frame-transform.html[Delete {transforms}] -* {ref}/get-data-frame-transform.html[Get {transforms}] -* {ref}/get-data-frame-transform-stats.html[Get {transforms} statistics] -* {ref}/preview-data-frame-transform.html[Preview {transforms}] -* {ref}/start-data-frame-transform.html[Start {transforms}] -* {ref}/stop-data-frame-transform.html[Stop {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}] +* {ref}/update-transform.html[Update {transforms}] -For the full list, see {ref}/data-frame-apis.html[{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 1717e595020a8..06ac3c8f5d329 100644 --- a/docs/reference/transform/apis/delete-transform.asciidoc +++ b/docs/reference/transform/apis/delete-transform.asciidoc @@ -1,6 +1,6 @@ [role="xpack"] [testenv="basic"] -[[delete-data-frame-transform]] +[[delete-transform]] === Delete {transforms} API [subs="attributes"] @@ -12,12 +12,12 @@ Deletes an existing {transform}. beta[] -[[delete-data-frame-transform-request]] +[[delete-transform-request]] ==== {api-request-title} `DELETE _data_frame/transforms/` -[[delete-data-frame-transform-prereqs]] +[[delete-transform-prereqs]] ==== {api-prereq-title} * Before you can delete the {transform}, you must stop it. @@ -28,13 +28,13 @@ 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} ``:: (Required, string) Identifier for the {transform}. -[[delete-data-frame-transform-query-parms]] +[[delete-transform-query-parms]] ==== {api-query-parms-title} `force`:: @@ -42,7 +42,7 @@ see {stack-ov}/security-privileges.html[Security privileges] and current state. The default value is `false`, meaning that the {transform} must be `stopped` before it can be deleted. -[[delete-data-frame-transform-examples]] +[[delete-transform-examples]] ==== {api-examples-title} [source,console] diff --git a/docs/reference/transform/apis/get-transform-stats.asciidoc b/docs/reference/transform/apis/get-transform-stats.asciidoc index 2ebe3c27993c8..b4b485b52c5e9 100644 --- a/docs/reference/transform/apis/get-transform-stats.asciidoc +++ b/docs/reference/transform/apis/get-transform-stats.asciidoc @@ -1,6 +1,6 @@ [role="xpack"] [testenv="basic"] -[[get-data-frame-transform-stats]] +[[get-transform-stats]] === Get {transform} statistics API [subs="attributes"] @@ -13,7 +13,7 @@ Retrieves usage information for {transforms}. beta[] -[[get-data-frame-transform-stats-request]] +[[get-transform-stats-request]] ==== {api-request-title} `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,7 +37,7 @@ 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 {transforms} in a single API @@ -47,7 +47,7 @@ specifying `*` as the ``, or by omitting the ``. -[[get-data-frame-transform-stats-path-parms]] +[[get-transform-stats-path-parms]] ==== {api-path-parms-title} ``:: @@ -57,7 +57,7 @@ specifying `*` as the ``, or by omitting the {transforms}. -[[get-data-frame-transform-stats-query-parms]] +[[get-transform-stats-query-parms]] ==== {api-query-parms-title} `allow_no_match`:: @@ -81,21 +81,21 @@ are no matches or only partial matches. `size`:: (Optional, integer) 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 {transforms}, which are sorted by the `id` value in ascending order. -[[get-data-frame-transform-stats-response-codes]] +[[get-transform-stats-response-codes]] ==== {api-response-codes-title} `404` (Missing resources):: If `allow_no_match` is `false`, this code indicates that there are no resources that match the request or only partial matches for the request. -[[get-data-frame-transform-stats-example]] +[[get-transform-stats-example]] ==== Examples The following example skips for the first five {transforms} and diff --git a/docs/reference/transform/apis/get-transform.asciidoc b/docs/reference/transform/apis/get-transform.asciidoc index 7b4b7b8df6afc..63b272ad7fb18 100644 --- a/docs/reference/transform/apis/get-transform.asciidoc +++ b/docs/reference/transform/apis/get-transform.asciidoc @@ -1,6 +1,6 @@ [role="xpack"] [testenv="basic"] -[[get-data-frame-transform]] +[[get-transform]] === Get {transforms} API [subs="attributes"] @@ -12,12 +12,12 @@ 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,25 +34,24 @@ 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 {transforms} in a single API request by using a comma-separated list of identifiers or a wildcard expression. You can get information for all {transforms} by using `_all`, by -specifying `*` as the ``, or by omitting the -``. +specifying `*` as the ``, or by omitting the ``. -[[get-data-frame-transform-path-parms]] +[[get-transform-path-parms]] ==== {api-path-parms-title} -``:: +``:: (Optional, string) 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 {transforms}. -[[get-data-frame-transform-query-parms]] +[[get-transform-query-parms]] ==== {api-query-parms-title} `allow_no_match`:: @@ -76,21 +75,21 @@ are no matches or only partial matches. `size`:: (Optional, integer) 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. See <>. + ascending order. See <>. -[[get-data-frame-transform-response-codes]] +[[get-transform-response-codes]] ==== {api-response-codes-title} `404` (Missing resources):: If `allow_no_match` is `false`, this code indicates that there are no resources that match the request or only partial matches for the request. -[[get-data-frame-transform-example]] +[[get-transform-example]] ==== {api-examples-title} The following example retrieves information about a maximum of ten {transforms}: diff --git a/docs/reference/transform/apis/index.asciidoc b/docs/reference/transform/apis/index.asciidoc index e2b5172a6a3d4..e496401d340dd 100644 --- a/docs/reference/transform/apis/index.asciidoc +++ b/docs/reference/transform/apis/index.asciidoc @@ -1,18 +1,18 @@ [role="xpack"] [testenv="basic"] -[[data-frame-apis]] +[[transform-apis]] == {transform-cap} APIs 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 0652dbb867a3c..e86f6c42bbb93 100644 --- a/docs/reference/transform/apis/preview-transform.asciidoc +++ b/docs/reference/transform/apis/preview-transform.asciidoc @@ -1,6 +1,6 @@ [role="xpack"] [testenv="basic"] -[[preview-data-frame-transform]] +[[preview-transform]] === Preview {transforms} API [subs="attributes"] @@ -12,12 +12,12 @@ 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 @@ -28,15 +28,15 @@ beta[] {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`:: @@ -55,9 +55,9 @@ on all the current data in the source index. `pivot`:: (Required, object) 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`:: diff --git a/docs/reference/transform/apis/put-transform.asciidoc b/docs/reference/transform/apis/put-transform.asciidoc index 284a27157e907..49c3d7981ddb0 100644 --- a/docs/reference/transform/apis/put-transform.asciidoc +++ b/docs/reference/transform/apis/put-transform.asciidoc @@ -1,6 +1,6 @@ [role="xpack"] [testenv="basic"] -[[put-data-frame-transform]] +[[put-transform]] === Create {transforms} API [subs="attributes"] @@ -12,12 +12,12 @@ 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,7 +28,7 @@ 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 {transform}, which copies data from source indices, @@ -59,15 +59,15 @@ IMPORTANT: You must use {kib} or this API to create a {transform}. 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 {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-query-parms]] +[[put-transform-query-parms]] ==== {api-query-parms-title} `defer_validation`:: @@ -75,7 +75,7 @@ IMPORTANT: You must use {kib} or this API to create a {transform}. behavior may be desired if the source index does not exist until after the {transform} is created. -[[put-data-frame-transform-request-body]] +[[put-transform-request-body]] ==== {api-request-body-title} `description`:: @@ -100,7 +100,7 @@ IMPORTANT: You must use {kib} or this API to create a {transform}. `pivot`:: (Required, object) Defines the pivot function `group by` fields and the aggregation to - reduce the data. See <>. + reduce the data. See <>. `source`:: (Required, object) The source configuration, which has the following @@ -136,7 +136,7 @@ delays. (Optional, <>) The time delay between the current time and the latest input data time. The default value is `60s`. -[[put-data-frame-transform-example]] +[[put-transform-example]] ==== {api-examples-title} [source,console] diff --git a/docs/reference/transform/apis/start-transform.asciidoc b/docs/reference/transform/apis/start-transform.asciidoc index a633bbf996195..3480ddea86fce 100644 --- a/docs/reference/transform/apis/start-transform.asciidoc +++ b/docs/reference/transform/apis/start-transform.asciidoc @@ -1,6 +1,6 @@ [role="xpack"] [testenv="basic"] -[[start-data-frame-transform]] +[[start-transform]] === Start {transforms} API [subs="attributes"] @@ -12,12 +12,12 @@ 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 @@ -27,7 +27,7 @@ have `view_index_metadata` privileges on the source index for the {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 {transform}, it creates the destination index if it @@ -50,15 +50,15 @@ time of creation and uses those same roles. If those roles do not have the required privileges on the source and destination indices, the {transform} fails when it attempts unauthorized operations. -[[start-data-frame-transform-path-parms]] +[[start-transform-path-parms]] ==== {api-path-parms-title} -``:: +``:: (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. -[[start-data-frame-transform-example]] +[[start-transform-example]] ==== {api-examples-title} [source,console] diff --git a/docs/reference/transform/apis/stop-transform.asciidoc b/docs/reference/transform/apis/stop-transform.asciidoc index a6b77c98512cd..c294186b6c37e 100644 --- a/docs/reference/transform/apis/stop-transform.asciidoc +++ b/docs/reference/transform/apis/stop-transform.asciidoc @@ -1,6 +1,6 @@ [role="xpack"] [testenv="basic"] -[[stop-data-frame-transform]] +[[stop-transform]] === Stop {transforms} API [subs="attributes"] @@ -13,17 +13,17 @@ 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 @@ -33,25 +33,25 @@ 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 {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} -``:: +``:: (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. -[[stop-data-frame-transform-query-parms]] +[[stop-transform-query-parms]] ==== {api-query-parms-title} `allow_no_match`:: @@ -92,7 +92,7 @@ are no matches or only partial matches. indexer will be stopped asynchronously in the background. Defaults to `false`. -[[stop-data-frame-transform-response-codes]] +[[stop-transform-response-codes]] ==== {api-response-codes-title} `404` (Missing resources):: @@ -100,7 +100,7 @@ are no matches or only partial matches. resources that match the request or only partial matches for the request. -[[stop-data-frame-transform-example]] +[[stop-transform-example]] ==== {api-examples-title} [source,console] diff --git a/docs/reference/transform/apis/transformresource.asciidoc b/docs/reference/transform/apis/transformresource.asciidoc index 155aa5a7160ad..55b2095a6ec84 100644 --- a/docs/reference/transform/apis/transformresource.asciidoc +++ b/docs/reference/transform/apis/transformresource.asciidoc @@ -1,15 +1,15 @@ [role="xpack"] [testenv="basic"] -[[data-frame-transform-resource]] +[[transform-resource]] === {transform-cap} resources -{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`:: @@ -17,7 +17,7 @@ For more information, see `dest`:: (object) The destination for the {transform}. See - <>. + <>. `frequency`:: (time units) The interval between checks for changes in the source indices @@ -31,20 +31,20 @@ For more information, see `pivot`:: (object) The method for transforming the data. See - <>. + <>. `source`:: (object) The source of the data for the {transform}. See - <>. + <>. -[[data-frame-transform-dest]] +[[transform-dest]] ==== Dest objects {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`:: @@ -53,14 +53,14 @@ you create a {transform}, you must define its destination. `pipeline`:: (string) The unique identifier for a <>. -[[data-frame-transform-source]] +[[transform-source]] ==== Source objects {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`:: @@ -72,14 +72,14 @@ you create a {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 {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`:: @@ -122,8 +122,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 -<>. +<>. diff --git a/docs/reference/transform/apis/update-transform.asciidoc b/docs/reference/transform/apis/update-transform.asciidoc index b055fac867f3e..a71bdbe15b844 100644 --- a/docs/reference/transform/apis/update-transform.asciidoc +++ b/docs/reference/transform/apis/update-transform.asciidoc @@ -1,6 +1,6 @@ [role="xpack"] [testenv="basic"] -[[update-data-frame-transform]] +[[update-transform]] === Update {transforms} API [subs="attributes"] @@ -12,12 +12,12 @@ Updates an existing {transform}. beta[] -[[update-data-frame-transform-request]] +[[update-transform-request]] ==== {api-request-title} -`POST _data_frame/transforms//_update` +`POST _data_frame/transforms//_update` -[[update-data-frame-transform-prereqs]] +[[update-transform-prereqs]] ==== {api-prereq-title} * If the {es} {security-features} are enabled, you must have @@ -28,7 +28,7 @@ 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]. -[[update-data-frame-transform-desc]] +[[update-transform-desc]] ==== {api-description-title} This API updates an existing {transform}. All settings except description do not @@ -45,15 +45,15 @@ IMPORTANT: You must use {kib} or this API to update a {transform}. If {es} {security-features} are enabled, do not give users any privileges on `.data-frame-internal*` indices. -[[update-data-frame-transform-path-parms]] +[[update-transform-path-parms]] ==== {api-path-parms-title} -``:: +``:: (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. -[[update-data-frame-transform-query-parms]] +[[update-transform-query-parms]] ==== {api-query-parms-title} `defer_validation`:: @@ -61,7 +61,7 @@ IMPORTANT: You must use {kib} or this API to update a {transform}. behavior may be desired if the source index does not exist until after the {transform} is updated. -[[update-data-frame-transform-request-body]] +[[update-transform-request-body]] ==== {api-request-body-title} `description`:: @@ -118,7 +118,7 @@ delays. (Optional, <>) The time delay between the current time and the latest input data time. The default value is `60s`. -[[update-data-frame-transform-example]] +[[update-transform-example]] ==== {api-examples-title} [source,console] diff --git a/docs/reference/transform/ecommerce-example.asciidoc b/docs/reference/transform/ecommerce-example.asciidoc index f236649bb69c8..7f8267baa1656 100644 --- a/docs/reference/transform/ecommerce-example.asciidoc +++ b/docs/reference/transform/ecommerce-example.asciidoc @@ -81,7 +81,7 @@ If you want to use 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 {transforms} API]: +{ref}/preview-transform.html[preview {transforms} API]: [source,console] -------------------------------------------------- @@ -156,7 +156,7 @@ entities have changed. In general, it's a good idea to use the ingest timestamp field. In this example, however, you can use the `order_date` field. If you prefer, you can use the -{ref}/put-data-frame-transform.html[create {transforms} API]. For +{ref}/put-transform.html[create {transforms} API]. For example: [source,console] @@ -231,8 +231,8 @@ You can start, stop, and manage {transforms} in {kib}: image::images/dataframe-transforms.jpg["Managing {transforms} in {kib}"] Alternatively, you can use the -{ref}/start-data-frame-transform.html[start {transforms}] and -{ref}/stop-data-frame-transform.html[stop {transforms}] APIs. For +{ref}/start-transform.html[start {transforms}] and +{ref}/stop-transform.html[stop {transforms}] APIs. For example: [source,console] @@ -255,6 +255,6 @@ image::images/ecommerce-results.jpg["Exploring the new index in {kib}"] 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 {transform} API]. When +{ref}/delete-transform.html[delete {transform} API]. When you delete a {transform}, its destination index and {kib} index patterns remain. diff --git a/docs/reference/transform/limitations.asciidoc b/docs/reference/transform/limitations.asciidoc index 5b5088f0435f8..a97737464b3fc 100644 --- a/docs/reference/transform/limitations.asciidoc +++ b/docs/reference/transform/limitations.asciidoc @@ -54,7 +54,7 @@ table. A single cluster will support up to 1,000 {transforms}. When using the -{ref}/get-data-frame-transform.html[GET {transforms} API] a total +{ref}/get-transform.html[GET {transforms} API] a total `count` of {transforms} is returned. Use the `size` and `from` parameters to enumerate through the full list. diff --git a/docs/reference/transform/overview.asciidoc b/docs/reference/transform/overview.asciidoc index ddf9dd2057d1b..fa161f2e9ea3b 100644 --- a/docs/reference/transform/overview.asciidoc +++ b/docs/reference/transform/overview.asciidoc @@ -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[{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. diff --git a/docs/reference/transform/troubleshooting.asciidoc b/docs/reference/transform/troubleshooting.asciidoc index 231abc288c1cc..9d76e93415db6 100644 --- a/docs/reference/transform/troubleshooting.asciidoc +++ b/docs/reference/transform/troubleshooting.asciidoc @@ -17,7 +17,7 @@ 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 {transform} statistics API] +{ref}/get-transform-stats.html[get {transform} statistics API] provides information about the {transform} status and failures. * If the {transform} exists as a task, you can use the {ref}/tasks.html[task management API] to gather task information. For example: 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 5c09d1b60b60b..d8545728ab9c9 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,7 +1,7 @@ { "data_frame.delete_data_frame_transform":{ "documentation":{ - "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-data-frame-transform.html" + "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html" }, "stability":"beta", "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 812648c5fb152..e25a3301ec0c3 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,7 +1,7 @@ { "data_frame.get_data_frame_transform":{ "documentation":{ - "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-data-frame-transform.html" + "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html" }, "stability":"beta", "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 61083d1fd7873..57b004482a720 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,7 +1,7 @@ { "data_frame.get_data_frame_transform_stats":{ "documentation":{ - "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-data-frame-transform-stats.html" + "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html" }, "stability":"beta", "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 a0d585c203a9f..e3f24448b9f6a 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,7 +1,7 @@ { "data_frame.preview_data_frame_transform":{ "documentation":{ - "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-data-frame-transform.html" + "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html" }, "stability":"beta", "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 b4996d22861a7..5e7354f435d9d 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,7 +1,7 @@ { "data_frame.put_data_frame_transform":{ "documentation":{ - "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/put-data-frame-transform.html" + "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html" }, "stability":"beta", "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 b2e4997ebbe1e..c0d701be5624f 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,7 +1,7 @@ { "data_frame.start_data_frame_transform":{ "documentation":{ - "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/start-data-frame-transform.html" + "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html" }, "stability":"beta", "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 af0c35b156390..c88a7176309a9 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,7 +1,7 @@ { "data_frame.stop_data_frame_transform":{ "documentation":{ - "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-data-frame-transform.html" + "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html" }, "stability":"beta", "url":{ diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.update_data_frame_transform.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.update_data_frame_transform.json index 5dcf277796555..70d1342815eb8 100644 --- a/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.update_data_frame_transform.json +++ b/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.update_data_frame_transform.json @@ -1,7 +1,7 @@ { "data_frame.update_data_frame_transform": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-data-frame-transform.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html" }, "stability": "beta", "url": {