Kinetica C# API  Version 7.1.10.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 
36  public struct Options
37  {
38 
40  public const string JOB_TAG = "job_tag";
41  } // end struct Options
42 
43 
46  public long job_id { get; set; }
47 
58  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
59 
60 
63  public GetJobRequest() { }
64 
81  public GetJobRequest( long job_id,
82  IDictionary<string, string> options = null)
83  {
84  this.job_id = job_id;
85  this.options = options ?? new Dictionary<string, string>();
86  } // end constructor
87 
88  } // end class GetJobRequest
89 
90 
91 
96  {
97 
129  public struct JobStatus
130  {
131 
133  public const string RUNNING = "RUNNING";
134 
138  public const string DONE = "DONE";
139 
143  public const string ERROR = "ERROR";
144 
147  public const string CANCELLED = "CANCELLED";
148  } // end struct JobStatus
149 
150 
170  public struct ResponseEncoding
171  {
172 
175  public const string BINARY = "binary";
176 
179  public const string JSON = "json";
180  } // end struct ResponseEncoding
181 
182 
196  public struct StatusMap
197  {
198 
202  public const string ERROR_MESSAGE = "error_message";
203  } // end struct StatusMap
204 
205 
208  public string endpoint { get; set; }
209 
239  public string job_status { get; set; }
240 
242  public bool running { get; set; }
243 
245  public int progress { get; set; }
246 
249  public bool successful { get; set; }
250 
268  public string response_encoding { get; set; }
269 
273  public byte[] job_response { get; set; }
274 
278  public string job_response_str { get; set; }
279 
291  public IDictionary<string, string> status_map { get; set; } = new Dictionary<string, string>();
292 
294  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
295 
296  } // end class GetJobResponse
297 
298 
299 
300 
301 } // 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:170
byte[] job_response
The binary-encoded response of the job.
Definition: GetJob.cs:273
const string BINARY
The job result is binary-encoded.
Definition: GetJob.cs:175
long job_id
A unique identifier for the job whose status and result is to be fetched.
Definition: GetJob.cs:46
string job_status
Status of the submitted job.
Definition: GetJob.cs:239
Optional parameters.
Definition: GetJob.cs:36
const string CANCELLED
Job cancellation was requested while the execution was in progress.
Definition: GetJob.cs:147
string job_response_str
The json-encoded response of the job.
Definition: GetJob.cs:278
Map of various status strings for the executed job.
Definition: GetJob.cs:196
IDictionary< string, string > info
Additional information.
Definition: GetJob.cs:294
const string RUNNING
The job is currently executing.
Definition: GetJob.cs:133
GetJobRequest(long job_id, IDictionary< string, string > options=null)
Constructs a GetJobRequest object with the specified parameters.
Definition: GetJob.cs:81
const string ERROR
The job was attempted, but an error was encountered.
Definition: GetJob.cs:143
IDictionary< string, string > status_map
Map of various status strings for the executed job.
Definition: GetJob.cs:291
string endpoint
The endpoint which is being executed asynchronously.
Definition: GetJob.cs:208
Status of the submitted job.
Definition: GetJob.cs:129
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:138
IDictionary< string, string > options
Optional parameters.
Definition: GetJob.cs:58
bool running
True if the end point is still executing.
Definition: GetJob.cs:242
const string JOB_TAG
Job tag returned in call to create the job
Definition: GetJob.cs:40
bool successful
True if the job execution completed and no errors were encountered.
Definition: GetJob.cs:249
const string JSON
The job result is json-encoded.
Definition: GetJob.cs:179
int progress
Approximate percentage of the job completed.
Definition: GetJob.cs:245
const string ERROR_MESSAGE
Explains what error occurred while running the job asynchronously.
Definition: GetJob.cs:202
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:268
A set of results returned by Kinetica.getJob(long,IDictionary{string, string}).
Definition: GetJob.cs:95
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:63