Skip to main content

◆ createJob() [1/4]

CreateJobResponse gpudb::GPUdb::createJob (const CreateJobRequest &request_) 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 getJob.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ createJob() [2/4]

CreateJobResponse & gpudb::GPUdb::createJob (const CreateJobRequest &request_,
CreateJobResponse &response_ ) 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 getJob.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ createJob() [3/4]

CreateJobResponse gpudb::GPUdb::createJob (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 ) 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 getJob.

Parameters
[in]endpointIndicates which endpoint to execute, e.g. ‘/alter/table’.
[in]requestEncodingThe encoding of the request payload for the job. Supported values:The default value is create_job_binary.
[in]dataBinary-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]dataStrJSON-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]optionsOptional parameters.
  • 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.
Returns
Response object containing the result of the operation.

◆ createJob() [4/4]

CreateJobResponse & gpudb::GPUdb::createJob (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,
CreateJobResponse &response_ ) 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 getJob.

Parameters
[in]endpointIndicates which endpoint to execute, e.g. ‘/alter/table’.
[in]requestEncodingThe encoding of the request payload for the job. Supported values:The default value is create_job_binary.
[in]dataBinary-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]dataStrJSON-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]optionsOptional parameters.
  • 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.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).