Package co.elastic.clients.elasticsearch.rollup

Class ElasticsearchRollupClient

java.lang.Object

co.elastic.clients.base.ApiClient

co.elastic.clients.elasticsearch.rollup.ElasticsearchRollupClient

public class ElasticsearchRollupClient
extends ApiClient

Client for the rollup namespace.

Field Summary

Fields inherited from class co.elastic.clients.base.ApiClient

transport

Constructor Summary

Constructors

Constructor	Description
ElasticsearchRollupClient(Transport transport)

Method Summary

Modifier and Type	Method	Description
DeleteJobResponse	deleteJob(DeleteJobRequest request)	Deletes an existing rollup job.
DeleteJobResponse	deleteJob(java.util.function.Function<DeleteJobRequest.Builder,ObjectBuilder<DeleteJobRequest>> fn)	Deletes an existing rollup job.
GetJobsResponse	getJobs(GetJobsRequest request)	Retrieves the configuration, stats, and status of rollup jobs.
GetJobsResponse	getJobs(java.util.function.Function<GetJobsRequest.Builder,ObjectBuilder<GetJobsRequest>> fn)	Retrieves the configuration, stats, and status of rollup jobs.
GetRollupCapsResponse	getRollupCaps(GetRollupCapsRequest request)	Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.
GetRollupCapsResponse	getRollupCaps(java.util.function.Function<GetRollupCapsRequest.Builder,ObjectBuilder<GetRollupCapsRequest>> fn)	Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.
GetRollupIndexCapsResponse	getRollupIndexCaps(GetRollupIndexCapsRequest request)	Returns the rollup capabilities of all jobs inside of a rollup index (e.g.
GetRollupIndexCapsResponse	getRollupIndexCaps(java.util.function.Function<GetRollupIndexCapsRequest.Builder,ObjectBuilder<GetRollupIndexCapsRequest>> fn)	Returns the rollup capabilities of all jobs inside of a rollup index (e.g.
PutJobResponse	putJob(PutJobRequest request)	Creates a rollup job.
PutJobResponse	putJob(java.util.function.Function<PutJobRequest.Builder,ObjectBuilder<PutJobRequest>> fn)	Creates a rollup job.
RollupResponse	rollup(RollupRequest request)	Rollup an index
RollupResponse	rollup(java.util.function.Function<RollupRequest.Builder,ObjectBuilder<RollupRequest>> fn)	Rollup an index
<TDocument> RollupSearchResponse<TDocument>	rollupSearch(RollupSearchRequest request, java.lang.Class<TDocument> tDocumentClass)	Enables searching rolled-up data using the standard query DSL.
<TDocument> RollupSearchResponse<TDocument>	rollupSearch(java.util.function.Function<RollupSearchRequest.Builder,ObjectBuilder<RollupSearchRequest>> fn, java.lang.Class<TDocument> tDocumentClass)	Enables searching rolled-up data using the standard query DSL.
StartJobResponse	startJob(StartJobRequest request)	Starts an existing, stopped rollup job.
StartJobResponse	startJob(java.util.function.Function<StartJobRequest.Builder,ObjectBuilder<StartJobRequest>> fn)	Starts an existing, stopped rollup job.
StopJobResponse	stopJob(StopJobRequest request)	Stops an existing, started rollup job.
StopJobResponse	stopJob(java.util.function.Function<StopJobRequest.Builder,ObjectBuilder<StopJobRequest>> fn)	Stops an existing, started rollup job.

Methods inherited from class co.elastic.clients.base.ApiClient

_transport, getDeserializer

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchRollupClient

public ElasticsearchRollupClient(Transport transport)

Method Details

deleteJob

public DeleteJobResponse deleteJob(DeleteJobRequest request)
                            throws java.io.IOException

Deletes an existing rollup job.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

deleteJob

public final DeleteJobResponse deleteJob(java.util.function.Function<DeleteJobRequest.Builder,ObjectBuilder<DeleteJobRequest>> fn)
                                  throws java.io.IOException

Deletes an existing rollup job.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getJobs

public GetJobsResponse getJobs(GetJobsRequest request)
                        throws java.io.IOException

Retrieves the configuration, stats, and status of rollup jobs.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getJobs

public final GetJobsResponse getJobs(java.util.function.Function<GetJobsRequest.Builder,ObjectBuilder<GetJobsRequest>> fn)
                              throws java.io.IOException

Retrieves the configuration, stats, and status of rollup jobs.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getRollupCaps

public GetRollupCapsResponse getRollupCaps(GetRollupCapsRequest request)
                                    throws java.io.IOException

Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getRollupCaps

public final GetRollupCapsResponse getRollupCaps(java.util.function.Function<GetRollupCapsRequest.Builder,ObjectBuilder<GetRollupCapsRequest>> fn)
                                          throws java.io.IOException

Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getRollupIndexCaps

public GetRollupIndexCapsResponse getRollupIndexCaps(GetRollupIndexCapsRequest request)
                                              throws java.io.IOException

Returns the rollup capabilities of all jobs inside of a rollup index (e.g. the index where rollup data is stored).

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getRollupIndexCaps

public final GetRollupIndexCapsResponse getRollupIndexCaps(java.util.function.Function<GetRollupIndexCapsRequest.Builder,ObjectBuilder<GetRollupIndexCapsRequest>> fn)
                                                    throws java.io.IOException

Returns the rollup capabilities of all jobs inside of a rollup index (e.g. the index where rollup data is stored).

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

putJob

public PutJobResponse putJob(PutJobRequest request)
                      throws java.io.IOException

Creates a rollup job.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

putJob

public final PutJobResponse putJob(java.util.function.Function<PutJobRequest.Builder,ObjectBuilder<PutJobRequest>> fn)
                            throws java.io.IOException

Creates a rollup job.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

rollup

public RollupResponse rollup(RollupRequest request)
                      throws java.io.IOException

Rollup an index

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

rollup

public final RollupResponse rollup(java.util.function.Function<RollupRequest.Builder,ObjectBuilder<RollupRequest>> fn)
                            throws java.io.IOException

Rollup an index

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

rollupSearch

public <TDocument> RollupSearchResponse<TDocument> rollupSearch(RollupSearchRequest request,
java.lang.Class<TDocument> tDocumentClass)
                                                         throws java.io.IOException

Enables searching rolled-up data using the standard query DSL.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

rollupSearch

public final <TDocument>
RollupSearchResponse<TDocument> rollupSearch(java.util.function.Function<RollupSearchRequest.Builder,ObjectBuilder<RollupSearchRequest>> fn,
java.lang.Class<TDocument> tDocumentClass)
                                      throws java.io.IOException

Enables searching rolled-up data using the standard query DSL.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

startJob

public StartJobResponse startJob(StartJobRequest request)
                          throws java.io.IOException

Starts an existing, stopped rollup job.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

startJob

public final StartJobResponse startJob(java.util.function.Function<StartJobRequest.Builder,ObjectBuilder<StartJobRequest>> fn)
                                throws java.io.IOException

Starts an existing, stopped rollup job.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

stopJob

public StopJobResponse stopJob(StopJobRequest request)
                        throws java.io.IOException

Stops an existing, started rollup job.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

stopJob

public final StopJobResponse stopJob(java.util.function.Function<StopJobRequest.Builder,ObjectBuilder<StopJobRequest>> fn)
                              throws java.io.IOException

Stops an existing, started rollup job.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co