endpoint |
string |
The endpoint which is being executed asynchronously. E.g. '/alter/table'. |
job_status |
string |
Status of the submitted job.
Possible
Values |
Description |
RUNNING |
The job is currently executing. |
DONE |
The job execution has successfully completed and the response is included in the output parameter job_response or output parameter job_response_str field |
ERROR |
The job was attempted, but an error was encountered. The output parameter status_map contains the details of the error in error_message |
CANCELLED |
Job cancellation was requested while the execution was in progress. |
|
running |
boolean |
True if the end point is still executing. |
progress |
int |
Approximate percentage of the job completed. |
successful |
boolean |
True if the job execution completed and no errors were encountered. |
response_encoding |
string |
The encoding of the job result (contained in output parameter job_response or output parameter job_response_str.
Possible
Values |
Description |
binary |
The job result is binary-encoded. It is contained in output parameter job_response. |
json |
The job result is json-encoded. It is contained in output parameter job_response_str. |
|
job_response |
bytes |
The binary-encoded response of the job. This field is populated only when the job has completed and output parameter response_encoding is binary |
job_response_str |
string |
The json-encoded response of the job. This field is populated only when the job has completed and output parameter response_encoding is json |
status_map |
map of
string
to
strings |
Map of various status strings for the executed job.
Possible
Parameters
(keys) |
Parameter Description |
error_message |
Explains what error occurred while running the job asynchronously. This entry only exists when the job status is ERROR. |
|