GPUdb C++ API  Version 7.2.2.4
gpudb::GetJobRequest Struct Reference

A set of parameters for GPUdb::getJob. More...

#include <gpudb/protocol/get_job.h>

Public Member Functions

 GetJobRequest ()
 Constructs a GetJobRequest object with default parameters. More...
 
 GetJobRequest (const int64_t jobId_, const std::map< std::string, std::string > &options_)
 Constructs a GetJobRequest object with the specified parameters. More...
 

Public Attributes

int64_t jobId
 A unique identifier for the job whose status and result is to be fetched. More...
 
std::map< std::string, std::string > options
 Optional parameters. More...
 

Detailed Description

A set of parameters for GPUdb::getJob.

Get the status and result of asynchronously running job. See the GPUdb::createJob for starting an asynchronous job. Some fields of the response are filled only after the submitted job has finished execution.

Definition at line 20 of file get_job.h.

Constructor & Destructor Documentation

◆ GetJobRequest() [1/2]

gpudb::GetJobRequest::GetJobRequest ( )
inline

Constructs a GetJobRequest object with default parameters.

Definition at line 25 of file get_job.h.

◆ GetJobRequest() [2/2]

gpudb::GetJobRequest::GetJobRequest ( const int64_t  jobId_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs a GetJobRequest object with the specified parameters.

Parameters
[in]jobId_A unique identifier for the job whose status and result is to be fetched.
[in]options_Optional parameters. The default value is an empty map.

Definition at line 44 of file get_job.h.

Member Data Documentation

◆ jobId

int64_t gpudb::GetJobRequest::jobId

A unique identifier for the job whose status and result is to be fetched.

Definition at line 54 of file get_job.h.

◆ options

std::map<std::string, std::string> gpudb::GetJobRequest::options

Optional parameters.

The default value is an empty map.

Definition at line 64 of file get_job.h.


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