Package co.elastic.clients.elasticsearch.rollup

Class ElasticsearchRollupAsyncClient

java.lang.Object

co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchRollupAsyncClient>

co.elastic.clients.elasticsearch.rollup.ElasticsearchRollupAsyncClient

public class ElasticsearchRollupAsyncClient
extends ApiClient<ElasticsearchTransport,ElasticsearchRollupAsyncClient>

Client for the rollup namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
ElasticsearchRollupAsyncClient(ElasticsearchTransport transport)
ElasticsearchRollupAsyncClient(ElasticsearchTransport transport, TransportOptions transportOptions)

Method Summary

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

Methods inherited from class co.elastic.clients.ApiClient

_transport, _transportOptions, getDeserializer

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchRollupAsyncClient

public ElasticsearchRollupAsyncClient(ElasticsearchTransport transport)

ElasticsearchRollupAsyncClient

public ElasticsearchRollupAsyncClient(ElasticsearchTransport transport,
@Nullable
TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchRollupAsyncClient withTransportOptions(@Nullable
TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchRollupAsyncClient>

deleteJob

public java.util.concurrent.CompletableFuture<DeleteJobResponse> deleteJob(DeleteJobRequest request)
                                                                    throws java.io.IOException,
ElasticsearchException

Deletes an existing rollup job.

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

deleteJob

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

Deletes an existing rollup job.

Parameters:

fn - a function that initializes a builder to create the DeleteJobRequest

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

getJobs

public java.util.concurrent.CompletableFuture<GetJobsResponse> getJobs(GetJobsRequest request)
                                                                throws java.io.IOException,
ElasticsearchException

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

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

getJobs

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

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

Parameters:

fn - a function that initializes a builder to create the GetJobsRequest

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

getJobs

public java.util.concurrent.CompletableFuture<GetJobsResponse> getJobs()
                                                                throws java.io.IOException,
ElasticsearchException

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

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

getRollupCaps

public java.util.concurrent.CompletableFuture<GetRollupCapsResponse> getRollupCaps(GetRollupCapsRequest request)
                                                                            throws java.io.IOException,
ElasticsearchException

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

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

getRollupCaps

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

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 builder to create the GetRollupCapsRequest

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

getRollupCaps

public java.util.concurrent.CompletableFuture<GetRollupCapsResponse> getRollupCaps()
                                                                            throws java.io.IOException,
ElasticsearchException

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

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

getRollupIndexCaps

public java.util.concurrent.CompletableFuture<GetRollupIndexCapsResponse> getRollupIndexCaps(GetRollupIndexCapsRequest request)
                                                                                      throws java.io.IOException,
ElasticsearchException

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

ElasticsearchException

See Also:

Documentation on elastic.co

getRollupIndexCaps

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

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 builder to create the GetRollupIndexCapsRequest

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

putJob

public java.util.concurrent.CompletableFuture<PutJobResponse> putJob(PutJobRequest request)
                                                              throws java.io.IOException,
ElasticsearchException

Creates a rollup job.

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

putJob

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

Creates a rollup job.

Parameters:

fn - a function that initializes a builder to create the PutJobRequest

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

rollup

public java.util.concurrent.CompletableFuture<RollupResponse> rollup(RollupRequest request)
                                                              throws java.io.IOException,
ElasticsearchException

Rollup an index

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

rollup

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

Rollup an index

Parameters:

fn - a function that initializes a builder to create the RollupRequest

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

rollupSearch

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

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

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

rollupSearch

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

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

Parameters:

fn - a function that initializes a builder to create the RollupSearchRequest

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

startJob

public java.util.concurrent.CompletableFuture<StartJobResponse> startJob(StartJobRequest request)
                                                                  throws java.io.IOException,
ElasticsearchException

Starts an existing, stopped rollup job.

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

startJob

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

Starts an existing, stopped rollup job.

Parameters:

fn - a function that initializes a builder to create the StartJobRequest

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

stopJob

public java.util.concurrent.CompletableFuture<StopJobResponse> stopJob(StopJobRequest request)
                                                                throws java.io.IOException,
ElasticsearchException

Stops an existing, started rollup job.

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

stopJob

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

Stops an existing, started rollup job.

Parameters:

fn - a function that initializes a builder to create the StopJobRequest

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co