mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-27 15:39:49 +00:00
b2243337d8
This adds a setting to data frame analytics jobs called `max_number_threads`. The setting expects a positive integer. When used the user specifies the max number of threads that may be used by the analysis. Note that the actual number of threads used is limited by the number of processors on the node where the job is assigned. Also, the process may use a couple more threads for operational functionality that is not the analysis itself. This setting may also be updated for a stopped job. More threads may reduce the time it takes to complete the job at the cost of using more CPU. Backport of #59254 and #57274
53 lines
1.7 KiB
Plaintext
53 lines
1.7 KiB
Plaintext
--
|
|
:api: update-data-frame-analytics
|
|
:request: UpdateDataFrameAnalyticsRequest
|
|
:response: UpdateDataFrameAnalyticsResponse
|
|
--
|
|
[role="xpack"]
|
|
[id="{upid}-{api}"]
|
|
=== Update {dfanalytics-jobs} API
|
|
|
|
Updates an existing {dfanalytics-job}.
|
|
The API accepts an +{request}+ object as a request and returns an +{response}+.
|
|
|
|
[id="{upid}-{api}-request"]
|
|
==== Update {dfanalytics-jobs} request
|
|
|
|
An +{request}+ requires the following argument:
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
|
--------------------------------------------------
|
|
<1> The configuration of the {dfanalytics-job} update to perform
|
|
|
|
[id="{upid}-{api}-config"]
|
|
==== {dfanalytics-cap} configuration update
|
|
|
|
The `DataFrameAnalyticsConfigUpdate` object contains all the details about the {dfanalytics-job}
|
|
configuration update and contains the following arguments:
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-config-update]
|
|
--------------------------------------------------
|
|
<1> The {dfanalytics-job} ID
|
|
<2> The human-readable description
|
|
<3> The memory limit for the model created as part of the analysis process
|
|
<4> The maximum number of threads to be used by the analysis
|
|
|
|
[id="{upid}-{api}-query-config"]
|
|
|
|
|
|
include::../execution.asciidoc[]
|
|
|
|
[id="{upid}-{api}-response"]
|
|
==== Response
|
|
|
|
The returned +{response}+ contains the updated {dfanalytics-job}.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-response]
|
|
--------------------------------------------------
|