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. More...

Public Attributes
std::string	endpoint
	The endpoint which is being executed asynchronously. More...

std::string	jobStatus
	Status of the submitted job. More...

bool	running
	True if the end point is still executing. More...

int32_t	progress
	Approximate percentage of the job completed. More...

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

std::string	responseEncoding
	The encoding of the job result (contained in jobResponse or jobResponseStr. More...

std::vector< uint8_t >	jobResponse
	The binary-encoded response of the job. More...

std::string	jobResponseStr
	The json-encoded response of the job. More...

std::map< std::string, std::string >	statusMap
	Map of various status strings for the executed job. More...

std::map< std::string, std::string >	info
	Additional information. More...

Detailed Description

A set of results returned by GPUdb::getJob.

Definition at line 116 of file get_job.h.

Constructor & Destructor Documentation

◆ GetJobResponse()

gpudb::GetJobResponse::GetJobResponse ( )

inline

Constructs a GetJobResponse object with default parameters.

Definition at line 121 of file get_job.h.

Member Data Documentation

◆ endpoint

std::string gpudb::GetJobResponse::endpoint

The endpoint which is being executed asynchronously.

E.g. '/alter/table'.

Definition at line 139 of file get_job.h.

◆ info

std::map<std::string, std::string> gpudb::GetJobResponse::info

Additional information.

Definition at line 216 of file get_job.h.

◆ 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

Definition at line 193 of file get_job.h.

◆ 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

Definition at line 200 of file get_job.h.

◆ 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.

Definition at line 158 of file get_job.h.

◆ progress

int32_t gpudb::GetJobResponse::progress

Approximate percentage of the job completed.

Definition at line 168 of file get_job.h.

◆ 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.

Definition at line 186 of file get_job.h.

◆ running

bool gpudb::GetJobResponse::running

True if the end point is still executing.

Definition at line 163 of file get_job.h.

◆ 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.

Definition at line 211 of file get_job.h.

◆ successful

bool gpudb::GetJobResponse::successful

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

Definition at line 173 of file get_job.h.

The documentation for this struct was generated from the following file:

gpudb/protocol/get_job.h

Public Member Functions

Public Attributes