Package org.elasticsearch.client

Class RollupClient

java.lang.Object

org.elasticsearch.client.RollupClient

public class RollupClient
extends java.lang.Object

A wrapper for the RestHighLevelClient that provides methods for accessing the Elastic Rollup-related methods

See the X-Pack Rollup APIs on elastic.co for more information.

Method Summary

Modifier and Type	Method	Description
AcknowledgedResponse	deleteRollupJob(DeleteRollupJobRequest request, RequestOptions options)	Delete a rollup job from the cluster See the docs for more.
void	deleteRollupJobAsync(DeleteRollupJobRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener)	Asynchronously delete a rollup job from the cluster See The docs for details.
GetRollupCapsResponse	getRollupCapabilities(GetRollupCapsRequest request, RequestOptions options)	Get the Rollup Capabilities of a target (non-rollup) index or pattern See the docs for more.
void	getRollupCapabilitiesAsync(GetRollupCapsRequest request, RequestOptions options, ActionListener<GetRollupCapsResponse> listener)	Asynchronously Get the Rollup Capabilities of a target (non-rollup) index or pattern See the docs for more.
GetRollupIndexCapsResponse	getRollupIndexCapabilities(GetRollupIndexCapsRequest request, RequestOptions options)	Get the Rollup Index Capabilities of a rollup index or pattern See the docs for more.
void	getRollupIndexCapabilitiesAsync(GetRollupIndexCapsRequest request, RequestOptions options, ActionListener<GetRollupIndexCapsResponse> listener)	Asynchronously Get the Rollup Index Capabilities of a rollup index or pattern See the docs for more.
GetRollupJobResponse	getRollupJob(GetRollupJobRequest request, RequestOptions options)	Get a rollup job from the cluster.
void	getRollupJobAsync(GetRollupJobRequest request, RequestOptions options, ActionListener<GetRollupJobResponse> listener)	Asynchronously get a rollup job from the cluster.
AcknowledgedResponse	putRollupJob(PutRollupJobRequest request, RequestOptions options)	Put a rollup job into the cluster See the docs for more.
void	putRollupJobAsync(PutRollupJobRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener)	Asynchronously put a rollup job into the cluster See the docs for more.
SearchResponse	search(SearchRequest request, RequestOptions options)	Perform a rollup search.
void	searchAsync(SearchRequest request, RequestOptions options, ActionListener<SearchResponse> listener)	Perform a rollup search.
StartRollupJobResponse	startRollupJob(StartRollupJobRequest request, RequestOptions options)	Start a rollup job See the docs for more.
void	startRollupJobAsync(StartRollupJobRequest request, RequestOptions options, ActionListener<StartRollupJobResponse> listener)	Asynchronously start a rollup job See the docs for more.
StopRollupJobResponse	stopRollupJob(StopRollupJobRequest request, RequestOptions options)	Stop a rollup job See the docs for more.
void	stopRollupJobAsync(StopRollupJobRequest request, RequestOptions options, ActionListener<StopRollupJobResponse> listener)	Asynchronously stop a rollup job See the docs for more.

Methods inherited from class java.lang.Object

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

Method Detail

putRollupJob

public AcknowledgedResponse putRollupJob(PutRollupJobRequest request,
                                         RequestOptions options)
                                  throws java.io.IOException

Put a rollup job into the cluster See the docs for more.

Parameters:

request - the request

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

Returns:

the response

Throws:

java.io.IOException - in case there is a problem sending the request or parsing back the response

putRollupJobAsync

public void putRollupJobAsync(PutRollupJobRequest request,
                              RequestOptions options,
                              ActionListener<AcknowledgedResponse> listener)

Asynchronously put a rollup job into the cluster See the docs for more.

Parameters:

request - the request

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

listener - the listener to be notified upon request completion

startRollupJob

public StartRollupJobResponse startRollupJob(StartRollupJobRequest request,
                                             RequestOptions options)
                                      throws java.io.IOException

Start a rollup job See the docs for more.

Parameters:

request - the request

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

Returns:

the response

Throws:

java.io.IOException - in case there is a problem sending the request or parsing back the response

startRollupJobAsync

public void startRollupJobAsync(StartRollupJobRequest request,
                                RequestOptions options,
                                ActionListener<StartRollupJobResponse> listener)

Asynchronously start a rollup job See the docs for more.

Parameters:

request - the request

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

listener - the listener to be notified upon request completion

stopRollupJob

public StopRollupJobResponse stopRollupJob(StopRollupJobRequest request,
                                           RequestOptions options)
                                    throws java.io.IOException

Stop a rollup job See the docs for more.

Parameters:

request - the request

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

Returns:

the response

Throws:

java.io.IOException - in case there is a problem sending the request or parsing back the response

stopRollupJobAsync

public void stopRollupJobAsync(StopRollupJobRequest request,
                               RequestOptions options,
                               ActionListener<StopRollupJobResponse> listener)

Asynchronously stop a rollup job See the docs for more.

Parameters:

request - the request

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

listener - the listener to be notified upon request completion

deleteRollupJob

public AcknowledgedResponse deleteRollupJob(DeleteRollupJobRequest request,
                                            RequestOptions options)
                                     throws java.io.IOException

Delete a rollup job from the cluster See the docs for more.

Parameters:

request - the request

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

Returns:

the response

Throws:

java.io.IOException - in case there is a problem sending the request or parsing back the response

deleteRollupJobAsync

public void deleteRollupJobAsync(DeleteRollupJobRequest request,
                                 RequestOptions options,
                                 ActionListener<AcknowledgedResponse> listener)

Asynchronously delete a rollup job from the cluster See The docs for details.

Parameters:

request - the request

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

listener - the listener to be notified upon request completion

getRollupJob

public GetRollupJobResponse getRollupJob(GetRollupJobRequest request,
                                         RequestOptions options)
                                  throws java.io.IOException

Get a rollup job from the cluster. See the docs for more.

Parameters:

request - the request

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

Returns:

the response

Throws:

java.io.IOException - in case there is a problem sending the request or parsing back the response

getRollupJobAsync

public void getRollupJobAsync(GetRollupJobRequest request,
                              RequestOptions options,
                              ActionListener<GetRollupJobResponse> listener)

Asynchronously get a rollup job from the cluster. See the docs for more.

Parameters:

request - the request

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

listener - the listener to be notified upon request completion

search

public SearchResponse search(SearchRequest request,
                             RequestOptions options)
                      throws java.io.IOException

Perform a rollup search. See the docs for more.

Parameters:

request - the request

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

Returns:

the response

Throws:

java.io.IOException - in case there is a problem sending the request or parsing back the response

searchAsync

public void searchAsync(SearchRequest request,
                        RequestOptions options,
                        ActionListener<SearchResponse> listener)

Perform a rollup search. See the docs for more.

Parameters:

request - the request

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

listener - the listener to be notified upon request completion

getRollupCapabilities

public GetRollupCapsResponse getRollupCapabilities(GetRollupCapsRequest request,
                                                   RequestOptions options)
                                            throws java.io.IOException

Get the Rollup Capabilities of a target (non-rollup) index or pattern See the docs for more.

Parameters:

request - the request

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

Returns:

the response

Throws:

java.io.IOException - in case there is a problem sending the request or parsing back the response

getRollupCapabilitiesAsync

public void getRollupCapabilitiesAsync(GetRollupCapsRequest request,
                                       RequestOptions options,
                                       ActionListener<GetRollupCapsResponse> listener)

Asynchronously Get the Rollup Capabilities of a target (non-rollup) index or pattern See the docs for more.

Parameters:

request - the request

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

listener - the listener to be notified upon request completion

getRollupIndexCapabilities

public GetRollupIndexCapsResponse getRollupIndexCapabilities(GetRollupIndexCapsRequest request,
                                                             RequestOptions options)
                                                      throws java.io.IOException

Get the Rollup Index Capabilities of a rollup index or pattern See the docs for more.

Parameters:

request - the request

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

Returns:

the response

Throws:

java.io.IOException - in case there is a problem sending the request or parsing back the response

getRollupIndexCapabilitiesAsync

public void getRollupIndexCapabilitiesAsync(GetRollupIndexCapsRequest request,
                                            RequestOptions options,
                                            ActionListener<GetRollupIndexCapsResponse> listener)

Asynchronously Get the Rollup Index Capabilities of a rollup index or pattern See the docs for more.

Parameters:

request - the request

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

listener - the listener to be notified upon request completion