Class MachineLearningClient
public final class MachineLearningClient
extends java.lang.Object
RestHighLevelClient
See the X-Pack Machine Learning APIs for additional information.
-
Method Summary
Modifier and Type Method Description CloseJobResponse
closeJob(CloseJobRequest request, org.elasticsearch.client.RequestOptions options)
Closes one or more Machine Learning Jobs.org.elasticsearch.client.Cancellable
closeJobAsync(CloseJobRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<CloseJobResponse> listener)
Closes one or more Machine Learning Jobs asynchronously, notifies listener on completion A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.org.elasticsearch.action.support.master.AcknowledgedResponse
deleteCalendar(DeleteCalendarRequest request, org.elasticsearch.client.RequestOptions options)
Deletes the given Machine Learning Calendarorg.elasticsearch.client.Cancellable
deleteCalendarAsync(DeleteCalendarRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.support.master.AcknowledgedResponse> listener)
Deletes the given Machine Learning Job asynchronously and notifies the listener on completionorg.elasticsearch.action.support.master.AcknowledgedResponse
deleteCalendarEvent(DeleteCalendarEventRequest request, org.elasticsearch.client.RequestOptions options)
Removes a Scheduled Event from a calendarorg.elasticsearch.client.Cancellable
deleteCalendarEventAsync(DeleteCalendarEventRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.support.master.AcknowledgedResponse> listener)
Removes a Scheduled Event from a calendar, notifies listener when completedPutCalendarResponse
deleteCalendarJob(DeleteCalendarJobRequest request, org.elasticsearch.client.RequestOptions options)
Removes Machine Learning Job(s) from a calendarorg.elasticsearch.client.Cancellable
deleteCalendarJobAsync(DeleteCalendarJobRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PutCalendarResponse> listener)
Removes Machine Learning Job(s) from a calendar, notifies listener when completedorg.elasticsearch.action.support.master.AcknowledgedResponse
deleteDatafeed(DeleteDatafeedRequest request, org.elasticsearch.client.RequestOptions options)
Deletes the given Machine Learning Datafeedorg.elasticsearch.client.Cancellable
deleteDatafeedAsync(DeleteDatafeedRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.support.master.AcknowledgedResponse> listener)
Deletes the given Machine Learning Datafeed asynchronously and notifies the listener on completionorg.elasticsearch.action.support.master.AcknowledgedResponse
deleteDataFrameAnalytics(DeleteDataFrameAnalyticsRequest request, org.elasticsearch.client.RequestOptions options)
Deletes the given Data Frame Analytics configorg.elasticsearch.client.Cancellable
deleteDataFrameAnalyticsAsync(DeleteDataFrameAnalyticsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.support.master.AcknowledgedResponse> listener)
Deletes the given Data Frame Analytics config asynchronously and notifies listener upon completionDeleteExpiredDataResponse
deleteExpiredData(DeleteExpiredDataRequest request, org.elasticsearch.client.RequestOptions options)
Deletes expired data from Machine Learning Jobsorg.elasticsearch.client.Cancellable
deleteExpiredDataAsync(DeleteExpiredDataRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<DeleteExpiredDataResponse> listener)
Deletes expired data from Machine Learning Jobs asynchronously and notifies the listener on completionorg.elasticsearch.action.support.master.AcknowledgedResponse
deleteFilter(DeleteFilterRequest request, org.elasticsearch.client.RequestOptions options)
Deletes the given Machine Learning filterorg.elasticsearch.client.Cancellable
deleteFilterAsync(DeleteFilterRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.support.master.AcknowledgedResponse> listener)
Deletes the given Machine Learning filter asynchronously and notifies the listener on completionorg.elasticsearch.action.support.master.AcknowledgedResponse
deleteForecast(DeleteForecastRequest request, org.elasticsearch.client.RequestOptions options)
Deletes Machine Learning Job Forecastsorg.elasticsearch.client.Cancellable
deleteForecastAsync(DeleteForecastRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.support.master.AcknowledgedResponse> listener)
Deletes Machine Learning Job Forecasts asynchronouslyDeleteJobResponse
deleteJob(DeleteJobRequest request, org.elasticsearch.client.RequestOptions options)
Deletes the given Machine Learning Joborg.elasticsearch.client.Cancellable
deleteJobAsync(DeleteJobRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<DeleteJobResponse> listener)
Deletes the given Machine Learning Job asynchronously and notifies the listener on completionorg.elasticsearch.action.support.master.AcknowledgedResponse
deleteModelSnapshot(DeleteModelSnapshotRequest request, org.elasticsearch.client.RequestOptions options)
Deletes Machine Learning Model Snapshotsorg.elasticsearch.client.Cancellable
deleteModelSnapshotAsync(DeleteModelSnapshotRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.support.master.AcknowledgedResponse> listener)
Deletes Machine Learning Model Snapshots asynchronously and notifies the listener on completionorg.elasticsearch.action.support.master.AcknowledgedResponse
deleteTrainedModel(DeleteTrainedModelRequest request, org.elasticsearch.client.RequestOptions options)
Deletes the given Trained Modelorg.elasticsearch.client.Cancellable
deleteTrainedModelAsync(DeleteTrainedModelRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.support.master.AcknowledgedResponse> listener)
Deletes the given Trained Model asynchronously and notifies listener upon completionEstimateModelMemoryResponse
estimateModelMemory(EstimateModelMemoryRequest request, org.elasticsearch.client.RequestOptions options)
Estimate the model memory an analysis config is likely to need given supplied field cardinalitiesorg.elasticsearch.client.Cancellable
estimateModelMemoryAsync(EstimateModelMemoryRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<EstimateModelMemoryResponse> listener)
Estimate the model memory an analysis config is likely to need given supplied field cardinalities and notifies listener upon completionEvaluateDataFrameResponse
evaluateDataFrame(EvaluateDataFrameRequest request, org.elasticsearch.client.RequestOptions options)
Evaluates the given Data Frameorg.elasticsearch.client.Cancellable
evaluateDataFrameAsync(EvaluateDataFrameRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<EvaluateDataFrameResponse> listener)
Evaluates the given Data Frame asynchronously and notifies listener upon completionExplainDataFrameAnalyticsResponse
explainDataFrameAnalytics(ExplainDataFrameAnalyticsRequest request, org.elasticsearch.client.RequestOptions options)
Explains the given Data Frame Analyticsorg.elasticsearch.client.Cancellable
explainDataFrameAnalyticsAsync(ExplainDataFrameAnalyticsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<ExplainDataFrameAnalyticsResponse> listener)
Explains the given Data Frame Analytics asynchronously and notifies listener upon completionFindFileStructureResponse
findFileStructure(FindFileStructureRequest request, org.elasticsearch.client.RequestOptions options)
Finds the structure of a fileorg.elasticsearch.client.Cancellable
findFileStructureAsync(FindFileStructureRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<FindFileStructureResponse> listener)
Finds the structure of a file asynchronously and notifies the listener on completionFlushJobResponse
flushJob(FlushJobRequest request, org.elasticsearch.client.RequestOptions options)
Flushes internally buffered data for the given Machine Learning Job ensuring all data sent to the has been processed.org.elasticsearch.client.Cancellable
flushJobAsync(FlushJobRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<FlushJobResponse> listener)
Flushes internally buffered data for the given Machine Learning Job asynchronously ensuring all data sent to the has been processed.ForecastJobResponse
forecastJob(ForecastJobRequest request, org.elasticsearch.client.RequestOptions options)
Creates a forecast of an existing, opened Machine Learning Job This predicts the future behavior of a time series by using its historical behavior.org.elasticsearch.client.Cancellable
forecastJobAsync(ForecastJobRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<ForecastJobResponse> listener)
Creates a forecast of an existing, opened Machine Learning Job asynchronously This predicts the future behavior of a time series by using its historical behavior.GetBucketsResponse
getBuckets(GetBucketsRequest request, org.elasticsearch.client.RequestOptions options)
Gets the buckets for a Machine Learning Job.org.elasticsearch.client.Cancellable
getBucketsAsync(GetBucketsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetBucketsResponse> listener)
Gets the buckets for a Machine Learning Job, notifies listener once the requested buckets are retrieved.GetCalendarEventsResponse
getCalendarEvents(GetCalendarEventsRequest request, org.elasticsearch.client.RequestOptions options)
Gets the events for a machine learning calendarorg.elasticsearch.client.Cancellable
getCalendarEventsAsync(GetCalendarEventsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetCalendarEventsResponse> listener)
Gets the events for a a machine learning calendar asynchronously, notifies the listener on completionGetCalendarsResponse
getCalendars(GetCalendarsRequest request, org.elasticsearch.client.RequestOptions options)
Gets a single or multiple calendars.org.elasticsearch.client.Cancellable
getCalendarsAsync(GetCalendarsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetCalendarsResponse> listener)
Gets a single or multiple calendars, notifies listener once the requested records are retrieved.GetCategoriesResponse
getCategories(GetCategoriesRequest request, org.elasticsearch.client.RequestOptions options)
Gets the categories for a Machine Learning Job.org.elasticsearch.client.Cancellable
getCategoriesAsync(GetCategoriesRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetCategoriesResponse> listener)
Gets the categories for a Machine Learning Job, notifies listener once the requested buckets are retrieved.GetDatafeedResponse
getDatafeed(GetDatafeedRequest request, org.elasticsearch.client.RequestOptions options)
Gets one or more Machine Learning datafeed configuration info.org.elasticsearch.client.Cancellable
getDatafeedAsync(GetDatafeedRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetDatafeedResponse> listener)
Gets one or more Machine Learning datafeed configuration info, asynchronously.GetDatafeedStatsResponse
getDatafeedStats(GetDatafeedStatsRequest request, org.elasticsearch.client.RequestOptions options)
Gets statistics for one or more Machine Learning datafeedsorg.elasticsearch.client.Cancellable
getDatafeedStatsAsync(GetDatafeedStatsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetDatafeedStatsResponse> listener)
Gets statistics for one or more Machine Learning datafeeds, asynchronously.GetDataFrameAnalyticsResponse
getDataFrameAnalytics(GetDataFrameAnalyticsRequest request, org.elasticsearch.client.RequestOptions options)
Gets a single or multiple Data Frame Analytics configsorg.elasticsearch.client.Cancellable
getDataFrameAnalyticsAsync(GetDataFrameAnalyticsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetDataFrameAnalyticsResponse> listener)
Gets a single or multiple Data Frame Analytics configs asynchronously and notifies listener upon completionGetDataFrameAnalyticsStatsResponse
getDataFrameAnalyticsStats(GetDataFrameAnalyticsStatsRequest request, org.elasticsearch.client.RequestOptions options)
Gets the running statistics of a Data Frame Analyticsorg.elasticsearch.client.Cancellable
getDataFrameAnalyticsStatsAsync(GetDataFrameAnalyticsStatsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetDataFrameAnalyticsStatsResponse> listener)
Gets the running statistics of a Data Frame Analytics asynchronously and notifies listener upon completionGetFiltersResponse
getFilter(GetFiltersRequest request, org.elasticsearch.client.RequestOptions options)
Gets Machine Learning Filtersorg.elasticsearch.client.Cancellable
getFilterAsync(GetFiltersRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetFiltersResponse> listener)
Gets Machine Learning Filters asynchronously and notifies listener on completionGetInfluencersResponse
getInfluencers(GetInfluencersRequest request, org.elasticsearch.client.RequestOptions options)
Gets the influencers for a Machine Learning Job.org.elasticsearch.client.Cancellable
getInfluencersAsync(GetInfluencersRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetInfluencersResponse> listener)
Gets the influencers for a Machine Learning Job, notifies listener once the requested influencers are retrieved.GetJobResponse
getJob(GetJobRequest request, org.elasticsearch.client.RequestOptions options)
Gets one or more Machine Learning job configuration info.org.elasticsearch.client.Cancellable
getJobAsync(GetJobRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetJobResponse> listener)
Gets one or more Machine Learning job configuration info, asynchronously.GetJobStatsResponse
getJobStats(GetJobStatsRequest request, org.elasticsearch.client.RequestOptions options)
Gets usage statistics for one or more Machine Learning jobsorg.elasticsearch.client.Cancellable
getJobStatsAsync(GetJobStatsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetJobStatsResponse> listener)
Gets usage statistics for one or more Machine Learning jobs, asynchronously.MlInfoResponse
getMlInfo(MlInfoRequest request, org.elasticsearch.client.RequestOptions options)
Gets Machine Learning information about default values and limits.org.elasticsearch.client.Cancellable
getMlInfoAsync(MlInfoRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<MlInfoResponse> listener)
Gets Machine Learning information about default values and limits, asynchronously.GetModelSnapshotsResponse
getModelSnapshots(GetModelSnapshotsRequest request, org.elasticsearch.client.RequestOptions options)
Gets the snapshots for a Machine Learning Job.org.elasticsearch.client.Cancellable
getModelSnapshotsAsync(GetModelSnapshotsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetModelSnapshotsResponse> listener)
Gets the snapshots for a Machine Learning Job, notifies listener once the requested snapshots are retrieved.GetOverallBucketsResponse
getOverallBuckets(GetOverallBucketsRequest request, org.elasticsearch.client.RequestOptions options)
Gets overall buckets for a set of Machine Learning Jobs.org.elasticsearch.client.Cancellable
getOverallBucketsAsync(GetOverallBucketsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetOverallBucketsResponse> listener)
Gets overall buckets for a set of Machine Learning Jobs, notifies listener once the requested buckets are retrieved.GetRecordsResponse
getRecords(GetRecordsRequest request, org.elasticsearch.client.RequestOptions options)
Gets the records for a Machine Learning Job.org.elasticsearch.client.Cancellable
getRecordsAsync(GetRecordsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetRecordsResponse> listener)
Gets the records for a Machine Learning Job, notifies listener once the requested records are retrieved.GetTrainedModelsResponse
getTrainedModels(GetTrainedModelsRequest request, org.elasticsearch.client.RequestOptions options)
Gets trained model configsorg.elasticsearch.client.Cancellable
getTrainedModelsAsync(GetTrainedModelsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetTrainedModelsResponse> listener)
Gets trained model configs asynchronously and notifies listener upon completionGetTrainedModelsStatsResponse
getTrainedModelsStats(GetTrainedModelsStatsRequest request, org.elasticsearch.client.RequestOptions options)
Gets trained model statsorg.elasticsearch.client.Cancellable
getTrainedModelsStatsAsync(GetTrainedModelsStatsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetTrainedModelsStatsResponse> listener)
Gets trained model stats asynchronously and notifies listener upon completionOpenJobResponse
openJob(OpenJobRequest request, org.elasticsearch.client.RequestOptions options)
Opens a Machine Learning Job.org.elasticsearch.client.Cancellable
openJobAsync(OpenJobRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<OpenJobResponse> listener)
Opens a Machine Learning Job asynchronously, notifies listener on completion.PostCalendarEventResponse
postCalendarEvent(PostCalendarEventRequest request, org.elasticsearch.client.RequestOptions options)
Creates new events for a a machine learning calendarorg.elasticsearch.client.Cancellable
postCalendarEventAsync(PostCalendarEventRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PostCalendarEventResponse> listener)
Creates new events for a a machine learning calendar asynchronously, notifies the listener on completionPostDataResponse
postData(PostDataRequest request, org.elasticsearch.client.RequestOptions options)
Sends data to an anomaly detection job for analysis.org.elasticsearch.client.Cancellable
postDataAsync(PostDataRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PostDataResponse> listener)
Sends data to an anomaly detection job for analysis, asynchronouslyPreviewDatafeedResponse
previewDatafeed(PreviewDatafeedRequest request, org.elasticsearch.client.RequestOptions options)
Previews the given Machine Learning Datafeedorg.elasticsearch.client.Cancellable
previewDatafeedAsync(PreviewDatafeedRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PreviewDatafeedResponse> listener)
Previews the given Machine Learning Datafeed asynchronously and notifies the listener on completionPutCalendarResponse
putCalendar(PutCalendarRequest request, org.elasticsearch.client.RequestOptions options)
Create a new machine learning calendarorg.elasticsearch.client.Cancellable
putCalendarAsync(PutCalendarRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PutCalendarResponse> listener)
Create a new machine learning calendar, notifies listener with the created calendarPutCalendarResponse
putCalendarJob(PutCalendarJobRequest request, org.elasticsearch.client.RequestOptions options)
Adds Machine Learning Job(s) to a calendarorg.elasticsearch.client.Cancellable
putCalendarJobAsync(PutCalendarJobRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PutCalendarResponse> listener)
Adds Machine Learning Job(s) to a calendar, notifies listener when completedPutDatafeedResponse
putDatafeed(PutDatafeedRequest request, org.elasticsearch.client.RequestOptions options)
Creates a new Machine Learning Datafeedorg.elasticsearch.client.Cancellable
putDatafeedAsync(PutDatafeedRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PutDatafeedResponse> listener)
Creates a new Machine Learning Datafeed asynchronously and notifies listener on completionPutDataFrameAnalyticsResponse
putDataFrameAnalytics(PutDataFrameAnalyticsRequest request, org.elasticsearch.client.RequestOptions options)
Creates a new Data Frame Analytics configorg.elasticsearch.client.Cancellable
putDataFrameAnalyticsAsync(PutDataFrameAnalyticsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PutDataFrameAnalyticsResponse> listener)
Creates a new Data Frame Analytics config asynchronously and notifies listener upon completionPutFilterResponse
putFilter(PutFilterRequest request, org.elasticsearch.client.RequestOptions options)
Creates a new Machine Learning Filterorg.elasticsearch.client.Cancellable
putFilterAsync(PutFilterRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PutFilterResponse> listener)
Creates a new Machine Learning Filter asynchronously and notifies listener on completionPutJobResponse
putJob(PutJobRequest request, org.elasticsearch.client.RequestOptions options)
Creates a new Machine Learning Joborg.elasticsearch.client.Cancellable
putJobAsync(PutJobRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PutJobResponse> listener)
Creates a new Machine Learning Job asynchronously and notifies listener on completionPutTrainedModelResponse
putTrainedModel(PutTrainedModelRequest request, org.elasticsearch.client.RequestOptions options)
Put trained model configorg.elasticsearch.client.Cancellable
putTrainedModelAsync(PutTrainedModelRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PutTrainedModelResponse> listener)
Put trained model config asynchronously and notifies listener upon completionRevertModelSnapshotResponse
revertModelSnapshot(RevertModelSnapshotRequest request, org.elasticsearch.client.RequestOptions options)
Reverts to a particular Machine Learning Model Snapshotorg.elasticsearch.client.Cancellable
revertModelSnapshotAsync(RevertModelSnapshotRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<RevertModelSnapshotResponse> listener)
Reverts to a particular Machine Learning Model Snapshot asynchronously and notifies the listener on completionorg.elasticsearch.action.support.master.AcknowledgedResponse
setUpgradeMode(SetUpgradeModeRequest request, org.elasticsearch.client.RequestOptions options)
Sets the ML cluster setting upgrade_modeorg.elasticsearch.client.Cancellable
setUpgradeModeAsync(SetUpgradeModeRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.support.master.AcknowledgedResponse> listener)
Sets the ML cluster setting upgrade_mode asynchronouslyStartDatafeedResponse
startDatafeed(StartDatafeedRequest request, org.elasticsearch.client.RequestOptions options)
Starts the given Machine Learning Datafeedorg.elasticsearch.client.Cancellable
startDatafeedAsync(StartDatafeedRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<StartDatafeedResponse> listener)
Starts the given Machine Learning Datafeed asynchronously and notifies the listener on completionStartDataFrameAnalyticsResponse
startDataFrameAnalytics(StartDataFrameAnalyticsRequest request, org.elasticsearch.client.RequestOptions options)
Starts Data Frame Analyticsorg.elasticsearch.client.Cancellable
startDataFrameAnalyticsAsync(StartDataFrameAnalyticsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<StartDataFrameAnalyticsResponse> listener)
Starts Data Frame Analytics asynchronously and notifies listener upon completionStopDatafeedResponse
stopDatafeed(StopDatafeedRequest request, org.elasticsearch.client.RequestOptions options)
Stops the given Machine Learning Datafeedorg.elasticsearch.client.Cancellable
stopDatafeedAsync(StopDatafeedRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<StopDatafeedResponse> listener)
Stops the given Machine Learning Datafeed asynchronously and notifies the listener on completionStopDataFrameAnalyticsResponse
stopDataFrameAnalytics(StopDataFrameAnalyticsRequest request, org.elasticsearch.client.RequestOptions options)
Stops Data Frame Analyticsorg.elasticsearch.client.Cancellable
stopDataFrameAnalyticsAsync(StopDataFrameAnalyticsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<StopDataFrameAnalyticsResponse> listener)
Stops Data Frame Analytics asynchronously and notifies listener upon completionPutDatafeedResponse
updateDatafeed(UpdateDatafeedRequest request, org.elasticsearch.client.RequestOptions options)
Updates a Machine Learning Datafeedorg.elasticsearch.client.Cancellable
updateDatafeedAsync(UpdateDatafeedRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PutDatafeedResponse> listener)
Updates a Machine Learning Datafeed asynchronously and notifies listener on completionPutDataFrameAnalyticsResponse
updateDataFrameAnalytics(UpdateDataFrameAnalyticsRequest request, org.elasticsearch.client.RequestOptions options)
Updates a Data Frame Analytics configorg.elasticsearch.client.Cancellable
updateDataFrameAnalyticsAsync(UpdateDataFrameAnalyticsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PutDataFrameAnalyticsResponse> listener)
Updates a Data Frame Analytics config asynchronously and notifies listener upon completionPutFilterResponse
updateFilter(UpdateFilterRequest request, org.elasticsearch.client.RequestOptions options)
Updates a Machine Learning Filterorg.elasticsearch.client.Cancellable
updateFilterAsync(UpdateFilterRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PutFilterResponse> listener)
Updates a Machine Learning Filter asynchronously and notifies listener on completionPutJobResponse
updateJob(UpdateJobRequest request, org.elasticsearch.client.RequestOptions options)
Updates a Machine LearningJob
org.elasticsearch.client.Cancellable
updateJobAsync(UpdateJobRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PutJobResponse> listener)
Updates a Machine LearningJob
asynchronouslyUpdateModelSnapshotResponse
updateModelSnapshot(UpdateModelSnapshotRequest request, org.elasticsearch.client.RequestOptions options)
Updates a snapshot for a Machine Learning Job.org.elasticsearch.client.Cancellable
updateModelSnapshotAsync(UpdateModelSnapshotRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<UpdateModelSnapshotResponse> listener)
Updates a snapshot for a Machine Learning Job, notifies listener once the requested snapshots are retrieved.
-
Method Details
-
putJob
public PutJobResponse putJob(PutJobRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionCreates a new Machine Learning JobFor additional info see ML PUT job documentation
- Parameters:
request
- The PutJobRequest containing theJob
settingsoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- PutJobResponse with enclosed
Job
object - Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
putJobAsync
public org.elasticsearch.client.Cancellable putJobAsync(PutJobRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PutJobResponse> listener)Creates a new Machine Learning Job asynchronously and notifies listener on completionFor additional info see ML PUT job documentation
- Parameters:
request
- The request containing theJob
settingsoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
getJob
public GetJobResponse getJob(GetJobRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionGets one or more Machine Learning job configuration info.For additional info see ML GET job documentation
- Parameters:
request
-GetJobRequest
Request containing a list of jobId(s) and additional optionsoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
GetJobResponse
response object containing theJob
objects and the number of jobs found- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
getJobAsync
public org.elasticsearch.client.Cancellable getJobAsync(GetJobRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetJobResponse> listener)Gets one or more Machine Learning job configuration info, asynchronously.For additional info see ML GET job documentation
- Parameters:
request
-GetJobRequest
Request containing a list of jobId(s) and additional optionsoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified withGetJobResponse
upon request completion- Returns:
- cancellable that may be used to cancel the request
-
getJobStats
public GetJobStatsResponse getJobStats(GetJobStatsRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionGets usage statistics for one or more Machine Learning jobsFor additional info see Get job stats docs
- Parameters:
request
-GetJobStatsRequest
Request containing a list of jobId(s) and additional optionsoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
GetJobStatsResponse
response object containing theJobStats
objects and the number of jobs found- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
getJobStatsAsync
public org.elasticsearch.client.Cancellable getJobStatsAsync(GetJobStatsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetJobStatsResponse> listener)Gets usage statistics for one or more Machine Learning jobs, asynchronously.For additional info see Get job stats docs
- Parameters:
request
-GetJobStatsRequest
Request containing a list of jobId(s) and additional optionsoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified withGetJobStatsResponse
upon request completion- Returns:
- cancellable that may be used to cancel the request
-
deleteExpiredData
public DeleteExpiredDataResponse deleteExpiredData(DeleteExpiredDataRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionDeletes expired data from Machine Learning JobsFor additional info see ML Delete Expired Data documentation
- Parameters:
request
- The request to delete expired ML dataoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- The action response which contains the acknowledgement or the task id depending on whether the action was set to wait for completion
- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
deleteExpiredDataAsync
public org.elasticsearch.client.Cancellable deleteExpiredDataAsync(DeleteExpiredDataRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<DeleteExpiredDataResponse> listener)Deletes expired data from Machine Learning Jobs asynchronously and notifies the listener on completionFor additional info see ML Delete Expired Data documentation
- Parameters:
request
- The request to delete expired ML dataoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
deleteJob
public DeleteJobResponse deleteJob(DeleteJobRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionDeletes the given Machine Learning JobFor additional info see ML Delete job documentation
- Parameters:
request
- The request to delete the joboptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- The action response which contains the acknowledgement or the task id depending on whether the action was set to wait for completion
- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
deleteJobAsync
public org.elasticsearch.client.Cancellable deleteJobAsync(DeleteJobRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<DeleteJobResponse> listener)Deletes the given Machine Learning Job asynchronously and notifies the listener on completionFor additional info see ML Delete Job documentation
- Parameters:
request
- The request to delete the joboptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
openJob
public OpenJobResponse openJob(OpenJobRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionOpens a Machine Learning Job. When you open a new job, it starts with an empty model. When you open an existing job, the most recent model state is automatically loaded. The job is ready to resume its analysis from where it left off, once new data is received.For additional info see ML Open Job documentation
- Parameters:
request
- Request containing job_id and additional optional optionsoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- response containing if the job was successfully opened or not.
- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
openJobAsync
public org.elasticsearch.client.Cancellable openJobAsync(OpenJobRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<OpenJobResponse> listener)Opens a Machine Learning Job asynchronously, notifies listener on completion. When you open a new job, it starts with an empty model. When you open an existing job, the most recent model state is automatically loaded. The job is ready to resume its analysis from where it left off, once new data is received.For additional info see ML Open Job documentation
- Parameters:
request
- Request containing job_id and additional optional optionsoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
closeJob
public CloseJobResponse closeJob(CloseJobRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionCloses one or more Machine Learning Jobs. A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.For additional info see ML Close Job documentation
- Parameters:
request
- Request containing job_ids and additional options. SeeCloseJobRequest
options
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- response containing if the job was successfully closed or not.
- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
closeJobAsync
public org.elasticsearch.client.Cancellable closeJobAsync(CloseJobRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<CloseJobResponse> listener)Closes one or more Machine Learning Jobs asynchronously, notifies listener on completion A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.For additional info see ML Close Job documentation
- Parameters:
request
- Request containing job_ids and additional options. SeeCloseJobRequest
options
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
flushJob
public FlushJobResponse flushJob(FlushJobRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionFlushes internally buffered data for the given Machine Learning Job ensuring all data sent to the has been processed. This may cause new results to be calculated depending on the contents of the buffer Both flush and close operations are similar, however the flush is more efficient if you are expecting to send more data for analysis. When flushing, the job remains open and is available to continue analyzing data. A close operation additionally prunes and persists the model state to disk and the job must be opened again before analyzing further data.For additional info see Flush ML job documentation
- Parameters:
request
- TheFlushJobRequest
object enclosing the `jobId` and additional request optionsoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
flushJobAsync
public org.elasticsearch.client.Cancellable flushJobAsync(FlushJobRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<FlushJobResponse> listener)Flushes internally buffered data for the given Machine Learning Job asynchronously ensuring all data sent to the has been processed. This may cause new results to be calculated depending on the contents of the buffer Both flush and close operations are similar, however the flush is more efficient if you are expecting to send more data for analysis. When flushing, the job remains open and is available to continue analyzing data. A close operation additionally prunes and persists the model state to disk and the job must be opened again before analyzing further data.For additional info see Flush ML job documentation
- Parameters:
request
- TheFlushJobRequest
object enclosing the `jobId` and additional request optionsoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
forecastJob
public ForecastJobResponse forecastJob(ForecastJobRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionCreates a forecast of an existing, opened Machine Learning Job This predicts the future behavior of a time series by using its historical behavior.For additional info see Forecast ML Job Documentation
- Parameters:
request
- ForecastJobRequest with forecasting optionsoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- response containing forecast acknowledgement and new forecast's ID
- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
forecastJobAsync
public org.elasticsearch.client.Cancellable forecastJobAsync(ForecastJobRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<ForecastJobResponse> listener)Creates a forecast of an existing, opened Machine Learning Job asynchronously This predicts the future behavior of a time series by using its historical behavior.For additional info see Forecast ML Job Documentation
- Parameters:
request
- ForecastJobRequest with forecasting optionsoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
deleteForecast
public org.elasticsearch.action.support.master.AcknowledgedResponse deleteForecast(DeleteForecastRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionDeletes Machine Learning Job ForecastsFor additional info see Delete Job Forecast Documentation
- Parameters:
request
- theDeleteForecastRequest
object enclosing the desired jobId, forecastIDs, and other optionsoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- a AcknowledgedResponse object indicating request success
- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
deleteForecastAsync
public org.elasticsearch.client.Cancellable deleteForecastAsync(DeleteForecastRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.support.master.AcknowledgedResponse> listener)Deletes Machine Learning Job Forecasts asynchronouslyFor additional info see Delete Job Forecast Documentation
- Parameters:
request
- theDeleteForecastRequest
object enclosing the desired jobId, forecastIDs, and other optionsoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
deleteModelSnapshot
public org.elasticsearch.action.support.master.AcknowledgedResponse deleteModelSnapshot(DeleteModelSnapshotRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionDeletes Machine Learning Model SnapshotsFor additional info see ML Delete Model Snapshot documentation
- Parameters:
request
- The request to delete the model snapshotoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- action acknowledgement
- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
deleteModelSnapshotAsync
public org.elasticsearch.client.Cancellable deleteModelSnapshotAsync(DeleteModelSnapshotRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.support.master.AcknowledgedResponse> listener)Deletes Machine Learning Model Snapshots asynchronously and notifies the listener on completionFor additional info see ML Delete Model Snapshot documentation
- Parameters:
request
- The request to delete the model snapshotoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
revertModelSnapshot
public RevertModelSnapshotResponse revertModelSnapshot(RevertModelSnapshotRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionReverts to a particular Machine Learning Model SnapshotFor additional info see ML Revert Model Snapshot documentation
- Parameters:
request
- The request to revert to a previous model snapshotoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- action acknowledgement
- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
revertModelSnapshotAsync
public org.elasticsearch.client.Cancellable revertModelSnapshotAsync(RevertModelSnapshotRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<RevertModelSnapshotResponse> listener)Reverts to a particular Machine Learning Model Snapshot asynchronously and notifies the listener on completionFor additional info see ML Revert Model Snapshot documentation
- Parameters:
request
- The request to revert to a previous model snapshotoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
putDatafeed
public PutDatafeedResponse putDatafeed(PutDatafeedRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionCreates a new Machine Learning DatafeedFor additional info see ML PUT datafeed documentation
- Parameters:
request
- The PutDatafeedRequest containing theDatafeedConfig
settingsoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- PutDatafeedResponse with enclosed
DatafeedConfig
object - Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
putDatafeedAsync
public org.elasticsearch.client.Cancellable putDatafeedAsync(PutDatafeedRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PutDatafeedResponse> listener)Creates a new Machine Learning Datafeed asynchronously and notifies listener on completionFor additional info see ML PUT datafeed documentation
- Parameters:
request
- The request containing theDatafeedConfig
settingsoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
updateDatafeed
public PutDatafeedResponse updateDatafeed(UpdateDatafeedRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionUpdates a Machine Learning DatafeedFor additional info see ML Update datafeed documentation
- Parameters:
request
- The UpdateDatafeedRequest containing theDatafeedUpdate
settingsoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- PutDatafeedResponse with enclosed, updated
DatafeedConfig
object - Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
updateDatafeedAsync
public org.elasticsearch.client.Cancellable updateDatafeedAsync(UpdateDatafeedRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PutDatafeedResponse> listener)Updates a Machine Learning Datafeed asynchronously and notifies listener on completionFor additional info see ML Update datafeed documentation
- Parameters:
request
- The request containing theDatafeedUpdate
settingsoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
getDatafeed
public GetDatafeedResponse getDatafeed(GetDatafeedRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionGets one or more Machine Learning datafeed configuration info.For additional info see ML GET datafeed documentation
- Parameters:
request
-GetDatafeedRequest
Request containing a list of datafeedId(s) and additional optionsoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
GetDatafeedResponse
response object containing theDatafeedConfig
objects and the number of jobs found- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
getDatafeedAsync
public org.elasticsearch.client.Cancellable getDatafeedAsync(GetDatafeedRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetDatafeedResponse> listener)Gets one or more Machine Learning datafeed configuration info, asynchronously.For additional info see ML GET datafeed documentation
- Parameters:
request
-GetDatafeedRequest
Request containing a list of datafeedId(s) and additional optionsoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified withGetDatafeedResponse
upon request completion- Returns:
- cancellable that may be used to cancel the request
-
deleteDatafeed
public org.elasticsearch.action.support.master.AcknowledgedResponse deleteDatafeed(DeleteDatafeedRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionDeletes the given Machine Learning DatafeedFor additional info see ML Delete Datafeed documentation
- Parameters:
request
- The request to delete the datafeedoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- action acknowledgement
- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
deleteDatafeedAsync
public org.elasticsearch.client.Cancellable deleteDatafeedAsync(DeleteDatafeedRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.support.master.AcknowledgedResponse> listener)Deletes the given Machine Learning Datafeed asynchronously and notifies the listener on completionFor additional info see ML Delete Datafeed documentation
- Parameters:
request
- The request to delete the datafeedoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
startDatafeed
public StartDatafeedResponse startDatafeed(StartDatafeedRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionStarts the given Machine Learning DatafeedFor additional info see ML Start Datafeed documentation
- Parameters:
request
- The request to start the datafeedoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- action acknowledgement
- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
startDatafeedAsync
public org.elasticsearch.client.Cancellable startDatafeedAsync(StartDatafeedRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<StartDatafeedResponse> listener)Starts the given Machine Learning Datafeed asynchronously and notifies the listener on completionFor additional info see ML Start Datafeed documentation
- Parameters:
request
- The request to start the datafeedoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
stopDatafeed
public StopDatafeedResponse stopDatafeed(StopDatafeedRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionStops the given Machine Learning DatafeedFor additional info see ML Stop Datafeed documentation
- Parameters:
request
- The request to stop the datafeedoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- action acknowledgement
- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
stopDatafeedAsync
public org.elasticsearch.client.Cancellable stopDatafeedAsync(StopDatafeedRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<StopDatafeedResponse> listener)Stops the given Machine Learning Datafeed asynchronously and notifies the listener on completionFor additional info see ML Stop Datafeed documentation
- Parameters:
request
- The request to stop the datafeedoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
getDatafeedStats
public GetDatafeedStatsResponse getDatafeedStats(GetDatafeedStatsRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionGets statistics for one or more Machine Learning datafeedsFor additional info see Get datafeed stats docs
- Parameters:
request
-GetDatafeedStatsRequest
Request containing a list of datafeedId(s) and additional optionsoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
GetDatafeedStatsResponse
response object containing theDatafeedStats
objects and the number of datafeeds found- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
previewDatafeed
public PreviewDatafeedResponse previewDatafeed(PreviewDatafeedRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionPreviews the given Machine Learning DatafeedFor additional info see ML Preview Datafeed documentation
- Parameters:
request
- The request to preview the datafeedoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
PreviewDatafeedResponse
object containing aBytesReference
of the data in JSON format- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
getDatafeedStatsAsync
public org.elasticsearch.client.Cancellable getDatafeedStatsAsync(GetDatafeedStatsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetDatafeedStatsResponse> listener)Gets statistics for one or more Machine Learning datafeeds, asynchronously.For additional info see Get datafeed stats docs
- Parameters:
request
-GetDatafeedStatsRequest
Request containing a list of datafeedId(s) and additional optionsoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified withGetDatafeedStatsResponse
upon request completion- Returns:
- cancellable that may be used to cancel the request
-
previewDatafeedAsync
public org.elasticsearch.client.Cancellable previewDatafeedAsync(PreviewDatafeedRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PreviewDatafeedResponse> listener)Previews the given Machine Learning Datafeed asynchronously and notifies the listener on completionFor additional info see ML Preview Datafeed documentation
- Parameters:
request
- The request to preview the datafeedoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
updateJob
public PutJobResponse updateJob(UpdateJobRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionUpdates a Machine LearningJob
For additional info see ML Update Job Documentation
- Parameters:
request
- theUpdateJobRequest
object enclosing the desired updatesoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- a PutJobResponse object containing the updated job object
- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
updateJobAsync
public org.elasticsearch.client.Cancellable updateJobAsync(UpdateJobRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PutJobResponse> listener)Updates a Machine LearningJob
asynchronouslyFor additional info see ML Update Job Documentation
- Parameters:
request
- theUpdateJobRequest
object enclosing the desired updatesoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
getBuckets
public GetBucketsResponse getBuckets(GetBucketsRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionGets the buckets for a Machine Learning Job.For additional info see ML GET buckets documentation
- Parameters:
request
- The requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Throws:
java.io.IOException
-
getBucketsAsync
public org.elasticsearch.client.Cancellable getBucketsAsync(GetBucketsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetBucketsResponse> listener)Gets the buckets for a Machine Learning Job, notifies listener once the requested buckets are retrieved.For additional info see ML GET buckets documentation
- Parameters:
request
- The requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
getCategories
public GetCategoriesResponse getCategories(GetCategoriesRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionGets the categories for a Machine Learning Job.For additional info see ML GET categories documentation
- Parameters:
request
- The requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
getCategoriesAsync
public org.elasticsearch.client.Cancellable getCategoriesAsync(GetCategoriesRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetCategoriesResponse> listener)Gets the categories for a Machine Learning Job, notifies listener once the requested buckets are retrieved.For additional info see ML GET categories documentation
- Parameters:
request
- The requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
getModelSnapshots
public GetModelSnapshotsResponse getModelSnapshots(GetModelSnapshotsRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionGets the snapshots for a Machine Learning Job.For additional info see ML GET model snapshots documentation
- Parameters:
request
- The requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
getModelSnapshotsAsync
public org.elasticsearch.client.Cancellable getModelSnapshotsAsync(GetModelSnapshotsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetModelSnapshotsResponse> listener)Gets the snapshots for a Machine Learning Job, notifies listener once the requested snapshots are retrieved.For additional info see ML GET model snapshots documentation
- Parameters:
request
- The requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
updateModelSnapshot
public UpdateModelSnapshotResponse updateModelSnapshot(UpdateModelSnapshotRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionUpdates a snapshot for a Machine Learning Job.For additional info see ML UPDATE model snapshots documentation
- Parameters:
request
- The requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
updateModelSnapshotAsync
public org.elasticsearch.client.Cancellable updateModelSnapshotAsync(UpdateModelSnapshotRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<UpdateModelSnapshotResponse> listener)Updates a snapshot for a Machine Learning Job, notifies listener once the requested snapshots are retrieved.For additional info see ML UPDATE model snapshots documentation
- Parameters:
request
- The requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
getOverallBuckets
public GetOverallBucketsResponse getOverallBuckets(GetOverallBucketsRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionGets overall buckets for a set of Machine Learning Jobs.For additional info see ML GET overall buckets documentation
- Parameters:
request
- The requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Throws:
java.io.IOException
-
getOverallBucketsAsync
public org.elasticsearch.client.Cancellable getOverallBucketsAsync(GetOverallBucketsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetOverallBucketsResponse> listener)Gets overall buckets for a set of Machine Learning Jobs, notifies listener once the requested buckets are retrieved.For additional info see ML GET overall buckets documentation
- Parameters:
request
- The requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
getRecords
public GetRecordsResponse getRecords(GetRecordsRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionGets the records for a Machine Learning Job.For additional info see ML GET records documentation
- Parameters:
request
- the requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Throws:
java.io.IOException
-
getRecordsAsync
public org.elasticsearch.client.Cancellable getRecordsAsync(GetRecordsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetRecordsResponse> listener)Gets the records for a Machine Learning Job, notifies listener once the requested records are retrieved.For additional info see ML GET records documentation
- Parameters:
request
- the requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
postData
public PostDataResponse postData(PostDataRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionSends data to an anomaly detection job for analysis.NOTE: The job must have a state of open to receive and process the data.
For additional info see ML POST Data documentation
- Parameters:
request
- PostDataRequest containing the data to post and some additional optionsoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- response containing operational progress about the job
- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
postDataAsync
public org.elasticsearch.client.Cancellable postDataAsync(PostDataRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PostDataResponse> listener)Sends data to an anomaly detection job for analysis, asynchronouslyNOTE: The job must have a state of open to receive and process the data.
For additional info see ML POST Data documentation
- Parameters:
request
- PostDataRequest containing the data to post and some additional optionsoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
getCalendars
public GetCalendarsResponse getCalendars(GetCalendarsRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionGets a single or multiple calendars.For additional info see ML GET calendars documentation
- Parameters:
request
- The calendars requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
GetCalendarsResponse
response object containing theCalendar
objects and the number of calendars found- Throws:
java.io.IOException
-
getCalendarsAsync
public org.elasticsearch.client.Cancellable getCalendarsAsync(GetCalendarsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetCalendarsResponse> listener)Gets a single or multiple calendars, notifies listener once the requested records are retrieved.For additional info see ML GET calendars documentation
- Parameters:
request
- The calendars requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
getInfluencers
public GetInfluencersResponse getInfluencers(GetInfluencersRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionGets the influencers for a Machine Learning Job.For additional info see ML GET influencers documentation
- Parameters:
request
- the requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Throws:
java.io.IOException
-
getInfluencersAsync
public org.elasticsearch.client.Cancellable getInfluencersAsync(GetInfluencersRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetInfluencersResponse> listener)Gets the influencers for a Machine Learning Job, notifies listener once the requested influencers are retrieved.For additional info * see ML GET influencers documentation
- Parameters:
request
- the requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
putCalendar
public PutCalendarResponse putCalendar(PutCalendarRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionCreate a new machine learning calendarFor additional info see ML create calendar documentation
- Parameters:
request
- The requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- The
PutCalendarResponse
containing the calendar - Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
putCalendarAsync
public org.elasticsearch.client.Cancellable putCalendarAsync(PutCalendarRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PutCalendarResponse> listener)Create a new machine learning calendar, notifies listener with the created calendarFor additional info see ML create calendar documentation
- Parameters:
request
- The requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
putCalendarJob
public PutCalendarResponse putCalendarJob(PutCalendarJobRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionAdds Machine Learning Job(s) to a calendarFor additional info see ML Put calendar job documentation
- Parameters:
request
- The requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- The
PutCalendarResponse
containing the updated calendar - Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
putCalendarJobAsync
public org.elasticsearch.client.Cancellable putCalendarJobAsync(PutCalendarJobRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PutCalendarResponse> listener)Adds Machine Learning Job(s) to a calendar, notifies listener when completedFor additional info see ML Put calendar job documentation
- Parameters:
request
- The requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
deleteCalendarJob
public PutCalendarResponse deleteCalendarJob(DeleteCalendarJobRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionRemoves Machine Learning Job(s) from a calendarFor additional info see ML Delete calendar job documentation
- Parameters:
request
- The requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- The
PutCalendarResponse
containing the updated calendar - Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
deleteCalendarJobAsync
public org.elasticsearch.client.Cancellable deleteCalendarJobAsync(DeleteCalendarJobRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PutCalendarResponse> listener)Removes Machine Learning Job(s) from a calendar, notifies listener when completedFor additional info see ML Delete calendar job documentation
- Parameters:
request
- The requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
deleteCalendar
public org.elasticsearch.action.support.master.AcknowledgedResponse deleteCalendar(DeleteCalendarRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionDeletes the given Machine Learning CalendarFor additional info see ML Delete calendar documentation
- Parameters:
request
- The request to delete the calendaroptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- action acknowledgement
- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
deleteCalendarAsync
public org.elasticsearch.client.Cancellable deleteCalendarAsync(DeleteCalendarRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.support.master.AcknowledgedResponse> listener)Deletes the given Machine Learning Job asynchronously and notifies the listener on completionFor additional info see ML Delete calendar documentation
- Parameters:
request
- The request to delete the calendaroptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
getCalendarEvents
public GetCalendarEventsResponse getCalendarEvents(GetCalendarEventsRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionGets the events for a machine learning calendarFor additional info see GET Calendar Events API
- Parameters:
request
- The requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- The
PostCalendarEventRequest
containing the scheduled events - Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
getCalendarEventsAsync
public org.elasticsearch.client.Cancellable getCalendarEventsAsync(GetCalendarEventsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetCalendarEventsResponse> listener)Gets the events for a a machine learning calendar asynchronously, notifies the listener on completionFor additional info see GET Calendar Events API
- Parameters:
request
- The requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
postCalendarEvent
public PostCalendarEventResponse postCalendarEvent(PostCalendarEventRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionCreates new events for a a machine learning calendarFor additional info see Add Events to Calendar API
- Parameters:
request
- The requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- The
PostCalendarEventRequest
containing the scheduled events - Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
postCalendarEventAsync
public org.elasticsearch.client.Cancellable postCalendarEventAsync(PostCalendarEventRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PostCalendarEventResponse> listener)Creates new events for a a machine learning calendar asynchronously, notifies the listener on completionFor additional info see Add Events to Calendar API
- Parameters:
request
- The requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
deleteCalendarEvent
public org.elasticsearch.action.support.master.AcknowledgedResponse deleteCalendarEvent(DeleteCalendarEventRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionRemoves a Scheduled Event from a calendarFor additional info see ML Delete calendar event documentation
- Parameters:
request
- The requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- The
PutCalendarResponse
containing the updated calendar - Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
deleteCalendarEventAsync
public org.elasticsearch.client.Cancellable deleteCalendarEventAsync(DeleteCalendarEventRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.support.master.AcknowledgedResponse> listener)Removes a Scheduled Event from a calendar, notifies listener when completedFor additional info see ML Delete calendar event documentation
- Parameters:
request
- The requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
putFilter
public PutFilterResponse putFilter(PutFilterRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionCreates a new Machine Learning FilterFor additional info see ML PUT Filter documentation
- Parameters:
request
- The PutFilterRequest containing theMlFilter
settingsoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- PutFilterResponse with enclosed
MlFilter
object - Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
putFilterAsync
public org.elasticsearch.client.Cancellable putFilterAsync(PutFilterRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PutFilterResponse> listener)Creates a new Machine Learning Filter asynchronously and notifies listener on completionFor additional info see ML PUT Filter documentation
- Parameters:
request
- The request containing theMlFilter
settingsoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
getFilter
public GetFiltersResponse getFilter(GetFiltersRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionGets Machine Learning FiltersFor additional info see ML GET Filter documentation
- Parameters:
request
- The requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- GetFilterResponse with enclosed
MlFilter
objects - Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
getFilterAsync
public org.elasticsearch.client.Cancellable getFilterAsync(GetFiltersRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetFiltersResponse> listener)Gets Machine Learning Filters asynchronously and notifies listener on completionFor additional info see ML GET Filter documentation
- Parameters:
request
- The requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
updateFilter
public PutFilterResponse updateFilter(UpdateFilterRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionUpdates a Machine Learning FilterFor additional info see ML Update Filter documentation
- Parameters:
request
- The requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- PutFilterResponse with the updated
MlFilter
object - Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
updateFilterAsync
public org.elasticsearch.client.Cancellable updateFilterAsync(UpdateFilterRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PutFilterResponse> listener)Updates a Machine Learning Filter asynchronously and notifies listener on completionFor additional info see ML Update Filter documentation
- Parameters:
request
- The requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
deleteFilter
public org.elasticsearch.action.support.master.AcknowledgedResponse deleteFilter(DeleteFilterRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionDeletes the given Machine Learning filterFor additional info see ML Delete Filter documentation
- Parameters:
request
- The request to delete the filteroptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- action acknowledgement
- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
deleteFilterAsync
public org.elasticsearch.client.Cancellable deleteFilterAsync(DeleteFilterRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.support.master.AcknowledgedResponse> listener)Deletes the given Machine Learning filter asynchronously and notifies the listener on completionFor additional info see ML Delete Filter documentation
- Parameters:
request
- The request to delete the filteroptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
getMlInfo
public MlInfoResponse getMlInfo(MlInfoRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionGets Machine Learning information about default values and limits.For additional info see Machine Learning info
- Parameters:
request
- The request of Machine Learning infooptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- response info about default values and limits
- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
getMlInfoAsync
public org.elasticsearch.client.Cancellable getMlInfoAsync(MlInfoRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<MlInfoResponse> listener)Gets Machine Learning information about default values and limits, asynchronously.For additional info see Machine Learning info
- Parameters:
request
- The request of Machine Learning infooptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
findFileStructure
public FindFileStructureResponse findFileStructure(FindFileStructureRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionFinds the structure of a fileFor additional info see ML Find File Structure documentation
- Parameters:
request
- The find file structure requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- the response containing details of the file structure
- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
findFileStructureAsync
public org.elasticsearch.client.Cancellable findFileStructureAsync(FindFileStructureRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<FindFileStructureResponse> listener)Finds the structure of a file asynchronously and notifies the listener on completionFor additional info see ML Find File Structure documentation
- Parameters:
request
- The find file structure requestoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
setUpgradeMode
public org.elasticsearch.action.support.master.AcknowledgedResponse setUpgradeMode(SetUpgradeModeRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionSets the ML cluster setting upgrade_modeFor additional info see Set Upgrade Mode
- Parameters:
request
- The request to set upgrade modeoptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- response
- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
setUpgradeModeAsync
public org.elasticsearch.client.Cancellable setUpgradeModeAsync(SetUpgradeModeRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.support.master.AcknowledgedResponse> listener)Sets the ML cluster setting upgrade_mode asynchronouslyFor additional info see Set Upgrade Mode
- Parameters:
request
- The request of Machine Learning infooptions
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
estimateModelMemory
public EstimateModelMemoryResponse estimateModelMemory(EstimateModelMemoryRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionEstimate the model memory an analysis config is likely to need given supplied field cardinalitiesFor additional info see Estimate Model Memory
- Parameters:
request
- TheEstimateModelMemoryRequest
options
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
EstimateModelMemoryResponse
response object- Throws:
java.io.IOException
-
estimateModelMemoryAsync
public org.elasticsearch.client.Cancellable estimateModelMemoryAsync(EstimateModelMemoryRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<EstimateModelMemoryResponse> listener)Estimate the model memory an analysis config is likely to need given supplied field cardinalities and notifies listener upon completionFor additional info see Estimate Model Memory
- Parameters:
request
- TheEstimateModelMemoryRequest
options
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
putDataFrameAnalytics
public PutDataFrameAnalyticsResponse putDataFrameAnalytics(PutDataFrameAnalyticsRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionCreates a new Data Frame Analytics configFor additional info see PUT Data Frame Analytics documentation
- Parameters:
request
- ThePutDataFrameAnalyticsRequest
containing theDataFrameAnalyticsConfig
options
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- The
PutDataFrameAnalyticsResponse
containing the createdDataFrameAnalyticsConfig
- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
putDataFrameAnalyticsAsync
public org.elasticsearch.client.Cancellable putDataFrameAnalyticsAsync(PutDataFrameAnalyticsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PutDataFrameAnalyticsResponse> listener)Creates a new Data Frame Analytics config asynchronously and notifies listener upon completionFor additional info see PUT Data Frame Analytics documentation
- Parameters:
request
- ThePutDataFrameAnalyticsRequest
containing theDataFrameAnalyticsConfig
options
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
updateDataFrameAnalytics
public PutDataFrameAnalyticsResponse updateDataFrameAnalytics(UpdateDataFrameAnalyticsRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionUpdates a Data Frame Analytics configFor additional info see PUT Data Frame Analytics documentation
- Parameters:
request
- TheUpdateDataFrameAnalyticsRequest
containing theDataFrameAnalyticsConfigUpdate
options
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- The
PutDataFrameAnalyticsResponse
containing the updatedDataFrameAnalyticsConfig
- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
updateDataFrameAnalyticsAsync
public org.elasticsearch.client.Cancellable updateDataFrameAnalyticsAsync(UpdateDataFrameAnalyticsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PutDataFrameAnalyticsResponse> listener)Updates a Data Frame Analytics config asynchronously and notifies listener upon completionFor additional info see Update Data Frame Analytics documentation
- Parameters:
request
- TheUpdateDataFrameAnalyticsRequest
containing theDataFrameAnalyticsConfigUpdate
options
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
getDataFrameAnalytics
public GetDataFrameAnalyticsResponse getDataFrameAnalytics(GetDataFrameAnalyticsRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionGets a single or multiple Data Frame Analytics configsFor additional info see GET Data Frame Analytics documentation
- Parameters:
request
- TheGetDataFrameAnalyticsRequest
options
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
GetDataFrameAnalyticsResponse
response object containing theDataFrameAnalyticsConfig
objects- Throws:
java.io.IOException
-
getDataFrameAnalyticsAsync
public org.elasticsearch.client.Cancellable getDataFrameAnalyticsAsync(GetDataFrameAnalyticsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetDataFrameAnalyticsResponse> listener)Gets a single or multiple Data Frame Analytics configs asynchronously and notifies listener upon completionFor additional info see GET Data Frame Analytics documentation
- Parameters:
request
- TheGetDataFrameAnalyticsRequest
options
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
getDataFrameAnalyticsStats
public GetDataFrameAnalyticsStatsResponse getDataFrameAnalyticsStats(GetDataFrameAnalyticsStatsRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionGets the running statistics of a Data Frame AnalyticsFor additional info see GET Data Frame Analytics Stats documentation
- Parameters:
request
- TheGetDataFrameAnalyticsStatsRequest
options
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
GetDataFrameAnalyticsStatsResponse
response object- Throws:
java.io.IOException
-
getDataFrameAnalyticsStatsAsync
public org.elasticsearch.client.Cancellable getDataFrameAnalyticsStatsAsync(GetDataFrameAnalyticsStatsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetDataFrameAnalyticsStatsResponse> listener)Gets the running statistics of a Data Frame Analytics asynchronously and notifies listener upon completionFor additional info see GET Data Frame Analytics Stats documentation
- Parameters:
request
- TheGetDataFrameAnalyticsStatsRequest
options
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
startDataFrameAnalytics
public StartDataFrameAnalyticsResponse startDataFrameAnalytics(StartDataFrameAnalyticsRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionStarts Data Frame AnalyticsFor additional info see Start Data Frame Analytics documentation
- Parameters:
request
- TheStartDataFrameAnalyticsRequest
options
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- action acknowledgement
- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
startDataFrameAnalyticsAsync
public org.elasticsearch.client.Cancellable startDataFrameAnalyticsAsync(StartDataFrameAnalyticsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<StartDataFrameAnalyticsResponse> listener)Starts Data Frame Analytics asynchronously and notifies listener upon completionFor additional info see Start Data Frame Analytics documentation
- Parameters:
request
- TheStartDataFrameAnalyticsRequest
options
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
stopDataFrameAnalytics
public StopDataFrameAnalyticsResponse stopDataFrameAnalytics(StopDataFrameAnalyticsRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionStops Data Frame AnalyticsFor additional info see Stop Data Frame Analytics documentation
- Parameters:
request
- TheStopDataFrameAnalyticsRequest
options
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
StopDataFrameAnalyticsResponse
- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
stopDataFrameAnalyticsAsync
public org.elasticsearch.client.Cancellable stopDataFrameAnalyticsAsync(StopDataFrameAnalyticsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<StopDataFrameAnalyticsResponse> listener)Stops Data Frame Analytics asynchronously and notifies listener upon completionFor additional info see Stop Data Frame Analytics documentation
- Parameters:
request
- TheStopDataFrameAnalyticsRequest
options
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
deleteDataFrameAnalytics
public org.elasticsearch.action.support.master.AcknowledgedResponse deleteDataFrameAnalytics(DeleteDataFrameAnalyticsRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionDeletes the given Data Frame Analytics configFor additional info see DELETE Data Frame Analytics documentation
- Parameters:
request
- TheDeleteDataFrameAnalyticsRequest
options
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- action acknowledgement
- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
deleteDataFrameAnalyticsAsync
public org.elasticsearch.client.Cancellable deleteDataFrameAnalyticsAsync(DeleteDataFrameAnalyticsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.support.master.AcknowledgedResponse> listener)Deletes the given Data Frame Analytics config asynchronously and notifies listener upon completionFor additional info see DELETE Data Frame Analytics documentation
- Parameters:
request
- TheDeleteDataFrameAnalyticsRequest
options
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
evaluateDataFrame
public EvaluateDataFrameResponse evaluateDataFrame(EvaluateDataFrameRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionEvaluates the given Data FrameFor additional info see Evaluate Data Frame documentation
- Parameters:
request
- TheEvaluateDataFrameRequest
options
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
EvaluateDataFrameResponse
response object- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
evaluateDataFrameAsync
public org.elasticsearch.client.Cancellable evaluateDataFrameAsync(EvaluateDataFrameRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<EvaluateDataFrameResponse> listener)Evaluates the given Data Frame asynchronously and notifies listener upon completionFor additional info see Evaluate Data Frame documentation
- Parameters:
request
- TheEvaluateDataFrameRequest
options
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
explainDataFrameAnalytics
public ExplainDataFrameAnalyticsResponse explainDataFrameAnalytics(ExplainDataFrameAnalyticsRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionExplains the given Data Frame AnalyticsFor additional info see Explain Data Frame Analytics documentation
- Parameters:
request
- TheExplainDataFrameAnalyticsRequest
options
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
ExplainDataFrameAnalyticsResponse
response object- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
explainDataFrameAnalyticsAsync
public org.elasticsearch.client.Cancellable explainDataFrameAnalyticsAsync(ExplainDataFrameAnalyticsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<ExplainDataFrameAnalyticsResponse> listener)Explains the given Data Frame Analytics asynchronously and notifies listener upon completionFor additional info see Explain Data Frame Analytics documentation
- Parameters:
request
- TheExplainDataFrameAnalyticsRequest
options
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
getTrainedModels
public GetTrainedModelsResponse getTrainedModels(GetTrainedModelsRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionGets trained model configsFor additional info see GET Trained Model Configs documentation
- Parameters:
request
- TheGetTrainedModelsRequest
options
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
GetTrainedModelsResponse
response object- Throws:
java.io.IOException
-
getTrainedModelsAsync
public org.elasticsearch.client.Cancellable getTrainedModelsAsync(GetTrainedModelsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetTrainedModelsResponse> listener)Gets trained model configs asynchronously and notifies listener upon completionFor additional info see GET Trained Model Configs documentation
- Parameters:
request
- TheGetTrainedModelsRequest
options
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
putTrainedModel
public PutTrainedModelResponse putTrainedModel(PutTrainedModelRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionPut trained model configFor additional info see PUT Trained Model Config documentation
- Parameters:
request
- ThePutTrainedModelRequest
options
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
PutTrainedModelResponse
response object- Throws:
java.io.IOException
-
putTrainedModelAsync
public org.elasticsearch.client.Cancellable putTrainedModelAsync(PutTrainedModelRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PutTrainedModelResponse> listener)Put trained model config asynchronously and notifies listener upon completionFor additional info see PUT Trained Model Config documentation
- Parameters:
request
- ThePutTrainedModelRequest
options
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
getTrainedModelsStats
public GetTrainedModelsStatsResponse getTrainedModelsStats(GetTrainedModelsStatsRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionGets trained model statsFor additional info see GET Trained Model Stats documentation
- Parameters:
request
- TheGetTrainedModelsStatsRequest
options
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
GetTrainedModelsStatsResponse
response object- Throws:
java.io.IOException
-
getTrainedModelsStatsAsync
public org.elasticsearch.client.Cancellable getTrainedModelsStatsAsync(GetTrainedModelsStatsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetTrainedModelsStatsResponse> listener)Gets trained model stats asynchronously and notifies listener upon completionFor additional info see GET Trained Model Stats documentation
- Parameters:
request
- TheGetTrainedModelsStatsRequest
options
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-
deleteTrainedModel
public org.elasticsearch.action.support.master.AcknowledgedResponse deleteTrainedModel(DeleteTrainedModelRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOExceptionDeletes the given Trained ModelFor additional info see DELETE Trained Model documentation
- Parameters:
request
- TheDeleteTrainedModelRequest
options
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- action acknowledgement
- Throws:
java.io.IOException
- when there is a serialization issue sending the request or receiving the response
-
deleteTrainedModelAsync
public org.elasticsearch.client.Cancellable deleteTrainedModelAsync(DeleteTrainedModelRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.support.master.AcknowledgedResponse> listener)Deletes the given Trained Model asynchronously and notifies listener upon completionFor additional info see DELETE Trained Model documentation
- Parameters:
request
- TheDeleteTrainedModelRequest
options
- Additional request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- Listener to be notified upon request completion- Returns:
- cancellable that may be used to cancel the request
-