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

_jsonpMapper, _transport, _transportOptions, getDeserializer, withTransportOptions

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 CompletableFuture<DeleteJobResponse> deleteJob(DeleteJobRequest request)

Deletes an existing rollup job.

See Also:

• Documentation on elastic.co

deleteJob

public final CompletableFuture<DeleteJobResponse> deleteJob(Function<DeleteJobRequest.Builder,ObjectBuilder<DeleteJobRequest>> fn)

Deletes an existing rollup job.

Parameters:

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

See Also:

• Documentation on elastic.co

getJobs

public CompletableFuture<GetJobsResponse> getJobs(GetJobsRequest request)

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

See Also:

• Documentation on elastic.co

getJobs

public final CompletableFuture<GetJobsResponse> getJobs(Function<GetJobsRequest.Builder,ObjectBuilder<GetJobsRequest>> fn)

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

Parameters:

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

See Also:

• Documentation on elastic.co

getJobs

public CompletableFuture<GetJobsResponse> getJobs()

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

See Also:

• Documentation on elastic.co

getRollupCaps

public CompletableFuture<GetRollupCapsResponse> getRollupCaps(GetRollupCapsRequest request)

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

See Also:

• Documentation on elastic.co

getRollupCaps

public final CompletableFuture<GetRollupCapsResponse> getRollupCaps(Function<GetRollupCapsRequest.Builder,ObjectBuilder<GetRollupCapsRequest>> fn)

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

See Also:

• Documentation on elastic.co

getRollupCaps

public CompletableFuture<GetRollupCapsResponse> getRollupCaps()

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

See Also:

• Documentation on elastic.co

getRollupIndexCaps

public CompletableFuture<GetRollupIndexCapsResponse> getRollupIndexCaps(GetRollupIndexCapsRequest request)

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

See Also:

• Documentation on elastic.co

getRollupIndexCaps

public final CompletableFuture<GetRollupIndexCapsResponse> getRollupIndexCaps(Function<GetRollupIndexCapsRequest.Builder,ObjectBuilder<GetRollupIndexCapsRequest>> fn)

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

See Also:

• Documentation on elastic.co

putJob

public CompletableFuture<PutJobResponse> putJob(PutJobRequest request)

Creates a rollup job.

See Also:

• Documentation on elastic.co

putJob

public final CompletableFuture<PutJobResponse> putJob(Function<PutJobRequest.Builder,ObjectBuilder<PutJobRequest>> fn)

Creates a rollup job.

Parameters:

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

See Also:

• Documentation on elastic.co

rollupSearch

public <TDocument>
CompletableFuture<RollupSearchResponse<TDocument>> rollupSearch(RollupSearchRequest request,
 Class<TDocument> tDocumentClass)

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

See Also:

• Documentation on elastic.co

rollupSearch

public final <TDocument>
CompletableFuture<RollupSearchResponse<TDocument>> rollupSearch(Function<RollupSearchRequest.Builder,ObjectBuilder<RollupSearchRequest>> fn,
 Class<TDocument> tDocumentClass)

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

Parameters:

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

See Also:

• Documentation on elastic.co

startJob

public CompletableFuture<StartJobResponse> startJob(StartJobRequest request)

Starts an existing, stopped rollup job.

See Also:

• Documentation on elastic.co

startJob

public final CompletableFuture<StartJobResponse> startJob(Function<StartJobRequest.Builder,ObjectBuilder<StartJobRequest>> fn)

Starts an existing, stopped rollup job.

Parameters:

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

See Also:

• Documentation on elastic.co

stopJob

public CompletableFuture<StopJobResponse> stopJob(StopJobRequest request)

Stops an existing, started rollup job.

See Also:

• Documentation on elastic.co

stopJob

public final CompletableFuture<StopJobResponse> stopJob(Function<StopJobRequest.Builder,ObjectBuilder<StopJobRequest>> fn)

Stops an existing, started rollup job.

Parameters:

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

See Also:

• Documentation on elastic.co