GPUdb C++ API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
gpudb::CreateJobRequest Struct Reference

A set of input parameters for const. More...

#include <gpudb/protocol/create_job.h>

Public Member Functions

 CreateJobRequest ()
 Constructs a CreateJobRequest object with default parameter values. More...
 
 CreateJobRequest (const std::string &endpoint_, const std::string &requestEncoding_, const std::vector< uint8_t > &data_, const std::string &dataStr_, const std::map< std::string, std::string > &options_)
 Constructs a CreateJobRequest object with the specified parameters. More...
 

Public Attributes

std::string endpoint
 
std::string requestEncoding
 
std::vector< uint8_t > data
 
std::string dataStr
 
std::map< std::string,
std::string > 
options
 

Detailed Description

A set of input parameters for const.

Create a job which will run asynchronously. The response returns a job ID, which can be used to query the status and result of the job. The status and the result of the job upon completion can be requested by const.

Definition at line 21 of file create_job.h.

Constructor & Destructor Documentation

gpudb::CreateJobRequest::CreateJobRequest ( )
inline

Constructs a CreateJobRequest object with default parameter values.

Definition at line 27 of file create_job.h.

gpudb::CreateJobRequest::CreateJobRequest ( const std::string &  endpoint_,
const std::string &  requestEncoding_,
const std::vector< uint8_t > &  data_,
const std::string &  dataStr_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs a CreateJobRequest object with the specified parameters.

Parameters
[in]endpoint_Indicates which endpoint to execute, e.g. '/alter/table'.
[in]requestEncoding_The encoding of the request payload for the job. The default value is gpudb::create_job_binary.
[in]data_Binary-encoded payload for the job to be run asynchronously. The payload must contain the relevant input parameters for the endpoint indicated in endpoint. Please see the documentation for the appropriate endpoint to see what values must (or can) be specified. If this parameter is used, then requestEncoding must be binary or snappy.
[in]dataStr_JSON-encoded payload for the job to be run asynchronously. The payload must contain the relevant input parameters for the endpoint indicated in endpoint. Please see the documentation for the appropriate endpoint to see what values must (or can) be specified. If this parameter is used, then requestEncoding must be json.
[in]options_Optional parameters.

Definition at line 69 of file create_job.h.

Member Data Documentation

std::vector<uint8_t> gpudb::CreateJobRequest::data

Definition at line 80 of file create_job.h.

std::string gpudb::CreateJobRequest::dataStr

Definition at line 81 of file create_job.h.

std::string gpudb::CreateJobRequest::endpoint

Definition at line 78 of file create_job.h.

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

Definition at line 82 of file create_job.h.

std::string gpudb::CreateJobRequest::requestEncoding

Definition at line 79 of file create_job.h.


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