Skip to main content

◆ createJob() [1/2]

CreateJobResponse kinetica.Kinetica.createJob (CreateJobRequestrequest_)
inline

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
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 20851 of file KineticaFunctions.cs.

◆ createJob() [2/2]

CreateJobResponse kinetica.Kinetica.createJob (stringendpoint,
stringrequest_encoding,
byte[]data,
stringdata_str,
IDictionary< string, string >options = null )
inline

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
endpointIndicates which endpoint to execute, e.g. ‘/alter/table’.
request_encodingThe encoding of the request payload for the job. Supported values:The default value is BINARY.
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 request_encoding must be BINARY or SNAPPY.
data_strJSON-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 request_encoding must be JSON.
optionsOptional parameters.
  • 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 Dictionary.
Returns
Response object containing the result of the operation.

Definition at line 20935 of file KineticaFunctions.cs.

◆ CreateJobAsync() [1/2]

async System.Threading.Tasks.Task< CreateJobResponse > kinetica.Kinetica.CreateJobAsync (CreateJobRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
inline

Create a job which will run asynchronously.

(async)

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
request_Request object containing the parameters for the operation.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 20870 of file KineticaFunctions.cs.

◆ CreateJobAsync() [2/2]

async System.Threading.Tasks.Task< CreateJobResponse > kinetica.Kinetica.CreateJobAsync (stringendpoint,
stringrequest_encoding,
byte[]data,
stringdata_str,
IDictionary< string, string >options = null,
System.Threading.CancellationTokencancellationToken = default )
inline

Create a job which will run asynchronously.

(async)

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
endpointIndicates which endpoint to execute, e.g. ‘/alter/table’.
request_encodingThe encoding of the request payload for the job. Supported values:The default value is BINARY.
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 request_encoding must be BINARY or SNAPPY.
data_strJSON-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 request_encoding must be JSON.
optionsOptional parameters.
  • 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 Dictionary.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 21004 of file KineticaFunctions.cs.