github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-06-30 18:33:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS] Update data frame transform URLs (#46940) (#46946)

Browse source
This commit is contained in:
Lisa Cawley 2019-09-20 15:57:43 -07:00 • committed by GitHub
parent f51b2592a4
commit 875d864be6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
40 changed files with 424 additions and 308 deletions
Download patch file Download diff file Expand all files Collapse all files

118
client/rest-high-level/src/main/java/org/elasticsearch/client/DataFrameClient.java
View file

@ -48,11 +48,11 @@ public final class DataFrameClient {
} }
/** /**
* Creates a new Data Frame Transform * Creates a new transform
* <p> * <p>
* For additional info * For additional info
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/put-data-frame-transform.html"> * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html">
* Create data frame transform documentation</a> * Create transform documentation</a>
* *
* @param request The PutDataFrameTransformRequest containing the * @param request The PutDataFrameTransformRequest containing the
* {@link org.elasticsearch.client.transform.transforms.DataFrameTransformConfig}. * {@link org.elasticsearch.client.transform.transforms.DataFrameTransformConfig}.
@ -69,11 +69,11 @@ public final class DataFrameClient {
} }
/** /**
* Creates a new Data Frame Transform asynchronously and notifies listener on completion * Creates a new transform asynchronously and notifies listener on completion
* <p> * <p>
* For additional info * For additional info
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/put-data-frame-transform.html"> * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html">
* Create data frame transform documentation</a> * Create transform documentation</a>
* @param request The PutDataFrameTransformRequest containing the * @param request The PutDataFrameTransformRequest containing the
* {@link org.elasticsearch.client.transform.transforms.DataFrameTransformConfig}. * {@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 * @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
@ -91,11 +91,11 @@ public final class DataFrameClient {
} }
/** /**
* Updates an existing Data Frame Transform * Updates an existing transform
* <p> * <p>
* For additional info * For additional info
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/update-data-frame-transform.html"> * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html">
* Create data frame transform documentation</a> * Create transform documentation</a>
* *
* @param request The UpdateDataFrameTransformRequest containing the * @param request The UpdateDataFrameTransformRequest containing the
* {@link org.elasticsearch.client.transform.transforms.DataFrameTransformConfigUpdate}. * {@link org.elasticsearch.client.transform.transforms.DataFrameTransformConfigUpdate}.
@ -113,11 +113,11 @@ public final class DataFrameClient {
} }
/** /**
* Updates an existing Data Frame Transform asynchronously and notifies listener on completion * Updates an existing transform asynchronously and notifies listener on completion
* <p> * <p>
* For additional info * For additional info
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/update-data-frame-transform.html"> * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html">
* Create data frame transform documentation</a> * Create transform documentation</a>
* @param request The UpdateDataFrameTransformRequest containing the * @param request The UpdateDataFrameTransformRequest containing the
* {@link org.elasticsearch.client.transform.transforms.DataFrameTransformConfigUpdate}. * {@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 * @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
@ -136,15 +136,15 @@ public final class DataFrameClient {
} }
/** /**
* Get the running statistics of a Data Frame Transform * Get the running statistics of a transform
* <p> * <p>
* For additional info * For additional info
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/get-data-frame-transform-stats.html"> * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html">
* Get data frame transform stats documentation</a> * Get transform stats documentation</a>
* *
* @param request Specifies the which transforms to get the stats for * @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 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 * @throws IOException when there is a serialization issue sending the request or receiving the response
*/ */
public GetDataFrameTransformStatsResponse getDataFrameTransformStats(GetDataFrameTransformStatsRequest request, RequestOptions options) public GetDataFrameTransformStatsResponse getDataFrameTransformStats(GetDataFrameTransformStatsRequest request, RequestOptions options)
@ -157,11 +157,11 @@ public final class DataFrameClient {
} }
/** /**
* 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
* <p> * <p>
* For additional info * For additional info
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/get-data-frame-transform-stats.html"> * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html">
* Get data frame transform stats documentation</a> * Get transform stats documentation</a>
* @param request Specifies the which transforms to get the stats for * @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 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 * @param listener Listener to be notified upon request completion
@ -178,13 +178,13 @@ public final class DataFrameClient {
} }
/** /**
* Delete a data frame transform * Delete a transform
* <p> * <p>
* For additional info * For additional info
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-data-frame-transform.html"> * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html">
* Delete data frame transform documentation</a> * Delete transform documentation</a>
* *
* @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 options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
* @return An AcknowledgedResponse object indicating request success * @return An AcknowledgedResponse object indicating request success
* @throws IOException when there is a serialization issue sending the request or receiving the response * @throws IOException when there is a serialization issue sending the request or receiving the response
@ -199,12 +199,12 @@ public final class DataFrameClient {
} }
/** /**
* Delete a data frame transform asynchronously and notifies listener on completion * Delete a transform asynchronously and notifies listener on completion
* <p> * <p>
* For additional info * For additional info
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-data-frame-transform.html"> * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html">
* Delete data frame transform documentation</a> * Delete transform documentation</a>
* @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 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 * @param listener Listener to be notified upon request completion
* @return cancellable that may be used to cancel the request * @return cancellable that may be used to cancel the request
@ -220,13 +220,13 @@ public final class DataFrameClient {
} }
/** /**
* Preview the result of a data frame transform * Preview the result of a transform
* <p> * <p>
* For additional info * For additional info
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-data-frame-transform.html"> * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html">
* Preview data frame transform documentation</a> * Preview transform documentation</a>
* *
* @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 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 * @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 * @throws IOException when there is a serialization issue sending the request or receiving the response
@ -241,11 +241,11 @@ public final class DataFrameClient {
} }
/** /**
* 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
* <p> * <p>
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-data-frame-transform.html"> * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html">
* Preview data frame transform documentation</a> * Preview transform documentation</a>
* @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 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 * @param listener Listener to be notified upon request completion
* @return cancellable that may be used to cancel the request * @return cancellable that may be used to cancel the request
@ -261,13 +261,13 @@ public final class DataFrameClient {
} }
/** /**
* Start a data frame transform * Start a transform
* <p> * <p>
* For additional info * For additional info
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/start-data-frame-transform.html"> * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html">
* Start data frame transform documentation</a> * Start transform documentation</a>
* *
* @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 options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
* @return A response object indicating request success * @return A response object indicating request success
* @throws IOException when there is a serialization issue sending the request or receiving the response * @throws IOException when there is a serialization issue sending the request or receiving the response
@ -282,12 +282,12 @@ public final class DataFrameClient {
} }
/** /**
* Start a data frame transform asynchronously and notifies listener on completion * Start a transform asynchronously and notifies listener on completion
* <p> * <p>
* For additional info * For additional info
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/start-data-frame-transform.html"> * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html">
* Start data frame transform documentation</a> * Start transform documentation</a>
* @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 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 * @param listener Listener to be notified upon request completion
* @return cancellable that may be used to cancel the request * @return cancellable that may be used to cancel the request
@ -303,13 +303,13 @@ public final class DataFrameClient {
} }
/** /**
* Stop a data frame transform * Stop a transform
* <p> * <p>
* For additional info * For additional info
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-data-frame-transform.html"> * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html">
* Stop data frame transform documentation</a> * Stop transform documentation</a>
* *
* @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 options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
* @return A response object indicating request success * @return A response object indicating request success
* @throws IOException when there is a serialization issue sending the request or receiving the response * @throws IOException when there is a serialization issue sending the request or receiving the response
@ -324,12 +324,12 @@ public final class DataFrameClient {
} }
/** /**
* Stop a data frame transform asynchronously and notifies listener on completion * Stop a transform asynchronously and notifies listener on completion
* <p> * <p>
* For additional info * For additional info
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-data-frame-transform.html"> * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html">
* Stop data frame transform documentation</a> * Stop transform documentation</a>
* @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 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 * @param listener Listener to be notified upon request completion
* @return cancellable that may be used to cancel the request * @return cancellable that may be used to cancel the request
@ -345,13 +345,13 @@ public final class DataFrameClient {
} }
/** /**
* Get one or more data frame transform configurations * Get one or more transform configurations
* <p> * <p>
* For additional info * For additional info
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/get-data-frame-transform.html"> * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html">
* Get data frame transform documentation</a> * Get transform documentation</a>
* *
* @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 options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
* @return An GetDataFrameTransformResponse containing the requested transforms * @return An GetDataFrameTransformResponse containing the requested transforms
* @throws IOException when there is a serialization issue sending the request or receiving the response * @throws IOException when there is a serialization issue sending the request or receiving the response
@ -366,12 +366,12 @@ public final class DataFrameClient {
} }
/** /**
* 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
* <p> * <p>
* For additional info * For additional info
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/get-data-frame-transform.html"> * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html">
* Get data frame transform documentation</a> * Get data transform documentation</a>
* @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 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 * @param listener Listener to be notified upon request completion
* @return cancellable that may be used to cancel the request * @return cancellable that may be used to cancel the request

4
client/rest-high-level/src/main/java/org/elasticsearch/client/RestHighLevelClient.java
View file

@ -472,8 +472,8 @@ public class RestHighLevelClient implements Closeable {
* are shipped with the Elastic Stack distribution of Elasticsearch. All of * are shipped with the Elastic Stack distribution of Elasticsearch. All of
* these APIs will 404 if run against the OSS distribution of Elasticsearch. * these APIs will 404 if run against the OSS distribution of Elasticsearch.
* <p> * <p>
* See the <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/data-frame-apis.html"> * See the <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/transform-apis.html">
* Data Frame APIs on elastic.co</a> for more information. * Transform APIs on elastic.co</a> for more information.
* *
* @return the client wrapper for making Data Frame API calls * @return the client wrapper for making Data Frame API calls
*/ */

184
client/rest-high-level/src/test/java/org/elasticsearch/client/documentation/DataFrameTransformDocumentationIT.java
View file

@ -121,39 +121,39 @@ public class DataFrameTransformDocumentationIT extends ESRestHighLevelClientTest
RestHighLevelClient client = highLevelClient(); RestHighLevelClient client = highLevelClient();
// tag::put-data-frame-transform-query-config // tag::put-transform-query-config
QueryConfig queryConfig = new QueryConfig(new MatchAllQueryBuilder()); QueryConfig queryConfig = new QueryConfig(new MatchAllQueryBuilder());
// end::put-data-frame-transform-query-config // end::put-transform-query-config
// tag::put-data-frame-transform-source-config // tag::put-transform-source-config
SourceConfig sourceConfig = SourceConfig.builder() SourceConfig sourceConfig = SourceConfig.builder()
.setIndex("source-index") .setIndex("source-index")
.setQueryConfig(queryConfig).build(); .setQueryConfig(queryConfig).build();
// end::put-data-frame-transform-source-config // end::put-transform-source-config
// tag::put-data-frame-transform-dest-config // tag::put-transform-dest-config
DestConfig destConfig = DestConfig.builder() DestConfig destConfig = DestConfig.builder()
.setIndex("pivot-destination") .setIndex("pivot-destination")
.setPipeline("my-pipeline").build(); .setPipeline("my-pipeline").build();
// end::put-data-frame-transform-dest-config // end::put-transform-dest-config
// tag::put-data-frame-transform-group-config // tag::put-transform-group-config
GroupConfig groupConfig = GroupConfig.builder() GroupConfig groupConfig = GroupConfig.builder()
.groupBy("reviewer", // <1> .groupBy("reviewer", // <1>
TermsGroupSource.builder().setField("user_id").build()) // <2> TermsGroupSource.builder().setField("user_id").build()) // <2>
.build(); .build();
// end::put-data-frame-transform-group-config // end::put-transform-group-config
// tag::put-data-frame-transform-agg-config // tag::put-transform-agg-config
AggregatorFactories.Builder aggBuilder = new AggregatorFactories.Builder(); AggregatorFactories.Builder aggBuilder = new AggregatorFactories.Builder();
aggBuilder.addAggregator( aggBuilder.addAggregator(
AggregationBuilders.avg("avg_rating").field("stars")); // <1> AggregationBuilders.avg("avg_rating").field("stars")); // <1>
AggregationConfig aggConfig = new AggregationConfig(aggBuilder); AggregationConfig aggConfig = new AggregationConfig(aggBuilder);
// end::put-data-frame-transform-agg-config // end::put-transform-agg-config
// tag::put-data-frame-transform-pivot-config // tag::put-transform-pivot-config
PivotConfig pivotConfig = PivotConfig.builder() PivotConfig pivotConfig = PivotConfig.builder()
.setGroups(groupConfig) // <1> .setGroups(groupConfig) // <1>
.setAggregationConfig(aggConfig) // <2> .setAggregationConfig(aggConfig) // <2>
.setMaxPageSearchSize(1000) // <3> .setMaxPageSearchSize(1000) // <3>
.build(); .build();
// end::put-data-frame-transform-pivot-config // end::put-transform-pivot-config
// tag::put-data-frame-transform-config // tag::put-transform-config
DataFrameTransformConfig transformConfig = DataFrameTransformConfig DataFrameTransformConfig transformConfig = DataFrameTransformConfig
.builder() .builder()
.setId("reviewer-avg-rating") // <1> .setId("reviewer-avg-rating") // <1>
@ -163,20 +163,20 @@ public class DataFrameTransformDocumentationIT extends ESRestHighLevelClientTest
.setPivotConfig(pivotConfig) // <5> .setPivotConfig(pivotConfig) // <5>
.setDescription("This is my test transform") // <6> .setDescription("This is my test transform") // <6>
.build(); .build();
// end::put-data-frame-transform-config // end::put-transform-config
{ {
// tag::put-data-frame-transform-request // tag::put-transform-request
PutDataFrameTransformRequest request = PutDataFrameTransformRequest request =
new PutDataFrameTransformRequest(transformConfig); // <1> new PutDataFrameTransformRequest(transformConfig); // <1>
request.setDeferValidation(false); // <2> 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 = AcknowledgedResponse response =
client.dataFrame().putDataFrameTransform( client.dataFrame().putDataFrameTransform(
request, RequestOptions.DEFAULT); request, RequestOptions.DEFAULT);
// end::put-data-frame-transform-execute // end::put-transform-execute
transformsToClean.add(request.getConfig().getId()); transformsToClean.add(request.getConfig().getId());
assertTrue(response.isAcknowledged()); assertTrue(response.isAcknowledged());
@ -190,7 +190,7 @@ public class DataFrameTransformDocumentationIT extends ESRestHighLevelClientTest
.build(); .build();
PutDataFrameTransformRequest request = new PutDataFrameTransformRequest(configWithDifferentId); PutDataFrameTransformRequest request = new PutDataFrameTransformRequest(configWithDifferentId);
// tag::put-data-frame-transform-execute-listener // tag::put-transform-execute-listener
ActionListener<AcknowledgedResponse> listener = ActionListener<AcknowledgedResponse> listener =
new ActionListener<AcknowledgedResponse>() { new ActionListener<AcknowledgedResponse>() {
@Override @Override
@ -203,16 +203,16 @@ public class DataFrameTransformDocumentationIT extends ESRestHighLevelClientTest
// <2> // <2>
} }
}; };
// end::put-data-frame-transform-execute-listener // end::put-transform-execute-listener
// Replace the empty listener by a blocking listener in test // Replace the empty listener by a blocking listener in test
final CountDownLatch latch = new CountDownLatch(1); final CountDownLatch latch = new CountDownLatch(1);
listener = new LatchedActionListener<>(listener, latch); listener = new LatchedActionListener<>(listener, latch);
// tag::put-data-frame-transform-execute-async // tag::put-transform-execute-async
client.dataFrame().putDataFrameTransformAsync( client.dataFrame().putDataFrameTransformAsync(
request, RequestOptions.DEFAULT, listener); // <1> request, RequestOptions.DEFAULT, listener); // <1>
// end::put-data-frame-transform-execute-async // end::put-transform-execute-async
assertTrue(latch.await(30L, TimeUnit.SECONDS)); assertTrue(latch.await(30L, TimeUnit.SECONDS));
transformsToClean.add(request.getConfig().getId()); transformsToClean.add(request.getConfig().getId());
@ -242,7 +242,7 @@ public class DataFrameTransformDocumentationIT extends ESRestHighLevelClientTest
client.dataFrame().putDataFrameTransform(new PutDataFrameTransformRequest(transformConfig), RequestOptions.DEFAULT); client.dataFrame().putDataFrameTransform(new PutDataFrameTransformRequest(transformConfig), RequestOptions.DEFAULT);
transformsToClean.add(transformConfig.getId()); transformsToClean.add(transformConfig.getId());
// tag::update-data-frame-transform-config // tag::update-transform-config
DataFrameTransformConfigUpdate update = DataFrameTransformConfigUpdate DataFrameTransformConfigUpdate update = DataFrameTransformConfigUpdate
.builder() .builder()
.setSource(SourceConfig.builder() .setSource(SourceConfig.builder()
@ -256,24 +256,24 @@ public class DataFrameTransformDocumentationIT extends ESRestHighLevelClientTest
TimeValue.timeValueSeconds(120))) // <4> TimeValue.timeValueSeconds(120))) // <4>
.setDescription("This is my updated transform") // <5> .setDescription("This is my updated transform") // <5>
.build(); .build();
// end::update-data-frame-transform-config // end::update-transform-config
{ {
// tag::update-data-frame-transform-request // tag::update-transform-request
UpdateDataFrameTransformRequest request = UpdateDataFrameTransformRequest request =
new UpdateDataFrameTransformRequest( new UpdateDataFrameTransformRequest(
update, // <1> update, // <1>
"my-transform-to-update"); // <2> "my-transform-to-update"); // <2>
request.setDeferValidation(false); // <3> 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 = UpdateDataFrameTransformResponse response =
client.dataFrame().updateDataFrameTransform(request, client.dataFrame().updateDataFrameTransform(request,
RequestOptions.DEFAULT); RequestOptions.DEFAULT);
DataFrameTransformConfig updatedConfig = DataFrameTransformConfig updatedConfig =
response.getTransformConfiguration(); response.getTransformConfiguration();
// end::update-data-frame-transform-execute // end::update-transform-execute
assertThat(updatedConfig.getDescription(), equalTo("This is my updated transform")); assertThat(updatedConfig.getDescription(), equalTo("This is my updated transform"));
} }
@ -281,7 +281,7 @@ public class DataFrameTransformDocumentationIT extends ESRestHighLevelClientTest
UpdateDataFrameTransformRequest request = new UpdateDataFrameTransformRequest(update, UpdateDataFrameTransformRequest request = new UpdateDataFrameTransformRequest(update,
"my-transform-to-update"); "my-transform-to-update");
// tag::update-data-frame-transform-execute-listener // tag::update-transform-execute-listener
ActionListener<UpdateDataFrameTransformResponse> listener = ActionListener<UpdateDataFrameTransformResponse> listener =
new ActionListener<UpdateDataFrameTransformResponse>() { new ActionListener<UpdateDataFrameTransformResponse>() {
@Override @Override
@ -294,16 +294,16 @@ public class DataFrameTransformDocumentationIT extends ESRestHighLevelClientTest
// <2> // <2>
} }
}; };
// end::update-data-frame-transform-execute-listener // end::update-transform-execute-listener
// Replace the empty listener by a blocking listener in test // Replace the empty listener by a blocking listener in test
final CountDownLatch latch = new CountDownLatch(1); final CountDownLatch latch = new CountDownLatch(1);
listener = new LatchedActionListener<>(listener, latch); listener = new LatchedActionListener<>(listener, latch);
// tag::update-data-frame-transform-execute-async // tag::update-transform-execute-async
client.dataFrame().updateDataFrameTransformAsync( client.dataFrame().updateDataFrameTransformAsync(
request, RequestOptions.DEFAULT, listener); // <1> request, RequestOptions.DEFAULT, listener); // <1>
// end::update-data-frame-transform-execute-async // end::update-transform-execute-async
assertTrue(latch.await(30L, TimeUnit.SECONDS)); assertTrue(latch.await(30L, TimeUnit.SECONDS));
} }
@ -333,45 +333,45 @@ public class DataFrameTransformDocumentationIT extends ESRestHighLevelClientTest
transformsToClean.add(transformConfig.getId()); transformsToClean.add(transformConfig.getId());
{ {
// tag::start-data-frame-transform-request // tag::start-transform-request
StartDataFrameTransformRequest request = StartDataFrameTransformRequest request =
new StartDataFrameTransformRequest("mega-transform"); // <1> 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> 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 = StartDataFrameTransformResponse response =
client.dataFrame().startDataFrameTransform( client.dataFrame().startDataFrameTransform(
request, RequestOptions.DEFAULT); request, RequestOptions.DEFAULT);
// end::start-data-frame-transform-execute // end::start-transform-execute
assertTrue(response.isAcknowledged()); assertTrue(response.isAcknowledged());
} }
{ {
// tag::stop-data-frame-transform-request // tag::stop-transform-request
StopDataFrameTransformRequest request = StopDataFrameTransformRequest request =
new StopDataFrameTransformRequest("mega-transform"); // <1> 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.setWaitForCompletion(Boolean.TRUE); // <1>
request.setTimeout(TimeValue.timeValueSeconds(30)); // <2> request.setTimeout(TimeValue.timeValueSeconds(30)); // <2>
request.setAllowNoMatch(true); // <3> 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 = StopDataFrameTransformResponse response =
client.dataFrame().stopDataFrameTransform( client.dataFrame().stopDataFrameTransform(
request, RequestOptions.DEFAULT); request, RequestOptions.DEFAULT);
// end::stop-data-frame-transform-execute // end::stop-transform-execute
assertTrue(response.isAcknowledged()); assertTrue(response.isAcknowledged());
} }
{ {
// tag::start-data-frame-transform-execute-listener // tag::start-transform-execute-listener
ActionListener<StartDataFrameTransformResponse> listener = ActionListener<StartDataFrameTransformResponse> listener =
new ActionListener<StartDataFrameTransformResponse>() { new ActionListener<StartDataFrameTransformResponse>() {
@Override @Override
@ -385,22 +385,22 @@ public class DataFrameTransformDocumentationIT extends ESRestHighLevelClientTest
// <2> // <2>
} }
}; };
// end::start-data-frame-transform-execute-listener // end::start-transform-execute-listener
// Replace the empty listener by a blocking listener in test // Replace the empty listener by a blocking listener in test
final CountDownLatch latch = new CountDownLatch(1); final CountDownLatch latch = new CountDownLatch(1);
listener = new LatchedActionListener<>(listener, latch); listener = new LatchedActionListener<>(listener, latch);
StartDataFrameTransformRequest request = new StartDataFrameTransformRequest("mega-transform"); StartDataFrameTransformRequest request = new StartDataFrameTransformRequest("mega-transform");
// tag::start-data-frame-transform-execute-async // tag::start-transform-execute-async
client.dataFrame().startDataFrameTransformAsync( client.dataFrame().startDataFrameTransformAsync(
request, RequestOptions.DEFAULT, listener); // <1> request, RequestOptions.DEFAULT, listener); // <1>
// end::start-data-frame-transform-execute-async // end::start-transform-execute-async
assertTrue(latch.await(30L, TimeUnit.SECONDS)); assertTrue(latch.await(30L, TimeUnit.SECONDS));
} }
{ {
// tag::stop-data-frame-transform-execute-listener // tag::stop-transform-execute-listener
ActionListener<StopDataFrameTransformResponse> listener = ActionListener<StopDataFrameTransformResponse> listener =
new ActionListener<StopDataFrameTransformResponse>() { new ActionListener<StopDataFrameTransformResponse>() {
@Override @Override
@ -414,17 +414,17 @@ public class DataFrameTransformDocumentationIT extends ESRestHighLevelClientTest
// <2> // <2>
} }
}; };
// end::stop-data-frame-transform-execute-listener // end::stop-transform-execute-listener
// Replace the empty listener by a blocking listener in test // Replace the empty listener by a blocking listener in test
final CountDownLatch latch = new CountDownLatch(1); final CountDownLatch latch = new CountDownLatch(1);
listener = new LatchedActionListener<>(listener, latch); listener = new LatchedActionListener<>(listener, latch);
StopDataFrameTransformRequest request = new StopDataFrameTransformRequest("mega-transform"); StopDataFrameTransformRequest request = new StopDataFrameTransformRequest("mega-transform");
// tag::stop-data-frame-transform-execute-async // tag::stop-transform-execute-async
client.dataFrame().stopDataFrameTransformAsync( client.dataFrame().stopDataFrameTransformAsync(
request, RequestOptions.DEFAULT, listener); // <1> request, RequestOptions.DEFAULT, listener); // <1>
// end::stop-data-frame-transform-execute-async // end::stop-transform-execute-async
assertTrue(latch.await(30L, TimeUnit.SECONDS)); assertTrue(latch.await(30L, TimeUnit.SECONDS));
} }
@ -465,22 +465,22 @@ public class DataFrameTransformDocumentationIT extends ESRestHighLevelClientTest
client.dataFrame().putDataFrameTransform(new PutDataFrameTransformRequest(transformConfig2), RequestOptions.DEFAULT); client.dataFrame().putDataFrameTransform(new PutDataFrameTransformRequest(transformConfig2), RequestOptions.DEFAULT);
{ {
// tag::delete-data-frame-transform-request // tag::delete-transform-request
DeleteDataFrameTransformRequest request = DeleteDataFrameTransformRequest request =
new DeleteDataFrameTransformRequest("mega-transform"); // <1> new DeleteDataFrameTransformRequest("mega-transform"); // <1>
request.setForce(false); // <2> 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 = AcknowledgedResponse response =
client.dataFrame() client.dataFrame()
.deleteDataFrameTransform(request, RequestOptions.DEFAULT); .deleteDataFrameTransform(request, RequestOptions.DEFAULT);
// end::delete-data-frame-transform-execute // end::delete-transform-execute
assertTrue(response.isAcknowledged()); assertTrue(response.isAcknowledged());
} }
{ {
// tag::delete-data-frame-transform-execute-listener // tag::delete-transform-execute-listener
ActionListener<AcknowledgedResponse> listener = ActionListener<AcknowledgedResponse> listener =
new ActionListener<AcknowledgedResponse>() { new ActionListener<AcknowledgedResponse>() {
@Override @Override
@ -493,7 +493,7 @@ public class DataFrameTransformDocumentationIT extends ESRestHighLevelClientTest
// <2> // <2>
} }
}; };
// end::delete-data-frame-transform-execute-listener // end::delete-transform-execute-listener
// Replace the empty listener by a blocking listener in test // Replace the empty listener by a blocking listener in test
final CountDownLatch latch = new CountDownLatch(1); final CountDownLatch latch = new CountDownLatch(1);
@ -501,10 +501,10 @@ public class DataFrameTransformDocumentationIT extends ESRestHighLevelClientTest
DeleteDataFrameTransformRequest request = new DeleteDataFrameTransformRequest("mega-transform2"); DeleteDataFrameTransformRequest request = new DeleteDataFrameTransformRequest("mega-transform2");
// tag::delete-data-frame-transform-execute-async // tag::delete-transform-execute-async
client.dataFrame().deleteDataFrameTransformAsync( client.dataFrame().deleteDataFrameTransformAsync(
request, RequestOptions.DEFAULT, listener); // <1> request, RequestOptions.DEFAULT, listener); // <1>
// end::delete-data-frame-transform-execute-async // end::delete-transform-execute-async
assertTrue(latch.await(30L, TimeUnit.SECONDS)); assertTrue(latch.await(30L, TimeUnit.SECONDS));
} }
@ -523,7 +523,7 @@ public class DataFrameTransformDocumentationIT extends ESRestHighLevelClientTest
AggregationConfig aggConfig = new AggregationConfig(aggBuilder); AggregationConfig aggConfig = new AggregationConfig(aggBuilder);
PivotConfig pivotConfig = PivotConfig.builder().setGroups(groupConfig).setAggregationConfig(aggConfig).build(); PivotConfig pivotConfig = PivotConfig.builder().setGroups(groupConfig).setAggregationConfig(aggConfig).build();
// tag::preview-data-frame-transform-request // tag::preview-transform-request
DataFrameTransformConfig transformConfig = DataFrameTransformConfig transformConfig =
DataFrameTransformConfig.forPreview( DataFrameTransformConfig.forPreview(
SourceConfig.builder() SourceConfig.builder()
@ -534,20 +534,20 @@ public class DataFrameTransformDocumentationIT extends ESRestHighLevelClientTest
PreviewDataFrameTransformRequest request = PreviewDataFrameTransformRequest request =
new PreviewDataFrameTransformRequest(transformConfig); // <3> 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 = PreviewDataFrameTransformResponse response =
client.dataFrame() client.dataFrame()
.previewDataFrameTransform(request, RequestOptions.DEFAULT); .previewDataFrameTransform(request, RequestOptions.DEFAULT);
// end::preview-data-frame-transform-execute // end::preview-transform-execute
assertNotNull(response.getDocs()); assertNotNull(response.getDocs());
assertNotNull(response.getMappings()); assertNotNull(response.getMappings());
} }
{ {
// tag::preview-data-frame-transform-execute-listener // tag::preview-transform-execute-listener
ActionListener<PreviewDataFrameTransformResponse> listener = ActionListener<PreviewDataFrameTransformResponse> listener =
new ActionListener<PreviewDataFrameTransformResponse>() { new ActionListener<PreviewDataFrameTransformResponse>() {
@Override @Override
@ -560,16 +560,16 @@ public class DataFrameTransformDocumentationIT extends ESRestHighLevelClientTest
// <2> // <2>
} }
}; };
// end::preview-data-frame-transform-execute-listener // end::preview-transform-execute-listener
// Replace the empty listener by a blocking listener in test // Replace the empty listener by a blocking listener in test
final CountDownLatch latch = new CountDownLatch(1); final CountDownLatch latch = new CountDownLatch(1);
listener = new LatchedActionListener<>(listener, latch); listener = new LatchedActionListener<>(listener, latch);
// tag::preview-data-frame-transform-execute-async // tag::preview-transform-execute-async
client.dataFrame().previewDataFrameTransformAsync( client.dataFrame().previewDataFrameTransformAsync(
request, RequestOptions.DEFAULT, listener); // <1> request, RequestOptions.DEFAULT, listener); // <1>
// end::preview-data-frame-transform-execute-async // end::preview-transform-execute-async
assertTrue(latch.await(30L, TimeUnit.SECONDS)); assertTrue(latch.await(30L, TimeUnit.SECONDS));
} }
@ -600,26 +600,26 @@ public class DataFrameTransformDocumentationIT extends ESRestHighLevelClientTest
client.dataFrame().putDataFrameTransform(new PutDataFrameTransformRequest(transformConfig), RequestOptions.DEFAULT); client.dataFrame().putDataFrameTransform(new PutDataFrameTransformRequest(transformConfig), RequestOptions.DEFAULT);
transformsToClean.add(id); transformsToClean.add(id);
// tag::get-data-frame-transform-stats-request // tag::get-transform-stats-request
GetDataFrameTransformStatsRequest request = GetDataFrameTransformStatsRequest request =
new GetDataFrameTransformStatsRequest(id); // <1> 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.setPageParams(new PageParams(0, 100)); // <1>
request.setAllowNoMatch(true); // <2> 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 = GetDataFrameTransformStatsResponse response =
client.dataFrame() client.dataFrame()
.getDataFrameTransformStats(request, RequestOptions.DEFAULT); .getDataFrameTransformStats(request, RequestOptions.DEFAULT);
// end::get-data-frame-transform-stats-execute // end::get-transform-stats-execute
assertThat(response.getTransformsStats(), hasSize(1)); assertThat(response.getTransformsStats(), hasSize(1));
// tag::get-data-frame-transform-stats-response // tag::get-transform-stats-response
DataFrameTransformStats stats = DataFrameTransformStats stats =
response.getTransformsStats().get(0); // <1> response.getTransformsStats().get(0); // <1>
DataFrameTransformStats.State state = DataFrameTransformStats.State state =
@ -631,14 +631,14 @@ public class DataFrameTransformDocumentationIT extends ESRestHighLevelClientTest
.getNext().getCheckpointProgress(); // <4> .getNext().getCheckpointProgress(); // <4>
NodeAttributes node = NodeAttributes node =
stats.getNode(); // <5> stats.getNode(); // <5>
// end::get-data-frame-transform-stats-response // end::get-transform-stats-response
assertEquals(DataFrameTransformStats.State.STOPPED, state); assertEquals(DataFrameTransformStats.State.STOPPED, state);
assertNotNull(indexerStats); assertNotNull(indexerStats);
assertNull(progress); assertNull(progress);
} }
{ {
// tag::get-data-frame-transform-stats-execute-listener // tag::get-transform-stats-execute-listener
ActionListener<GetDataFrameTransformStatsResponse> listener = ActionListener<GetDataFrameTransformStatsResponse> listener =
new ActionListener<GetDataFrameTransformStatsResponse>() { new ActionListener<GetDataFrameTransformStatsResponse>() {
@Override @Override
@ -652,16 +652,16 @@ public class DataFrameTransformDocumentationIT extends ESRestHighLevelClientTest
// <2> // <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 // Replace the empty listener by a blocking listener in test
final CountDownLatch latch = new CountDownLatch(1); final CountDownLatch latch = new CountDownLatch(1);
listener = new LatchedActionListener<>(listener, latch); listener = new LatchedActionListener<>(listener, latch);
// tag::get-data-frame-transform-stats-execute-async // tag::get-transform-stats-execute-async
client.dataFrame().getDataFrameTransformStatsAsync( client.dataFrame().getDataFrameTransformStatsAsync(
request, RequestOptions.DEFAULT, listener); // <1> 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)); assertTrue(latch.await(30L, TimeUnit.SECONDS));
} }
@ -694,31 +694,31 @@ public class DataFrameTransformDocumentationIT extends ESRestHighLevelClientTest
transformsToClean.add(putTransformConfig.getId()); transformsToClean.add(putTransformConfig.getId());
{ {
// tag::get-data-frame-transform-request // tag::get-transform-request
GetDataFrameTransformRequest request = GetDataFrameTransformRequest request =
new GetDataFrameTransformRequest("mega-transform"); // <1> 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.setPageParams(new PageParams(0, 100)); // <1>
request.setAllowNoMatch(true); // <2> 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 = GetDataFrameTransformResponse response =
client.dataFrame() client.dataFrame()
.getDataFrameTransform(request, RequestOptions.DEFAULT); .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<DataFrameTransformConfig> transformConfigs = List<DataFrameTransformConfig> transformConfigs =
response.getTransformConfigurations(); response.getTransformConfigurations();
// end::get-data-frame-transform-response // end::get-transform-response
assertEquals(1, transformConfigs.size()); assertEquals(1, transformConfigs.size());
} }
{ {
// tag::get-data-frame-transform-execute-listener // tag::get-transform-execute-listener
ActionListener<GetDataFrameTransformResponse> listener = ActionListener<GetDataFrameTransformResponse> listener =
new ActionListener<GetDataFrameTransformResponse>() { new ActionListener<GetDataFrameTransformResponse>() {
@Override @Override
@ -731,7 +731,7 @@ public class DataFrameTransformDocumentationIT extends ESRestHighLevelClientTest
// <2> // <2>
} }
}; };
// end::get-data-frame-transform-execute-listener // end::get-transform-execute-listener
// Replace the empty listener by a blocking listener in test // Replace the empty listener by a blocking listener in test
final CountDownLatch latch = new CountDownLatch(1); final CountDownLatch latch = new CountDownLatch(1);
@ -739,10 +739,10 @@ public class DataFrameTransformDocumentationIT extends ESRestHighLevelClientTest
GetDataFrameTransformRequest request = new GetDataFrameTransformRequest("mega-transform"); GetDataFrameTransformRequest request = new GetDataFrameTransformRequest("mega-transform");
// tag::get-data-frame-transform-execute-async // tag::get-transform-execute-async
client.dataFrame().getDataFrameTransformAsync( client.dataFrame().getDataFrameTransformAsync(
request, RequestOptions.DEFAULT, listener); // <1> request, RequestOptions.DEFAULT, listener); // <1>
// end::get-data-frame-transform-execute-async // end::get-transform-execute-async
assertTrue(latch.await(30L, TimeUnit.SECONDS)); assertTrue(latch.await(30L, TimeUnit.SECONDS));
} }

36
docs/java-rest/high-level/supported-apis.asciidoc
View file

@ -576,29 +576,29 @@ include::ilm/retry_lifecycle_policy.asciidoc[]
include::ilm/remove_lifecycle_policy_from_index.asciidoc[] include::ilm/remove_lifecycle_policy_from_index.asciidoc[]
[role="xpack"] [role="xpack"]
[[_data_frame_transform_apis]] [[transform_apis]]
== {transform-cap} APIs == {transform-cap} APIs
:upid: {mainid}-dataframe :upid: {mainid}
:doc-tests-file: {doc-tests}/DataFrameTransformDocumentationIT.java :doc-tests-file: {doc-tests}/DataFrameTransformDocumentationIT.java
The Java High Level REST Client supports the following {transform} The Java High Level REST Client supports the following {transform}
APIs: APIs:
* <<{upid}-get-data-frame-transform>> * <<{upid}-get-transform>>
* <<{upid}-get-data-frame-transform-stats>> * <<{upid}-get-transform-stats>>
* <<{upid}-put-data-frame-transform>> * <<{upid}-put-transform>>
* <<{upid}-update-data-frame-transform>> * <<{upid}-update-transform>>
* <<{upid}-delete-data-frame-transform>> * <<{upid}-delete-transform>>
* <<{upid}-preview-data-frame-transform>> * <<{upid}-preview-transform>>
* <<{upid}-start-data-frame-transform>> * <<{upid}-start-transform>>
* <<{upid}-stop-data-frame-transform>> * <<{upid}-stop-transform>>
include::dataframe/get_data_frame.asciidoc[] include::transform/get_transform.asciidoc[]
include::dataframe/get_data_frame_stats.asciidoc[] include::transform/get_transform_stats.asciidoc[]
include::dataframe/put_data_frame.asciidoc[] include::transform/put_transform.asciidoc[]
include::dataframe/update_data_frame.asciidoc[] include::transform/update_transform.asciidoc[]
include::dataframe/delete_data_frame.asciidoc[] include::transform/delete_transform.asciidoc[]
include::dataframe/preview_data_frame.asciidoc[] include::transform/preview_transform.asciidoc[]
include::dataframe/start_data_frame.asciidoc[] include::transform/start_transform.asciidoc[]
include::dataframe/stop_data_frame.asciidoc[] include::transform/stop_transform.asciidoc[]

2
docs/java-rest/high-level/dataframe/delete_data_frame.asciidoc → docs/java-rest/high-level/transform/delete_transform.asciidoc
View file

@ -1,5 +1,5 @@
-- --
:api: delete-data-frame-transform :api: delete-transform
:request: DeleteDataFrameTransformRequest :request: DeleteDataFrameTransformRequest
:response: AcknowledgedResponse :response: AcknowledgedResponse
-- --

2
docs/java-rest/high-level/dataframe/get_data_frame.asciidoc → docs/java-rest/high-level/transform/get_transform.asciidoc
View file

@ -1,5 +1,5 @@
-- --
:api: get-data-frame-transform :api: get-transform
:request: GetDataFrameTransformRequest :request: GetDataFrameTransformRequest
:response: GetDataFrameTransformResponse :response: GetDataFrameTransformResponse
-- --

2
docs/java-rest/high-level/dataframe/get_data_frame_stats.asciidoc → docs/java-rest/high-level/transform/get_transform_stats.asciidoc
View file

@ -1,5 +1,5 @@
-- --
:api: get-data-frame-transform-stats :api: get-transform-stats
:request: GetDataFrameTransformStatsRequest :request: GetDataFrameTransformStatsRequest
:response: GetDataFrameTransformStatsResponse :response: GetDataFrameTransformStatsResponse
-- --

2
docs/java-rest/high-level/dataframe/preview_data_frame.asciidoc → docs/java-rest/high-level/transform/preview_transform.asciidoc
View file

@ -1,5 +1,5 @@
-- --
:api: preview-data-frame-transform :api: preview-transform
:request: PreviewDataFrameTransformRequest :request: PreviewDataFrameTransformRequest
:response: PreviewDataFrameTransformResponse :response: PreviewDataFrameTransformResponse
-- --

2
docs/java-rest/high-level/dataframe/put_data_frame.asciidoc → docs/java-rest/high-level/transform/put_transform.asciidoc
View file

@ -1,5 +1,5 @@
-- --
:api: put-data-frame-transform :api: put-transform
:request: PutDataFrameTransformRequest :request: PutDataFrameTransformRequest
:response: AcknowledgedResponse :response: AcknowledgedResponse
-- --

2
docs/java-rest/high-level/dataframe/start_data_frame.asciidoc → docs/java-rest/high-level/transform/start_transform.asciidoc
View file

@ -1,5 +1,5 @@
-- --
:api: start-data-frame-transform :api: start-transform
:request: StartDataFrameTransformRequest :request: StartDataFrameTransformRequest
:response: StartDataFrameTransformResponse :response: StartDataFrameTransformResponse
-- --

2
docs/java-rest/high-level/dataframe/stop_data_frame.asciidoc → docs/java-rest/high-level/transform/stop_transform.asciidoc
View file

@ -1,5 +1,5 @@
-- --
:api: stop-data-frame-transform :api: stop-transform
:request: StopDataFrameTransformRequest :request: StopDataFrameTransformRequest
:response: StopDataFrameTransformResponse :response: StopDataFrameTransformResponse
-- --

2
docs/java-rest/high-level/dataframe/update_data_frame.asciidoc → docs/java-rest/high-level/transform/update_transform.asciidoc
View file

@ -1,5 +1,5 @@
-- --
:api: update-data-frame-transform :api: update-transform
:request: UpdateDataFrameTransformRequest :request: UpdateDataFrameTransformRequest
:response: UpdateDataFrameTransformResponse :response: UpdateDataFrameTransformResponse
-- --

2
docs/java-rest/index.asciidoc
View file

@ -8,3 +8,5 @@ include::overview.asciidoc[]
include::low-level/index.asciidoc[] include::low-level/index.asciidoc[]
include::high-level/index.asciidoc[] include::high-level/index.asciidoc[]
include::redirects.asciidoc[]

49
docs/java-rest/redirects.asciidoc Normal file
View file

@ -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 <<transform_apis>>.
[role="exclude",id="java-rest-high-dataframe-get-data-frame-transform"]
=== Get {transform} API
See <<java-rest-high-get-transform>>.
[role="exclude",id="java-rest-high-dataframe-get-data-frame-transform-stats"]
=== Get {transform} stats API
See <<java-rest-high-get-transform-stats>>.
[role="exclude",id="java-rest-high-dataframe-put-data-frame-transform"]
=== Put {transform} API
See <<java-rest-high-put-transform>>.
[role="exclude",id="java-rest-high-dataframe-update-data-frame-transform"]
=== Update {transform} API
See <<java-rest-high-update-transform>>.
[role="exclude",id="java-rest-high-dataframe-delete-data-frame-transform"]
=== Delete {transform} API
See <<java-rest-high-delete-transform>>.
[role="exclude",id="java-rest-high-dataframe-preview-data-frame-transform"]
=== Preview {transform} API
See <<java-rest-high-preview-transform>>.
[role="exclude",id="java-rest-high-dataframe-start-data-frame-transform"]
=== Start {transform} API
See <<java-rest-high-start-transform>>.
[role="exclude",id="java-rest-high-dataframe-stop-data-frame-transform"]
=== Stop {transform} API
See <<java-rest-high-stop-transform>>.

67
docs/reference/redirects.asciidoc
View file

@ -819,4 +819,69 @@ See <<ccs-works>>.
[role="exclude",id="administer-elasticsearch"] [role="exclude",id="administer-elasticsearch"]
=== Administering {es} === Administering {es}
See <<high-availability>>. See <<high-availability>>.
[role="exclude",id="delete-data-frame-transform"]
=== Delete {transforms} API
See <<delete-transform>>.
[role="exclude",id="get-data-frame-transform-stats"]
=== Get {transform} statistics API
See <<get-transform-stats>>.
[role="exclude",id="get-data-frame-transform"]
=== Get {transforms} API
See <<get-transform>>.
[role="exclude",id="preview-data-frame-transform"]
=== Preview {transforms} API
See <<preview-transform>>.
[role="exclude",id="put-data-frame-transform"]
=== Create {transforms} API
See <<put-transform>>.
[role="exclude",id="start-data-frame-transform"]
=== Start {transforms} API
See <<start-transform>>.
[role="exclude",id="stop-data-frame-transform"]
=== Stop {transforms} API
See <<stop-transform>>.
[role="exclude",id="update-data-frame-transform"]
=== Update {transforms} API
See <<update-transform>>.
[role="exclude",id="data-frame-apis"]
=== {transform-cap} APIs
See <<transform-apis>>.
[role="exclude",id="data-frame-transform-resource"]
=== {transform-cap} resources
See <<transform-resource>>.
[role="exclude",id="data-frame-transform-dest"]
=== Dest objects
See <<transform-dest>>.
[role="exclude",id="data-frame-transform-source"]
==== Source objects
See <<transform-source>>.
[role="exclude",id="data-frame-transform-pivot"]
==== Pivot objects
See <<transform-pivot>>.

2
docs/reference/rest-api/defs.asciidoc
View file

@ -14,7 +14,7 @@ These resource definitions are used in APIs related to {ml-features} and
* <<ml-snapshot-resource,{anomaly-detect-cap} model snapshots>> * <<ml-snapshot-resource,{anomaly-detect-cap} model snapshots>>
* <<ml-results-resource,{anomaly-detect-cap} results>> * <<ml-results-resource,{anomaly-detect-cap} results>>
* <<role-mapping-resources,Role mappings>> * <<role-mapping-resources,Role mappings>>
* <<data-frame-transform-resource,{transforms-cap}>> * <<transform-resource,{transforms-cap}>>
include::{es-repo-dir}/ml/anomaly-detection/apis/datafeedresource.asciidoc[] include::{es-repo-dir}/ml/anomaly-detection/apis/datafeedresource.asciidoc[]
include::{es-repo-dir}/ml/df-analytics/apis/dfanalyticsresources.asciidoc[] include::{es-repo-dir}/ml/df-analytics/apis/dfanalyticsresources.asciidoc[]

2
docs/reference/rest-api/index.asciidoc
View file

@ -29,7 +29,7 @@ not be included yet.
* <<search, Search APIs>> * <<search, Search APIs>>
* <<security-api,Security APIs>> * <<security-api,Security APIs>>
* <<snapshot-lifecycle-management-api,Snapshot lifecycle management APIs>> * <<snapshot-lifecycle-management-api,Snapshot lifecycle management APIs>>
* <<data-frame-apis,{transform-cap} APIs>> * <<transform-apis,{transform-cap} APIs>>
* <<watcher-api,Watcher APIs>> * <<watcher-api,Watcher APIs>>
-- --

17
docs/reference/transform/api-quickref.asciidoc
View file

@ -10,12 +10,13 @@ All {transform} endpoints have the following base:
---- ----
// NOTCONSOLE // NOTCONSOLE
* {ref}/put-data-frame-transform.html[Create {transforms}] * {ref}/put-transform.html[Create {transforms}]
* {ref}/delete-data-frame-transform.html[Delete {transforms}] * {ref}/delete-transform.html[Delete {transforms}]
* {ref}/get-data-frame-transform.html[Get {transforms}] * {ref}/get-transform.html[Get {transforms}]
* {ref}/get-data-frame-transform-stats.html[Get {transforms} statistics] * {ref}/get-transform-stats.html[Get {transforms} statistics]
* {ref}/preview-data-frame-transform.html[Preview {transforms}] * {ref}/preview-transform.html[Preview {transforms}]
* {ref}/start-data-frame-transform.html[Start {transforms}] * {ref}/start-transform.html[Start {transforms}]
* {ref}/stop-data-frame-transform.html[Stop {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].

12
docs/reference/transform/apis/delete-transform.asciidoc
View file

@ -1,6 +1,6 @@
[role="xpack"] [role="xpack"]
[testenv="basic"] [testenv="basic"]
[[delete-data-frame-transform]] [[delete-transform]]
=== Delete {transforms} API === Delete {transforms} API
[subs="attributes"] [subs="attributes"]
@ -12,12 +12,12 @@ Deletes an existing {transform}.
beta[] beta[]
[[delete-data-frame-transform-request]] [[delete-transform-request]]
==== {api-request-title} ==== {api-request-title}
`DELETE _data_frame/transforms/<transform_id>` `DELETE _data_frame/transforms/<transform_id>`
[[delete-data-frame-transform-prereqs]] [[delete-transform-prereqs]]
==== {api-prereq-title} ==== {api-prereq-title}
* Before you can delete the {transform}, you must stop it. * 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]. {stack-ov}/built-in-roles.html[Built-in roles].
[[delete-data-frame-transform-path-parms]] [[delete-transform-path-parms]]
==== {api-path-parms-title} ==== {api-path-parms-title}
`<transform_id>`:: `<transform_id>`::
(Required, string) Identifier for the {transform}. (Required, string) Identifier for the {transform}.
[[delete-data-frame-transform-query-parms]] [[delete-transform-query-parms]]
==== {api-query-parms-title} ==== {api-query-parms-title}
`force`:: `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 current state. The default value is `false`, meaning that the {transform} must be
`stopped` before it can be deleted. `stopped` before it can be deleted.
[[delete-data-frame-transform-examples]] [[delete-transform-examples]]
==== {api-examples-title} ==== {api-examples-title}
[source,console] [source,console]

18
docs/reference/transform/apis/get-transform-stats.asciidoc
View file

@ -1,6 +1,6 @@
[role="xpack"] [role="xpack"]
[testenv="basic"] [testenv="basic"]
[[get-data-frame-transform-stats]] [[get-transform-stats]]
=== Get {transform} statistics API === Get {transform} statistics API
[subs="attributes"] [subs="attributes"]
@ -13,7 +13,7 @@ Retrieves usage information for {transforms}.
beta[] beta[]
[[get-data-frame-transform-stats-request]] [[get-transform-stats-request]]
==== {api-request-title} ==== {api-request-title}
`GET _data_frame/transforms/<transform_id>/_stats` `GET _data_frame/transforms/<transform_id>/_stats`
@ -27,7 +27,7 @@ beta[]
`GET _data_frame/transforms/*/_stats` + `GET _data_frame/transforms/*/_stats` +
[[get-data-frame-transform-stats-prereqs]] [[get-transform-stats-prereqs]]
==== {api-prereq-title} ==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have * 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]. {stack-ov}/built-in-roles.html[Built-in roles].
[[get-data-frame-transform-stats-desc]] [[get-transform-stats-desc]]
==== {api-description-title} ==== {api-description-title}
You can get statistics for multiple {transforms} in a single API You can get statistics for multiple {transforms} in a single API
@ -47,7 +47,7 @@ specifying `*` as the `<transform_id>`, or by omitting the
`<transform_id>`. `<transform_id>`.
[[get-data-frame-transform-stats-path-parms]] [[get-transform-stats-path-parms]]
==== {api-path-parms-title} ==== {api-path-parms-title}
`<transform_id>`:: `<transform_id>`::
@ -57,7 +57,7 @@ specifying `*` as the `<transform_id>`, or by omitting the
{transforms}. {transforms}.
[[get-data-frame-transform-stats-query-parms]] [[get-transform-stats-query-parms]]
==== {api-query-parms-title} ==== {api-query-parms-title}
`allow_no_match`:: `allow_no_match`::
@ -81,21 +81,21 @@ are no matches or only partial matches.
`size`:: `size`::
(Optional, integer) Specifies the maximum number of {transforms} to obtain. The default value is `100`. (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} ==== {api-response-body-title}
`transforms`:: `transforms`::
(array) An array of statistics objects for {transforms}, which are (array) An array of statistics objects for {transforms}, which are
sorted by the `id` value in ascending order. sorted by the `id` value in ascending order.
[[get-data-frame-transform-stats-response-codes]] [[get-transform-stats-response-codes]]
==== {api-response-codes-title} ==== {api-response-codes-title}
`404` (Missing resources):: `404` (Missing resources)::
If `allow_no_match` is `false`, this code indicates that there are no 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. resources that match the request or only partial matches for the request.
[[get-data-frame-transform-stats-example]] [[get-transform-stats-example]]
==== Examples ==== Examples
The following example skips for the first five {transforms} and The following example skips for the first five {transforms} and

29
docs/reference/transform/apis/get-transform.asciidoc
View file

@ -1,6 +1,6 @@
[role="xpack"] [role="xpack"]
[testenv="basic"] [testenv="basic"]
[[get-data-frame-transform]] [[get-transform]]
=== Get {transforms} API === Get {transforms} API
[subs="attributes"] [subs="attributes"]
@ -12,12 +12,12 @@ Retrieves configuration information for {transforms}.
beta[] beta[]
[[get-data-frame-transform-request]] [[get-transform-request]]
==== {api-request-title} ==== {api-request-title}
`GET _data_frame/transforms/<data_frame_transform_id>` + `GET _data_frame/transforms/<transform_id>` +
`GET _data_frame/transforms/<data_frame_transform_id>,<data_frame_transform_id>` + `GET _data_frame/transforms/<transform_id>,<transform_id>` +
`GET _data_frame/transforms/` + `GET _data_frame/transforms/` +
@ -25,7 +25,7 @@ beta[]
`GET _data_frame/transforms/*` `GET _data_frame/transforms/*`
[[get-data-frame-transform-prereqs]] [[get-transform-prereqs]]
==== {api-prereq-title} ==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have * If the {es} {security-features} are enabled, you must have
@ -34,25 +34,24 @@ beta[]
see {stack-ov}/security-privileges.html[Security privileges] and see {stack-ov}/security-privileges.html[Security privileges] and
{stack-ov}/built-in-roles.html[Built-in roles]. {stack-ov}/built-in-roles.html[Built-in roles].
[[get-data-frame-transform-desc]] [[get-transform-desc]]
==== {api-description-title} ==== {api-description-title}
You can get information for multiple {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. request by using a comma-separated list of identifiers or a wildcard expression.
You can get information for all {transforms} by using `_all`, by You can get information for all {transforms} by using `_all`, by
specifying `*` as the `<data_frame_transform_id>`, or by omitting the specifying `*` as the `<transform_id>`, or by omitting the `<transform_id>`.
`<data_frame_transform_id>`.
[[get-data-frame-transform-path-parms]] [[get-transform-path-parms]]
==== {api-path-parms-title} ==== {api-path-parms-title}
`<data_frame_transform_id>`:: `<transform_id>`::
(Optional, string) Identifier for the {transform}. It can be a (Optional, string) Identifier for the {transform}. It can be a
{transform} identifier or a wildcard expression. If you do not {transform} identifier or a wildcard expression. If you do not
specify one of these options, the API returns information for all specify one of these options, the API returns information for all
{transforms}. {transforms}.
[[get-data-frame-transform-query-parms]] [[get-transform-query-parms]]
==== {api-query-parms-title} ==== {api-query-parms-title}
`allow_no_match`:: `allow_no_match`::
@ -76,21 +75,21 @@ are no matches or only partial matches.
`size`:: `size`::
(Optional, integer) Specifies the maximum number of {transforms} to obtain. The default value is `100`. (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} ==== {api-response-body-title}
`transforms`:: `transforms`::
(array) An array of {transform} resources, which are sorted by the `id` value in (array) An array of {transform} resources, which are sorted by the `id` value in
ascending order. See <<data-frame-transform-resource>>. ascending order. See <<transform-resource>>.
[[get-data-frame-transform-response-codes]] [[get-transform-response-codes]]
==== {api-response-codes-title} ==== {api-response-codes-title}
`404` (Missing resources):: `404` (Missing resources)::
If `allow_no_match` is `false`, this code indicates that there are no 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. resources that match the request or only partial matches for the request.
[[get-data-frame-transform-example]] [[get-transform-example]]
==== {api-examples-title} ==== {api-examples-title}
The following example retrieves information about a maximum of ten {transforms}: The following example retrieves information about a maximum of ten {transforms}:

18
docs/reference/transform/apis/index.asciidoc
View file

@ -1,18 +1,18 @@
[role="xpack"] [role="xpack"]
[testenv="basic"] [testenv="basic"]
[[data-frame-apis]] [[transform-apis]]
== {transform-cap} APIs == {transform-cap} APIs
See also {stack-ov}/ml-dataframes.html[{transforms-cap}]. See also {stack-ov}/ml-dataframes.html[{transforms-cap}].
* <<put-data-frame-transform>> * <<put-transform>>
* <<update-data-frame-transform>> * <<update-transform>>
* <<delete-data-frame-transform>> * <<delete-transform>>
* <<get-data-frame-transform>> * <<get-transform>>
* <<get-data-frame-transform-stats>> * <<get-transform-stats>>
* <<preview-data-frame-transform>> * <<preview-transform>>
* <<start-data-frame-transform>> * <<start-transform>>
* <<stop-data-frame-transform>> * <<stop-transform>>
//CREATE //CREATE
include::put-transform.asciidoc[] include::put-transform.asciidoc[]

16
docs/reference/transform/apis/preview-transform.asciidoc
View file

@ -1,6 +1,6 @@
[role="xpack"] [role="xpack"]
[testenv="basic"] [testenv="basic"]
[[preview-data-frame-transform]] [[preview-transform]]
=== Preview {transforms} API === Preview {transforms} API
[subs="attributes"] [subs="attributes"]
@ -12,12 +12,12 @@ Previews a {transform}.
beta[] beta[]
[[preview-data-frame-transform-request]] [[preview-transform-request]]
==== {api-request-title} ==== {api-request-title}
`POST _data_frame/transforms/_preview` `POST _data_frame/transforms/_preview`
[[preview-data-frame-transform-prereq]] [[preview-transform-prereq]]
==== {api-prereq-title} ==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have * 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}/security-privileges.html[Security privileges] and
{stack-ov}/built-in-roles.html[Built-in roles]. {stack-ov}/built-in-roles.html[Built-in roles].
[[preview-data-frame-transform-desc]] [[preview-transform-desc]]
==== {api-description-title} ==== {api-description-title}
This API generates a preview of the results that you will get when you run the This API generates a preview of the results that you will get when you run the
<<put-data-frame-transform,create {transforms} API>> with the same <<put-transform,create {transforms} API>> with the same
configuration. It returns a maximum of 100 results. The calculations are based configuration. It returns a maximum of 100 results. The calculations are based
on all the current data in the source index. on all the current data in the source index.
[[preview-data-frame-transform-request-body]] [[preview-transform-request-body]]
==== {api-request-body-title} ==== {api-request-body-title}
`source`:: `source`::
@ -55,9 +55,9 @@ on all the current data in the source index.
`pivot`:: `pivot`::
(Required, object) Defines the pivot function `group by` fields and the (Required, object) Defines the pivot function `group by` fields and the
aggregation to reduce the data. See <<data-frame-transform-pivot>>. aggregation to reduce the data. See <<transform-pivot>>.
[[preview-data-frame-transform-response]] [[preview-transform-response]]
==== {api-response-body-title} ==== {api-response-body-title}
`preview`:: `preview`::

22
docs/reference/transform/apis/put-transform.asciidoc
View file

@ -1,6 +1,6 @@
[role="xpack"] [role="xpack"]
[testenv="basic"] [testenv="basic"]
[[put-data-frame-transform]] [[put-transform]]
=== Create {transforms} API === Create {transforms} API
[subs="attributes"] [subs="attributes"]
@ -12,12 +12,12 @@ Instantiates a {transform}.
beta[] beta[]
[[put-data-frame-transform-request]] [[put-transform-request]]
==== {api-request-title} ==== {api-request-title}
`PUT _data_frame/transforms/<data_frame_transform_id>` `PUT _data_frame/transforms/<transform_id>`
[[put-data-frame-transform-prereqs]] [[put-transform-prereqs]]
==== {api-prereq-title} ==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have * 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 information, see {stack-ov}/security-privileges.html[Security privileges] and
{stack-ov}/built-in-roles.html[Built-in roles]. {stack-ov}/built-in-roles.html[Built-in roles].
[[put-data-frame-transform-desc]] [[put-transform-desc]]
==== {api-description-title} ==== {api-description-title}
This API defines a {transform}, which copies data from source indices, 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 If {es} {security-features} are enabled, do not give users any
privileges on `.data-frame-internal*` indices. privileges on `.data-frame-internal*` indices.
[[put-data-frame-transform-path-parms]] [[put-transform-path-parms]]
==== {api-path-parms-title} ==== {api-path-parms-title}
`<data_frame_transform_id>`:: `<transform_id>`::
(Required, string) Identifier for the {transform}. This identifier (Required, string) Identifier for the {transform}. This identifier
can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and
underscores. It must start and end with alphanumeric characters. underscores. It must start and end with alphanumeric characters.
[[put-data-frame-transform-query-parms]] [[put-transform-query-parms]]
==== {api-query-parms-title} ==== {api-query-parms-title}
`defer_validation`:: `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 behavior may be desired if the source index does not exist until after the
{transform} is created. {transform} is created.
[[put-data-frame-transform-request-body]] [[put-transform-request-body]]
==== {api-request-body-title} ==== {api-request-body-title}
`description`:: `description`::
@ -100,7 +100,7 @@ IMPORTANT: You must use {kib} or this API to create a {transform}.
`pivot`:: `pivot`::
(Required, object) Defines the pivot function `group by` fields and the aggregation to (Required, object) Defines the pivot function `group by` fields and the aggregation to
reduce the data. See <<data-frame-transform-pivot>>. reduce the data. See <<transform-pivot>>.
`source`:: `source`::
(Required, object) The source configuration, which has the following (Required, object) The source configuration, which has the following
@ -136,7 +136,7 @@ delays.
(Optional, <<time-units, time units>>) The time delay between the current time and the (Optional, <<time-units, time units>>) The time delay between the current time and the
latest input data time. The default value is `60s`. latest input data time. The default value is `60s`.
[[put-data-frame-transform-example]] [[put-transform-example]]
==== {api-examples-title} ==== {api-examples-title}
[source,console] [source,console]

16
docs/reference/transform/apis/start-transform.asciidoc
View file

@ -1,6 +1,6 @@
[role="xpack"] [role="xpack"]
[testenv="basic"] [testenv="basic"]
[[start-data-frame-transform]] [[start-transform]]
=== Start {transforms} API === Start {transforms} API
[subs="attributes"] [subs="attributes"]
@ -12,12 +12,12 @@ Starts one or more {transforms}.
beta[] beta[]
[[start-data-frame-transform-request]] [[start-transform-request]]
==== {api-request-title} ==== {api-request-title}
`POST _data_frame/transforms/<data_frame_transform_id>/_start` `POST _data_frame/transforms/<transform_id>/_start`
[[start-data-frame-transform-prereqs]] [[start-transform-prereqs]]
==== {api-prereq-title} ==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have * 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}/security-privileges.html[Security privileges] and
{stack-ov}/built-in-roles.html[Built-in roles]. {stack-ov}/built-in-roles.html[Built-in roles].
[[start-data-frame-transform-desc]] [[start-transform-desc]]
==== {api-description-title} ==== {api-description-title}
When you start a {transform}, it creates the destination index if it 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 required privileges on the source and destination indices, the
{transform} fails when it attempts unauthorized operations. {transform} fails when it attempts unauthorized operations.
[[start-data-frame-transform-path-parms]] [[start-transform-path-parms]]
==== {api-path-parms-title} ==== {api-path-parms-title}
`<data_frame_transform_id>`:: `<transform_id>`::
(Required, string) Identifier for the {transform}. This identifier (Required, string) Identifier for the {transform}. This identifier
can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and
underscores. It must start and end with alphanumeric characters. underscores. It must start and end with alphanumeric characters.
[[start-data-frame-transform-example]] [[start-transform-example]]
==== {api-examples-title} ==== {api-examples-title}
[source,console] [source,console]

24
docs/reference/transform/apis/stop-transform.asciidoc
View file

@ -1,6 +1,6 @@
[role="xpack"] [role="xpack"]
[testenv="basic"] [testenv="basic"]
[[stop-data-frame-transform]] [[stop-transform]]
=== Stop {transforms} API === Stop {transforms} API
[subs="attributes"] [subs="attributes"]
@ -13,17 +13,17 @@ Stops one or more {transforms}.
beta[] beta[]
[[stop-data-frame-transform-request]] [[stop-transform-request]]
==== {api-request-title} ==== {api-request-title}
`POST _data_frame/transforms/<data_frame_transform_id>/_stop` + `POST _data_frame/transforms/<transform_id>/_stop` +
`POST _data_frame/transforms/<data_frame_transform_id1>,<data_frame_transform_id2>/_stop` + `POST _data_frame/transforms/<transform_id1>,<transform_id2>/_stop` +
`POST _data_frame/transforms/_all/_stop` `POST _data_frame/transforms/_all/_stop`
[[stop-data-frame-transform-prereq]] [[stop-transform-prereq]]
==== {api-prereq-title} ==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have * 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]. {stack-ov}/built-in-roles.html[Built-in roles].
[[stop-data-frame-transform-desc]] [[stop-transform-desc]]
==== {api-description-title} ==== {api-description-title}
You can stop multiple {transforms} in a single API request by using a You can stop multiple {transforms} in a single API request by using a
comma-separated list of {transforms} or a wildcard expression. comma-separated list of {transforms} or a wildcard expression.
All {transforms} can be stopped by using `_all` or `*` as the All {transforms} can be stopped by using `_all` or `*` as the
`<data_frame_transform_id>`. `<transform_id>`.
[[stop-data-frame-transform-path-parms]] [[stop-transform-path-parms]]
==== {api-path-parms-title} ==== {api-path-parms-title}
`<data_frame_transform_id>`:: `<transform_id>`::
(Required, string) Identifier for the {transform}. This identifier (Required, string) Identifier for the {transform}. This identifier
can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and
underscores. It must start and end with alphanumeric characters. underscores. It must start and end with alphanumeric characters.
[[stop-data-frame-transform-query-parms]] [[stop-transform-query-parms]]
==== {api-query-parms-title} ==== {api-query-parms-title}
`allow_no_match`:: `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`. 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} ==== {api-response-codes-title}
`404` (Missing resources):: `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. resources that match the request or only partial matches for the request.
[[stop-data-frame-transform-example]] [[stop-transform-example]]
==== {api-examples-title} ==== {api-examples-title}
[source,console] [source,console]

28
docs/reference/transform/apis/transformresource.asciidoc
View file

@ -1,15 +1,15 @@
[role="xpack"] [role="xpack"]
[testenv="basic"] [testenv="basic"]
[[data-frame-transform-resource]] [[transform-resource]]
=== {transform-cap} resources === {transform-cap} resources
{transform-cap} resources relate to the <<data-frame-apis>>. {transform-cap} resources relate to the <<transform-apis>>.
For more information, see For more information, see
{stack-ov}/ecommerce-dataframes.html[Transforming your data with {dataframes}]. {stack-ov}/ecommerce-dataframes.html[Transforming your data with {dataframes}].
[discrete] [discrete]
[[data-frame-transform-properties]] [[transform-properties]]
==== {api-definitions-title} ==== {api-definitions-title}
`description`:: `description`::
@ -17,7 +17,7 @@ For more information, see
`dest`:: `dest`::
(object) The destination for the {transform}. See (object) The destination for the {transform}. See
<<data-frame-transform-dest>>. <<transform-dest>>.
`frequency`:: `frequency`::
(time units) The interval between checks for changes in the source indices (time units) The interval between checks for changes in the source indices
@ -31,20 +31,20 @@ For more information, see
`pivot`:: `pivot`::
(object) The method for transforming the data. See (object) The method for transforming the data. See
<<data-frame-transform-pivot>>. <<transform-pivot>>.
`source`:: `source`::
(object) The source of the data for the {transform}. See (object) The source of the data for the {transform}. See
<<data-frame-transform-source>>. <<transform-source>>.
[[data-frame-transform-dest]] [[transform-dest]]
==== Dest objects ==== Dest objects
{transform-cap} resources contain `dest` objects. For example, when {transform-cap} resources contain `dest` objects. For example, when
you create a {transform}, you must define its destination. you create a {transform}, you must define its destination.
[discrete] [discrete]
[[data-frame-transform-dest-properties]] [[transform-dest-properties]]
===== {api-definitions-title} ===== {api-definitions-title}
`index`:: `index`::
@ -53,14 +53,14 @@ you create a {transform}, you must define its destination.
`pipeline`:: `pipeline`::
(string) The unique identifier for a <<pipeline,pipeline>>. (string) The unique identifier for a <<pipeline,pipeline>>.
[[data-frame-transform-source]] [[transform-source]]
==== Source objects ==== Source objects
{transform-cap} resources contain `source` objects. For example, when {transform-cap} resources contain `source` objects. For example, when
you create a {transform}, you must define its source. you create a {transform}, you must define its source.
[discrete] [discrete]
[[data-frame-transform-source-properties]] [[transform-source-properties]]
===== {api-definitions-title} ===== {api-definitions-title}
`index`:: `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. (object) A query clause that retrieves a subset of data from the source index.
See <<query-dsl>>. See <<query-dsl>>.
[[data-frame-transform-pivot]] [[transform-pivot]]
==== Pivot objects ==== Pivot objects
{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. pivot function `group by` fields and the aggregation to reduce the data.
[discrete] [discrete]
[[data-frame-transform-pivot-properties]] [[transform-pivot-properties]]
===== {api-definitions-title} ===== {api-definitions-title}
`aggregations` or `aggs`:: `aggregations` or `aggs`::
@ -122,8 +122,8 @@ composite aggregations. See
dynamically adjusted to a lower value. The minimum value is `10` and the dynamically adjusted to a lower value. The minimum value is `10` and the
maximum is `10,000`. The default value is `500`. maximum is `10,000`. The default value is `500`.
[[data-frame-transform-example]] [[transform-example]]
==== {api-examples-title} ==== {api-examples-title}
See the See the
<<put-data-frame-transform-example,create {transforms} API examples>>. <<put-transform-example,create {transforms} API examples>>.

20
docs/reference/transform/apis/update-transform.asciidoc
View file

@ -1,6 +1,6 @@
[role="xpack"] [role="xpack"]
[testenv="basic"] [testenv="basic"]
[[update-data-frame-transform]] [[update-transform]]
=== Update {transforms} API === Update {transforms} API
[subs="attributes"] [subs="attributes"]
@ -12,12 +12,12 @@ Updates an existing {transform}.
beta[] beta[]
[[update-data-frame-transform-request]] [[update-transform-request]]
==== {api-request-title} ==== {api-request-title}
`POST _data_frame/transforms/<data_frame_transform_id>/_update` `POST _data_frame/transforms/<transform_id>/_update`
[[update-data-frame-transform-prereqs]] [[update-transform-prereqs]]
==== {api-prereq-title} ==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have * 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 information, see {stack-ov}/security-privileges.html[Security privileges] and
{stack-ov}/built-in-roles.html[Built-in roles]. {stack-ov}/built-in-roles.html[Built-in roles].
[[update-data-frame-transform-desc]] [[update-transform-desc]]
==== {api-description-title} ==== {api-description-title}
This API updates an existing {transform}. All settings except description do not 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 If {es} {security-features} are enabled, do not give users any
privileges on `.data-frame-internal*` indices. privileges on `.data-frame-internal*` indices.
[[update-data-frame-transform-path-parms]] [[update-transform-path-parms]]
==== {api-path-parms-title} ==== {api-path-parms-title}
`<data_frame_transform_id>`:: `<transform_id>`::
(Required, string) Identifier for the {transform}. This identifier (Required, string) Identifier for the {transform}. This identifier
can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and
underscores. It must start and end with alphanumeric characters. underscores. It must start and end with alphanumeric characters.
[[update-data-frame-transform-query-parms]] [[update-transform-query-parms]]
==== {api-query-parms-title} ==== {api-query-parms-title}
`defer_validation`:: `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 behavior may be desired if the source index does not exist until after the
{transform} is updated. {transform} is updated.
[[update-data-frame-transform-request-body]] [[update-transform-request-body]]
==== {api-request-body-title} ==== {api-request-body-title}
`description`:: `description`::
@ -118,7 +118,7 @@ delays.
(Optional, <<time-units, time units>>) The time delay between the current (Optional, <<time-units, time units>>) The time delay between the current
time and the latest input data time. The default value is `60s`. time and the latest input data time. The default value is `60s`.
[[update-data-frame-transform-example]] [[update-transform-example]]
==== {api-examples-title} ==== {api-examples-title}
[source,console] [source,console]

10
docs/reference/transform/ecommerce-example.asciidoc
View file

@ -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]. {kibana-ref}/save-open-search.html[saved search].
If you prefer, you can use the 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] [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. field. In this example, however, you can use the `order_date` field.
If you prefer, you can use the 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: example:
[source,console] [source,console]
@ -231,8 +231,8 @@ You can start, stop, and manage {transforms} in {kib}:
image::images/dataframe-transforms.jpg["Managing {transforms} in {kib}"] image::images/dataframe-transforms.jpg["Managing {transforms} in {kib}"]
Alternatively, you can use the Alternatively, you can use the
{ref}/start-data-frame-transform.html[start {transforms}] and {ref}/start-transform.html[start {transforms}] and
{ref}/stop-data-frame-transform.html[stop {transforms}] APIs. For {ref}/stop-transform.html[stop {transforms}] APIs. For
example: example:
[source,console] [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 TIP: If you do not want to keep the {transform}, you can delete it in
{kib} or use the {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 you delete a {transform}, its destination index and {kib} index
patterns remain. patterns remain.

2
docs/reference/transform/limitations.asciidoc
View file

@ -54,7 +54,7 @@ table.
A single cluster will support up to 1,000 {transforms}. A single cluster will support up to 1,000 {transforms}.
When using the 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 `count` of {transforms} is returned. Use the `size` and `from` parameters to
enumerate through the full list. enumerate through the full list.

2
docs/reference/transform/overview.asciidoc
View file

@ -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 using aggregations, you practically ask questions about the index. There are
different types of aggregations, each with its own purpose and output. To learn different types of aggregations, each with its own purpose and output. To learn
more about the supported aggregations and group-by fields, see 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 As an optional step, you can also add a query to further limit the scope of the
aggregation. aggregation.

2
docs/reference/transform/troubleshooting.asciidoc
View file

@ -17,7 +17,7 @@ information from the following files and APIs:
* Lightweight audit messages are stored in `.data-frame-notifications-*`. Search * Lightweight audit messages are stored in `.data-frame-notifications-*`. Search
by your `transform_id`. by your `transform_id`.
* The * 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. provides information about the {transform} status and failures.
* If the {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: {ref}/tasks.html[task management API] to gather task information. For example:

2
x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.delete_data_frame_transform.json
View file

@ -1,7 +1,7 @@
{ {
"data_frame.delete_data_frame_transform":{ "data_frame.delete_data_frame_transform":{
"documentation":{ "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", "stability":"beta",
"url":{ "url":{

2
x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.get_data_frame_transform.json
View file

@ -1,7 +1,7 @@
{ {
"data_frame.get_data_frame_transform":{ "data_frame.get_data_frame_transform":{
"documentation":{ "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", "stability":"beta",
"url":{ "url":{

2
x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.get_data_frame_transform_stats.json
View file

@ -1,7 +1,7 @@
{ {
"data_frame.get_data_frame_transform_stats":{ "data_frame.get_data_frame_transform_stats":{
"documentation":{ "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", "stability":"beta",
"url":{ "url":{

2
x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.preview_data_frame_transform.json
View file

@ -1,7 +1,7 @@
{ {
"data_frame.preview_data_frame_transform":{ "data_frame.preview_data_frame_transform":{
"documentation":{ "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", "stability":"beta",
"url":{ "url":{

2
x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.put_data_frame_transform.json
View file

@ -1,7 +1,7 @@
{ {
"data_frame.put_data_frame_transform":{ "data_frame.put_data_frame_transform":{
"documentation":{ "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", "stability":"beta",
"url":{ "url":{

2
x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.start_data_frame_transform.json
View file

@ -1,7 +1,7 @@
{ {
"data_frame.start_data_frame_transform":{ "data_frame.start_data_frame_transform":{
"documentation":{ "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", "stability":"beta",
"url":{ "url":{

2
x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.stop_data_frame_transform.json
View file

@ -1,7 +1,7 @@
{ {
"data_frame.stop_data_frame_transform":{ "data_frame.stop_data_frame_transform":{
"documentation":{ "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", "stability":"beta",
"url":{ "url":{

2
x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.update_data_frame_transform.json
View file

@ -1,7 +1,7 @@
{ {
"data_frame.update_data_frame_transform": { "data_frame.update_data_frame_transform": {
"documentation": { "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", "stability": "beta",
"url": { "url": {