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...

	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...

	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...

Properties inherited from Avro.Specific.ISpecificRecord
Schema	Schema `[get]`

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...

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/4]

kinetica.CreateJobRequest.CreateJobRequest ( )

inline

Constructs a CreateJobRequest object with default parameters.

Definition at line 104 of file CreateJob.cs.

◆ CreateJobRequest() [2/4]

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 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. 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 155 of file CreateJob.cs.

◆ CreateJobRequest() [3/4]

kinetica.CreateJobRequest.CreateJobRequest ( )

inline

Constructs a CreateJobRequest object with default parameters.

Definition at line 104 of file CreateJob.cs.

◆ CreateJobRequest() [4/4]

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 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. 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 155 of file CreateJob.cs.

Property Documentation

◆ data

byte [] kinetica.CreateJobRequest.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 77 of file CreateJob.cs.

◆ data_str

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 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 87 of file CreateJob.cs.

◆ endpoint

string kinetica.CreateJobRequest.endpoint

getset

Indicates which endpoint to execute, e.g.

'/alter/table'.

Definition at line 47 of file CreateJob.cs.

◆ options

IDictionary< string, string > kinetica.CreateJobRequest.options = new Dictionary<string, string>()

getset

Optional 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.

Definition at line 100 of file CreateJob.cs.

◆ request_encoding

string kinetica.CreateJobRequest.request_encoding = RequestEncoding.BINARY

getset

The encoding of the request payload for the job.

Supported values:

The default value is BINARY.

Definition at line 66 of file CreateJob.cs.

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

_build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/CreateJob.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CreateJobRequest() [1/4]

◆ CreateJobRequest() [2/4]

◆ CreateJobRequest() [3/4]

◆ CreateJobRequest() [4/4]

Property Documentation

◆ data

◆ data_str

◆ endpoint

◆ options

◆ request_encoding