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

#include <gpudb/protocol/create_job.h>

Public Member Functions
	CreateJobRequest ()
	Constructs a CreateJobRequest object with default parameters. 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
	Indicates which endpoint to execute, e.g. '/alter/table'. More...

std::string	requestEncoding
	The encoding of the request payload for the job. More...

std::vector< uint8_t >	data
	Binary-encoded payload for the job to be run asynchronously. More...

std::string	dataStr
	JSON-encoded payload for the job to be run asynchronously. More...

std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::createJob.

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 GPUdb::getJob.

Definition at line 20 of file create_job.h.

Constructor & Destructor Documentation

◆ CreateJobRequest() [1/2]

gpudb::CreateJobRequest::CreateJobRequest ( )

inline

Constructs a CreateJobRequest object with default parameters.

Definition at line 25 of file create_job.h.

◆ CreateJobRequest() [2/2]

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. Supported values: create_job_binary create_job_json create_job_snappy The default value is 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. create_job_remove_job_on_complete: Supported values: create_job_true create_job_false create_job_job_tag: Tag to use for submitted job. The same tag could be used on backup cluster to retrieve response for the job. Tags can use letter, numbers, '_' and '-' The default value is an empty map.

Definition at line 92 of file create_job.h.

Member Data Documentation

◆ data

std::vector<uint8_t> gpudb::CreateJobRequest::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.

Definition at line 128 of file create_job.h.

◆ dataStr

std::string gpudb::CreateJobRequest::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.

Definition at line 138 of file create_job.h.

◆ endpoint

std::string gpudb::CreateJobRequest::endpoint

Indicates which endpoint to execute, e.g. '/alter/table'.

Definition at line 104 of file create_job.h.

◆ options

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

Optional parameters.

create_job_remove_job_on_complete: Supported values:
- create_job_true
- create_job_false
create_job_job_tag: Tag to use for submitted job. The same tag could be used on backup cluster to retrieve response for the job. Tags can use letter, numbers, '_' and '-'

The default value is an empty map.

Definition at line 157 of file create_job.h.

◆ requestEncoding

std::string gpudb::CreateJobRequest::requestEncoding

The encoding of the request payload for the job.

Supported values:

The default value is create_job_binary.

Definition at line 117 of file create_job.h.

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

gpudb/protocol/create_job.h

Public Member Functions

Public Attributes