Package org.elasticsearch.client

Class TransformClient

java.lang.Object

org.elasticsearch.client.TransformClient

public final class TransformClient
extends Object

Method Summary

Modifier and Type	Method	Description
AcknowledgedResponse	deleteTransform(DeleteTransformRequest request, RequestOptions options)	Delete a transform
Cancellable	deleteTransformAsync(DeleteTransformRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener)	Delete a transform asynchronously and notifies listener on completion
GetTransformResponse	getTransform(GetTransformRequest request, RequestOptions options)	Get one or more transform configurations
Cancellable	getTransformAsync(GetTransformRequest request, RequestOptions options, ActionListener<GetTransformResponse> listener)	Get one or more transform configurations asynchronously and notifies listener on completion
GetTransformStatsResponse	getTransformStats(GetTransformStatsRequest request, RequestOptions options)	Get the running statistics of a transform
Cancellable	getTransformStatsAsync(GetTransformStatsRequest request, RequestOptions options, ActionListener<GetTransformStatsResponse> listener)	Get the running statistics of a transform asynchronously and notifies listener on completion
PreviewTransformResponse	previewTransform(PreviewTransformRequest request, RequestOptions options)	Preview the result of a transform
Cancellable	previewTransformAsync(PreviewTransformRequest request, RequestOptions options, ActionListener<PreviewTransformResponse> listener)	Preview the result of a transform asynchronously and notifies listener on completion
AcknowledgedResponse	putTransform(PutTransformRequest request, RequestOptions options)	Creates a new transform
Cancellable	putTransformAsync(PutTransformRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener)	Creates a new transform asynchronously and notifies listener on completion
StartTransformResponse	startTransform(StartTransformRequest request, RequestOptions options)	Start a transform
Cancellable	startTransformAsync(StartTransformRequest request, RequestOptions options, ActionListener<StartTransformResponse> listener)	Start a transform asynchronously and notifies listener on completion
StopTransformResponse	stopTransform(StopTransformRequest request, RequestOptions options)	Stop a transform
Cancellable	stopTransformAsync(StopTransformRequest request, RequestOptions options, ActionListener<StopTransformResponse> listener)	Stop a transform asynchronously and notifies listener on completion
UpdateTransformResponse	updateTransform(UpdateTransformRequest request, RequestOptions options)	Updates an existing transform
Cancellable	updateTransformAsync(UpdateTransformRequest request, RequestOptions options, ActionListener<UpdateTransformResponse> 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

putTransform

public AcknowledgedResponse putTransform(PutTransformRequest request,
                                         RequestOptions options)
                                  throws IOException

Creates a new transform

For additional info see Create transform documentation

Parameters:

request - The PutTransformRequest containing the TransformConfig.

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

Returns:

An AcknowledgedResponse object indicating request success

Throws:

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

putTransformAsync

public Cancellable putTransformAsync(PutTransformRequest 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 PutTransformRequest containing the TransformConfig.

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

listener - Listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

updateTransform

public UpdateTransformResponse updateTransform(UpdateTransformRequest request,
                                               RequestOptions options)
                                        throws IOException

Updates an existing transform

For additional info see Create transform documentation

Parameters:

request - The UpdateTransformRequest containing the TransformConfigUpdate.

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

Returns:

An UpdateTransformResponse object containing the updated configuration

Throws:

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

updateTransformAsync

public Cancellable updateTransformAsync(UpdateTransformRequest request,
                                        RequestOptions options,
                                        ActionListener<UpdateTransformResponse> listener)

Updates an existing transform asynchronously and notifies listener on completion

For additional info see Create transform documentation

Parameters:

request - The UpdateTransformRequest containing the TransformConfigUpdate.

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

listener - Listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

getTransformStats

public GetTransformStatsResponse getTransformStats(GetTransformStatsRequest request,
                                                   RequestOptions options)
                                            throws IOException

Get the running statistics of a transform

For additional info see Get transform stats documentation

Parameters:

request - Specifies 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:

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

getTransformStatsAsync

public Cancellable getTransformStatsAsync(GetTransformStatsRequest request,
                                          RequestOptions options,
                                          ActionListener<GetTransformStatsResponse> 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 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

Returns:

cancellable that may be used to cancel the request

deleteTransform

public AcknowledgedResponse deleteTransform(DeleteTransformRequest request,
                                            RequestOptions options)
                                     throws 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:

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

deleteTransformAsync

public Cancellable deleteTransformAsync(DeleteTransformRequest 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

Returns:

cancellable that may be used to cancel the request

previewTransform

public PreviewTransformResponse previewTransform(PreviewTransformRequest request,
                                                 RequestOptions options)
                                          throws 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:

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

previewTransformAsync

public Cancellable previewTransformAsync(PreviewTransformRequest request,
                                         RequestOptions options,
                                         ActionListener<PreviewTransformResponse> 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

Returns:

cancellable that may be used to cancel the request

startTransform

public StartTransformResponse startTransform(StartTransformRequest request,
                                             RequestOptions options)
                                      throws 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:

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

startTransformAsync

public Cancellable startTransformAsync(StartTransformRequest request,
                                       RequestOptions options,
                                       ActionListener<StartTransformResponse> 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

Returns:

cancellable that may be used to cancel the request

stopTransform

public StopTransformResponse stopTransform(StopTransformRequest request,
                                           RequestOptions options)
                                    throws 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:

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

stopTransformAsync

public Cancellable stopTransformAsync(StopTransformRequest request,
                                      RequestOptions options,
                                      ActionListener<StopTransformResponse> 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

Returns:

cancellable that may be used to cancel the request

getTransform

public GetTransformResponse getTransform(GetTransformRequest request,
                                         RequestOptions options)
                                  throws 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 GetTransformResponse containing the requested transforms

Throws:

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

getTransformAsync

public Cancellable getTransformAsync(GetTransformRequest request,
                                     RequestOptions options,
                                     ActionListener<GetTransformResponse> listener)

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

For additional info see Get data 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

Returns:

cancellable that may be used to cancel the request