Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
CreateProc.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 
56  public struct ExecutionMode
57  {
58 
67  public const string DISTRIBUTED = "distributed";
68 
77  public const string NONDISTRIBUTED = "nondistributed";
78  } // end struct ExecutionMode
79 
80 
101  public struct Options
102  {
103 
107  public const string MAX_CONCURRENCY_PER_NODE = "max_concurrency_per_node";
108 
112  public const string SET_ENVIRONMENT = "set_environment";
113  } // end struct Options
114 
115 
118  public string proc_name { get; set; }
119 
149  public string execution_mode { get; set; } = ExecutionMode.DISTRIBUTED;
150 
162  public IDictionary<string, byte[]> files { get; set; } = new Dictionary<string, byte[]>();
163 
181  public string command { get; set; } = "";
182 
186  public IList<string> args { get; set; } = new List<string>();
187 
206  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
207 
208 
211  public CreateProcRequest() { }
212 
298  public CreateProcRequest( string proc_name,
299  string execution_mode = null,
300  IDictionary<string, byte[]> files = null,
301  string command = null,
302  IList<string> args = null,
303  IDictionary<string, string> options = null)
304  {
305  this.proc_name = proc_name ?? "";
306  this.execution_mode = execution_mode ?? ExecutionMode.DISTRIBUTED;
307  this.files = files ?? new Dictionary<string, byte[]>();
308  this.command = command ?? "";
309  this.args = args ?? new List<string>();
310  this.options = options ?? new Dictionary<string, string>();
311  } // end constructor
312 
313  } // end class CreateProcRequest
314 
315 
316 
321  {
322 
325  public string proc_name { get; set; }
326 
328  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
329 
330  } // end class CreateProcResponse
331 
332 
333 
334 
335 } // end namespace kinetica
IDictionary< string, string > info
Additional information.
Definition: CreateProc.cs:328
CreateProcRequest()
Constructs a CreateProcRequest object with default parameters.
Definition: CreateProc.cs:211
A set of parameters for Kinetica.createProc(string,string,IDictionary{string, byte[]},string,IList{string},IDictionary{string, string}).
Definition: CreateProc.cs:23
IDictionary< string, string > options
Optional parameters.
Definition: CreateProc.cs:206
IDictionary< string, byte[]> files
A map of the files that make up the proc.
Definition: CreateProc.cs:162
IList< string > args
An array of command-line arguments that will be passed to when the proc is executed.
Definition: CreateProc.cs:186
string command
The command (excluding arguments) that will be invoked when the proc is executed. ...
Definition: CreateProc.cs:181
string proc_name
Name of the proc to be created.
Definition: CreateProc.cs:118
const string SET_ENVIRONMENT
A python environment to use when executing the proc.
Definition: CreateProc.cs:112
string execution_mode
The execution mode of the proc.
Definition: CreateProc.cs:149
const string DISTRIBUTED
Input table data will be divided into data segments that are distributed across all nodes in the clus...
Definition: CreateProc.cs:67
A set of results returned by Kinetica.createProc(string,string,IDictionary{string, byte[]},string,IList{string},IDictionary{string, string}).
Definition: CreateProc.cs:320
CreateProcRequest(string proc_name, string execution_mode=null, IDictionary< string, byte[]> files=null, string command=null, IList< string > args=null, IDictionary< string, string > options=null)
Constructs a CreateProcRequest object with the specified parameters.
Definition: CreateProc.cs:298
const string MAX_CONCURRENCY_PER_NODE
The maximum number of concurrent instances of the proc that will be executed per node.
Definition: CreateProc.cs:107
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
string proc_name
Value of .
Definition: CreateProc.cs:325
The execution mode of the proc.
Definition: CreateProc.cs:56
const string NONDISTRIBUTED
The proc command will be invoked only once per execution, and will not have direct access to any tabl...
Definition: CreateProc.cs:77