Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
CreateJob.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 
24  {
25 
46  public struct RequestEncoding
47  {
48  public const string BINARY = "binary";
49  public const string JSON = "json";
50  public const string SNAPPY = "snappy";
51  } // end struct RequestEncoding
52 
53 
83  public struct Options
84  {
85 
98  public const string REMOVE_JOB_ON_COMPLETE = "remove_job_on_complete";
99  public const string TRUE = "true";
100  public const string FALSE = "false";
101 
105  public const string JOB_TAG = "job_tag";
106  } // end struct Options
107 
108 
111  public string endpoint { get; set; }
112 
132  public string request_encoding { get; set; } = RequestEncoding.BINARY;
133 
142  public byte[] data { get; set; }
143 
151  public string data_str { get; set; }
152 
180  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
181 
182 
185  public CreateJobRequest() { }
186 
256  public CreateJobRequest( string endpoint,
257  string request_encoding,
258  byte[] data,
259  string data_str,
260  IDictionary<string, string> options = null)
261  {
262  this.endpoint = endpoint ?? "";
263  this.request_encoding = request_encoding ?? RequestEncoding.BINARY;
264  this.data = data ?? new byte[] { };
265  this.data_str = data_str ?? "";
266  this.options = options ?? new Dictionary<string, string>();
267  } // end constructor
268 
269  } // end class CreateJobRequest
270 
271 
272 
277  {
278 
292  public struct Info
293  {
294 
298  public const string JOB_TAG = "job_tag";
299  } // end struct Info
300 
301 
304  public long job_id { get; set; }
305 
317  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
318 
319  } // end class CreateJobResponse
320 
321 
322 
323 
324 } // end namespace kinetica
string data_str
JSON-encoded payload for the job to be run asynchronously.
Definition: CreateJob.cs:151
byte[] data
Binary-encoded payload for the job to be run asynchronously.
Definition: CreateJob.cs:142
The encoding of the request payload for the job.
Definition: CreateJob.cs:46
CreateJobRequest(string endpoint, string request_encoding, byte[] data, string data_str, IDictionary< string, string > options=null)
Constructs a CreateJobRequest object with the specified parameters.
Definition: CreateJob.cs:256
IDictionary< string, string > options
Optional parameters.
Definition: CreateJob.cs:180
IDictionary< string, string > info
Additional information.
Definition: CreateJob.cs:317
const string JOB_TAG
Tag to use for submitted job.
Definition: CreateJob.cs:105
const string JOB_TAG
The job tag specified by the user or if unspecified by user, a unique identifier generated internally...
Definition: CreateJob.cs:298
Additional information.
Definition: CreateJob.cs:292
A set of results returned by Kinetica.createJob(string,string,byte[],string,IDictionary{string, string}).
Definition: CreateJob.cs:276
Optional parameters.
Definition: CreateJob.cs:83
string endpoint
Indicates which endpoint to execute, e.g.
Definition: CreateJob.cs:111
string request_encoding
The encoding of the request payload for the job.
Definition: CreateJob.cs:132
const string REMOVE_JOB_ON_COMPLETE
Supported values: TRUE FALSE
Definition: CreateJob.cs:98
long job_id
An identifier for the job created by this call.
Definition: CreateJob.cs:304
A set of parameters for Kinetica.createJob(string,string,byte[],string,IDictionary{string, string}).
Definition: CreateJob.cs:23
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
CreateJobRequest()
Constructs a CreateJobRequest object with default parameters.
Definition: CreateJob.cs:185