Package co.elastic.clients.elasticsearch.rollup

Class ElasticsearchRollupClient

java.lang.Object

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

co.elastic.clients.elasticsearch.rollup.ElasticsearchRollupClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchRollupClient
extends ApiClient<ElasticsearchTransport,ElasticsearchRollupClient>

Client for the rollup namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, close, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchRollupClient

public ElasticsearchRollupClient(ElasticsearchTransport transport)

ElasticsearchRollupClient

public ElasticsearchRollupClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchRollupClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchRollupClient>

deleteJob

public DeleteJobResponse deleteJob(DeleteJobRequest request)
                            throws IOException,
ElasticsearchException

Deletes an existing rollup job.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteJob

public final DeleteJobResponse deleteJob(Function<DeleteJobRequest.Builder,ObjectBuilder<DeleteJobRequest>> fn)
                                  throws IOException,
ElasticsearchException

Deletes an existing rollup job.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getJobs

public GetJobsResponse getJobs(GetJobsRequest request)
                        throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getJobs

public final GetJobsResponse getJobs(Function<GetJobsRequest.Builder,ObjectBuilder<GetJobsRequest>> fn)
                              throws IOException,
ElasticsearchException

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

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getJobs

public GetJobsResponse getJobs()
                        throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getRollupCaps

public GetRollupCapsResponse getRollupCaps(GetRollupCapsRequest request)
                                    throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getRollupCaps

public final GetRollupCapsResponse getRollupCaps(Function<GetRollupCapsRequest.Builder,ObjectBuilder<GetRollupCapsRequest>> fn)
                                          throws 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:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getRollupCaps

public GetRollupCapsResponse getRollupCaps()
                                    throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getRollupIndexCaps

public GetRollupIndexCapsResponse getRollupIndexCaps(GetRollupIndexCapsRequest request)
                                              throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getRollupIndexCaps

public final GetRollupIndexCapsResponse getRollupIndexCaps(Function<GetRollupIndexCapsRequest.Builder,ObjectBuilder<GetRollupIndexCapsRequest>> fn)
                                                    throws 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:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putJob

public PutJobResponse putJob(PutJobRequest request)
                      throws IOException,
ElasticsearchException

Creates a rollup job.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putJob

public final PutJobResponse putJob(Function<PutJobRequest.Builder,ObjectBuilder<PutJobRequest>> fn)
                            throws IOException,
ElasticsearchException

Creates a rollup job.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

rollup

public RollupResponse rollup(RollupRequest request)
                      throws IOException,
ElasticsearchException

Rollup an index

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

rollup

public final RollupResponse rollup(Function<RollupRequest.Builder,ObjectBuilder<RollupRequest>> fn)
                            throws IOException,
ElasticsearchException

Rollup an index

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

rollupSearch

public <TDocument> RollupSearchResponse<TDocument> rollupSearch(RollupSearchRequest request,
 Class<TDocument> tDocumentClass)
                                                         throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

rollupSearch

public final <TDocument>
RollupSearchResponse<TDocument> rollupSearch(Function<RollupSearchRequest.Builder,ObjectBuilder<RollupSearchRequest>> fn,
 Class<TDocument> tDocumentClass)
                                      throws 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:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

rollupSearch

public <TDocument> RollupSearchResponse<TDocument> rollupSearch(RollupSearchRequest request,
 Type tDocumentType)
                                                         throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

rollupSearch

public final <TDocument>
RollupSearchResponse<TDocument> rollupSearch(Function<RollupSearchRequest.Builder,ObjectBuilder<RollupSearchRequest>> fn,
 Type tDocumentType)
                                      throws 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:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

startJob

public StartJobResponse startJob(StartJobRequest request)
                          throws IOException,
ElasticsearchException

Starts an existing, stopped rollup job.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

startJob

public final StartJobResponse startJob(Function<StartJobRequest.Builder,ObjectBuilder<StartJobRequest>> fn)
                                throws IOException,
ElasticsearchException

Starts an existing, stopped rollup job.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stopJob

public StopJobResponse stopJob(StopJobRequest request)
                        throws IOException,
ElasticsearchException

Stops an existing, started rollup job.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stopJob

public final StopJobResponse stopJob(Function<StopJobRequest.Builder,ObjectBuilder<StopJobRequest>> fn)
                              throws IOException,
ElasticsearchException

Stops an existing, started rollup job.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co