Kinetica   C#   API  Version 7.2.3.0
Classes | Properties | List of all members
kinetica.GetJobResponse Class Reference

A set of results returned by Kinetica.getJob. More...

+ Inheritance diagram for kinetica.GetJobResponse:
+ Collaboration diagram for kinetica.GetJobResponse:

Classes

struct  JobStatus
 A set of string constants for the parameter job_status. More...
 
struct  ResponseEncoding
 A set of string constants for the parameter response_encoding. More...
 
struct  StatusMap
 A set of string constants for the parameter status_map. More...
 

Properties

string endpoint [get, set]
 The endpoint which is being executed asynchronously. More...
 
string job_status [get, set]
 Status of the submitted job. More...
 
bool running [get, set]
 True if the end point is still executing. More...
 
int progress [get, set]
 Approximate percentage of the job completed. More...
 
bool successful [get, set]
 True if the job execution completed and no errors were encountered. More...
 
string response_encoding [get, set]
 The encoding of the job result (contained in job_response or job_response_str. More...
 
byte [] job_response [get, set]
 The binary-encoded response of the job. More...
 
string job_response_str [get, set]
 The json-encoded response of the job. More...
 
IDictionary< string, string > status_map = new Dictionary<string, string>() [get, set]
 Map of various status strings for the executed job. More...
 
IDictionary< string, string > info = new Dictionary<string, string>() [get, set]
 Additional information. More...
 
- Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class More...
 

Additional Inherited Members

- 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...
 
- 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 results returned by Kinetica.getJob.

Definition at line 73 of file GetJob.cs.

Property Documentation

◆ endpoint

string kinetica.GetJobResponse.endpoint
getset

The endpoint which is being executed asynchronously.

E.g. '/alter/table'.

Definition at line 133 of file GetJob.cs.

◆ info

IDictionary<string, string> kinetica.GetJobResponse.info = new Dictionary<string, string>()
getset

Additional information.

Definition at line 220 of file GetJob.cs.

◆ job_response

byte [] kinetica.GetJobResponse.job_response
getset

The binary-encoded response of the job.

This field is populated only when the job has completed and response_encoding is BINARY

Definition at line 197 of file GetJob.cs.

◆ job_response_str

string kinetica.GetJobResponse.job_response_str
getset

The json-encoded response of the job.

This field is populated only when the job has completed and response_encoding is JSON

Definition at line 203 of file GetJob.cs.

◆ job_status

string kinetica.GetJobResponse.job_status
getset

Status of the submitted job.

Supported values:

  • RUNNING: The job is currently executing.
  • DONE: The job execution has successfully completed and the response is included in the job_response or job_response_str field
  • ERROR: The job was attempted, but an error was encountered. The status_map contains the details of the error in error_message
  • CANCELLED: Job cancellation was requested while the execution was in progress.

Definition at line 162 of file GetJob.cs.

◆ progress

int kinetica.GetJobResponse.progress
getset

Approximate percentage of the job completed.

Definition at line 168 of file GetJob.cs.

◆ response_encoding

string kinetica.GetJobResponse.response_encoding
getset

The encoding of the job result (contained in job_response or job_response_str.

Supported values:

Definition at line 191 of file GetJob.cs.

◆ running

bool kinetica.GetJobResponse.running
getset

True if the end point is still executing.

Definition at line 165 of file GetJob.cs.

◆ status_map

IDictionary<string, string> kinetica.GetJobResponse.status_map = new Dictionary<string, string>()
getset

Map of various status strings for the executed job.

  • ERROR_MESSAGE: Explains what error occurred while running the job asynchronously. This entry only exists when the job status is ERROR.

Definition at line 217 of file GetJob.cs.

◆ successful

bool kinetica.GetJobResponse.successful
getset

True if the job execution completed and no errors were encountered.

Definition at line 172 of file GetJob.cs.

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