8000 add documentation for Pregel jobs API by jsteemann · Pull Request #16278 · arangodb/arangodb · GitHub
[go: up one dir, main page]
Skip to content

add documentation for Pregel jobs API #16278

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 17, 2022
Merged

add documentation for Pregel jobs API #16278

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d179e5a
add documentation for Pregel jobs API
jsteemann May 16, 2022
ea6171d
Update get_api_control_pregel_overview.md
ansoboleva May 16, 2022
74bc9f3
Update get_api_control_pregel_status.md
ansoboleva May 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Update get_api_control_pregel_status.md
  • Loading branch information
@ansoboleva
ansoboleva authored May 16, 2022
commit 74bc9f3396e044428e6a422275178aacb2cce2de
16 changes: 8 additions & 8 deletions Documentation/DocuBlocks/Rest/Pregel/get_api_control_pregel_status.md
View file
Open in desktop
94F1
Original file line number Diff line number Diff line change
Expand Up @@ -20,22 +20,22 @@ HTTP 200 will be returned in case the job execution id was valid and the state i
returned along with the response.

@RESTREPLYBODY{id,string,required,string}
Id of the Pregel job, as a string.
An id of the Pregel job, as a string.

@RESTREPLYBODY{algorithm,string,required,string}
The algorithm used by the job.
An algorithm used by the job.

@RESTREPLYBODY{created,string,required,string}
The date and time the job was created.
A date and time when the job was created.

@RESTREPLYBODY{expires,string,optional,string}
The date and time the job results will expire. The expiration date is only
meaningful for jobs that have completed, errored or were canceled. Such jobs
will be cleaned up by the garbage collection when they reach their expire date/time.
A date and time when the job results expire. The expiration date is only
meaningful for jobs that were completed, canceled or resulted in an error. Such jobs
are cleaned up by the garbage collection when they reach their expiration date/time.

@RESTREPLYBODY{ttl,number,required,float}
The TTL (time to live) value for the job results, specified in seconds.
The TTL is used to calculate the expire date for the job's results.
A TTL (time to live) value for the job results, specified in seconds.
The TTL is used to calculate the expiration date for the job's results.

@RESTREPLYBODY{state,string,required,string}
State of the execution. The following values can be returned:
Expand Down
0