Class ElasticsearchRollupClient
java.lang.Object
co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchRollupClient>
co.elastic.clients.elasticsearch.rollup.ElasticsearchRollupClient
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
ConstructorDescriptionElasticsearchRollupClient
(ElasticsearchTransport transport) ElasticsearchRollupClient
(ElasticsearchTransport transport, TransportOptions transportOptions) -
Method Summary
Modifier and TypeMethodDescriptiondeleteJob
(DeleteJobRequest request) Deletes an existing rollup job.final DeleteJobResponse
Deletes an existing rollup job.getJobs()
Retrieves the configuration, stats, and status of rollup jobs.getJobs
(GetJobsRequest request) Retrieves the configuration, stats, and status of rollup jobs.final GetJobsResponse
Retrieves the configuration, stats, and status of rollup jobs.Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.getRollupCaps
(GetRollupCapsRequest request) Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.final GetRollupCapsResponse
Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.Returns the rollup capabilities of all jobs inside of a rollup index (e.g.getRollupIndexCaps
(Function<GetRollupIndexCapsRequest.Builder, ObjectBuilder<GetRollupIndexCapsRequest>> fn) Returns the rollup capabilities of all jobs inside of a rollup index (e.g.putJob
(PutJobRequest request) Creates a rollup job.final PutJobResponse
Creates a rollup job.<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.startJob
(StartJobRequest request) Starts an existing, stopped rollup job.final StartJobResponse
Starts an existing, stopped rollup job.stopJob
(StopJobRequest request) Stops an existing, started rollup job.final StopJobResponse
Stops an existing, started rollup job.withTransportOptions
(TransportOptions transportOptions) Creates a new client with some request optionsMethods inherited from class co.elastic.clients.ApiClient
_jsonpMapper, _transport, _transportOptions, getDeserializer, withTransportOptions
-
Constructor Details
-
ElasticsearchRollupClient
-
ElasticsearchRollupClient
public ElasticsearchRollupClient(ElasticsearchTransport transport, @Nullable TransportOptions transportOptions)
-
-
Method Details
-
withTransportOptions
Description copied from class:ApiClient
Creates a new client with some request options- Specified by:
withTransportOptions
in classApiClient<ElasticsearchTransport,
ElasticsearchRollupClient>
-
deleteJob
public DeleteJobResponse deleteJob(DeleteJobRequest request) throws IOException, ElasticsearchException Deletes an existing rollup job.- Throws:
IOException
ElasticsearchException
- See Also:
-
deleteJob
public final DeleteJobResponse deleteJob(Function<DeleteJobRequest.Builder, ObjectBuilder<DeleteJobRequest>> fn) throws IOException, ElasticsearchExceptionDeletes an existing rollup job.- Parameters:
fn
- a function that initializes a builder to create theDeleteJobRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
getJobs
Retrieves the configuration, stats, and status of rollup jobs.- Throws:
IOException
ElasticsearchException
- See Also:
-
getJobs
public final GetJobsResponse getJobs(Function<GetJobsRequest.Builder, ObjectBuilder<GetJobsRequest>> fn) throws IOException, ElasticsearchExceptionRetrieves the configuration, stats, and status of rollup jobs.- Parameters:
fn
- a function that initializes a builder to create theGetJobsRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
getJobs
Retrieves the configuration, stats, and status of rollup jobs.- Throws:
IOException
ElasticsearchException
- See Also:
-
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:
-
getRollupCaps
public final GetRollupCapsResponse getRollupCaps(Function<GetRollupCapsRequest.Builder, ObjectBuilder<GetRollupCapsRequest>> fn) throws IOException, ElasticsearchExceptionReturns 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 theGetRollupCapsRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
getRollupCaps
Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.- Throws:
IOException
ElasticsearchException
- See Also:
-
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:
-
getRollupIndexCaps
public final GetRollupIndexCapsResponse getRollupIndexCaps(Function<GetRollupIndexCapsRequest.Builder, ObjectBuilder<GetRollupIndexCapsRequest>> fn) throws IOException, ElasticsearchExceptionReturns 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 theGetRollupIndexCapsRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
putJob
Creates a rollup job.- Throws:
IOException
ElasticsearchException
- See Also:
-
putJob
public final PutJobResponse putJob(Function<PutJobRequest.Builder, ObjectBuilder<PutJobRequest>> fn) throws IOException, ElasticsearchExceptionCreates a rollup job.- Parameters:
fn
- a function that initializes a builder to create thePutJobRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
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:
-
rollupSearch
public final <TDocument> RollupSearchResponse<TDocument> rollupSearch(Function<RollupSearchRequest.Builder, ObjectBuilder<RollupSearchRequest>> fn, Class<TDocument> tDocumentClass) throws IOException, ElasticsearchExceptionEnables searching rolled-up data using the standard query DSL.- Parameters:
fn
- a function that initializes a builder to create theRollupSearchRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
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:
-
rollupSearch
public final <TDocument> RollupSearchResponse<TDocument> rollupSearch(Function<RollupSearchRequest.Builder, ObjectBuilder<RollupSearchRequest>> fn, Type tDocumentType) throws IOException, ElasticsearchExceptionEnables searching rolled-up data using the standard query DSL.- Parameters:
fn
- a function that initializes a builder to create theRollupSearchRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
startJob
public StartJobResponse startJob(StartJobRequest request) throws IOException, ElasticsearchException Starts an existing, stopped rollup job.- Throws:
IOException
ElasticsearchException
- See Also:
-
startJob
public final StartJobResponse startJob(Function<StartJobRequest.Builder, ObjectBuilder<StartJobRequest>> fn) throws IOException, ElasticsearchExceptionStarts an existing, stopped rollup job.- Parameters:
fn
- a function that initializes a builder to create theStartJobRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
stopJob
Stops an existing, started rollup job.- Throws:
IOException
ElasticsearchException
- See Also:
-
stopJob
public final StopJobResponse stopJob(Function<StopJobRequest.Builder, ObjectBuilder<StopJobRequest>> fn) throws IOException, ElasticsearchExceptionStops an existing, started rollup job.- Parameters:
fn
- a function that initializes a builder to create theStopJobRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-