A set of parameters for Kinetica.createJob. More...
Inheritance diagram for kinetica.CreateJobRequest:
Collaboration diagram for kinetica.CreateJobRequest:
Classes | |
| struct | Options |
| A set of string constants for the parameter options. More... | |
| struct | RequestEncoding |
| A set of string constants for the parameter request_encoding. More... | |
Public Member Functions | |
| CreateJobRequest () | |
| Constructs a CreateJobRequest object with default parameters. More... | |
| CreateJobRequest (string endpoint, string request_encoding, byte[] data, string data_str, IDictionary< string, string > options=null) | |
| Constructs a CreateJobRequest object with the specified parameters. More... | |
| Public Member Functions inherited from kinetica.KineticaData | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type More... | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type More... | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object More... | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object More... | |
Properties | |
| string | endpoint [get, set] |
| Indicates which endpoint to execute, e.g. More... | |
| string | request_encoding = RequestEncoding.BINARY [get, set] |
| The encoding of the request payload for the job. More... | |
| byte [] | data [get, set] |
| Binary-encoded payload for the job to be run asynchronously. More... | |
| string | data_str [get, set] |
| JSON-encoded payload for the job to be run asynchronously. More... | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [get, set] |
| Optional parameters. More... | |
| Properties inherited from kinetica.KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from kinetica.KineticaData | |
| static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. More... | |
Detailed Description
A set of parameters for Kinetica.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 Kinetica.getJob.
Definition at line 20 of file CreateJob.cs.
Constructor & Destructor Documentation
◆ CreateJobRequest() [1/2]
|
inline |
Constructs a CreateJobRequest object with default parameters.
Definition at line 132 of file CreateJob.cs.
◆ CreateJobRequest() [2/2]
|
inline |
Constructs a CreateJobRequest object with the specified parameters.
- Parameters
-
endpoint Indicates which endpoint to execute, e.g. '/alter/table'. request_encoding The encoding of the request payload for the job. Supported values: The default value is BINARY. 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 request_encoding must be BINARY or SNAPPY. data_str 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 request_encoding must be JSON. options Optional parameters. - REMOVE_JOB_ON_COMPLETE: Supported values:
- 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 '-'
Definition at line 197 of file CreateJob.cs.
Property Documentation
◆ data
|
getset |
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 request_encoding must be BINARY or SNAPPY.
Definition at line 91 of file CreateJob.cs.
◆ data_str
|
getset |
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 request_encoding must be JSON.
Definition at line 101 of file CreateJob.cs.
◆ endpoint
|
getset |
Indicates which endpoint to execute, e.g.
'/alter/table'.
Definition at line 61 of file CreateJob.cs.
◆ options
|
getset |
Optional parameters.
- REMOVE_JOB_ON_COMPLETE: Supported values:
- 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.
Definition at line 128 of file CreateJob.cs.
◆ request_encoding
|
getset |
The documentation for this class was generated from the following file:
- Kinetica/Protocol/CreateJob.cs
