Kinetica   C#   API  Version 7.2.3.0
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 namespace kinetica
10 {
19  {
23  public struct ExecutionMode
24  {
32  public const string DISTRIBUTED = "distributed";
33 
41  public const string NONDISTRIBUTED = "nondistributed";
42  } // end struct ExecutionMode
43 
47  public struct Options
48  {
53  public const string MAX_CONCURRENCY_PER_NODE = "max_concurrency_per_node";
54 
59  public const string SET_ENVIRONMENT = "set_environment";
60  } // end struct Options
61 
65  public string proc_name { get; set; }
66 
96  public string execution_mode { get; set; } = ExecutionMode.DISTRIBUTED;
97 
107  public IDictionary<string, byte[]> files { get; set; } = new Dictionary<string, byte[]>();
108 
121  public string command { get; set; } = "";
122 
126  public IList<string> args { get; set; } = new List<string>();
127 
148  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
149 
152  public CreateProcRequest() { }
153 
229  public CreateProcRequest( string proc_name,
230  string execution_mode = null,
231  IDictionary<string, byte[]> files = null,
232  string command = null,
233  IList<string> args = null,
234  IDictionary<string, string> options = null)
235  {
236  this.proc_name = proc_name ?? "";
238  this.files = files ?? new Dictionary<string, byte[]>();
239  this.command = command ?? "";
240  this.args = args ?? new List<string>();
241  this.options = options ?? new Dictionary<string, string>();
242  } // end constructor
243  } // end class CreateProcRequest
244 
249  {
252  public string proc_name { get; set; }
253 
255  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
256  } // end class CreateProcResponse
257 } // end namespace kinetica
IDictionary< string, string > info
Additional information.
Definition: CreateProc.cs:255
CreateProcRequest()
Constructs a CreateProcRequest object with default parameters.
Definition: CreateProc.cs:152
A set of parameters for Kinetica.createProc.
Definition: CreateProc.cs:18
IDictionary< string, string > options
Optional parameters.
Definition: CreateProc.cs:148
IDictionary< string, byte[]> files
A map of the files that make up the proc.
Definition: CreateProc.cs:107
IList< string > args
An array of command-line arguments that will be passed to command when the proc is executed.
Definition: CreateProc.cs:126
string command
The command (excluding arguments) that will be invoked when the proc is executed.
Definition: CreateProc.cs:121
string proc_name
Name of the proc to be created.
Definition: CreateProc.cs:65
const string SET_ENVIRONMENT
A python environment to use when executing the proc.
Definition: CreateProc.cs:59
string execution_mode
The execution mode of the proc.
Definition: CreateProc.cs:96
const string DISTRIBUTED
Input table data will be divided into data segments that are distributed across all nodes in the clus...
Definition: CreateProc.cs:32
A set of string constants for the parameter options.
Definition: CreateProc.cs:47
A set of results returned by Kinetica.createProc.
Definition: CreateProc.cs:248
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:229
const string MAX_CONCURRENCY_PER_NODE
The maximum number of concurrent instances of the proc that will be executed per node.
Definition: CreateProc.cs:53
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
string proc_name
Value of proc_name.
Definition: CreateProc.cs:252
A set of string constants for the parameter execution_mode.
Definition: CreateProc.cs:23
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:41