Kinetica   C#   API  Version 7.2.3.0
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 namespace kinetica
10 {
21  {
26  public struct RequestEncoding
27  {
28  public const string BINARY = "binary";
29  public const string JSON = "json";
30  public const string SNAPPY = "snappy";
31  } // end struct RequestEncoding
32 
36  public struct Options
37  {
47  public const string REMOVE_JOB_ON_COMPLETE = "remove_job_on_complete";
48 
49  public const string TRUE = "true";
50  public const string FALSE = "false";
51 
56  public const string JOB_TAG = "job_tag";
57  } // end struct Options
58 
61  public string endpoint { get; set; }
62 
80  public string request_encoding { get; set; } = RequestEncoding.BINARY;
81 
91  public byte[] data { get; set; }
92 
101  public string data_str { get; set; }
102 
128  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
129 
132  public CreateJobRequest() { }
133 
197  public CreateJobRequest( string endpoint,
198  string request_encoding,
199  byte[] data,
200  string data_str,
201  IDictionary<string, string> options = null)
202  {
203  this.endpoint = endpoint ?? "";
204  this.request_encoding = request_encoding ?? RequestEncoding.BINARY;
205  this.data = data ?? new byte[] { };
206  this.data_str = data_str ?? "";
207  this.options = options ?? new Dictionary<string, string>();
208  } // end constructor
209  } // end class CreateJobRequest
210 
215  {
219  public struct Info
220  {
224  public const string JOB_TAG = "job_tag";
225  } // end struct Info
226 
228  public long job_id { get; set; }
229 
240  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
241  } // end class CreateJobResponse
242 } // end namespace kinetica
string data_str
JSON-encoded payload for the job to be run asynchronously.
Definition: CreateJob.cs:101
byte [] data
Binary-encoded payload for the job to be run asynchronously.
Definition: CreateJob.cs:91
A set of string constants for the parameter request_encoding.
Definition: CreateJob.cs:26
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:197
IDictionary< string, string > options
Optional parameters.
Definition: CreateJob.cs:128
IDictionary< string, string > info
Additional information.
Definition: CreateJob.cs:240
const string JOB_TAG
Tag to use for submitted job.
Definition: CreateJob.cs:56
const string JOB_TAG
The job tag specified by the user or if unspecified by user, a unique identifier generated internally...
Definition: CreateJob.cs:224
A set of string constants for the parameter info.
Definition: CreateJob.cs:219
A set of results returned by Kinetica.createJob.
Definition: CreateJob.cs:214
A set of string constants for the parameter options.
Definition: CreateJob.cs:36
string endpoint
Indicates which endpoint to execute, e.g.
Definition: CreateJob.cs:61
string request_encoding
The encoding of the request payload for the job.
Definition: CreateJob.cs:80
long job_id
An identifier for the job created by this call.
Definition: CreateJob.cs:228
A set of parameters for Kinetica.createJob.
Definition: CreateJob.cs:20
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
CreateJobRequest()
Constructs a CreateJobRequest object with default parameters.
Definition: CreateJob.cs:132