Kinetica   C#   API  Version 7.2.3.1
GetJob.cs
Go to the documentation of this file.
1 /*
2  * This file was autogenerated by the Kinetica schema processor.
3  *
4  * DO NOT EDIT DIRECTLY.
5  */
6 
7 using System.Collections.Generic;
8 
9 namespace kinetica;
10 
19 {
23  public struct Options
24  {
26  public const string JOB_TAG = "job_tag";
27  } // end struct Options
28 
31  public long job_id { get; set; }
32 
42  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
43 
46  public GetJobRequest() { }
47 
62  public GetJobRequest( long job_id,
63  IDictionary<string, string> options = null)
64  {
65  this.job_id = job_id;
66  this.options = options ?? new Dictionary<string, string>();
67  } // end constructor
68 } // end class GetJobRequest
69 
73 {
77  public struct JobStatus
78  {
80  public const string RUNNING = "RUNNING";
81 
85  public const string DONE = "DONE";
86 
91  public const string ERROR = "ERROR";
92 
95  public const string CANCELLED = "CANCELLED";
96  } // end struct JobStatus
97 
103  public struct ResponseEncoding
104  {
108  public const string BINARY = "binary";
109 
113  public const string JSON = "json";
114  } // end struct ResponseEncoding
115 
120  public struct StatusMap
121  {
126  public const string ERROR_MESSAGE = "error_message";
127  } // end struct StatusMap
128 
131  public string endpoint { get; set; }
132 
158  public string job_status { get; set; }
159 
161  public bool running { get; set; }
162 
164  public int progress { get; set; }
165 
168  public bool successful { get; set; }
169 
185  public string response_encoding { get; set; }
186 
191  public byte[] job_response { get; set; }
192 
197  public string job_response_str { get; set; }
198 
209  public IDictionary<string, string> status_map { get; set; } = new Dictionary<string, string>();
210 
212  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
213 } // end class GetJobResponse
const string JOB_TAG
Job tag returned in call to create the job.
Definition: GetJob.cs:26
bool successful
True if the job execution completed and no errors were encountered.
Definition: GetJob.cs:168
const string CANCELLED
Job cancellation was requested while the execution was in progress.
Definition: GetJob.cs:95
const string JSON
The job result is JSON-encoded.
Definition: GetJob.cs:113
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
A set of string constants for the parameter options.
Definition: GetJob.cs:23
IDictionary< string, string > options
Optional parameters.
Definition: GetJob.cs:42
GetJobRequest()
Constructs a GetJobRequest object with default parameters.
Definition: GetJob.cs:46
const string RUNNING
The job is currently executing.
Definition: GetJob.cs:80
const string ERROR_MESSAGE
Explains what error occurred while running the job asynchronously.
Definition: GetJob.cs:126
A set of results returned by Kinetica.getJob.
Definition: GetJob.cs:72
GetJobRequest(long job_id, IDictionary< string, string > options=null)
Constructs a GetJobRequest object with the specified parameters.
Definition: GetJob.cs:62
string endpoint
The endpoint which is being executed asynchronously.
Definition: GetJob.cs:131
const string BINARY
The job result is binary-encoded.
Definition: GetJob.cs:108
long job_id
A unique identifier for the job whose status and result is to be fetched.
Definition: GetJob.cs:31
string job_status
Status of the submitted job.
Definition: GetJob.cs:158
string job_response_str
The json-encoded response of the job.
Definition: GetJob.cs:197
string response_encoding
The encoding of the job result (contained in job_response or job_response_str.
Definition: GetJob.cs:185
A set of parameters for Kinetica.getJob.
Definition: GetJob.cs:18
A set of string constants for the parameter job_status.
Definition: GetJob.cs:77
bool running
True if the end point is still executing.
Definition: GetJob.cs:161
A set of string constants for the parameter status_map.
Definition: GetJob.cs:120
const string DONE
The job execution has successfully completed and the response is included in the job_response or job_...
Definition: GetJob.cs:85
const string ERROR
The job was attempted, but an error was encountered.
Definition: GetJob.cs:91
IDictionary< string, string > status_map
Map of various status strings for the executed job.
Definition: GetJob.cs:209
IDictionary< string, string > info
Additional information.
Definition: GetJob.cs:212
A set of string constants for the parameter response_encoding.
Definition: GetJob.cs:103
byte [] job_response
The binary-encoded response of the job.
Definition: GetJob.cs:191
int progress
Approximate percentage of the job completed.
Definition: GetJob.cs:164