Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Update data frame transform URLs #46940

Merged
merged 3 commits into from
Sep 20, 2019
Merged

[DOCS] Update data frame transform URLs #46940

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
360f046
[DOCS] Updates transform URLs
lcawl Sep 20, 2019
aa475be
[DOCS] Renames HLRC dataframe folder
lcawl Sep 20, 2019
967e12b
[DOCS] Fixes client doc tests
lcawl Sep 20, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 59 additions & 59 deletions client/rest-high-level/src/main/java/org/elasticsearch/client/DataFrameClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,11 @@ public final class DataFrameClient {
}

/**
* Creates a new Data Frame Transform
* Creates a new transform
* <p>
* For additional info
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/put-data-frame-transform.html">
* Create data frame transform documentation</a>
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html">
* Create transform documentation</a>
*
* @param request The PutDataFrameTransformRequest containing the
* {@link org.elasticsearch.client.transform.transforms.DataFrameTransformConfig}.
Expand All @@ -69,11 +69,11 @@ public AcknowledgedResponse putDataFrameTransform(PutDataFrameTransformRequest r
}

/**
* Creates a new Data Frame Transform asynchronously and notifies listener on completion
* Creates a new transform asynchronously and notifies listener on completion
* <p>
* For additional info
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/put-data-frame-transform.html">
* Create data frame transform documentation</a>
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html">
* Create transform documentation</a>
* @param request The PutDataFrameTransformRequest containing the
* {@link org.elasticsearch.client.transform.transforms.DataFrameTransformConfig}.
* @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
Expand All @@ -91,11 +91,11 @@ public Cancellable putDataFrameTransformAsync(PutDataFrameTransformRequest reque
}

/**
* Updates an existing Data Frame Transform
* Updates an existing transform
* <p>
* For additional info
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/update-data-frame-transform.html">
* Create data frame transform documentation</a>
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html">
* Create transform documentation</a>
*
* @param request The UpdateDataFrameTransformRequest containing the
* {@link org.elasticsearch.client.transform.transforms.DataFrameTransformConfigUpdate}.
Expand All @@ -113,11 +113,11 @@ public UpdateDataFrameTransformResponse updateDataFrameTransform(UpdateDataFrame
}

/**
* Updates an existing Data Frame Transform asynchronously and notifies listener on completion
* Updates an existing transform asynchronously and notifies listener on completion
* <p>
* For additional info
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/update-data-frame-transform.html">
* Create data frame transform documentation</a>
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html">
* Create transform documentation</a>
* @param request The UpdateDataFrameTransformRequest containing the
* {@link org.elasticsearch.client.transform.transforms.DataFrameTransformConfigUpdate}.
* @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
Expand All @@ -136,15 +136,15 @@ public Cancellable updateDataFrameTransformAsync(UpdateDataFrameTransformRequest
}

/**
* Get the running statistics of a Data Frame Transform
* Get the running statistics of a transform
* <p>
* For additional info
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/get-data-frame-transform-stats.html">
* Get data frame transform stats documentation</a>
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html">
* Get transform stats documentation</a>
*
* @param request Specifies the which transforms to get the stats for
* @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
* @return The Data Frame Transform stats
* @return The transform stats
* @throws IOException when there is a serialization issue sending the request or receiving the response
*/
public GetDataFrameTransformStatsResponse getDataFrameTransformStats(GetDataFrameTransformStatsRequest request, RequestOptions options)
Expand All @@ -157,11 +157,11 @@ public GetDataFrameTransformStatsResponse getDataFrameTransformStats(GetDataFram
}

/**
* Get the running statistics of a Data Frame Transform asynchronously and notifies listener on completion
* Get the running statistics of a transform asynchronously and notifies listener on completion
* <p>
* For additional info
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/get-data-frame-transform-stats.html">
* Get data frame transform stats documentation</a>
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html">
* Get transform stats documentation</a>
* @param request Specifies the which transforms to get the stats for
* @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
* @param listener Listener to be notified upon request completion
Expand All @@ -178,13 +178,13 @@ public Cancellable getDataFrameTransformStatsAsync(GetDataFrameTransformStatsReq
}

/**
* Delete a data frame transform
* Delete a transform
* <p>
* For additional info
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-data-frame-transform.html">
* Delete data frame transform documentation</a>
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html">
* 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
* @return An AcknowledgedResponse object indicating request success
* @throws IOException when there is a serialization issue sending the request or receiving the response
Expand All @@ -199,12 +199,12 @@ public AcknowledgedResponse deleteDataFrameTransform(DeleteDataFrameTransformReq
}

/**
* Delete a data frame transform asynchronously and notifies listener on completion
* Delete a transform asynchronously and notifies listener on completion
* <p>
* For additional info
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-data-frame-transform.html">
* Delete data frame transform documentation</a>
* @param request The delete data frame transform request
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html">
* Delete transform documentation</a>
* @param request The delete transform request
* @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
* @param listener Listener to be notified upon request completion
* @return cancellable that may be used to cancel the request
Expand All @@ -220,13 +220,13 @@ public Cancellable deleteDataFrameTransformAsync(DeleteDataFrameTransformRequest
}

/**
* Preview the result of a data frame transform
* Preview the result of a transform
* <p>
* For additional info
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-data-frame-transform.html">
* Preview data frame transform documentation</a>
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html">
* 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
* @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
Expand All @@ -241,11 +241,11 @@ public PreviewDataFrameTransformResponse previewDataFrameTransform(PreviewDataFr
}

/**
* Preview the result of a data frame transform asynchronously and notifies listener on completion
* Preview the result of a transform asynchronously and notifies listener on completion
* <p>
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-data-frame-transform.html">
* Preview data frame transform documentation</a>
* @param request The preview data frame transform request
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html">
* Preview transform documentation</a>
* @param request The preview transform request
* @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
* @param listener Listener to be notified upon request completion
* @return cancellable that may be used to cancel the request
Expand All @@ -261,13 +261,13 @@ public Cancellable previewDataFrameTransformAsync(PreviewDataFrameTransformReque
}

/**
* Start a data frame transform
* Start a transform
* <p>
* For additional info
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/start-data-frame-transform.html">
* Start data frame transform documentation</a>
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html">
* 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
* @return A response object indicating request success
* @throws IOException when there is a serialization issue sending the request or receiving the response
Expand All @@ -282,12 +282,12 @@ public StartDataFrameTransformResponse startDataFrameTransform(StartDataFrameTra
}

/**
* Start a data frame transform asynchronously and notifies listener on completion
* Start a transform asynchronously and notifies listener on completion
* <p>
* For additional info
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/start-data-frame-transform.html">
* Start data frame transform documentation</a>
* @param request The start data frame transform request
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html">
* Start transform documentation</a>
* @param request The start transform request
* @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
* @param listener Listener to be notified upon request completion
* @return cancellable that may be used to cancel the request
Expand All @@ -303,13 +303,13 @@ public Cancellable startDataFrameTransformAsync(StartDataFrameTransformRequest r
}

/**
* Stop a data frame transform
* Stop a transform
* <p>
* For additional info
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-data-frame-transform.html">
* Stop data frame transform documentation</a>
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html">
* 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
* @return A response object indicating request success
* @throws IOException when there is a serialization issue sending the request or receiving the response
Expand All @@ -324,12 +324,12 @@ public StopDataFrameTransformResponse stopDataFrameTransform(StopDataFrameTransf
}

/**
* Stop a data frame transform asynchronously and notifies listener on completion
* Stop a transform asynchronously and notifies listener on completion
* <p>
* For additional info
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-data-frame-transform.html">
* Stop data frame transform documentation</a>
* @param request The stop data frame transform request
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html">
* Stop transform documentation</a>
* @param request The stop transform request
* @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
* @param listener Listener to be notified upon request completion
* @return cancellable that may be used to cancel the request
Expand All @@ -345,13 +345,13 @@ public Cancellable stopDataFrameTransformAsync(StopDataFrameTransformRequest req
}

/**
* Get one or more data frame transform configurations
* Get one or more transform configurations
* <p>
* For additional info
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/get-data-frame-transform.html">
* Get data frame transform documentation</a>
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html">
* 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
* @return An GetDataFrameTransformResponse containing the requested transforms
* @throws IOException when there is a serialization issue sending the request or receiving the response
Expand All @@ -366,12 +366,12 @@ public GetDataFrameTransformResponse getDataFrameTransform(GetDataFrameTransform
}

/**
* Get one or more data frame transform configurations asynchronously and notifies listener on completion
* Get one or more transform configurations asynchronously and notifies listener on completion
* <p>
* For additional info
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/get-data-frame-transform.html">
* Get data frame transform documentation</a>
* @param request The get data frame transform request
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html">
* Get data transform documentation</a>
* @param request The get transform request
* @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
* @param listener Listener to be notified upon request completion
* @return cancellable that may be used to cancel the request
Expand Down
4 changes: 2 additions & 2 deletions client/rest-high-level/src/main/java/org/elasticsearch/client/RestHighLevelClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -472,8 +472,8 @@ public SecurityClient security() {
* are shipped with the Elastic Stack distribution of Elasticsearch. All of
* these APIs will 404 if run against the OSS distribution of Elasticsearch.
* <p>
* See the <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/data-frame-apis.html">
* Data Frame APIs on elastic.co</a> for more information.
* See the <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/transform-apis.html">
* Transform APIs on elastic.co</a> for more information.
*
* @return the client wrapper for making Data Frame API calls
*/
Expand Down
Loading