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
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.
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.
PutRollupJobResponse	putRollupJob(PutRollupJobRequest request, RequestOptions options)	Put a rollup job into the cluster See the docs for more.
void	putRollupJobAsync(PutRollupJobRequest request, RequestOptions options, ActionListener<PutRollupJobResponse> listener)	Asynchronously put a rollup job into the cluster 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 PutRollupJobResponse 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<PutRollupJobResponse> 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

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

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