Note
This documentation is for a prior release of Kinetica. For the latest documentation, click here.
Get the status and result of asynchronously running job. See the Create Asynchronous Job for starting an asynchronous job. Some fields of the response are filled only after the submitted job has finished execution.
Input Parameter Description
| Name | Type | Description | ||||
|---|---|---|---|---|---|---|
| job_id | long | A unique identifier for the job whose status and result is to be fetched. | ||||
| options | map of string to strings | Optional parameters. The default value is an empty map ( {} ).
|
Output Parameter Description
| Name | Type | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| endpoint | string | The endpoint which is being executed asynchronously. E.g. '/alter/table'. | ||||||||||
| job_status | string | Status of the submitted job.
| ||||||||||
| 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.
| ||||||||||
| 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.
| ||||||||||
| info | map of string to strings | Additional information. |
