36 lines
1.1 KiB
Plaintext
36 lines
1.1 KiB
Plaintext
--
|
|
:api: open-job
|
|
:request: OpenJobRequest
|
|
:response: OpenJobResponse
|
|
--
|
|
[id="{upid}-{api}"]
|
|
=== Open 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.
|
|
|
|
[id="{upid}-{api}-request"]
|
|
==== Open Job Request
|
|
|
|
An +{request}+ object gets created with an existing non-null `jobId`.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
|
--------------------------------------------------
|
|
<1> Constructing a new request referencing an existing `jobId`
|
|
<2> Optionally setting the `timeout` value for how long the
|
|
execution should wait for the job to be opened.
|
|
|
|
[id="{upid}-{api}-response"]
|
|
==== Open Job Response
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-response]
|
|
--------------------------------------------------
|
|
<1> `isOpened()` from the +{response}+ indicates if the job was successfully
|
|
opened or not.
|
|
|
|
include::../execution.asciidoc[] |