Package co.elastic.clients.elasticsearch.ml

Class ElasticsearchMlClient

java.lang.Object

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

co.elastic.clients.elasticsearch.ml.ElasticsearchMlClient

public class ElasticsearchMlClient
extends ApiClient<ElasticsearchTransport,ElasticsearchMlClient>

Client for the ml namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ClearTrainedModelDeploymentCacheResponse	clearTrainedModelDeploymentCache(ClearTrainedModelDeploymentCacheRequest request)	Clears a trained model deployment cache on all nodes where the trained model is assigned.
final ClearTrainedModelDeploymentCacheResponse	clearTrainedModelDeploymentCache(Function<ClearTrainedModelDeploymentCacheRequest.Builder,ObjectBuilder<ClearTrainedModelDeploymentCacheRequest>> fn)	Clears a trained model deployment cache on all nodes where the trained model is assigned.
CloseJobResponse	closeJob(CloseJobRequest request)	Close anomaly detection jobs A job can be opened and closed multiple times throughout its lifecycle.
final CloseJobResponse	closeJob(Function<CloseJobRequest.Builder,ObjectBuilder<CloseJobRequest>> fn)	Close anomaly detection jobs A job can be opened and closed multiple times throughout its lifecycle.
DeleteCalendarResponse	deleteCalendar(DeleteCalendarRequest request)	Removes all scheduled events from a calendar, then deletes it.
final DeleteCalendarResponse	deleteCalendar(Function<DeleteCalendarRequest.Builder,ObjectBuilder<DeleteCalendarRequest>> fn)	Removes all scheduled events from a calendar, then deletes it.
DeleteCalendarEventResponse	deleteCalendarEvent(DeleteCalendarEventRequest request)	Deletes scheduled events from a calendar.
final DeleteCalendarEventResponse	deleteCalendarEvent(Function<DeleteCalendarEventRequest.Builder,ObjectBuilder<DeleteCalendarEventRequest>> fn)	Deletes scheduled events from a calendar.
DeleteCalendarJobResponse	deleteCalendarJob(DeleteCalendarJobRequest request)	Deletes anomaly detection jobs from a calendar.
final DeleteCalendarJobResponse	deleteCalendarJob(Function<DeleteCalendarJobRequest.Builder,ObjectBuilder<DeleteCalendarJobRequest>> fn)	Deletes anomaly detection jobs from a calendar.
DeleteDatafeedResponse	deleteDatafeed(DeleteDatafeedRequest request)	Deletes an existing datafeed.
final DeleteDatafeedResponse	deleteDatafeed(Function<DeleteDatafeedRequest.Builder,ObjectBuilder<DeleteDatafeedRequest>> fn)	Deletes an existing datafeed.
DeleteDataFrameAnalyticsResponse	deleteDataFrameAnalytics(DeleteDataFrameAnalyticsRequest request)	Deletes a data frame analytics job.
final DeleteDataFrameAnalyticsResponse	deleteDataFrameAnalytics(Function<DeleteDataFrameAnalyticsRequest.Builder,ObjectBuilder<DeleteDataFrameAnalyticsRequest>> fn)	Deletes a data frame analytics job.
DeleteExpiredDataResponse	deleteExpiredData()	Deletes expired and unused machine learning data.
DeleteExpiredDataResponse	deleteExpiredData(DeleteExpiredDataRequest request)	Deletes expired and unused machine learning data.
final DeleteExpiredDataResponse	deleteExpiredData(Function<DeleteExpiredDataRequest.Builder,ObjectBuilder<DeleteExpiredDataRequest>> fn)	Deletes expired and unused machine learning data.
DeleteFilterResponse	deleteFilter(DeleteFilterRequest request)	Deletes a filter.
final DeleteFilterResponse	deleteFilter(Function<DeleteFilterRequest.Builder,ObjectBuilder<DeleteFilterRequest>> fn)	Deletes a filter.
DeleteForecastResponse	deleteForecast(DeleteForecastRequest request)	Deletes forecasts from a machine learning job.
final DeleteForecastResponse	deleteForecast(Function<DeleteForecastRequest.Builder,ObjectBuilder<DeleteForecastRequest>> fn)	Deletes forecasts from a machine learning job.
DeleteJobResponse	deleteJob(DeleteJobRequest request)	Deletes an anomaly detection job.
final DeleteJobResponse	deleteJob(Function<DeleteJobRequest.Builder,ObjectBuilder<DeleteJobRequest>> fn)	Deletes an anomaly detection job.
DeleteModelSnapshotResponse	deleteModelSnapshot(DeleteModelSnapshotRequest request)	Deletes an existing model snapshot.
final DeleteModelSnapshotResponse	deleteModelSnapshot(Function<DeleteModelSnapshotRequest.Builder,ObjectBuilder<DeleteModelSnapshotRequest>> fn)	Deletes an existing model snapshot.
DeleteTrainedModelResponse	deleteTrainedModel(DeleteTrainedModelRequest request)	Deletes an existing trained inference model that is currently not referenced by an ingest pipeline.
final DeleteTrainedModelResponse	deleteTrainedModel(Function<DeleteTrainedModelRequest.Builder,ObjectBuilder<DeleteTrainedModelRequest>> fn)	Deletes an existing trained inference model that is currently not referenced by an ingest pipeline.
DeleteTrainedModelAliasResponse	deleteTrainedModelAlias(DeleteTrainedModelAliasRequest request)	Deletes a trained model alias.
final DeleteTrainedModelAliasResponse	deleteTrainedModelAlias(Function<DeleteTrainedModelAliasRequest.Builder,ObjectBuilder<DeleteTrainedModelAliasRequest>> fn)	Deletes a trained model alias.
EstimateModelMemoryResponse	estimateModelMemory()	Makes an estimation of the memory usage for an anomaly detection job model.
EstimateModelMemoryResponse	estimateModelMemory(EstimateModelMemoryRequest request)	Makes an estimation of the memory usage for an anomaly detection job model.
final EstimateModelMemoryResponse	estimateModelMemory(Function<EstimateModelMemoryRequest.Builder,ObjectBuilder<EstimateModelMemoryRequest>> fn)	Makes an estimation of the memory usage for an anomaly detection job model.
EvaluateDataFrameResponse	evaluateDataFrame(EvaluateDataFrameRequest request)	Evaluates the data frame analytics for an annotated index.
final EvaluateDataFrameResponse	evaluateDataFrame(Function<EvaluateDataFrameRequest.Builder,ObjectBuilder<EvaluateDataFrameRequest>> fn)	Evaluates the data frame analytics for an annotated index.
ExplainDataFrameAnalyticsResponse	explainDataFrameAnalytics()	Explains a data frame analytics config.
ExplainDataFrameAnalyticsResponse	explainDataFrameAnalytics(ExplainDataFrameAnalyticsRequest request)	Explains a data frame analytics config.
final ExplainDataFrameAnalyticsResponse	explainDataFrameAnalytics(Function<ExplainDataFrameAnalyticsRequest.Builder,ObjectBuilder<ExplainDataFrameAnalyticsRequest>> fn)	Explains a data frame analytics config.
FlushJobResponse	flushJob(FlushJobRequest request)	Forces any buffered data to be processed by the job.
final FlushJobResponse	flushJob(Function<FlushJobRequest.Builder,ObjectBuilder<FlushJobRequest>> fn)	Forces any buffered data to be processed by the job.
ForecastResponse	forecast(ForecastRequest request)	Predicts the future behavior of a time series by using its historical behavior.
final ForecastResponse	forecast(Function<ForecastRequest.Builder,ObjectBuilder<ForecastRequest>> fn)	Predicts the future behavior of a time series by using its historical behavior.
GetBucketsResponse	getBuckets(GetBucketsRequest request)	Retrieves anomaly detection job results for one or more buckets.
final GetBucketsResponse	getBuckets(Function<GetBucketsRequest.Builder,ObjectBuilder<GetBucketsRequest>> fn)	Retrieves anomaly detection job results for one or more buckets.
GetCalendarEventsResponse	getCalendarEvents(GetCalendarEventsRequest request)	Retrieves information about the scheduled events in calendars.
final GetCalendarEventsResponse	getCalendarEvents(Function<GetCalendarEventsRequest.Builder,ObjectBuilder<GetCalendarEventsRequest>> fn)	Retrieves information about the scheduled events in calendars.
GetCalendarsResponse	getCalendars()	Retrieves configuration information for calendars.
GetCalendarsResponse	getCalendars(GetCalendarsRequest request)	Retrieves configuration information for calendars.
final GetCalendarsResponse	getCalendars(Function<GetCalendarsRequest.Builder,ObjectBuilder<GetCalendarsRequest>> fn)	Retrieves configuration information for calendars.
GetCategoriesResponse	getCategories(GetCategoriesRequest request)	Retrieves anomaly detection job results for one or more categories.
final GetCategoriesResponse	getCategories(Function<GetCategoriesRequest.Builder,ObjectBuilder<GetCategoriesRequest>> fn)	Retrieves anomaly detection job results for one or more categories.
GetDatafeedsResponse	getDatafeeds()	Retrieves configuration information for datafeeds.
GetDatafeedsResponse	getDatafeeds(GetDatafeedsRequest request)	Retrieves configuration information for datafeeds.
final GetDatafeedsResponse	getDatafeeds(Function<GetDatafeedsRequest.Builder,ObjectBuilder<GetDatafeedsRequest>> fn)	Retrieves configuration information for datafeeds.
GetDatafeedStatsResponse	getDatafeedStats()	Retrieves usage information for datafeeds.
GetDatafeedStatsResponse	getDatafeedStats(GetDatafeedStatsRequest request)	Retrieves usage information for datafeeds.
final GetDatafeedStatsResponse	getDatafeedStats(Function<GetDatafeedStatsRequest.Builder,ObjectBuilder<GetDatafeedStatsRequest>> fn)	Retrieves usage information for datafeeds.
GetDataFrameAnalyticsResponse	getDataFrameAnalytics()	Retrieves configuration information for data frame analytics jobs.
GetDataFrameAnalyticsResponse	getDataFrameAnalytics(GetDataFrameAnalyticsRequest request)	Retrieves configuration information for data frame analytics jobs.
final GetDataFrameAnalyticsResponse	getDataFrameAnalytics(Function<GetDataFrameAnalyticsRequest.Builder,ObjectBuilder<GetDataFrameAnalyticsRequest>> fn)	Retrieves configuration information for data frame analytics jobs.
GetDataFrameAnalyticsStatsResponse	getDataFrameAnalyticsStats()	Retrieves usage information for data frame analytics jobs.
GetDataFrameAnalyticsStatsResponse	getDataFrameAnalyticsStats(GetDataFrameAnalyticsStatsRequest request)	Retrieves usage information for data frame analytics jobs.
final GetDataFrameAnalyticsStatsResponse	getDataFrameAnalyticsStats(Function<GetDataFrameAnalyticsStatsRequest.Builder,ObjectBuilder<GetDataFrameAnalyticsStatsRequest>> fn)	Retrieves usage information for data frame analytics jobs.
GetFiltersResponse	getFilters()	Retrieves filters.
GetFiltersResponse	getFilters(GetFiltersRequest request)	Retrieves filters.
final GetFiltersResponse	getFilters(Function<GetFiltersRequest.Builder,ObjectBuilder<GetFiltersRequest>> fn)	Retrieves filters.
GetInfluencersResponse	getInfluencers(GetInfluencersRequest request)	Retrieves anomaly detection job results for one or more influencers.
final GetInfluencersResponse	getInfluencers(Function<GetInfluencersRequest.Builder,ObjectBuilder<GetInfluencersRequest>> fn)	Retrieves anomaly detection job results for one or more influencers.
GetJobsResponse	getJobs()	Retrieves configuration information for anomaly detection jobs.
GetJobsResponse	getJobs(GetJobsRequest request)	Retrieves configuration information for anomaly detection jobs.
final GetJobsResponse	getJobs(Function<GetJobsRequest.Builder,ObjectBuilder<GetJobsRequest>> fn)	Retrieves configuration information for anomaly detection jobs.
GetJobStatsResponse	getJobStats()	Retrieves usage information for anomaly detection jobs.
GetJobStatsResponse	getJobStats(GetJobStatsRequest request)	Retrieves usage information for anomaly detection jobs.
final GetJobStatsResponse	getJobStats(Function<GetJobStatsRequest.Builder,ObjectBuilder<GetJobStatsRequest>> fn)	Retrieves usage information for anomaly detection jobs.
GetMemoryStatsResponse	getMemoryStats()	Get information about how machine learning jobs and trained models are using memory, on each node, both within the JVM heap, and natively, outside of the JVM.
GetMemoryStatsResponse	getMemoryStats(GetMemoryStatsRequest request)	Get information about how machine learning jobs and trained models are using memory, on each node, both within the JVM heap, and natively, outside of the JVM.
final GetMemoryStatsResponse	getMemoryStats(Function<GetMemoryStatsRequest.Builder,ObjectBuilder<GetMemoryStatsRequest>> fn)	Get information about how machine learning jobs and trained models are using memory, on each node, both within the JVM heap, and natively, outside of the JVM.
GetModelSnapshotsResponse	getModelSnapshots(GetModelSnapshotsRequest request)	Retrieves information about model snapshots.
final GetModelSnapshotsResponse	getModelSnapshots(Function<GetModelSnapshotsRequest.Builder,ObjectBuilder<GetModelSnapshotsRequest>> fn)	Retrieves information about model snapshots.
GetModelSnapshotUpgradeStatsResponse	getModelSnapshotUpgradeStats(GetModelSnapshotUpgradeStatsRequest request)	Retrieves usage information for anomaly detection job model snapshot upgrades.
final GetModelSnapshotUpgradeStatsResponse	getModelSnapshotUpgradeStats(Function<GetModelSnapshotUpgradeStatsRequest.Builder,ObjectBuilder<GetModelSnapshotUpgradeStatsRequest>> fn)	Retrieves usage information for anomaly detection job model snapshot upgrades.
GetOverallBucketsResponse	getOverallBuckets(GetOverallBucketsRequest request)	Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.
final GetOverallBucketsResponse	getOverallBuckets(Function<GetOverallBucketsRequest.Builder,ObjectBuilder<GetOverallBucketsRequest>> fn)	Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.
GetRecordsResponse	getRecords(GetRecordsRequest request)	Retrieves anomaly records for an anomaly detection job.
final GetRecordsResponse	getRecords(Function<GetRecordsRequest.Builder,ObjectBuilder<GetRecordsRequest>> fn)	Retrieves anomaly records for an anomaly detection job.
GetTrainedModelsResponse	getTrainedModels()	Retrieves configuration information for a trained model.
GetTrainedModelsResponse	getTrainedModels(GetTrainedModelsRequest request)	Retrieves configuration information for a trained model.
final GetTrainedModelsResponse	getTrainedModels(Function<GetTrainedModelsRequest.Builder,ObjectBuilder<GetTrainedModelsRequest>> fn)	Retrieves configuration information for a trained model.
GetTrainedModelsStatsResponse	getTrainedModelsStats()	Retrieves usage information for trained models.
GetTrainedModelsStatsResponse	getTrainedModelsStats(GetTrainedModelsStatsRequest request)	Retrieves usage information for trained models.
final GetTrainedModelsStatsResponse	getTrainedModelsStats(Function<GetTrainedModelsStatsRequest.Builder,ObjectBuilder<GetTrainedModelsStatsRequest>> fn)	Retrieves usage information for trained models.
InferTrainedModelResponse	inferTrainedModel(InferTrainedModelRequest request)	Evaluates a trained model.
final InferTrainedModelResponse	inferTrainedModel(Function<InferTrainedModelRequest.Builder,ObjectBuilder<InferTrainedModelRequest>> fn)	Evaluates a trained model.
MlInfoResponse	info()	Returns defaults and limits used by machine learning.
OpenJobResponse	openJob(OpenJobRequest request)	Opens one or more anomaly detection jobs.
final OpenJobResponse	openJob(Function<OpenJobRequest.Builder,ObjectBuilder<OpenJobRequest>> fn)	Opens one or more anomaly detection jobs.
PostCalendarEventsResponse	postCalendarEvents(PostCalendarEventsRequest request)	Adds scheduled events to a calendar.
final PostCalendarEventsResponse	postCalendarEvents(Function<PostCalendarEventsRequest.Builder,ObjectBuilder<PostCalendarEventsRequest>> fn)	Adds scheduled events to a calendar.
<TData> PostDataResponse	postData(PostDataRequest<TData> request)	Sends data to an anomaly detection job for analysis.
final <TData> PostDataResponse	postData(Function<PostDataRequest.Builder<TData>,ObjectBuilder<PostDataRequest<TData>>> fn)	Sends data to an anomaly detection job for analysis.
<TDocument> PreviewDatafeedResponse<TDocument>	previewDatafeed(PreviewDatafeedRequest request, Class<TDocument> tDocumentClass)	Previews a datafeed.
<TDocument> PreviewDatafeedResponse<TDocument>	previewDatafeed(PreviewDatafeedRequest request, Type tDocumentType)	Previews a datafeed.
final <TDocument> PreviewDatafeedResponse<TDocument>	previewDatafeed(Function<PreviewDatafeedRequest.Builder,ObjectBuilder<PreviewDatafeedRequest>> fn, Class<TDocument> tDocumentClass)	Previews a datafeed.
final <TDocument> PreviewDatafeedResponse<TDocument>	previewDatafeed(Function<PreviewDatafeedRequest.Builder,ObjectBuilder<PreviewDatafeedRequest>> fn, Type tDocumentType)	Previews a datafeed.
PreviewDataFrameAnalyticsResponse	previewDataFrameAnalytics()	Previews the extracted features used by a data frame analytics config.
PreviewDataFrameAnalyticsResponse	previewDataFrameAnalytics(PreviewDataFrameAnalyticsRequest request)	Previews the extracted features used by a data frame analytics config.
final PreviewDataFrameAnalyticsResponse	previewDataFrameAnalytics(Function<PreviewDataFrameAnalyticsRequest.Builder,ObjectBuilder<PreviewDataFrameAnalyticsRequest>> fn)	Previews the extracted features used by a data frame analytics config.
PutCalendarResponse	putCalendar(PutCalendarRequest request)	Creates a calendar.
final PutCalendarResponse	putCalendar(Function<PutCalendarRequest.Builder,ObjectBuilder<PutCalendarRequest>> fn)	Creates a calendar.
PutCalendarJobResponse	putCalendarJob(PutCalendarJobRequest request)	Adds an anomaly detection job to a calendar.
final PutCalendarJobResponse	putCalendarJob(Function<PutCalendarJobRequest.Builder,ObjectBuilder<PutCalendarJobRequest>> fn)	Adds an anomaly detection job to a calendar.
PutDatafeedResponse	putDatafeed(PutDatafeedRequest request)	Instantiates a datafeed.
final PutDatafeedResponse	putDatafeed(Function<PutDatafeedRequest.Builder,ObjectBuilder<PutDatafeedRequest>> fn)	Instantiates a datafeed.
PutDataFrameAnalyticsResponse	putDataFrameAnalytics(PutDataFrameAnalyticsRequest request)	Instantiates a data frame analytics job.
final PutDataFrameAnalyticsResponse	putDataFrameAnalytics(Function<PutDataFrameAnalyticsRequest.Builder,ObjectBuilder<PutDataFrameAnalyticsRequest>> fn)	Instantiates a data frame analytics job.
PutFilterResponse	putFilter(PutFilterRequest request)	Instantiates a filter.
final PutFilterResponse	putFilter(Function<PutFilterRequest.Builder,ObjectBuilder<PutFilterRequest>> fn)	Instantiates a filter.
PutJobResponse	putJob(PutJobRequest request)	Instantiates an anomaly detection job.
final PutJobResponse	putJob(Function<PutJobRequest.Builder,ObjectBuilder<PutJobRequest>> fn)	Instantiates an anomaly detection job.
PutTrainedModelResponse	putTrainedModel(PutTrainedModelRequest request)	Enables you to supply a trained model that is not created by data frame analytics.
final PutTrainedModelResponse	putTrainedModel(Function<PutTrainedModelRequest.Builder,ObjectBuilder<PutTrainedModelRequest>> fn)	Enables you to supply a trained model that is not created by data frame analytics.
PutTrainedModelAliasResponse	putTrainedModelAlias(PutTrainedModelAliasRequest request)	Creates or updates a trained model alias.
final PutTrainedModelAliasResponse	putTrainedModelAlias(Function<PutTrainedModelAliasRequest.Builder,ObjectBuilder<PutTrainedModelAliasRequest>> fn)	Creates or updates a trained model alias.
PutTrainedModelDefinitionPartResponse	putTrainedModelDefinitionPart(PutTrainedModelDefinitionPartRequest request)	Creates part of a trained model definition.
final PutTrainedModelDefinitionPartResponse	putTrainedModelDefinitionPart(Function<PutTrainedModelDefinitionPartRequest.Builder,ObjectBuilder<PutTrainedModelDefinitionPartRequest>> fn)	Creates part of a trained model definition.
PutTrainedModelVocabularyResponse	putTrainedModelVocabulary(PutTrainedModelVocabularyRequest request)	Creates a trained model vocabulary.
final PutTrainedModelVocabularyResponse	putTrainedModelVocabulary(Function<PutTrainedModelVocabularyRequest.Builder,ObjectBuilder<PutTrainedModelVocabularyRequest>> fn)	Creates a trained model vocabulary.
ResetJobResponse	resetJob(ResetJobRequest request)	Resets an anomaly detection job.
final ResetJobResponse	resetJob(Function<ResetJobRequest.Builder,ObjectBuilder<ResetJobRequest>> fn)	Resets an anomaly detection job.
RevertModelSnapshotResponse	revertModelSnapshot(RevertModelSnapshotRequest request)	Reverts to a specific snapshot.
final RevertModelSnapshotResponse	revertModelSnapshot(Function<RevertModelSnapshotRequest.Builder,ObjectBuilder<RevertModelSnapshotRequest>> fn)	Reverts to a specific snapshot.
SetUpgradeModeResponse	setUpgradeMode()	Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade.
SetUpgradeModeResponse	setUpgradeMode(SetUpgradeModeRequest request)	Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade.
final SetUpgradeModeResponse	setUpgradeMode(Function<SetUpgradeModeRequest.Builder,ObjectBuilder<SetUpgradeModeRequest>> fn)	Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade.
StartDatafeedResponse	startDatafeed(StartDatafeedRequest request)	Starts one or more datafeeds.
final StartDatafeedResponse	startDatafeed(Function<StartDatafeedRequest.Builder,ObjectBuilder<StartDatafeedRequest>> fn)	Starts one or more datafeeds.
StartDataFrameAnalyticsResponse	startDataFrameAnalytics(StartDataFrameAnalyticsRequest request)	Starts a data frame analytics job.
final StartDataFrameAnalyticsResponse	startDataFrameAnalytics(Function<StartDataFrameAnalyticsRequest.Builder,ObjectBuilder<StartDataFrameAnalyticsRequest>> fn)	Starts a data frame analytics job.
StartTrainedModelDeploymentResponse	startTrainedModelDeployment(StartTrainedModelDeploymentRequest request)	Starts a trained model deployment, which allocates the model to every machine learning node.
final StartTrainedModelDeploymentResponse	startTrainedModelDeployment(Function<StartTrainedModelDeploymentRequest.Builder,ObjectBuilder<StartTrainedModelDeploymentRequest>> fn)	Starts a trained model deployment, which allocates the model to every machine learning node.
StopDatafeedResponse	stopDatafeed(StopDatafeedRequest request)	Stops one or more datafeeds.
final StopDatafeedResponse	stopDatafeed(Function<StopDatafeedRequest.Builder,ObjectBuilder<StopDatafeedRequest>> fn)	Stops one or more datafeeds.
StopDataFrameAnalyticsResponse	stopDataFrameAnalytics(StopDataFrameAnalyticsRequest request)	Stops one or more data frame analytics jobs.
final StopDataFrameAnalyticsResponse	stopDataFrameAnalytics(Function<StopDataFrameAnalyticsRequest.Builder,ObjectBuilder<StopDataFrameAnalyticsRequest>> fn)	Stops one or more data frame analytics jobs.
StopTrainedModelDeploymentResponse	stopTrainedModelDeployment(StopTrainedModelDeploymentRequest request)	Stops a trained model deployment.
final StopTrainedModelDeploymentResponse	stopTrainedModelDeployment(Function<StopTrainedModelDeploymentRequest.Builder,ObjectBuilder<StopTrainedModelDeploymentRequest>> fn)	Stops a trained model deployment.
UpdateDatafeedResponse	updateDatafeed(UpdateDatafeedRequest request)	Updates the properties of a datafeed.
final UpdateDatafeedResponse	updateDatafeed(Function<UpdateDatafeedRequest.Builder,ObjectBuilder<UpdateDatafeedRequest>> fn)	Updates the properties of a datafeed.
UpdateDataFrameAnalyticsResponse	updateDataFrameAnalytics(UpdateDataFrameAnalyticsRequest request)	Updates an existing data frame analytics job.
final UpdateDataFrameAnalyticsResponse	updateDataFrameAnalytics(Function<UpdateDataFrameAnalyticsRequest.Builder,ObjectBuilder<UpdateDataFrameAnalyticsRequest>> fn)	Updates an existing data frame analytics job.
UpdateFilterResponse	updateFilter(UpdateFilterRequest request)	Updates the description of a filter, adds items, or removes items from the list.
final UpdateFilterResponse	updateFilter(Function<UpdateFilterRequest.Builder,ObjectBuilder<UpdateFilterRequest>> fn)	Updates the description of a filter, adds items, or removes items from the list.
UpdateJobResponse	updateJob(UpdateJobRequest request)	Updates certain properties of an anomaly detection job.
final UpdateJobResponse	updateJob(Function<UpdateJobRequest.Builder,ObjectBuilder<UpdateJobRequest>> fn)	Updates certain properties of an anomaly detection job.
UpdateModelSnapshotResponse	updateModelSnapshot(UpdateModelSnapshotRequest request)	Updates certain properties of a snapshot.
final UpdateModelSnapshotResponse	updateModelSnapshot(Function<UpdateModelSnapshotRequest.Builder,ObjectBuilder<UpdateModelSnapshotRequest>> fn)	Updates certain properties of a snapshot.
UpdateTrainedModelDeploymentResponse	updateTrainedModelDeployment(UpdateTrainedModelDeploymentRequest request)	Starts a trained model deployment, which allocates the model to every machine learning node.
final UpdateTrainedModelDeploymentResponse	updateTrainedModelDeployment(Function<UpdateTrainedModelDeploymentRequest.Builder,ObjectBuilder<UpdateTrainedModelDeploymentRequest>> fn)	Starts a trained model deployment, which allocates the model to every machine learning node.
UpgradeJobSnapshotResponse	upgradeJobSnapshot(UpgradeJobSnapshotRequest request)	Upgrades an anomaly detection model snapshot to the latest major version.
final UpgradeJobSnapshotResponse	upgradeJobSnapshot(Function<UpgradeJobSnapshotRequest.Builder,ObjectBuilder<UpgradeJobSnapshotRequest>> fn)	Upgrades an anomaly detection model snapshot to the latest major version.
ValidateResponse	validate()	Validates an anomaly detection job.
ValidateResponse	validate(ValidateRequest request)	Validates an anomaly detection job.
final ValidateResponse	validate(Function<ValidateRequest.Builder,ObjectBuilder<ValidateRequest>> fn)	Validates an anomaly detection job.
ValidateDetectorResponse	validateDetector()	Validates an anomaly detection detector.
ValidateDetectorResponse	validateDetector(ValidateDetectorRequest request)	Validates an anomaly detection detector.
final ValidateDetectorResponse	validateDetector(Function<ValidateDetectorRequest.Builder,ObjectBuilder<ValidateDetectorRequest>> fn)	Validates an anomaly detection detector.
ElasticsearchMlClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchMlClient

public ElasticsearchMlClient(ElasticsearchTransport transport)

ElasticsearchMlClient

public ElasticsearchMlClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchMlClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchMlClient>

clearTrainedModelDeploymentCache

public ClearTrainedModelDeploymentCacheResponse clearTrainedModelDeploymentCache(ClearTrainedModelDeploymentCacheRequest request)
                                                                          throws IOException,
ElasticsearchException

Clears a trained model deployment cache on all nodes where the trained model is assigned. A trained model deployment may have an inference cache enabled. As requests are handled by each allocated node, their responses may be cached on that individual node. Calling this API clears the caches without restarting the deployment.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

clearTrainedModelDeploymentCache

public final ClearTrainedModelDeploymentCacheResponse clearTrainedModelDeploymentCache(Function<ClearTrainedModelDeploymentCacheRequest.Builder,ObjectBuilder<ClearTrainedModelDeploymentCacheRequest>> fn)
                                                                                throws IOException,
ElasticsearchException

Clears a trained model deployment cache on all nodes where the trained model is assigned. A trained model deployment may have an inference cache enabled. As requests are handled by each allocated node, their responses may be cached on that individual node. Calling this API clears the caches without restarting the deployment.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

closeJob

public CloseJobResponse closeJob(CloseJobRequest request)
                          throws IOException,
ElasticsearchException

Close anomaly detection 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. When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data. If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. When a datafeed that has a specified end date stops, it automatically closes its associated job.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

closeJob

public final CloseJobResponse closeJob(Function<CloseJobRequest.Builder,ObjectBuilder<CloseJobRequest>> fn)
                                throws IOException,
ElasticsearchException

Close anomaly detection 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. When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data. If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. When a datafeed that has a specified end date stops, it automatically closes its associated job.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteCalendar

public DeleteCalendarResponse deleteCalendar(DeleteCalendarRequest request)
                                      throws IOException,
ElasticsearchException

Removes all scheduled events from a calendar, then deletes it.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteCalendar

public final DeleteCalendarResponse deleteCalendar(Function<DeleteCalendarRequest.Builder,ObjectBuilder<DeleteCalendarRequest>> fn)
                                            throws IOException,
ElasticsearchException

Removes all scheduled events from a calendar, then deletes it.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteCalendarEvent

public DeleteCalendarEventResponse deleteCalendarEvent(DeleteCalendarEventRequest request)
                                                throws IOException,
ElasticsearchException

Deletes scheduled events from a calendar.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteCalendarEvent

public final DeleteCalendarEventResponse deleteCalendarEvent(Function<DeleteCalendarEventRequest.Builder,ObjectBuilder<DeleteCalendarEventRequest>> fn)
                                                      throws IOException,
ElasticsearchException

Deletes scheduled events from a calendar.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteCalendarJob

public DeleteCalendarJobResponse deleteCalendarJob(DeleteCalendarJobRequest request)
                                            throws IOException,
ElasticsearchException

Deletes anomaly detection jobs from a calendar.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteCalendarJob

public final DeleteCalendarJobResponse deleteCalendarJob(Function<DeleteCalendarJobRequest.Builder,ObjectBuilder<DeleteCalendarJobRequest>> fn)
                                                  throws IOException,
ElasticsearchException

Deletes anomaly detection jobs from a calendar.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteDataFrameAnalytics

public DeleteDataFrameAnalyticsResponse deleteDataFrameAnalytics(DeleteDataFrameAnalyticsRequest request)
                                                          throws IOException,
ElasticsearchException

Deletes a data frame analytics job.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteDataFrameAnalytics

public final DeleteDataFrameAnalyticsResponse deleteDataFrameAnalytics(Function<DeleteDataFrameAnalyticsRequest.Builder,ObjectBuilder<DeleteDataFrameAnalyticsRequest>> fn)
                                                                throws IOException,
ElasticsearchException

Deletes a data frame analytics job.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteDatafeed

public DeleteDatafeedResponse deleteDatafeed(DeleteDatafeedRequest request)
                                      throws IOException,
ElasticsearchException

Deletes an existing datafeed.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteDatafeed

public final DeleteDatafeedResponse deleteDatafeed(Function<DeleteDatafeedRequest.Builder,ObjectBuilder<DeleteDatafeedRequest>> fn)
                                            throws IOException,
ElasticsearchException

Deletes an existing datafeed.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteExpiredData

public DeleteExpiredDataResponse deleteExpiredData(DeleteExpiredDataRequest request)
                                            throws IOException,
ElasticsearchException

Deletes expired and unused machine learning data. Deletes all job results, model snapshots and forecast data that have exceeded their retention days period. Machine learning state documents that are not associated with any job are also deleted. You can limit the request to a single or set of anomaly detection jobs by using a job identifier, a group name, a comma-separated list of jobs, or a wildcard expression. You can delete expired data for all anomaly detection jobs by using _all, by specifying * as the <job_id>, or by omitting the <job_id>.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteExpiredData

public final DeleteExpiredDataResponse deleteExpiredData(Function<DeleteExpiredDataRequest.Builder,ObjectBuilder<DeleteExpiredDataRequest>> fn)
                                                  throws IOException,
ElasticsearchException

Deletes expired and unused machine learning data. Deletes all job results, model snapshots and forecast data that have exceeded their retention days period. Machine learning state documents that are not associated with any job are also deleted. You can limit the request to a single or set of anomaly detection jobs by using a job identifier, a group name, a comma-separated list of jobs, or a wildcard expression. You can delete expired data for all anomaly detection jobs by using _all, by specifying * as the <job_id>, or by omitting the <job_id>.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteExpiredData

public DeleteExpiredDataResponse deleteExpiredData()
                                            throws IOException,
ElasticsearchException

Deletes expired and unused machine learning data. Deletes all job results, model snapshots and forecast data that have exceeded their retention days period. Machine learning state documents that are not associated with any job are also deleted. You can limit the request to a single or set of anomaly detection jobs by using a job identifier, a group name, a comma-separated list of jobs, or a wildcard expression. You can delete expired data for all anomaly detection jobs by using _all, by specifying * as the <job_id>, or by omitting the <job_id>.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteFilter

public DeleteFilterResponse deleteFilter(DeleteFilterRequest request)
                                  throws IOException,
ElasticsearchException

Deletes a filter. If an anomaly detection job references the filter, you cannot delete the filter. You must update or delete the job before you can delete the filter.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteFilter

public final DeleteFilterResponse deleteFilter(Function<DeleteFilterRequest.Builder,ObjectBuilder<DeleteFilterRequest>> fn)
                                        throws IOException,
ElasticsearchException

Deletes a filter. If an anomaly detection job references the filter, you cannot delete the filter. You must update or delete the job before you can delete the filter.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteForecast

public DeleteForecastResponse deleteForecast(DeleteForecastRequest request)
                                      throws IOException,
ElasticsearchException

Deletes forecasts from a machine learning job. By default, forecasts are retained for 14 days. You can specify a different retention period with the expires_in parameter in the forecast jobs API. The delete forecast API enables you to delete one or more forecasts before they expire.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteForecast

public final DeleteForecastResponse deleteForecast(Function<DeleteForecastRequest.Builder,ObjectBuilder<DeleteForecastRequest>> fn)
                                            throws IOException,
ElasticsearchException

Deletes forecasts from a machine learning job. By default, forecasts are retained for 14 days. You can specify a different retention period with the expires_in parameter in the forecast jobs API. The delete forecast API enables you to delete one or more forecasts before they expire.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteJob

public DeleteJobResponse deleteJob(DeleteJobRequest request)
                            throws IOException,
ElasticsearchException

Deletes an anomaly detection job.

All job configuration, model state and results are deleted. It is not currently possible to delete multiple jobs using wildcards or a comma separated list. If you delete a job that has a datafeed, the request first tries to delete the datafeed. This behavior is equivalent to calling the delete datafeed API with the same timeout and force parameters as the delete job request.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteJob

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

Deletes an anomaly detection job.

All job configuration, model state and results are deleted. It is not currently possible to delete multiple jobs using wildcards or a comma separated list. If you delete a job that has a datafeed, the request first tries to delete the datafeed. This behavior is equivalent to calling the delete datafeed API with the same timeout and force parameters as the delete job request.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteModelSnapshot

public DeleteModelSnapshotResponse deleteModelSnapshot(DeleteModelSnapshotRequest request)
                                                throws IOException,
ElasticsearchException

Deletes an existing model snapshot. You cannot delete the active model snapshot. To delete that snapshot, first revert to a different one. To identify the active model snapshot, refer to the model_snapshot_id in the results from the get jobs API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteModelSnapshot

public final DeleteModelSnapshotResponse deleteModelSnapshot(Function<DeleteModelSnapshotRequest.Builder,ObjectBuilder<DeleteModelSnapshotRequest>> fn)
                                                      throws IOException,
ElasticsearchException

Deletes an existing model snapshot. You cannot delete the active model snapshot. To delete that snapshot, first revert to a different one. To identify the active model snapshot, refer to the model_snapshot_id in the results from the get jobs API.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteTrainedModel

public DeleteTrainedModelResponse deleteTrainedModel(DeleteTrainedModelRequest request)
                                              throws IOException,
ElasticsearchException

Deletes an existing trained inference model that is currently not referenced by an ingest pipeline.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteTrainedModel

public final DeleteTrainedModelResponse deleteTrainedModel(Function<DeleteTrainedModelRequest.Builder,ObjectBuilder<DeleteTrainedModelRequest>> fn)
                                                    throws IOException,
ElasticsearchException

Deletes an existing trained inference model that is currently not referenced by an ingest pipeline.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteTrainedModelAlias

public DeleteTrainedModelAliasResponse deleteTrainedModelAlias(DeleteTrainedModelAliasRequest request)
                                                        throws IOException,
ElasticsearchException

Deletes a trained model alias. This API deletes an existing model alias that refers to a trained model. If the model alias is missing or refers to a model other than the one identified by the model_id, this API returns an error.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteTrainedModelAlias

public final DeleteTrainedModelAliasResponse deleteTrainedModelAlias(Function<DeleteTrainedModelAliasRequest.Builder,ObjectBuilder<DeleteTrainedModelAliasRequest>> fn)
                                                              throws IOException,
ElasticsearchException

Deletes a trained model alias. This API deletes an existing model alias that refers to a trained model. If the model alias is missing or refers to a model other than the one identified by the model_id, this API returns an error.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

estimateModelMemory

public EstimateModelMemoryResponse estimateModelMemory(EstimateModelMemoryRequest request)
                                                throws IOException,
ElasticsearchException

Makes an estimation of the memory usage for an anomaly detection job model. It is based on analysis configuration details for the job and cardinality estimates for the fields it references.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

estimateModelMemory

public final EstimateModelMemoryResponse estimateModelMemory(Function<EstimateModelMemoryRequest.Builder,ObjectBuilder<EstimateModelMemoryRequest>> fn)
                                                      throws IOException,
ElasticsearchException

Makes an estimation of the memory usage for an anomaly detection job model. It is based on analysis configuration details for the job and cardinality estimates for the fields it references.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

estimateModelMemory

public EstimateModelMemoryResponse estimateModelMemory()
                                                throws IOException,
ElasticsearchException

Makes an estimation of the memory usage for an anomaly detection job model. It is based on analysis configuration details for the job and cardinality estimates for the fields it references.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

evaluateDataFrame

public EvaluateDataFrameResponse evaluateDataFrame(EvaluateDataFrameRequest request)
                                            throws IOException,
ElasticsearchException

Evaluates the data frame analytics for an annotated index. The API packages together commonly used evaluation metrics for various types of machine learning features. This has been designed for use on indexes created by data frame analytics. Evaluation requires both a ground truth field and an analytics result field to be present.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

evaluateDataFrame

public final EvaluateDataFrameResponse evaluateDataFrame(Function<EvaluateDataFrameRequest.Builder,ObjectBuilder<EvaluateDataFrameRequest>> fn)
                                                  throws IOException,
ElasticsearchException

Evaluates the data frame analytics for an annotated index. The API packages together commonly used evaluation metrics for various types of machine learning features. This has been designed for use on indexes created by data frame analytics. Evaluation requires both a ground truth field and an analytics result field to be present.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

explainDataFrameAnalytics

public ExplainDataFrameAnalyticsResponse explainDataFrameAnalytics(ExplainDataFrameAnalyticsRequest request)
                                                            throws IOException,
ElasticsearchException

Explains a data frame analytics config. This API provides explanations for a data frame analytics config that either exists already or one that has not been created yet. The following explanations are provided:

• which fields are included or not in the analysis and why,
• how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. If you have object fields or fields that are excluded via source filtering, they are not included in the explanation.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

explainDataFrameAnalytics

public final ExplainDataFrameAnalyticsResponse explainDataFrameAnalytics(Function<ExplainDataFrameAnalyticsRequest.Builder,ObjectBuilder<ExplainDataFrameAnalyticsRequest>> fn)
                                                                  throws IOException,
ElasticsearchException

Explains a data frame analytics config. This API provides explanations for a data frame analytics config that either exists already or one that has not been created yet. The following explanations are provided:

• which fields are included or not in the analysis and why,
• how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. If you have object fields or fields that are excluded via source filtering, they are not included in the explanation.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

explainDataFrameAnalytics

public ExplainDataFrameAnalyticsResponse explainDataFrameAnalytics()
                                                            throws IOException,
ElasticsearchException

Explains a data frame analytics config. This API provides explanations for a data frame analytics config that either exists already or one that has not been created yet. The following explanations are provided:

• which fields are included or not in the analysis and why,
• how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. If you have object fields or fields that are excluded via source filtering, they are not included in the explanation.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

flushJob

public FlushJobResponse flushJob(FlushJobRequest request)
                          throws IOException,
ElasticsearchException

Forces any buffered data to be processed by the job. The flush jobs API is only applicable when sending data for analysis using the post data API. Depending on the content of the buffer, then it might additionally calculate new results. 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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

flushJob

public final FlushJobResponse flushJob(Function<FlushJobRequest.Builder,ObjectBuilder<FlushJobRequest>> fn)
                                throws IOException,
ElasticsearchException

Forces any buffered data to be processed by the job. The flush jobs API is only applicable when sending data for analysis using the post data API. Depending on the content of the buffer, then it might additionally calculate new results. 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.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

forecast

public ForecastResponse forecast(ForecastRequest request)
                          throws IOException,
ElasticsearchException

Predicts the future behavior of a time series by using its historical behavior.

Forecasts are not supported for jobs that perform population analysis; an error occurs if you try to create a forecast for a job that has an over_field_name in its configuration.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

forecast

public final ForecastResponse forecast(Function<ForecastRequest.Builder,ObjectBuilder<ForecastRequest>> fn)
                                throws IOException,
ElasticsearchException

Predicts the future behavior of a time series by using its historical behavior.

Forecasts are not supported for jobs that perform population analysis; an error occurs if you try to create a forecast for a job that has an over_field_name in its configuration.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getBuckets

public GetBucketsResponse getBuckets(GetBucketsRequest request)
                              throws IOException,
ElasticsearchException

Retrieves anomaly detection job results for one or more buckets. The API presents a chronological view of the records, grouped by bucket.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getBuckets

public final GetBucketsResponse getBuckets(Function<GetBucketsRequest.Builder,ObjectBuilder<GetBucketsRequest>> fn)
                                    throws IOException,
ElasticsearchException

Retrieves anomaly detection job results for one or more buckets. The API presents a chronological view of the records, grouped by bucket.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getCalendarEvents

public GetCalendarEventsResponse getCalendarEvents(GetCalendarEventsRequest request)
                                            throws IOException,
ElasticsearchException

Retrieves information about the scheduled events in calendars.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getCalendarEvents

public final GetCalendarEventsResponse getCalendarEvents(Function<GetCalendarEventsRequest.Builder,ObjectBuilder<GetCalendarEventsRequest>> fn)
                                                  throws IOException,
ElasticsearchException

Retrieves information about the scheduled events in calendars.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getCalendars

public GetCalendarsResponse getCalendars(GetCalendarsRequest request)
                                  throws IOException,
ElasticsearchException

Retrieves configuration information for calendars.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getCalendars

public final GetCalendarsResponse getCalendars(Function<GetCalendarsRequest.Builder,ObjectBuilder<GetCalendarsRequest>> fn)
                                        throws IOException,
ElasticsearchException

Retrieves configuration information for calendars.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getCalendars

public GetCalendarsResponse getCalendars()
                                  throws IOException,
ElasticsearchException

Retrieves configuration information for calendars.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getCategories

public GetCategoriesResponse getCategories(GetCategoriesRequest request)
                                    throws IOException,
ElasticsearchException

Retrieves anomaly detection job results for one or more categories.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getCategories

public final GetCategoriesResponse getCategories(Function<GetCategoriesRequest.Builder,ObjectBuilder<GetCategoriesRequest>> fn)
                                          throws IOException,
ElasticsearchException

Retrieves anomaly detection job results for one or more categories.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getDataFrameAnalytics

public GetDataFrameAnalyticsResponse getDataFrameAnalytics(GetDataFrameAnalyticsRequest request)
                                                    throws IOException,
ElasticsearchException

Retrieves configuration information for data frame analytics jobs. You can get information for multiple data frame analytics jobs in a single API request by using a comma-separated list of data frame analytics jobs or a wildcard expression.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getDataFrameAnalytics

public final GetDataFrameAnalyticsResponse getDataFrameAnalytics(Function<GetDataFrameAnalyticsRequest.Builder,ObjectBuilder<GetDataFrameAnalyticsRequest>> fn)
                                                          throws IOException,
ElasticsearchException

Retrieves configuration information for data frame analytics jobs. You can get information for multiple data frame analytics jobs in a single API request by using a comma-separated list of data frame analytics jobs or a wildcard expression.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getDataFrameAnalytics

public GetDataFrameAnalyticsResponse getDataFrameAnalytics()
                                                    throws IOException,
ElasticsearchException

Retrieves configuration information for data frame analytics jobs. You can get information for multiple data frame analytics jobs in a single API request by using a comma-separated list of data frame analytics jobs or a wildcard expression.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getDataFrameAnalyticsStats

public GetDataFrameAnalyticsStatsResponse getDataFrameAnalyticsStats(GetDataFrameAnalyticsStatsRequest request)
                                                              throws IOException,
ElasticsearchException

Retrieves usage information for data frame analytics jobs.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getDataFrameAnalyticsStats

public final GetDataFrameAnalyticsStatsResponse getDataFrameAnalyticsStats(Function<GetDataFrameAnalyticsStatsRequest.Builder,ObjectBuilder<GetDataFrameAnalyticsStatsRequest>> fn)
                                                                    throws IOException,
ElasticsearchException

Retrieves usage information for data frame analytics jobs.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getDataFrameAnalyticsStats

public GetDataFrameAnalyticsStatsResponse getDataFrameAnalyticsStats()
                                                              throws IOException,
ElasticsearchException

Retrieves usage information for data frame analytics jobs.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getDatafeedStats

public GetDatafeedStatsResponse getDatafeedStats(GetDatafeedStatsRequest request)
                                          throws IOException,
ElasticsearchException

Retrieves usage information for datafeeds. You can get statistics for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get statistics for all datafeeds by using _all, by specifying * as the <feed_id>, or by omitting the <feed_id>. If the datafeed is stopped, the only information you receive is the datafeed_id and the state. This API returns a maximum of 10,000 datafeeds.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getDatafeedStats

public final GetDatafeedStatsResponse getDatafeedStats(Function<GetDatafeedStatsRequest.Builder,ObjectBuilder<GetDatafeedStatsRequest>> fn)
                                                throws IOException,
ElasticsearchException

Retrieves usage information for datafeeds. You can get statistics for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get statistics for all datafeeds by using _all, by specifying * as the <feed_id>, or by omitting the <feed_id>. If the datafeed is stopped, the only information you receive is the datafeed_id and the state. This API returns a maximum of 10,000 datafeeds.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getDatafeedStats

public GetDatafeedStatsResponse getDatafeedStats()
                                          throws IOException,
ElasticsearchException

Retrieves usage information for datafeeds. You can get statistics for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get statistics for all datafeeds by using _all, by specifying * as the <feed_id>, or by omitting the <feed_id>. If the datafeed is stopped, the only information you receive is the datafeed_id and the state. This API returns a maximum of 10,000 datafeeds.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getDatafeeds

public GetDatafeedsResponse getDatafeeds(GetDatafeedsRequest request)
                                  throws IOException,
ElasticsearchException

Retrieves configuration information for datafeeds. You can get information for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get information for all datafeeds by using _all, by specifying * as the <feed_id>, or by omitting the <feed_id>. This API returns a maximum of 10,000 datafeeds.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getDatafeeds

public final GetDatafeedsResponse getDatafeeds(Function<GetDatafeedsRequest.Builder,ObjectBuilder<GetDatafeedsRequest>> fn)
                                        throws IOException,
ElasticsearchException

Retrieves configuration information for datafeeds. You can get information for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get information for all datafeeds by using _all, by specifying * as the <feed_id>, or by omitting the <feed_id>. This API returns a maximum of 10,000 datafeeds.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getDatafeeds

public GetDatafeedsResponse getDatafeeds()
                                  throws IOException,
ElasticsearchException

Retrieves configuration information for datafeeds. You can get information for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get information for all datafeeds by using _all, by specifying * as the <feed_id>, or by omitting the <feed_id>. This API returns a maximum of 10,000 datafeeds.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getFilters

public GetFiltersResponse getFilters(GetFiltersRequest request)
                              throws IOException,
ElasticsearchException

Retrieves filters. You can get a single filter or all filters.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getFilters

public final GetFiltersResponse getFilters(Function<GetFiltersRequest.Builder,ObjectBuilder<GetFiltersRequest>> fn)
                                    throws IOException,
ElasticsearchException

Retrieves filters. You can get a single filter or all filters.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getFilters

public GetFiltersResponse getFilters()
                              throws IOException,
ElasticsearchException

Retrieves filters. You can get a single filter or all filters.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getInfluencers

public GetInfluencersResponse getInfluencers(GetInfluencersRequest request)
                                      throws IOException,
ElasticsearchException

Retrieves anomaly detection job results for one or more influencers. Influencers are the entities that have contributed to, or are to blame for, the anomalies. Influencer results are available only if an influencer_field_name is specified in the job configuration.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getInfluencers

public final GetInfluencersResponse getInfluencers(Function<GetInfluencersRequest.Builder,ObjectBuilder<GetInfluencersRequest>> fn)
                                            throws IOException,
ElasticsearchException

Retrieves anomaly detection job results for one or more influencers. Influencers are the entities that have contributed to, or are to blame for, the anomalies. Influencer results are available only if an influencer_field_name is specified in the job configuration.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getJobStats

public GetJobStatsResponse getJobStats(GetJobStatsRequest request)
                                throws IOException,
ElasticsearchException

Retrieves usage information for anomaly detection jobs.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getJobStats

public final GetJobStatsResponse getJobStats(Function<GetJobStatsRequest.Builder,ObjectBuilder<GetJobStatsRequest>> fn)
                                      throws IOException,
ElasticsearchException

Retrieves usage information for anomaly detection jobs.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getJobStats

public GetJobStatsResponse getJobStats()
                                throws IOException,
ElasticsearchException

Retrieves usage information for anomaly detection jobs.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getJobs

public GetJobsResponse getJobs(GetJobsRequest request)
                        throws IOException,
ElasticsearchException

Retrieves configuration information for anomaly detection jobs. You can get information for multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can get information for all anomaly detection jobs by using _all, by specifying * as the <job_id>, or by omitting the <job_id>.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getJobs

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

Retrieves configuration information for anomaly detection jobs. You can get information for multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can get information for all anomaly detection jobs by using _all, by specifying * as the <job_id>, or by omitting the <job_id>.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getJobs

public GetJobsResponse getJobs()
                        throws IOException,
ElasticsearchException

Retrieves configuration information for anomaly detection jobs. You can get information for multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can get information for all anomaly detection jobs by using _all, by specifying * as the <job_id>, or by omitting the <job_id>.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getMemoryStats

public GetMemoryStatsResponse getMemoryStats(GetMemoryStatsRequest request)
                                      throws IOException,
ElasticsearchException

Get information about how machine learning jobs and trained models are using memory, on each node, both within the JVM heap, and natively, outside of the JVM.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getMemoryStats

public final GetMemoryStatsResponse getMemoryStats(Function<GetMemoryStatsRequest.Builder,ObjectBuilder<GetMemoryStatsRequest>> fn)
                                            throws IOException,
ElasticsearchException

Get information about how machine learning jobs and trained models are using memory, on each node, both within the JVM heap, and natively, outside of the JVM.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getMemoryStats

public GetMemoryStatsResponse getMemoryStats()
                                      throws IOException,
ElasticsearchException

Get information about how machine learning jobs and trained models are using memory, on each node, both within the JVM heap, and natively, outside of the JVM.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getModelSnapshotUpgradeStats

public GetModelSnapshotUpgradeStatsResponse getModelSnapshotUpgradeStats(GetModelSnapshotUpgradeStatsRequest request)
                                                                  throws IOException,
ElasticsearchException

Retrieves usage information for anomaly detection job model snapshot upgrades.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getModelSnapshotUpgradeStats

public final GetModelSnapshotUpgradeStatsResponse getModelSnapshotUpgradeStats(Function<GetModelSnapshotUpgradeStatsRequest.Builder,ObjectBuilder<GetModelSnapshotUpgradeStatsRequest>> fn)
                                                                        throws IOException,
ElasticsearchException

Retrieves usage information for anomaly detection job model snapshot upgrades.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getModelSnapshots

public GetModelSnapshotsResponse getModelSnapshots(GetModelSnapshotsRequest request)
                                            throws IOException,
ElasticsearchException

Retrieves information about model snapshots.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getModelSnapshots

public final GetModelSnapshotsResponse getModelSnapshots(Function<GetModelSnapshotsRequest.Builder,ObjectBuilder<GetModelSnapshotsRequest>> fn)
                                                  throws IOException,
ElasticsearchException

Retrieves information about model snapshots.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getOverallBuckets

public GetOverallBucketsResponse getOverallBuckets(GetOverallBucketsRequest request)
                                            throws IOException,
ElasticsearchException

Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.

The overall_score is calculated by combining the scores of all the buckets within the overall bucket span. First, the maximum anomaly_score per anomaly detection job in the overall bucket is calculated. Then the top_n of those scores are averaged to result in the overall_score. This means that you can fine-tune the overall_score so that it is more or less sensitive to the number of jobs that detect an anomaly at the same time. For example, if you set top_n to 1, the overall_score is the maximum bucket score in the overall bucket. Alternatively, if you set top_n to the number of jobs, the overall_score is high only when all jobs detect anomalies in that overall bucket. If you set the bucket_span parameter (to a value greater than its default), the overall_score is the maximum overall_score of the overall buckets that have a span equal to the jobs' largest bucket span.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getOverallBuckets

public final GetOverallBucketsResponse getOverallBuckets(Function<GetOverallBucketsRequest.Builder,ObjectBuilder<GetOverallBucketsRequest>> fn)
                                                  throws IOException,
ElasticsearchException

Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.

The overall_score is calculated by combining the scores of all the buckets within the overall bucket span. First, the maximum anomaly_score per anomaly detection job in the overall bucket is calculated. Then the top_n of those scores are averaged to result in the overall_score. This means that you can fine-tune the overall_score so that it is more or less sensitive to the number of jobs that detect an anomaly at the same time. For example, if you set top_n to 1, the overall_score is the maximum bucket score in the overall bucket. Alternatively, if you set top_n to the number of jobs, the overall_score is high only when all jobs detect anomalies in that overall bucket. If you set the bucket_span parameter (to a value greater than its default), the overall_score is the maximum overall_score of the overall buckets that have a span equal to the jobs' largest bucket span.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getRecords

public GetRecordsResponse getRecords(GetRecordsRequest request)
                              throws IOException,
ElasticsearchException

Retrieves anomaly records for an anomaly detection job. Records contain the detailed analytical results. They describe the anomalous activity that has been identified in the input data based on the detector configuration. There can be many anomaly records depending on the characteristics and size of the input data. In practice, there are often too many to be able to manually process them. The machine learning features therefore perform a sophisticated aggregation of the anomaly records into buckets. The number of record results depends on the number of anomalies found in each bucket, which relates to the number of time series being modeled and the number of detectors.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getRecords

public final GetRecordsResponse getRecords(Function<GetRecordsRequest.Builder,ObjectBuilder<GetRecordsRequest>> fn)
                                    throws IOException,
ElasticsearchException

Retrieves anomaly records for an anomaly detection job. Records contain the detailed analytical results. They describe the anomalous activity that has been identified in the input data based on the detector configuration. There can be many anomaly records depending on the characteristics and size of the input data. In practice, there are often too many to be able to manually process them. The machine learning features therefore perform a sophisticated aggregation of the anomaly records into buckets. The number of record results depends on the number of anomalies found in each bucket, which relates to the number of time series being modeled and the number of detectors.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getTrainedModels

public GetTrainedModelsResponse getTrainedModels(GetTrainedModelsRequest request)
                                          throws IOException,
ElasticsearchException

Retrieves configuration information for a trained model.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getTrainedModels

public final GetTrainedModelsResponse getTrainedModels(Function<GetTrainedModelsRequest.Builder,ObjectBuilder<GetTrainedModelsRequest>> fn)
                                                throws IOException,
ElasticsearchException

Retrieves configuration information for a trained model.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getTrainedModels

public GetTrainedModelsResponse getTrainedModels()
                                          throws IOException,
ElasticsearchException

Retrieves configuration information for a trained model.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getTrainedModelsStats

public GetTrainedModelsStatsResponse getTrainedModelsStats(GetTrainedModelsStatsRequest request)
                                                    throws IOException,
ElasticsearchException

Retrieves usage information for trained models. You can get usage information for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getTrainedModelsStats

public final GetTrainedModelsStatsResponse getTrainedModelsStats(Function<GetTrainedModelsStatsRequest.Builder,ObjectBuilder<GetTrainedModelsStatsRequest>> fn)
                                                          throws IOException,
ElasticsearchException

Retrieves usage information for trained models. You can get usage information for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getTrainedModelsStats

public GetTrainedModelsStatsResponse getTrainedModelsStats()
                                                    throws IOException,
ElasticsearchException

Retrieves usage information for trained models. You can get usage information for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

inferTrainedModel

public InferTrainedModelResponse inferTrainedModel(InferTrainedModelRequest request)
                                            throws IOException,
ElasticsearchException

Evaluates a trained model.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

inferTrainedModel

public final InferTrainedModelResponse inferTrainedModel(Function<InferTrainedModelRequest.Builder,ObjectBuilder<InferTrainedModelRequest>> fn)
                                                  throws IOException,
ElasticsearchException

Evaluates a trained model.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

info

public MlInfoResponse info()
                    throws IOException,
ElasticsearchException

Returns defaults and limits used by machine learning. This endpoint is designed to be used by a user interface that needs to fully understand machine learning configurations where some options are not specified, meaning that the defaults should be used. This endpoint may be used to find out what those defaults are. It also provides information about the maximum size of machine learning jobs that could run in the current cluster configuration.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

openJob

public OpenJobResponse openJob(OpenJobRequest request)
                        throws IOException,
ElasticsearchException

Opens one or more anomaly detection jobs. An anomaly detection job must be opened in order for it to be ready to receive and analyze data. It can be opened and closed multiple times throughout its lifecycle. 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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

openJob

public final OpenJobResponse openJob(Function<OpenJobRequest.Builder,ObjectBuilder<OpenJobRequest>> fn)
                              throws IOException,
ElasticsearchException

Opens one or more anomaly detection jobs. An anomaly detection job must be opened in order for it to be ready to receive and analyze data. It can be opened and closed multiple times throughout its lifecycle. 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.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

postCalendarEvents

public PostCalendarEventsResponse postCalendarEvents(PostCalendarEventsRequest request)
                                              throws IOException,
ElasticsearchException

Adds scheduled events to a calendar.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

postCalendarEvents

public final PostCalendarEventsResponse postCalendarEvents(Function<PostCalendarEventsRequest.Builder,ObjectBuilder<PostCalendarEventsRequest>> fn)
                                                    throws IOException,
ElasticsearchException

Adds scheduled events to a calendar.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

postData

public <TData> PostDataResponse postData(PostDataRequest<TData> request)
                                  throws IOException,
ElasticsearchException

Sends data to an anomaly detection job for analysis.

IMPORTANT: For each job, data can be accepted from only a single connection at a time. It is not currently possible to post data to multiple jobs using wildcards or a comma-separated list.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

postData

public final <TData> PostDataResponse postData(Function<PostDataRequest.Builder<TData>,ObjectBuilder<PostDataRequest<TData>>> fn)
                                        throws IOException,
ElasticsearchException

Sends data to an anomaly detection job for analysis.

IMPORTANT: For each job, data can be accepted from only a single connection at a time. It is not currently possible to post data to multiple jobs using wildcards or a comma-separated list.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

previewDataFrameAnalytics

public PreviewDataFrameAnalyticsResponse previewDataFrameAnalytics(PreviewDataFrameAnalyticsRequest request)
                                                            throws IOException,
ElasticsearchException

Previews the extracted features used by a data frame analytics config.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

previewDataFrameAnalytics

public final PreviewDataFrameAnalyticsResponse previewDataFrameAnalytics(Function<PreviewDataFrameAnalyticsRequest.Builder,ObjectBuilder<PreviewDataFrameAnalyticsRequest>> fn)
                                                                  throws IOException,
ElasticsearchException

Previews the extracted features used by a data frame analytics config.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

previewDataFrameAnalytics

public PreviewDataFrameAnalyticsResponse previewDataFrameAnalytics()
                                                            throws IOException,
ElasticsearchException

Previews the extracted features used by a data frame analytics config.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

previewDatafeed

public <TDocument>
PreviewDatafeedResponse<TDocument> previewDatafeed(PreviewDatafeedRequest request,
 Class<TDocument> tDocumentClass)
                                            throws IOException,
ElasticsearchException

Previews a datafeed. This API returns the first "page" of search results from a datafeed. You can preview an existing datafeed or provide configuration details for a datafeed and anomaly detection job in the API. The preview shows the structure of the data that will be passed to the anomaly detection engine. IMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that called the API. However, when the datafeed starts it uses the roles of the last user that created or updated the datafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials. You can also use secondary authorization headers to supply the credentials.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

previewDatafeed

public final <TDocument>
PreviewDatafeedResponse<TDocument> previewDatafeed(Function<PreviewDatafeedRequest.Builder,ObjectBuilder<PreviewDatafeedRequest>> fn,
 Class<TDocument> tDocumentClass)
                                            throws IOException,
ElasticsearchException

Previews a datafeed. This API returns the first "page" of search results from a datafeed. You can preview an existing datafeed or provide configuration details for a datafeed and anomaly detection job in the API. The preview shows the structure of the data that will be passed to the anomaly detection engine. IMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that called the API. However, when the datafeed starts it uses the roles of the last user that created or updated the datafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials. You can also use secondary authorization headers to supply the credentials.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

previewDatafeed

public <TDocument>
PreviewDatafeedResponse<TDocument> previewDatafeed(PreviewDatafeedRequest request,
 Type tDocumentType)
                                            throws IOException,
ElasticsearchException

Previews a datafeed. This API returns the first "page" of search results from a datafeed. You can preview an existing datafeed or provide configuration details for a datafeed and anomaly detection job in the API. The preview shows the structure of the data that will be passed to the anomaly detection engine. IMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that called the API. However, when the datafeed starts it uses the roles of the last user that created or updated the datafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials. You can also use secondary authorization headers to supply the credentials.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

previewDatafeed

public final <TDocument>
PreviewDatafeedResponse<TDocument> previewDatafeed(Function<PreviewDatafeedRequest.Builder,ObjectBuilder<PreviewDatafeedRequest>> fn,
 Type tDocumentType)
                                            throws IOException,
ElasticsearchException

Previews a datafeed. This API returns the first "page" of search results from a datafeed. You can preview an existing datafeed or provide configuration details for a datafeed and anomaly detection job in the API. The preview shows the structure of the data that will be passed to the anomaly detection engine. IMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that called the API. However, when the datafeed starts it uses the roles of the last user that created or updated the datafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials. You can also use secondary authorization headers to supply the credentials.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putCalendar

public PutCalendarResponse putCalendar(PutCalendarRequest request)
                                throws IOException,
ElasticsearchException

Creates a calendar.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putCalendar

public final PutCalendarResponse putCalendar(Function<PutCalendarRequest.Builder,ObjectBuilder<PutCalendarRequest>> fn)
                                      throws IOException,
ElasticsearchException

Creates a calendar.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putCalendarJob

public PutCalendarJobResponse putCalendarJob(PutCalendarJobRequest request)
                                      throws IOException,
ElasticsearchException

Adds an anomaly detection job to a calendar.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putCalendarJob

public final PutCalendarJobResponse putCalendarJob(Function<PutCalendarJobRequest.Builder,ObjectBuilder<PutCalendarJobRequest>> fn)
                                            throws IOException,
ElasticsearchException

Adds an anomaly detection job to a calendar.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putDataFrameAnalytics

public PutDataFrameAnalyticsResponse putDataFrameAnalytics(PutDataFrameAnalyticsRequest request)
                                                    throws IOException,
ElasticsearchException

Instantiates a data frame analytics job. This API creates a data frame analytics job that performs an analysis on the source indices and stores the outcome in a destination index.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putDataFrameAnalytics

public final PutDataFrameAnalyticsResponse putDataFrameAnalytics(Function<PutDataFrameAnalyticsRequest.Builder,ObjectBuilder<PutDataFrameAnalyticsRequest>> fn)
                                                          throws IOException,
ElasticsearchException

Instantiates a data frame analytics job. This API creates a data frame analytics job that performs an analysis on the source indices and stores the outcome in a destination index.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putDatafeed

public PutDatafeedResponse putDatafeed(PutDatafeedRequest request)
                                throws IOException,
ElasticsearchException

Instantiates a datafeed. Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. You can associate only one datafeed with each anomaly detection job. The datafeed contains a query that runs at a defined interval (frequency). If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putDatafeed

public final PutDatafeedResponse putDatafeed(Function<PutDatafeedRequest.Builder,ObjectBuilder<PutDatafeedRequest>> fn)
                                      throws IOException,
ElasticsearchException

Instantiates a datafeed. Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. You can associate only one datafeed with each anomaly detection job. The datafeed contains a query that runs at a defined interval (frequency). If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putFilter

public PutFilterResponse putFilter(PutFilterRequest request)
                            throws IOException,
ElasticsearchException

Instantiates a filter. A filter contains a list of strings. It can be used by one or more anomaly detection jobs. Specifically, filters are referenced in the custom_rules property of detector configuration objects.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putFilter

public final PutFilterResponse putFilter(Function<PutFilterRequest.Builder,ObjectBuilder<PutFilterRequest>> fn)
                                  throws IOException,
ElasticsearchException

Instantiates a filter. A filter contains a list of strings. It can be used by one or more anomaly detection jobs. Specifically, filters are referenced in the custom_rules property of detector configuration objects.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putJob

public PutJobResponse putJob(PutJobRequest request)
                      throws IOException,
ElasticsearchException

Instantiates an anomaly detection job. If you include a datafeed_config, you must have read index privileges on the source index.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putJob

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

Instantiates an anomaly detection job. If you include a datafeed_config, you must have read index privileges on the source index.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putTrainedModel

public PutTrainedModelResponse putTrainedModel(PutTrainedModelRequest request)
                                        throws IOException,
ElasticsearchException

Enables you to supply a trained model that is not created by data frame analytics.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putTrainedModel

public final PutTrainedModelResponse putTrainedModel(Function<PutTrainedModelRequest.Builder,ObjectBuilder<PutTrainedModelRequest>> fn)
                                              throws IOException,
ElasticsearchException

Enables you to supply a trained model that is not created by data frame analytics.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putTrainedModelAlias

public PutTrainedModelAliasResponse putTrainedModelAlias(PutTrainedModelAliasRequest request)
                                                  throws IOException,
ElasticsearchException

Creates or updates a trained model alias. A trained model alias is a logical name used to reference a single trained model. You can use aliases instead of trained model identifiers to make it easier to reference your models. For example, you can use aliases in inference aggregations and processors. An alias must be unique and refer to only a single trained model. However, you can have multiple aliases for each trained model. If you use this API to update an alias such that it references a different trained model ID and the model uses a different type of data frame analytics, an error occurs. For example, this situation occurs if you have a trained model for regression analysis and a trained model for classification analysis; you cannot reassign an alias from one type of trained model to another. If you use this API to update an alias and there are very few input fields in common between the old and new trained models for the model alias, the API returns a warning.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putTrainedModelAlias

public final PutTrainedModelAliasResponse putTrainedModelAlias(Function<PutTrainedModelAliasRequest.Builder,ObjectBuilder<PutTrainedModelAliasRequest>> fn)
                                                        throws IOException,
ElasticsearchException

Creates or updates a trained model alias. A trained model alias is a logical name used to reference a single trained model. You can use aliases instead of trained model identifiers to make it easier to reference your models. For example, you can use aliases in inference aggregations and processors. An alias must be unique and refer to only a single trained model. However, you can have multiple aliases for each trained model. If you use this API to update an alias such that it references a different trained model ID and the model uses a different type of data frame analytics, an error occurs. For example, this situation occurs if you have a trained model for regression analysis and a trained model for classification analysis; you cannot reassign an alias from one type of trained model to another. If you use this API to update an alias and there are very few input fields in common between the old and new trained models for the model alias, the API returns a warning.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putTrainedModelDefinitionPart

public PutTrainedModelDefinitionPartResponse putTrainedModelDefinitionPart(PutTrainedModelDefinitionPartRequest request)
                                                                    throws IOException,
ElasticsearchException

Creates part of a trained model definition.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putTrainedModelDefinitionPart

public final PutTrainedModelDefinitionPartResponse putTrainedModelDefinitionPart(Function<PutTrainedModelDefinitionPartRequest.Builder,ObjectBuilder<PutTrainedModelDefinitionPartRequest>> fn)
                                                                          throws IOException,
ElasticsearchException

Creates part of a trained model definition.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putTrainedModelVocabulary

public PutTrainedModelVocabularyResponse putTrainedModelVocabulary(PutTrainedModelVocabularyRequest request)
                                                            throws IOException,
ElasticsearchException

Creates a trained model vocabulary. This API is supported only for natural language processing (NLP) models. The vocabulary is stored in the index as described in inference_config.*.vocabulary of the trained model definition.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putTrainedModelVocabulary

public final PutTrainedModelVocabularyResponse putTrainedModelVocabulary(Function<PutTrainedModelVocabularyRequest.Builder,ObjectBuilder<PutTrainedModelVocabularyRequest>> fn)
                                                                  throws IOException,
ElasticsearchException

Creates a trained model vocabulary. This API is supported only for natural language processing (NLP) models. The vocabulary is stored in the index as described in inference_config.*.vocabulary of the trained model definition.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

resetJob

public ResetJobResponse resetJob(ResetJobRequest request)
                          throws IOException,
ElasticsearchException

Resets an anomaly detection job. All model state and results are deleted. The job is ready to start over as if it had just been created. It is not currently possible to reset multiple jobs using wildcards or a comma separated list.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

resetJob

public final ResetJobResponse resetJob(Function<ResetJobRequest.Builder,ObjectBuilder<ResetJobRequest>> fn)
                                throws IOException,
ElasticsearchException

Resets an anomaly detection job. All model state and results are deleted. The job is ready to start over as if it had just been created. It is not currently possible to reset multiple jobs using wildcards or a comma separated list.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

revertModelSnapshot

public RevertModelSnapshotResponse revertModelSnapshot(RevertModelSnapshotRequest request)
                                                throws IOException,
ElasticsearchException

Reverts to a specific snapshot. The machine learning features react quickly to anomalous input, learning new behaviors in data. Highly anomalous input increases the variance in the models whilst the system learns whether this is a new step-change in behavior or a one-off event. In the case where this anomalous input is known to be a one-off, then it might be appropriate to reset the model state to a time before this event. For example, you might consider reverting to a saved snapshot after Black Friday or a critical system failure.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

revertModelSnapshot

public final RevertModelSnapshotResponse revertModelSnapshot(Function<RevertModelSnapshotRequest.Builder,ObjectBuilder<RevertModelSnapshotRequest>> fn)
                                                      throws IOException,
ElasticsearchException

Reverts to a specific snapshot. The machine learning features react quickly to anomalous input, learning new behaviors in data. Highly anomalous input increases the variance in the models whilst the system learns whether this is a new step-change in behavior or a one-off event. In the case where this anomalous input is known to be a one-off, then it might be appropriate to reset the model state to a time before this event. For example, you might consider reverting to a saved snapshot after Black Friday or a critical system failure.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

setUpgradeMode

public SetUpgradeModeResponse setUpgradeMode(SetUpgradeModeRequest request)
                                      throws IOException,
ElasticsearchException

Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade. When upgrading your cluster, in some circumstances you must restart your nodes and reindex your machine learning indices. In those circumstances, there must be no machine learning jobs running. You can close the machine learning jobs, do the upgrade, then open all the jobs again. Alternatively, you can use this API to temporarily halt tasks associated with the jobs and datafeeds and prevent new jobs from opening. You can also use this API during upgrades that do not require you to reindex your machine learning indices, though stopping jobs is not a requirement in that case. You can see the current value for the upgrade_mode setting by using the get machine learning info API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

setUpgradeMode

public final SetUpgradeModeResponse setUpgradeMode(Function<SetUpgradeModeRequest.Builder,ObjectBuilder<SetUpgradeModeRequest>> fn)
                                            throws IOException,
ElasticsearchException

Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade. When upgrading your cluster, in some circumstances you must restart your nodes and reindex your machine learning indices. In those circumstances, there must be no machine learning jobs running. You can close the machine learning jobs, do the upgrade, then open all the jobs again. Alternatively, you can use this API to temporarily halt tasks associated with the jobs and datafeeds and prevent new jobs from opening. You can also use this API during upgrades that do not require you to reindex your machine learning indices, though stopping jobs is not a requirement in that case. You can see the current value for the upgrade_mode setting by using the get machine learning info API.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

setUpgradeMode

public SetUpgradeModeResponse setUpgradeMode()
                                      throws IOException,
ElasticsearchException

Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade. When upgrading your cluster, in some circumstances you must restart your nodes and reindex your machine learning indices. In those circumstances, there must be no machine learning jobs running. You can close the machine learning jobs, do the upgrade, then open all the jobs again. Alternatively, you can use this API to temporarily halt tasks associated with the jobs and datafeeds and prevent new jobs from opening. You can also use this API during upgrades that do not require you to reindex your machine learning indices, though stopping jobs is not a requirement in that case. You can see the current value for the upgrade_mode setting by using the get machine learning info API.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

startDataFrameAnalytics

public StartDataFrameAnalyticsResponse startDataFrameAnalytics(StartDataFrameAnalyticsRequest request)
                                                        throws IOException,
ElasticsearchException

Starts a data frame analytics job. A data frame analytics job can be started and stopped multiple times throughout its lifecycle. If the destination index does not exist, it is created automatically the first time you start the data frame analytics job. The index.number_of_shards and index.number_of_replicas settings for the destination index are copied from the source index. If there are multiple source indices, the destination index copies the highest setting values. The mappings for the destination index are also copied from the source indices. If there are any mapping conflicts, the job fails to start. If the destination index exists, it is used as is. You can therefore set up the destination index in advance with custom settings and mappings.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

startDataFrameAnalytics

public final StartDataFrameAnalyticsResponse startDataFrameAnalytics(Function<StartDataFrameAnalyticsRequest.Builder,ObjectBuilder<StartDataFrameAnalyticsRequest>> fn)
                                                              throws IOException,
ElasticsearchException

Starts a data frame analytics job. A data frame analytics job can be started and stopped multiple times throughout its lifecycle. If the destination index does not exist, it is created automatically the first time you start the data frame analytics job. The index.number_of_shards and index.number_of_replicas settings for the destination index are copied from the source index. If there are multiple source indices, the destination index copies the highest setting values. The mappings for the destination index are also copied from the source indices. If there are any mapping conflicts, the job fails to start. If the destination index exists, it is used as is. You can therefore set up the destination index in advance with custom settings and mappings.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

startDatafeed

public StartDatafeedResponse startDatafeed(StartDatafeedRequest request)
                                    throws IOException,
ElasticsearchException

Starts one or more datafeeds.

A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped multiple times throughout its lifecycle.

Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs.

If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped. If new data was indexed for that exact millisecond between stopping and starting, it will be ignored.

When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or update it had at the time of creation or update and runs the query using those same roles. If you provided secondary authorization headers when you created or updated the datafeed, those credentials are used instead.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

startDatafeed

public final StartDatafeedResponse startDatafeed(Function<StartDatafeedRequest.Builder,ObjectBuilder<StartDatafeedRequest>> fn)
                                          throws IOException,
ElasticsearchException

Starts one or more datafeeds.

A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped multiple times throughout its lifecycle.

Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs.

If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped. If new data was indexed for that exact millisecond between stopping and starting, it will be ignored.

When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or update it had at the time of creation or update and runs the query using those same roles. If you provided secondary authorization headers when you created or updated the datafeed, those credentials are used instead.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

startTrainedModelDeployment

public StartTrainedModelDeploymentResponse startTrainedModelDeployment(StartTrainedModelDeploymentRequest request)
                                                                throws IOException,
ElasticsearchException

Starts a trained model deployment, which allocates the model to every machine learning node.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

startTrainedModelDeployment

public final StartTrainedModelDeploymentResponse startTrainedModelDeployment(Function<StartTrainedModelDeploymentRequest.Builder,ObjectBuilder<StartTrainedModelDeploymentRequest>> fn)
                                                                      throws IOException,
ElasticsearchException

Starts a trained model deployment, which allocates the model to every machine learning node.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stopDataFrameAnalytics

public StopDataFrameAnalyticsResponse stopDataFrameAnalytics(StopDataFrameAnalyticsRequest request)
                                                      throws IOException,
ElasticsearchException

Stops one or more data frame analytics jobs. A data frame analytics job can be started and stopped multiple times throughout its lifecycle.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stopDataFrameAnalytics

public final StopDataFrameAnalyticsResponse stopDataFrameAnalytics(Function<StopDataFrameAnalyticsRequest.Builder,ObjectBuilder<StopDataFrameAnalyticsRequest>> fn)
                                                            throws IOException,
ElasticsearchException

Stops one or more data frame analytics jobs. A data frame analytics job can be started and stopped multiple times throughout its lifecycle.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stopDatafeed

public StopDatafeedResponse stopDatafeed(StopDatafeedRequest request)
                                  throws IOException,
ElasticsearchException

Stops one or more datafeeds. A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped multiple times throughout its lifecycle.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stopDatafeed

public final StopDatafeedResponse stopDatafeed(Function<StopDatafeedRequest.Builder,ObjectBuilder<StopDatafeedRequest>> fn)
                                        throws IOException,
ElasticsearchException

Stops one or more datafeeds. A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped multiple times throughout its lifecycle.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stopTrainedModelDeployment

public StopTrainedModelDeploymentResponse stopTrainedModelDeployment(StopTrainedModelDeploymentRequest request)
                                                              throws IOException,
ElasticsearchException

Stops a trained model deployment.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stopTrainedModelDeployment

public final StopTrainedModelDeploymentResponse stopTrainedModelDeployment(Function<StopTrainedModelDeploymentRequest.Builder,ObjectBuilder<StopTrainedModelDeploymentRequest>> fn)
                                                                    throws IOException,
ElasticsearchException

Stops a trained model deployment.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateDataFrameAnalytics

public UpdateDataFrameAnalyticsResponse updateDataFrameAnalytics(UpdateDataFrameAnalyticsRequest request)
                                                          throws IOException,
ElasticsearchException

Updates an existing data frame analytics job.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateDataFrameAnalytics

public final UpdateDataFrameAnalyticsResponse updateDataFrameAnalytics(Function<UpdateDataFrameAnalyticsRequest.Builder,ObjectBuilder<UpdateDataFrameAnalyticsRequest>> fn)
                                                                throws IOException,
ElasticsearchException

Updates an existing data frame analytics job.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateDatafeed

public UpdateDatafeedResponse updateDatafeed(UpdateDatafeedRequest request)
                                      throws IOException,
ElasticsearchException

Updates the properties of a datafeed. You must stop and start the datafeed for the changes to be applied. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at the time of the update and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateDatafeed

public final UpdateDatafeedResponse updateDatafeed(Function<UpdateDatafeedRequest.Builder,ObjectBuilder<UpdateDatafeedRequest>> fn)
                                            throws IOException,
ElasticsearchException

Updates the properties of a datafeed. You must stop and start the datafeed for the changes to be applied. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at the time of the update and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateFilter

public UpdateFilterResponse updateFilter(UpdateFilterRequest request)
                                  throws IOException,
ElasticsearchException

Updates the description of a filter, adds items, or removes items from the list.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateFilter

public final UpdateFilterResponse updateFilter(Function<UpdateFilterRequest.Builder,ObjectBuilder<UpdateFilterRequest>> fn)
                                        throws IOException,
ElasticsearchException

Updates the description of a filter, adds items, or removes items from the list.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateJob

public UpdateJobResponse updateJob(UpdateJobRequest request)
                            throws IOException,
ElasticsearchException

Updates certain properties of an anomaly detection job.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateJob

public final UpdateJobResponse updateJob(Function<UpdateJobRequest.Builder,ObjectBuilder<UpdateJobRequest>> fn)
                                  throws IOException,
ElasticsearchException

Updates certain properties of an anomaly detection job.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateModelSnapshot

public UpdateModelSnapshotResponse updateModelSnapshot(UpdateModelSnapshotRequest request)
                                                throws IOException,
ElasticsearchException

Updates certain properties of a snapshot.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateModelSnapshot

public final UpdateModelSnapshotResponse updateModelSnapshot(Function<UpdateModelSnapshotRequest.Builder,ObjectBuilder<UpdateModelSnapshotRequest>> fn)
                                                      throws IOException,
ElasticsearchException

Updates certain properties of a snapshot.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateTrainedModelDeployment

public UpdateTrainedModelDeploymentResponse updateTrainedModelDeployment(UpdateTrainedModelDeploymentRequest request)
                                                                  throws IOException,
ElasticsearchException

Starts a trained model deployment, which allocates the model to every machine learning node.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateTrainedModelDeployment

public final UpdateTrainedModelDeploymentResponse updateTrainedModelDeployment(Function<UpdateTrainedModelDeploymentRequest.Builder,ObjectBuilder<UpdateTrainedModelDeploymentRequest>> fn)
                                                                        throws IOException,
ElasticsearchException

Starts a trained model deployment, which allocates the model to every machine learning node.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

upgradeJobSnapshot

public UpgradeJobSnapshotResponse upgradeJobSnapshot(UpgradeJobSnapshotRequest request)
                                              throws IOException,
ElasticsearchException

Upgrades an anomaly detection model snapshot to the latest major version. Over time, older snapshot formats are deprecated and removed. Anomaly detection jobs support only snapshots that are from the current or previous major version. This API provides a means to upgrade a snapshot to the current major version. This aids in preparing the cluster for an upgrade to the next major version. Only one snapshot per anomaly detection job can be upgraded at a time and the upgraded snapshot cannot be the current snapshot of the anomaly detection job.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

upgradeJobSnapshot

public final UpgradeJobSnapshotResponse upgradeJobSnapshot(Function<UpgradeJobSnapshotRequest.Builder,ObjectBuilder<UpgradeJobSnapshotRequest>> fn)
                                                    throws IOException,
ElasticsearchException

Upgrades an anomaly detection model snapshot to the latest major version. Over time, older snapshot formats are deprecated and removed. Anomaly detection jobs support only snapshots that are from the current or previous major version. This API provides a means to upgrade a snapshot to the current major version. This aids in preparing the cluster for an upgrade to the next major version. Only one snapshot per anomaly detection job can be upgraded at a time and the upgraded snapshot cannot be the current snapshot of the anomaly detection job.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

validate

public ValidateResponse validate(ValidateRequest request)
                          throws IOException,
ElasticsearchException

Validates an anomaly detection job.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

validate

public final ValidateResponse validate(Function<ValidateRequest.Builder,ObjectBuilder<ValidateRequest>> fn)
                                throws IOException,
ElasticsearchException

Validates an anomaly detection job.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

validate

public ValidateResponse validate()
                          throws IOException,
ElasticsearchException

Validates an anomaly detection job.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

validateDetector

public ValidateDetectorResponse validateDetector(ValidateDetectorRequest request)
                                          throws IOException,
ElasticsearchException

Validates an anomaly detection detector.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

validateDetector

public final ValidateDetectorResponse validateDetector(Function<ValidateDetectorRequest.Builder,ObjectBuilder<ValidateDetectorRequest>> fn)
                                                throws IOException,
ElasticsearchException

Validates an anomaly detection detector.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

validateDetector

public ValidateDetectorResponse validateDetector()
                                          throws IOException,
ElasticsearchException

Validates an anomaly detection detector.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co