A set of results returned by GPUdb::getJob. More…
#include <gpudb/protocol/get_job.h>
Public Member Functions | |
| GetJobResponse () | |
| Constructs a GetJobResponse object with default parameters. | |
Public Attributes | |
| std::string | endpoint |
| The endpoint which is being executed asynchronously. | |
| std::string | jobStatus |
| Status of the submitted job. | |
| bool | running |
| True if the end point is still executing. | |
| int32_t | progress |
| Approximate percentage of the job completed. | |
| bool | successful |
| True if the job execution completed and no errors were encountered. | |
| std::string | responseEncoding |
| The encoding of the job result (contained in jobResponse or jobResponseStr. | |
| std::vector< uint8_t > | jobResponse |
| The binary-encoded response of the job. | |
| std::string | jobResponseStr |
| The json-encoded response of the job. | |
| std::map< std::string, std::string > | statusMap |
| Map of various status strings for the executed job. | |
| std::map< std::string, std::string > | info |
| Additional information. | |
Detailed Description
A set of results returned by GPUdb::getJob.
Constructor & Destructor Documentation
◆ GetJobResponse()
| inline |
Constructs a GetJobResponse object with default parameters.
Member Data Documentation
◆ endpoint
| std::string gpudb::GetJobResponse::endpoint |
◆ info
| std::map<std::string, std::string> gpudb::GetJobResponse::info |
◆ jobResponse
| std::vector<uint8_t> gpudb::GetJobResponse::jobResponse |
The binary-encoded response of the job.
This field is populated only when the job has completed and responseEncoding is binary.
◆ jobResponseStr
| std::string gpudb::GetJobResponse::jobResponseStr |
The json-encoded response of the job.
This field is populated only when the job has completed and responseEncoding is json.
◆ jobStatus
| std::string gpudb::GetJobResponse::jobStatus |
Status of the submitted job.
Supported values:
- get_job_RUNNING: The job is currently executing.
- get_job_DONE: The job execution has successfully completed and the response is included in the jobResponse or jobResponseStr field.
- get_job_ERROR: The job was attempted, but an error was encountered. The statusMap contains the details of the error in error_message.
- get_job_CANCELLED: Job cancellation was requested while the execution was in progress.
◆ progress
| int32_t gpudb::GetJobResponse::progress |
◆ responseEncoding
| std::string gpudb::GetJobResponse::responseEncoding |
The encoding of the job result (contained in jobResponse or jobResponseStr.
Supported values:
- get_job_binary: The job result is binary-encoded. It is contained in jobResponse.
- get_job_json: The job result is JSON-encoded. It is contained in jobResponseStr.
◆ running
| bool gpudb::GetJobResponse::running |
◆ statusMap
| std::map<std::string, std::string> gpudb::GetJobResponse::statusMap |
Map of various status strings for the executed job.
- get_job_error_message: Explains what error occurred while running the job asynchronously. This entry only exists when the job status is ERROR.
◆ successful
| bool gpudb::GetJobResponse::successful |
The documentation for this struct was generated from the following file:
- gpudb/protocol/get_job.h