A set of parameters for Kinetica.createJob(string,string,byte[],string,IDictionary{string, string}). More...

Inheritance diagram for kinetica.CreateJobRequest:

Collaboration diagram for kinetica.CreateJobRequest:

Classes
struct	RequestEncoding
	The encoding of the request payload for the job. 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 `[get, set]`
	The encoding of the request payload for the job. More...

byte[]	data = RequestEncoding.BINARY `[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 `[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(string,string,byte[],string,IDictionary{string, string}).

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(long,IDictionary{string, string}).

Definition at line 23 of file CreateJob.cs.

Constructor & Destructor Documentation

kinetica.CreateJobRequest.CreateJobRequest ( )

inline

Constructs a CreateJobRequest object with default parameters.

Definition at line 105 of file CreateJob.cs.

kinetica.CreateJobRequest.CreateJobRequest	(	string	endpoint,
		string	request_encoding,
		byte[]	data,
		string	data_str,
		IDictionary< string, string >	options = `null`
	)

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: BINARY JSON SNAPPY 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 . Please see the documentation for the appropriate endpoint to see what values must (or can) be specified. If this parameter is used, then 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 . Please see the documentation for the appropriate endpoint to see what values must (or can) be specified. If this parameter is used, then must be json.
options	Optional parameters. The default value is an empty Dictionary.

Definition at line 151 of file CreateJob.cs.

Property Documentation

byte [] kinetica.CreateJobRequest.data = RequestEncoding.BINARY

getset

Binary-encoded payload for the job to be run asynchronously.

The payload must contain the relevant input parameters for the endpoint indicated in . Please see the documentation for the appropriate endpoint to see what values must (or can) be specified. If this parameter is used, then must be binary or snappy.

Definition at line 87 of file CreateJob.cs.

string kinetica.CreateJobRequest.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 . Please see the documentation for the appropriate endpoint to see what values must (or can) be specified. If this parameter is used, then must be json.

Definition at line 96 of file CreateJob.cs.

string kinetica.CreateJobRequest.endpoint

getset

Indicates which endpoint to execute, e.g.

'/alter/table'.

Definition at line 56 of file CreateJob.cs.

IDictionary<string, string> kinetica.CreateJobRequest.options

getset

Optional parameters.

The default value is an empty Dictionary.

Definition at line 100 of file CreateJob.cs.

string kinetica.CreateJobRequest.request_encoding

getset

The encoding of the request payload for the job.

Supported values:

The default value is BINARY.

Definition at line 77 of file CreateJob.cs.

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

Kinetica/Protocol/CreateJob.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Property Documentation