Skip to content

Commit 990e037

Browse files
lcawllcawl
authored
[DOCS] Updates terms in anomaly detection job APIs (#44839)
1 parent 0dfcdf3 commit 990e037

File tree

8 files changed

+54
-54
lines changed

8 files changed

+54
-54
lines changed

‎docs/java-rest/high-level/ml/close-job.asciidoc

+4-6
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,12 @@
44
:response: CloseJobResponse
55
--
66
[id="{upid}-{api}"]
7-
=== Close Job API
7+
=== Close {anomaly-job} API
88

9-
The Close Job API provides the ability to close {ml} jobs in the cluster.
10-
It accepts a +{request}+ object and responds
11-
with a +{response}+ object.
9+
Closes {anomaly-jobs} in the cluster. It accepts a +{request}+ object and responds with a +{response}+ object.
1210

1311
[id="{upid}-{api}-request"]
14-
==== Close Job Request
12+
==== Close {anomaly-job} request
1513

1614
A +{request}+ object gets created with an existing non-null `jobId`.
1715

@@ -28,7 +26,7 @@ which has not responded to its initial close request.
2826
execution should wait for the job to be closed.
2927

3028
[id="{upid}-{api}-response"]
31-
==== Close Job Response
29+
==== Close {anomaly-job} response
3230

3331
["source","java",subs="attributes,callouts,macros"]
3432
--------------------------------------------------

‎docs/java-rest/high-level/ml/delete-job.asciidoc

+15-10
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,12 @@
44
:response: AcknowledgedResponse
55
--
66
[id="{upid}-{api}"]
7-
=== Delete Job API
7+
=== Delete {anomaly-job} API
8+
9+
Deletes an {anomaly-job} that exists in the cluster.
810

911
[id="{upid}-{api}-request"]
10-
==== Delete Job Request
12+
==== Delete {anomaly-job} request
1113

1214
A +{request}+ object requires a non-null `jobId` and can optionally set `force`.
1315

@@ -17,7 +19,7 @@ include-tagged::{doc-tests-file}[{api}-request]
1719
---------------------------------------------------
1820
<1> Constructing a new request referencing an existing `jobId`
1921

20-
==== Optional Arguments
22+
==== Optional arguments
2123

2224
The following arguments are optional:
2325

@@ -33,21 +35,24 @@ Defaults to `false`.
3335
---------------------------------------------------
3436
include-tagged::{doc-tests-file}[{api}-request-wait-for-completion]
3537
---------------------------------------------------
36-
<1> Use to set whether the request should wait until the operation has completed before returning.
37-
Defaults to `true`.
38+
<1> Use to set whether the request should wait until the operation has completed
39+
before returning. Defaults to `true`.
3840

3941

4042
[id="{upid}-{api}-response"]
41-
==== Delete Job Response
43+
==== Delete {anomaly-job} response
4244

43-
The returned +{response}+ object indicates the acknowledgement of the job deletion or
44-
the deletion task depending on whether the request was set to wait for completion:
45+
The returned +{response}+ object indicates the acknowledgement of the job
46+
deletion or the deletion task depending on whether the request was set to wait
47+
for completion:
4548

4649
["source","java",subs="attributes,callouts,macros"]
4750
---------------------------------------------------
4851
include-tagged::{doc-tests-file}[{api}-response]
4952
---------------------------------------------------
50-
<1> whether was job deletion was acknowledged or not; will be `null` when set not to wait for completion
51-
<2> the id of the job deletion task; will be `null` when set to wait for completion
53+
<1> whether was job deletion was acknowledged or not; will be `null` when set
54+
not to wait for completion
55+
<2> the id of the job deletion task; will be `null` when set to wait for
56+
completion
5257

5358
include::../execution.asciidoc[]

‎docs/java-rest/high-level/ml/open-job.asciidoc

+5-6
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,13 @@
44
:response: OpenJobResponse
55
--
66
[id="{upid}-{api}"]
7-
=== Open Job API
7+
=== Open {anomaly-job} API
88

9-
The Open Job API provides the ability to open {ml} jobs in the cluster.
10-
It accepts a +{request}+ object and responds
11-
with a +{response}+ object.
9+
Opens {anomaly-jobs} in the cluster. It accepts a +{request}+ object and
10+
responds with a +{response}+ object.
1211

1312
[id="{upid}-{api}-request"]
14-
==== Open Job Request
13+
==== Open {anomaly-job} request
1514

1615
An +{request}+ object gets created with an existing non-null `jobId`.
1716

@@ -24,7 +23,7 @@ include-tagged::{doc-tests-file}[{api}-request]
2423
execution should wait for the job to be opened.
2524

2625
[id="{upid}-{api}-response"]
27-
==== Open Job Response
26+
==== Open {anomaly-job} response
2827

2928
["source","java",subs="attributes,callouts,macros"]
3029
--------------------------------------------------

‎docs/java-rest/high-level/ml/put-job.asciidoc

+9-10
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,26 @@
44
:response: PutJobResponse
55
--
66
[id="{upid}-{api}"]
7-
=== Put Job API
7+
=== Put {anomaly-job} API
88

9-
The Put Job API can be used to create a new {ml} job
10-
in the cluster. The API accepts a +{request}+ object
9+
Creates a new {anomaly-job} in the cluster. The API accepts a +{request}+ object
1110
as a request and returns a +{response}+.
1211

1312
[id="{upid}-{api}-request"]
14-
==== Put Job Request
13+
==== Put {anomaly-job} request
1514

1615
A +{request}+ requires the following argument:
1716

1817
["source","java",subs="attributes,callouts,macros"]
1918
--------------------------------------------------
2019
include-tagged::{doc-tests-file}[{api}-request]
2120
--------------------------------------------------
22-
<1> The configuration of the {ml} job to create as a `Job`
21+
<1> The configuration of the {anomaly-job} to create as a `Job`
2322

2423
[id="{upid}-{api}-config"]
25-
==== Job Configuration
24+
==== Job configuration
2625

27-
The `Job` object contains all the details about the {ml} job
26+
The `Job` object contains all the details about the {anomaly-job}
2827
configuration.
2928

3029
A `Job` requires the following arguments:
@@ -39,9 +38,9 @@ include-tagged::{doc-tests-file}[{api}-config]
3938
<4> Optionally, a human-readable description
4039

4140
[id="{upid}-{api}-analysis-config"]
42-
==== Analysis Configuration
41+
==== Analysis configuration
4342

44-
The analysis configuration of the {ml} job is defined in the `AnalysisConfig`.
43+
The analysis configuration of the {anomaly-job} is defined in the `AnalysisConfig`.
4544
`AnalysisConfig` reflects all the configuration
4645
settings that can be defined using the REST API.
4746

@@ -86,7 +85,7 @@ include-tagged::{doc-tests-file}[{api}-analysis-config]
8685
<3> The bucket span
8786

8887
[id="{upid}-{api}-data-description"]
89-
==== Data Description
88+
==== Data description
9089

9190
After defining the analysis config, the next thing to define is the
9291
data description, using a `DataDescription` instance. `DataDescription`

‎docs/reference/ml/anomaly-detection/apis/close-job.asciidoc

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
[role="xpack"]
22
[testenv="platinum"]
33
[[ml-close-job]]
4-
=== Close jobs API
4+
=== Close {anomaly-jobs} API
55
++++
66
<titleabbrev>Close jobs</titleabbrev>
77
++++
88

9-
Closes one or more jobs.
9+
Closes one or more {anomaly-jobs}.
1010
A job can be opened and closed multiple times throughout its lifecycle.
1111

1212
A closed job cannot receive data or perform analysis
@@ -31,9 +31,9 @@ operations, but you can still explore and navigate results.
3131
[[ml-close-job-desc]]
3232
==== {api-description-title}
3333

34-
You can close multiple jobs in a single API request by using a group name, a
35-
comma-separated list of jobs, or a wildcard expression. You can close all jobs
36-
by using `_all` or by specifying `*` as the `<job_id>`.
34+
You can close multiple {anomaly-jobs} in a single API request by using a group
35+
name, a comma-separated list of jobs, or a wildcard expression. You can close
36+
all jobs by using `_all` or by specifying `*` as the `<job_id>`.
3737

3838
When you close a job, it runs housekeeping tasks such as pruning the model history,
3939
flushing buffers, calculating final results and persisting the model snapshots.
@@ -58,8 +58,8 @@ results the job might have recently produced or might produce in the future.
5858
==== {api-path-parms-title}
5959

6060
`<job_id>`::
61-
(Required, string) Identifier for the job. It can be a job identifier, a group
62-
name, or a wildcard expression.
61+
(Required, string) Identifier for the {anomaly-job}. It can be a job
62+
identifier, a group name, or a wildcard expression.
6363

6464
[[ml-close-job-query-parms]]
6565
==== {api-query-parms-title}

‎docs/reference/ml/anomaly-detection/apis/delete-job.asciidoc

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
[role="xpack"]
22
[testenv="platinum"]
33
[[ml-delete-job]]
4-
=== Delete jobs API
4+
=== Delete {anomaly-jobs} API
55
++++
66
<titleabbrev>Delete jobs</titleabbrev>
77
++++
88

9-
Deletes an existing anomaly detection job.
9+
Deletes an existing {anomaly-job}.
1010

1111
[[ml-delete-job-request]]
1212
==== {api-request-title}
@@ -25,14 +25,14 @@ cluster privileges to use this API. See
2525

2626
All job configuration, model state and results are deleted.
2727

28-
IMPORTANT: Deleting a job must be done via this API only. Do not delete the
29-
job directly from the `.ml-*` indices using the Elasticsearch delete document
28+
IMPORTANT: Deleting an {anomaly-job} must be done via this API only. Do not
29+
delete the job directly from the `.ml-*` indices using the {es} delete document
3030
API. When {es} {security-features} are enabled, make sure no `write` privileges
3131
are granted to anyone over the `.ml-*` indices.
3232

3333
Before you can delete a job, you must delete the {dfeeds} that are associated
34-
with it. See <<ml-delete-datafeed,Delete {dfeeds-cap}>>. Unless the `force` parameter
35-
is used the job must be closed before it can be deleted.
34+
with it. See <<ml-delete-datafeed,Delete {dfeeds-cap}>>. Unless the `force`
35+
parameter is used the job must be closed before it can be deleted.
3636

3737
It is not currently possible to delete multiple jobs using wildcards or a comma
3838
separated list.
@@ -41,7 +41,7 @@ separated list.
4141
==== {api-path-parms-title}
4242

4343
`<job_id>`::
44-
(Required, string) Identifier for the job.
44+
(Required, string) Identifier for the {anomaly-job}.
4545

4646
[[ml-delete-job-query-parms]]
4747
==== {api-query-parms-title}

‎docs/reference/ml/anomaly-detection/apis/open-job.asciidoc

+6-5
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
[role="xpack"]
22
[testenv="platinum"]
33
[[ml-open-job]]
4-
=== Open jobs API
4+
=== Open {anomaly-jobs} API
55
++++
66
<titleabbrev>Open jobs</titleabbrev>
77
++++
88

9-
Opens one or more jobs.
9+
Opens one or more {anomaly-jobs}.
1010

1111
[[ml-open-job-request]]
1212
==== {api-request-title}
@@ -23,8 +23,9 @@ Opens one or more jobs.
2323
[[ml-open-job-desc]]
2424
==== {api-description-title}
2525

26-
A job must be opened in order for it to be ready to receive and analyze data.
27-
A job can be opened and closed multiple times throughout its lifecycle.
26+
An {anomaly-job} must be opened in order for it to be ready to receive and
27+
analyze data. It can be opened and closed multiple times throughout its
28+
lifecycle.
2829

2930
When you open a new job, it starts with an empty model.
3031

@@ -36,7 +37,7 @@ data is received.
3637
==== {api-path-parms-title}
3738

3839
`<job_id>`::
39-
(Required, string) Identifier for the job
40+
(Required, string) Identifier for the {anomaly-job}.
4041

4142
[[ml-open-job-request-body]]
4243
==== {api-request-body-title}

‎docs/reference/ml/anomaly-detection/apis/put-job.asciidoc

+1-3
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,8 @@
22
[testenv="platinum"]
33
[[ml-put-job]]
44
=== Create {anomaly-jobs} API
5-
6-
[subs="attributes"]
75
++++
8-
<titleabbrev>Create {anomaly-jobs}</titleabbrev>
6+
<titleabbrev>Create jobs</titleabbrev>
97
++++
108

119
Instantiates an {anomaly-job}.

0 commit comments

Comments
 (0)