8000 add documentation for Pregel jobs API (#16278) · arangodb/arangodb@2bcab23 · GitHub
[go: up one dir, main page]
Skip to content

Commit 2bcab23

Browse files
jsteemannansoboleva
jsteemann
and
ansoboleva
authored
add documentation for Pregel jobs API (#16278)
* add documentation for Pregel jobs API * Update get_api_control_pregel_overview.md * Update get_api_control_pregel_status.md Co-authored-by: ansoboleva <93702078+ansoboleva@users.noreply.github.com>
1 parent bb8a573 commit 2bcab23

File tree

2 files changed

+68
-1
lines changed

2 files changed

+68
-1
lines changed

‎Documentation/DocuBlocks/Rest/Pregel/get_api_control_pregel_overview.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
@startDocuBlock get_api_control_pregel_overview
2+
@brief Get the overview of currently running Pregel jobs
3+
4+
@RESTHEADER{GET /_api/control_pregel, Get currently running Pregel jobs}
5+
6+
@RESTDESCRIPTION
7+
Returns a list of currently running and recently finished Pregel jobs without
8+
retrieving their results.
9+
The returned object is a JSON array of Pregel job descriptions. Each job description
10+
is a JSON object with the following attributes:
11+
12+
- *id*: an id of the Pregel job, as a string.
13+
14+
- *algorithm*: an algorithm used by the job.
15+
16+
- *created*: a date and time when the job was created.
17+
18+
- *expires*: a date and time when the job results expire. The expiration date is only
19+
meaningful for jobs that were completed, canceled or resulted in an error. Such jobs
20+
are cleaned up by the garbage collection when they reach their expiration date/time.
21+
22+
- *ttl*: a TTL (time to live) value for the job results, specified in seconds.
23+
The TTL is used to calculate the expiration date for the job's results.
24+
25+
- *state*: a state of the execution, as a string.
26+
27+
- *gss*: a number of global supersteps executed.
28+
29+
- *totalRuntime*: a total runtime of the execution up to now (if the execution is still ongoing).
30+
31+
- *startupTime*: a startup runtime of the execution. The startup time includes the data
32+
loading time and can be substantial.
33+
The startup time is reported as 0, if the startup is still ongoing.
34+
35+
- *computationTime*: an algorithm execution time. The computation time is reported as 0, if the
36+
computation is still ongoing.
37+
38+
- *storageTime*: a time for storing the results if the job includes result storage.
39+
The storage time is reported as 0, if storing the results is still ongoing.
40+
41+
- *reports*: optional statistics about the Pregel execution. The value is only populated when
42+
the algorithm has finished.
43+
44+
@RESTRETURNCODES
45+
46+
@RESTRETURNCODE{200}
47+
Is returned when the list of jobs can be retrieved successfully.
48+
49+
@endDocuBlock

‎Documentation/DocuBlocks/Rest/Pregel/get_api_control_pregel_status.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,24 @@ received messages.
1919
HTTP 200 will be returned in case the job execution id was valid and the state is
2020
returned along with the response.
2121

22+
@RESTREPLYBODY{id,string,required,string}
23+
An id of the Pregel job, as a string.
24+
25+
@RESTREPLYBODY{algorithm,string,required,string}
26+
An algorithm used by the job.
27+
28+
@RESTREPLYBODY{created,string,required,string}
29+
A date and time when the job was created.
30+
31+
@RESTREPLYBODY{expires,string,optional,string}
32+
A date and time when the job results expire. The expiration date is only
33+
meaningful for jobs that were completed, canceled or resulted in an error. Such jobs
34+
are cleaned up by the garbage collection when they reach their expiration date/time.
35+
36+
@RESTREPLYBODY{ttl,number,required,float}
37+
A TTL (time to live) value for the job results, specified in seconds.
38+
The TTL is used to calculate the expiration date for the job's results.
39+
2240
@RESTREPLYBODY{state,string,required,string}
2341
State of the execution. The following values can be returned:
2442
- `"running"`: Algorithm is executing normally.
@@ -38,7 +56,7 @@ State of the execution. The following values can be returned:
3856
- `"recovering"` (currently unused): The execution is actively recovering, will
3957
switch back to `running` if the recovery was successful.
4058

41-
@RESTREPLYBODY{gss,number,required,string}
59+
@RESTREPLYBODY{gss,number,required,int64}
4260
The number of global supersteps executed.
4361

4462
@RESTREPLYBODY{totalRuntime,number,required,float}

0 commit comments

Comments
 (0)
0