Kinetica C# API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
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 
10 
11 namespace kinetica
12 {
13 
21  public class GetJobRequest : KineticaData
22  {
23 
26  public long job_id { get; set; }
27 
30  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
31 
32 
35  public GetJobRequest() { }
36 
45  public GetJobRequest( long job_id,
46  IDictionary<string, string> options = null)
47  {
48  this.job_id = job_id;
49  this.options = options ?? new Dictionary<string, string>();
50  } // end constructor
51 
52  } // end class GetJobRequest
53 
54 
55 
60  {
61 
93  public struct JobStatus
94  {
95 
97  public const string RUNNING = "RUNNING";
98 
102  public const string DONE = "DONE";
103 
107  public const string ERROR = "ERROR";
108 
111  public const string CANCELLED = "CANCELLED";
112  } // end struct JobStatus
113 
114 
134  public struct ResponseEncoding
135  {
136 
139  public const string BINARY = "binary";
140 
143  public const string JSON = "json";
144  } // end struct ResponseEncoding
145 
146 
160  public struct StatusMap
161  {
162 
166  public const string ERROR_MESSAGE = "error_message";
167  } // end struct StatusMap
168 
169 
172  public string endpoint { get; set; }
173 
203  public string job_status { get; set; }
204 
206  public bool running { get; set; }
207 
209  public int progress { get; set; }
210 
213  public bool successful { get; set; }
214 
232  public string response_encoding { get; set; }
233 
237  public byte[] job_response { get; set; }
238 
242  public string job_response_str { get; set; }
243 
255  public IDictionary<string, string> status_map { get; set; } = new Dictionary<string, string>();
256 
258  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
259 
260  } // end class GetJobResponse
261 
262 
263 
264 
265 } // end namespace kinetica
The encoding of the job result (contained in &lt;member name=&quot;job_response&quot;&gt; or &lt;member name=&quot;job_respon...
Definition: GetJob.cs:134
byte[] job_response
The binary-encoded response of the job.
Definition: GetJob.cs:237
const string BINARY
The job result is binary-encoded.
Definition: GetJob.cs:139
long job_id
A unique identifier for the job whose status and result is to be fetched.
Definition: GetJob.cs:26
string job_status
Status of the submitted job.
Definition: GetJob.cs:203
const string CANCELLED
Job cancellation was requested while the execution was in progress.
Definition: GetJob.cs:111
string job_response_str
The json-encoded response of the job.
Definition: GetJob.cs:242
Map of various status strings for the executed job.
Definition: GetJob.cs:160
IDictionary< string, string > info
Additional information.
Definition: GetJob.cs:258
const string RUNNING
The job is currently executing.
Definition: GetJob.cs:97
GetJobRequest(long job_id, IDictionary< string, string > options=null)
Constructs a GetJobRequest object with the specified parameters.
Definition: GetJob.cs:45
const string ERROR
The job was attempted, but an error was encountered.
Definition: GetJob.cs:107
IDictionary< string, string > status_map
Map of various status strings for the executed job.
Definition: GetJob.cs:255
string endpoint
The endpoint which is being executed asynchronously.
Definition: GetJob.cs:172
Status of the submitted job.
Definition: GetJob.cs:93
const string DONE
The job execution has successfully completed and the response is included in the &lt;member name=&quot;job_re...
Definition: GetJob.cs:102
IDictionary< string, string > options
Optional parameters.
Definition: GetJob.cs:30
bool running
True if the end point is still executing.
Definition: GetJob.cs:206
bool successful
True if the job execution completed and no errors were encountered.
Definition: GetJob.cs:213
const string JSON
The job result is json-encoded.
Definition: GetJob.cs:143
int progress
Approximate percentage of the job completed.
Definition: GetJob.cs:209
const string ERROR_MESSAGE
Explains what error occurred while running the job asynchronously.
Definition: GetJob.cs:166
string response_encoding
The encoding of the job result (contained in &lt;member name=&quot;job_response&quot;&gt; or &lt;member name=&quot;job_respon...
Definition: GetJob.cs:232
A set of results returned by Kinetica.getJob(long,IDictionary{string, string}).
Definition: GetJob.cs:59
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
A set of parameters for Kinetica.getJob(long,IDictionary{string, string}).
Definition: GetJob.cs:21
GetJobRequest()
Constructs a GetJobRequest object with default parameters.
Definition: GetJob.cs:35