Kinetica   C#   API  Version 7.2.3.0
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  public class GetJobRequest : KineticaData
20  {
24  public struct Options
25  {
27  public const string JOB_TAG = "job_tag";
28  } // end struct Options
29 
32  public long job_id { get; set; }
33 
43  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
44 
47  public GetJobRequest() { }
48 
63  public GetJobRequest( long job_id,
64  IDictionary<string, string> options = null)
65  {
66  this.job_id = job_id;
67  this.options = options ?? new Dictionary<string, string>();
68  } // end constructor
69  } // end class GetJobRequest
70 
74  {
78  public struct JobStatus
79  {
81  public const string RUNNING = "RUNNING";
82 
86  public const string DONE = "DONE";
87 
92  public const string ERROR = "ERROR";
93 
96  public const string CANCELLED = "CANCELLED";
97  } // end struct JobStatus
98 
104  public struct ResponseEncoding
105  {
109  public const string BINARY = "binary";
110 
114  public const string JSON = "json";
115  } // end struct ResponseEncoding
116 
121  public struct StatusMap
122  {
127  public const string ERROR_MESSAGE = "error_message";
128  } // end struct StatusMap
129 
133  public string endpoint { get; set; }
134 
162  public string job_status { get; set; }
163 
165  public bool running { get; set; }
166 
168  public int progress { get; set; }
169 
172  public bool successful { get; set; }
173 
191  public string response_encoding { get; set; }
192 
197  public byte[] job_response { get; set; }
198 
203  public string job_response_str { get; set; }
204 
217  public IDictionary<string, string> status_map { get; set; } = new Dictionary<string, string>();
218 
220  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
221  } // end class GetJobResponse
222 } // end namespace kinetica
A set of string constants for the parameter response_encoding.
Definition: GetJob.cs:104
byte [] job_response
The binary-encoded response of the job.
Definition: GetJob.cs:197
const string BINARY
The job result is binary-encoded.
Definition: GetJob.cs:109
long job_id
A unique identifier for the job whose status and result is to be fetched.
Definition: GetJob.cs:32
string job_status
Status of the submitted job.
Definition: GetJob.cs:162
A set of string constants for the parameter options.
Definition: GetJob.cs:24
const string CANCELLED
Job cancellation was requested while the execution was in progress.
Definition: GetJob.cs:96
string job_response_str
The json-encoded response of the job.
Definition: GetJob.cs:203
A set of string constants for the parameter status_map.
Definition: GetJob.cs:121
IDictionary< string, string > info
Additional information.
Definition: GetJob.cs:220
const string RUNNING
The job is currently executing.
Definition: GetJob.cs:81
GetJobRequest(long job_id, IDictionary< string, string > options=null)
Constructs a GetJobRequest object with the specified parameters.
Definition: GetJob.cs:63
const string ERROR
The job was attempted, but an error was encountered.
Definition: GetJob.cs:92
IDictionary< string, string > status_map
Map of various status strings for the executed job.
Definition: GetJob.cs:217
string endpoint
The endpoint which is being executed asynchronously.
Definition: GetJob.cs:133
A set of string constants for the parameter job_status.
Definition: GetJob.cs:78
const string DONE
The job execution has successfully completed and the response is included in the job_response or job_...
Definition: GetJob.cs:86
IDictionary< string, string > options
Optional parameters.
Definition: GetJob.cs:43
bool running
True if the end point is still executing.
Definition: GetJob.cs:165
const string JOB_TAG
Job tag returned in call to create the job
Definition: GetJob.cs:27
bool successful
True if the job execution completed and no errors were encountered.
Definition: GetJob.cs:172
const string JSON
The job result is json-encoded.
Definition: GetJob.cs:114
int progress
Approximate percentage of the job completed.
Definition: GetJob.cs:168
const string ERROR_MESSAGE
Explains what error occurred while running the job asynchronously.
Definition: GetJob.cs:127
string response_encoding
The encoding of the job result (contained in job_response or job_response_str.
Definition: GetJob.cs:191
A set of results returned by Kinetica.getJob.
Definition: GetJob.cs:73
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
A set of parameters for Kinetica.getJob.
Definition: GetJob.cs:19
GetJobRequest()
Constructs a GetJobRequest object with default parameters.
Definition: GetJob.cs:47