Skip to main content
interface GetJobResponse
endpoint: string;
info: Record<string, string>;
job_response: string;
job_response_str: string;
job_status: string;
progress: number;
request_time_secs?: number;
response_encoding: string;
running: boolean;
status_map: Record<string, string>;
successful: boolean;
endpoint info job_response job_response_str job_status progress request_time_secs? response_encoding running status_map successful
endpoint: string

The endpoint which is being executed asynchronously. E.g. ‘/alter/table’.

info: Record<string, string>

Additional information.

job_response: string

The binary-encoded response of the job. This field is populated only when the job has completed and 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 response_encoding is json.

job_status: string

Status of the submitted job.

progress: number

Approximate percentage of the job completed.

request_time_secs?: number

Server-reported request time in seconds, when it sent one

response_encoding: string

The encoding of the job result (contained in job_response or job_response_str.

running: boolean

True if the end point is still executing.

status_map: Record<string, string>

Map of various status strings for the executed job.

successful: boolean

True if the job execution completed and no errors were encountered.