Package org.elasticsearch.client

Class DataFrameClient

java.lang.Object

org.elasticsearch.client.DataFrameClient

public final class DataFrameClient
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
AcknowledgedResponse	deleteDataFrameTransform(DeleteDataFrameTransformRequest request, RequestOptions options)	Delete a transform
void	deleteDataFrameTransformAsync(DeleteDataFrameTransformRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener)	Delete a transform asynchronously and notifies listener on completion
GetDataFrameTransformResponse	getDataFrameTransform(GetDataFrameTransformRequest request, RequestOptions options)	Get one or more transform configurations
void	getDataFrameTransformAsync(GetDataFrameTransformRequest request, RequestOptions options, ActionListener<GetDataFrameTransformResponse> listener)	Get one or more transform configurations asynchronously and notifies listener on completion
GetDataFrameTransformStatsResponse	getDataFrameTransformStats(GetDataFrameTransformStatsRequest request, RequestOptions options)	Get the running statistics of a transform
void	getDataFrameTransformStatsAsync(GetDataFrameTransformStatsRequest request, RequestOptions options, ActionListener<GetDataFrameTransformStatsResponse> listener)	Get the running statistics of a transform asynchronously and notifies listener on completion
PreviewDataFrameTransformResponse	previewDataFrameTransform(PreviewDataFrameTransformRequest request, RequestOptions options)	Preview the result of a transform
void	previewDataFrameTransformAsync(PreviewDataFrameTransformRequest request, RequestOptions options, ActionListener<PreviewDataFrameTransformResponse> listener)	Preview the result of a transform asynchronously and notifies listener on completion
AcknowledgedResponse	putDataFrameTransform(PutDataFrameTransformRequest request, RequestOptions options)	Creates a new transform
void	putDataFrameTransformAsync(PutDataFrameTransformRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener)	Creates a new transform asynchronously and notifies listener on completion
StartDataFrameTransformResponse	startDataFrameTransform(StartDataFrameTransformRequest request, RequestOptions options)	Start a transform
void	startDataFrameTransformAsync(StartDataFrameTransformRequest request, RequestOptions options, ActionListener<StartDataFrameTransformResponse> listener)	Start a transform asynchronously and notifies listener on completion
StopDataFrameTransformResponse	stopDataFrameTransform(StopDataFrameTransformRequest request, RequestOptions options)	Stop a transform
void	stopDataFrameTransformAsync(StopDataFrameTransformRequest request, RequestOptions options, ActionListener<StopDataFrameTransformResponse> listener)	Stop a transform asynchronously and notifies listener on completion
UpdateDataFrameTransformResponse	updateDataFrameTransform(UpdateDataFrameTransformRequest request, RequestOptions options)	Updates an existing transform
void	updateDataFrameTransformAsync(UpdateDataFrameTransformRequest request, RequestOptions options, ActionListener<UpdateDataFrameTransformResponse> listener)	Updates an existing transform asynchronously and notifies listener on completion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

putDataFrameTransform

public AcknowledgedResponse putDataFrameTransform(PutDataFrameTransformRequest request,
                                                  RequestOptions options)
                                           throws java.io.IOException

Creates a new transform

For additional info see Create transform documentation

Parameters:

request - The PutDataFrameTransformRequest containing the DataFrameTransformConfig.

options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

An AcknowledgedResponse object indicating request success

Throws:

java.io.IOException - when there is a serialization issue sending the request or receiving the response

putDataFrameTransformAsync

public void putDataFrameTransformAsync(PutDataFrameTransformRequest request,
                                       RequestOptions options,
                                       ActionListener<AcknowledgedResponse> listener)

Creates a new transform asynchronously and notifies listener on completion

For additional info see Create transform documentation

Parameters:

request - The PutDataFrameTransformRequest containing the DataFrameTransformConfig.

options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - Listener to be notified upon request completion

updateDataFrameTransform

public UpdateDataFrameTransformResponse updateDataFrameTransform(UpdateDataFrameTransformRequest request,
                                                                 RequestOptions options)
                                                          throws java.io.IOException

Updates an existing transform

For additional info see Create transform documentation

Parameters:

request - The UpdateDataFrameTransformRequest containing the DataFrameTransformConfigUpdate.

options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

An UpdateDataFrameTransformResponse object containing the updated configuration

Throws:

java.io.IOException - when there is a serialization issue sending the request or receiving the response

updateDataFrameTransformAsync

public void updateDataFrameTransformAsync(UpdateDataFrameTransformRequest request,
                                          RequestOptions options,
                                          ActionListener<UpdateDataFrameTransformResponse> listener)

Updates an existing transform asynchronously and notifies listener on completion

For additional info see Create transform documentation

Parameters:

request - The UpdateDataFrameTransformRequest containing the DataFrameTransformConfigUpdate.

options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - Listener to be notified upon request completion

getDataFrameTransformStats

public GetDataFrameTransformStatsResponse getDataFrameTransformStats(GetDataFrameTransformStatsRequest request,
                                                                     RequestOptions options)
                                                              throws java.io.IOException

Get the running statistics of a transform

For additional info see Get transform stats documentation

Parameters:

request - Specifies the which transforms to get the stats for

options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

The transform stats

Throws:

java.io.IOException - when there is a serialization issue sending the request or receiving the response

getDataFrameTransformStatsAsync

public void getDataFrameTransformStatsAsync(GetDataFrameTransformStatsRequest request,
                                            RequestOptions options,
                                            ActionListener<GetDataFrameTransformStatsResponse> listener)

Get the running statistics of a transform asynchronously and notifies listener on completion

For additional info see Get transform stats documentation

Parameters:

request - Specifies the which transforms to get the stats for

options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - Listener to be notified upon request completion

deleteDataFrameTransform

public AcknowledgedResponse deleteDataFrameTransform(DeleteDataFrameTransformRequest request,
                                                     RequestOptions options)
                                              throws java.io.IOException

Delete a transform

For additional info see Delete transform documentation

Parameters:

request - The delete transform request

options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

An AcknowledgedResponse object indicating request success

Throws:

java.io.IOException - when there is a serialization issue sending the request or receiving the response

deleteDataFrameTransformAsync

public void deleteDataFrameTransformAsync(DeleteDataFrameTransformRequest request,
                                          RequestOptions options,
                                          ActionListener<AcknowledgedResponse> listener)

Delete a transform asynchronously and notifies listener on completion

For additional info see Delete transform documentation

Parameters:

request - The delete transform request

options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - Listener to be notified upon request completion

previewDataFrameTransform

public PreviewDataFrameTransformResponse previewDataFrameTransform(PreviewDataFrameTransformRequest request,
                                                                   RequestOptions options)
                                                            throws java.io.IOException

Preview the result of a transform

For additional info see Preview transform documentation

Parameters:

request - The preview transform request

options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

A response containing the results of the applied transform

Throws:

java.io.IOException - when there is a serialization issue sending the request or receiving the response

previewDataFrameTransformAsync

public void previewDataFrameTransformAsync(PreviewDataFrameTransformRequest request,
                                           RequestOptions options,
                                           ActionListener<PreviewDataFrameTransformResponse> listener)

Preview the result of a transform asynchronously and notifies listener on completion

see Preview transform documentation

Parameters:

request - The preview transform request

options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - Listener to be notified upon request completion

startDataFrameTransform

public StartDataFrameTransformResponse startDataFrameTransform(StartDataFrameTransformRequest request,
                                                               RequestOptions options)
                                                        throws java.io.IOException

Start a transform

For additional info see Start transform documentation

Parameters:

request - The start transform request

options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

A response object indicating request success

Throws:

java.io.IOException - when there is a serialization issue sending the request or receiving the response

startDataFrameTransformAsync

public void startDataFrameTransformAsync(StartDataFrameTransformRequest request,
                                         RequestOptions options,
                                         ActionListener<StartDataFrameTransformResponse> listener)

Start a transform asynchronously and notifies listener on completion

For additional info see Start transform documentation

Parameters:

request - The start transform request

options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - Listener to be notified upon request completion

stopDataFrameTransform

public StopDataFrameTransformResponse stopDataFrameTransform(StopDataFrameTransformRequest request,
                                                             RequestOptions options)
                                                      throws java.io.IOException

Stop a transform

For additional info see Stop transform documentation

Parameters:

request - The stop transform request

options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

A response object indicating request success

Throws:

java.io.IOException - when there is a serialization issue sending the request or receiving the response

stopDataFrameTransformAsync

public void stopDataFrameTransformAsync(StopDataFrameTransformRequest request,
                                        RequestOptions options,
                                        ActionListener<StopDataFrameTransformResponse> listener)

Stop a transform asynchronously and notifies listener on completion

For additional info see Stop transform documentation

Parameters:

request - The stop transform request

options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - Listener to be notified upon request completion

getDataFrameTransform

public GetDataFrameTransformResponse getDataFrameTransform(GetDataFrameTransformRequest request,
                                                           RequestOptions options)
                                                    throws java.io.IOException

Get one or more transform configurations

For additional info see Get transform documentation

Parameters:

request - The get transform request

options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

An GetDataFrameTransformResponse containing the requested transforms

Throws:

java.io.IOException - when there is a serialization issue sending the request or receiving the response

getDataFrameTransformAsync

public void getDataFrameTransformAsync(GetDataFrameTransformRequest request,
                                       RequestOptions options,
                                       ActionListener<GetDataFrameTransformResponse> listener)

Get one or more transform configurations asynchronously and notifies listener on completion

For additional info see Get transform documentation

Parameters:

request - The get transform request

options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - Listener to be notified upon request completion