Skip to main content

A set of parameters for Kinetica.getJob. More…

Inheritance diagram for kinetica.GetJobRequest:
[legend]
Collaboration diagram for kinetica.GetJobRequest:
[legend]

​
Classes

struct  Options
 A set of string constants for the parameter GetJobRequest.options. More…
 

​
Public Member Functions

 GetJobRequest ()
 Constructs a GetJobRequest object with default parameters.
 
 GetJobRequest (long job_id, IDictionary< string, string > options=null)
 Constructs a GetJobRequest object with the specified parameters.
 
 GetJobRequest ()
 Constructs a GetJobRequest object with default parameters.
 
 GetJobRequest (long job_id, IDictionary< string, string > options=null)
 Constructs a GetJobRequest object with the specified parameters.
 
 Public Member Functions inherited from kinetica.KineticaData
 KineticaData (KineticaType type)
 Constructor from Kinetica Type.
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type.
 
object Get (int fieldPos)
 Retrieve a specific property from this object.
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object.
 
 KineticaData (KineticaType type)
 Constructor from Kinetica Type.
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type.
 
object Get (int fieldPos)
 Retrieve a specific property from this object.
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object.
 

​
Properties

long job_id [get, set]
 A unique identifier for the job whose status and result is to be fetched.
 
IDictionary< string, string > options = new Dictionary<string, string>() [get, set]
 Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class.
 

​
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.
 
static ? RecordSchema SchemaFromType (System.Type t, KineticaType? ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType.
 

​
Detailed Description

A set of parameters for Kinetica.getJob.

Get the status and result of asynchronously running job. See the Kinetica.createJob for starting an asynchronous job. Some fields of the response are filled only after the submitted job has finished execution.

Definition at line 18 of file GetJob.cs.

​
Constructor & Destructor Documentation

​
◆ GetJobRequest() [1/4]

kinetica.GetJobRequest.GetJobRequest ()
 inline

Constructs a GetJobRequest object with default parameters.

Definition at line 47 of file GetJob.cs.

​
◆ GetJobRequest() [2/4]

kinetica.GetJobRequest.GetJobRequest (longjob_id,
IDictionary< string, string >options = null )
 inline

Constructs a GetJobRequest object with the specified parameters.

Parameters
job_idA unique identifier for the job whose status and result is to be fetched.
optionsOptional parameters.
  • JOB_TAG: Job tag returned in call to create the job.
The default value is an empty Dictionary.

Definition at line 64 of file GetJob.cs.

​
◆ GetJobRequest() [3/4]

kinetica.GetJobRequest.GetJobRequest ()
 inline

Constructs a GetJobRequest object with default parameters.

Definition at line 47 of file GetJob.cs.

​
◆ GetJobRequest() [4/4]

kinetica.GetJobRequest.GetJobRequest (longjob_id,
IDictionary< string, string >options = null )
 inline

Constructs a GetJobRequest object with the specified parameters.

Parameters
job_idA unique identifier for the job whose status and result is to be fetched.
optionsOptional parameters.
  • JOB_TAG: Job tag returned in call to create the job.
The default value is an empty Dictionary.

Definition at line 64 of file GetJob.cs.

​
Property Documentation

​
◆ job_id

long kinetica.GetJobRequest.job_id
 getset

A unique identifier for the job whose status and result is to be fetched.

Definition at line 31 of file GetJob.cs.

​
◆ options

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

Optional parameters.

  • JOB_TAG: Job tag returned in call to create the job.

The default value is an empty Dictionary.

Definition at line 43 of file GetJob.cs.

The documentation for this class was generated from the following files:
  • _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/GetJob.cs
  • Kinetica/Protocol/GetJob.cs