[DOCS] Updates terms in anomaly detection job APIs (#44839)

This commit is contained in:
Lisa Cawley 2019-07-25 08:58:16 -07:00 committed by GitHub
parent 0dfcdf327a
commit 990e037728
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 54 additions and 54 deletions

View file

@ -4,14 +4,12 @@
:response: CloseJobResponse
--
[id="{upid}-{api}"]
=== Close Job API
=== Close {anomaly-job} API
The Close Job API provides the ability to close {ml} jobs in the cluster.
It accepts a +{request}+ object and responds
with a +{response}+ object.
Closes {anomaly-jobs} in the cluster. It accepts a +{request}+ object and responds with a +{response}+ object.
[id="{upid}-{api}-request"]
==== Close Job Request
==== Close {anomaly-job} request
A +{request}+ object gets created with an existing non-null `jobId`.
@ -28,7 +26,7 @@ which has not responded to its initial close request.
execution should wait for the job to be closed.
[id="{upid}-{api}-response"]
==== Close Job Response
==== Close {anomaly-job} response
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------

View file

@ -4,10 +4,12 @@
:response: AcknowledgedResponse
--
[id="{upid}-{api}"]
=== Delete Job API
=== Delete {anomaly-job} API
Deletes an {anomaly-job} that exists in the cluster.
[id="{upid}-{api}-request"]
==== Delete Job Request
==== Delete {anomaly-job} request
A +{request}+ object requires a non-null `jobId` and can optionally set `force`.
@ -17,7 +19,7 @@ include-tagged::{doc-tests-file}[{api}-request]
---------------------------------------------------
<1> Constructing a new request referencing an existing `jobId`
==== Optional Arguments
==== Optional arguments
The following arguments are optional:
@ -33,21 +35,24 @@ Defaults to `false`.
---------------------------------------------------
include-tagged::{doc-tests-file}[{api}-request-wait-for-completion]
---------------------------------------------------
<1> Use to set whether the request should wait until the operation has completed before returning.
Defaults to `true`.
<1> Use to set whether the request should wait until the operation has completed
before returning. Defaults to `true`.
[id="{upid}-{api}-response"]
==== Delete Job Response
==== Delete {anomaly-job} response
The returned +{response}+ object indicates the acknowledgement of the job deletion or
the deletion task depending on whether the request was set to wait for completion:
The returned +{response}+ object indicates the acknowledgement of the job
deletion or the deletion task depending on whether the request was set to wait
for completion:
["source","java",subs="attributes,callouts,macros"]
---------------------------------------------------
include-tagged::{doc-tests-file}[{api}-response]
---------------------------------------------------
<1> whether was job deletion was acknowledged or not; will be `null` when set not to wait for completion
<2> the id of the job deletion task; will be `null` when set to wait for completion
<1> whether was job deletion was acknowledged or not; will be `null` when set
not to wait for completion
<2> the id of the job deletion task; will be `null` when set to wait for
completion
include::../execution.asciidoc[]

View file

@ -4,14 +4,13 @@
:response: OpenJobResponse
--
[id="{upid}-{api}"]
=== Open Job API
=== Open {anomaly-job} API
The Open Job API provides the ability to open {ml} jobs in the cluster.
It accepts a +{request}+ object and responds
with a +{response}+ object.
Opens {anomaly-jobs} in the cluster. It accepts a +{request}+ object and
responds with a +{response}+ object.
[id="{upid}-{api}-request"]
==== Open Job Request
==== Open {anomaly-job} request
An +{request}+ object gets created with an existing non-null `jobId`.
@ -24,7 +23,7 @@ include-tagged::{doc-tests-file}[{api}-request]
execution should wait for the job to be opened.
[id="{upid}-{api}-response"]
==== Open Job Response
==== Open {anomaly-job} response
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------

View file

@ -4,14 +4,13 @@
:response: PutJobResponse
--
[id="{upid}-{api}"]
=== Put Job API
=== Put {anomaly-job} API
The Put Job API can be used to create a new {ml} job
in the cluster. The API accepts a +{request}+ object
Creates a new {anomaly-job} in the cluster. The API accepts a +{request}+ object
as a request and returns a +{response}+.
[id="{upid}-{api}-request"]
==== Put Job Request
==== Put {anomaly-job} request
A +{request}+ requires the following argument:
@ -19,12 +18,12 @@ A +{request}+ requires the following argument:
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-request]
--------------------------------------------------
<1> The configuration of the {ml} job to create as a `Job`
<1> The configuration of the {anomaly-job} to create as a `Job`
[id="{upid}-{api}-config"]
==== Job Configuration
==== Job configuration
The `Job` object contains all the details about the {ml} job
The `Job` object contains all the details about the {anomaly-job}
configuration.
A `Job` requires the following arguments:
@ -39,9 +38,9 @@ include-tagged::{doc-tests-file}[{api}-config]
<4> Optionally, a human-readable description
[id="{upid}-{api}-analysis-config"]
==== Analysis Configuration
==== Analysis configuration
The analysis configuration of the {ml} job is defined in the `AnalysisConfig`.
The analysis configuration of the {anomaly-job} is defined in the `AnalysisConfig`.
`AnalysisConfig` reflects all the configuration
settings that can be defined using the REST API.
@ -86,7 +85,7 @@ include-tagged::{doc-tests-file}[{api}-analysis-config]
<3> The bucket span
[id="{upid}-{api}-data-description"]
==== Data Description
==== Data description
After defining the analysis config, the next thing to define is the
data description, using a `DataDescription` instance. `DataDescription`