Kinetica C# API  Version 6.2.0.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 
10 
11 namespace kinetica
12 {
13 
18  public class GetJobRequest : KineticaData
19  {
20 
23  public int job_id { get; set; }
24 
27  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
28 
29 
32  public GetJobRequest() { }
33 
42  public GetJobRequest( int job_id,
43  IDictionary<string, string> options = null)
44  {
45  this.job_id = job_id;
46  this.options = options ?? new Dictionary<string, string>();
47  } // end constructor
48 
49  } // end class GetJobRequest
50 
51 
52 
56  {
57 
89  public struct JobStatus
90  {
91 
93  public const string RUNNING = "RUNNING";
94 
98  public const string DONE = "DONE";
99 
103  public const string ERROR = "ERROR";
104 
107  public const string CANCELLED = "CANCELLED";
108  } // end struct JobStatus
109 
110 
130  public struct ResponseEncoding
131  {
132 
135  public const string BINARY = "binary";
136 
139  public const string JSON = "json";
140  } // end struct ResponseEncoding
141 
142 
156  public struct StatusMap
157  {
158 
162  public const string ERROR_MESSAGE = "error_message";
163  } // end struct StatusMap
164 
165 
168  public string endpoint { get; set; }
169 
199  public string job_status { get; set; }
200 
202  public bool running { get; set; }
203 
205  public int progress { get; set; }
206 
209  public bool successful { get; set; }
210 
228  public string response_encoding { get; set; }
229 
233  public byte[] job_response { get; set; }
234 
238  public string job_response_str { get; set; }
239 
251  public IDictionary<string, string> status_map { get; set; } = new Dictionary<string, string>();
252 
253  } // end class GetJobResponse
254 
255 
256 
257 
258 } // end namespace kinetica
The encoding of the job result (contained in <member name="job_response"> or <member name="job_respon...
Definition: GetJob.cs:130
Map of various status strings for the executed job.
Definition: GetJob.cs:156
Status of the submitted job.
Definition: GetJob.cs:89
IDictionary< string, string > options
Optional parameters.
Definition: GetJob.cs:27
GetJobRequest(int job_id, IDictionary< string, string > options=null)
Constructs a GetJobRequest object with the specified parameters.
Definition: GetJob.cs:42
int job_id
A unique identifier for the job whose status and result is to be fetched.
Definition: GetJob.cs:23
A set of results returned by Kinetica.getJob(int,IDictionary<string, string>).
Definition: GetJob.cs:55
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
A set of parameters for Kinetica.getJob(int,IDictionary<string, string>).
Definition: GetJob.cs:18
GetJobRequest()
Constructs a GetJobRequest object with default parameters.
Definition: GetJob.cs:32