Kinetica   C#   API  Version 7.2.3.1
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  {
31  public const string DISTRIBUTED = "distributed";
32 
40  public const string NONDISTRIBUTED = "nondistributed";
41  } // end struct ExecutionMode
42 
46  public struct Options
47  {
52  public const string MAX_CONCURRENCY_PER_NODE = "max_concurrency_per_node";
53 
58  public const string SET_ENVIRONMENT = "set_environment";
59  } // end struct Options
60 
64  public string proc_name { get; set; }
65 
92  public string execution_mode { get; set; } = ExecutionMode.DISTRIBUTED;
93 
103  public IDictionary<string, byte[]> files { get; set; } = new Dictionary<string, byte[]>();
104 
117  public string command { get; set; } = "";
118 
122  public IList<string> args { get; set; } = new List<string>();
123 
143  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
144 
147  public CreateProcRequest() { }
148 
221  public CreateProcRequest( string proc_name,
222  string execution_mode = null,
223  IDictionary<string, byte[]> files = null,
224  string command = null,
225  IList<string> args = null,
226  IDictionary<string, string> options = null)
227  {
228  this.proc_name = proc_name ?? "";
230  this.files = files ?? new Dictionary<string, byte[]>();
231  this.command = command ?? "";
232  this.args = args ?? new List<string>();
233  this.options = options ?? new Dictionary<string, string>();
234  } // end constructor
235 } // end class CreateProcRequest
236 
241 {
244  public string proc_name { get; set; }
245 
247  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
248 } // end class CreateProcResponse
A set of parameters for Kinetica.createProc.
Definition: CreateProc.cs:18
A set of string constants for the parameter execution_mode.
Definition: CreateProc.cs:23
A set of string constants for the parameter options.
Definition: CreateProc.cs:46
string proc_name
Name of the proc to be created.
Definition: CreateProc.cs:64
string execution_mode
The execution mode of the proc.
Definition: CreateProc.cs:92
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
const string SET_ENVIRONMENT
A python environment to use when executing the proc.
Definition: CreateProc.cs:58
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:221
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:40
string command
The command (excluding arguments) that will be invoked when the proc is executed.
Definition: CreateProc.cs:117
CreateProcRequest()
Constructs a CreateProcRequest object with default parameters.
Definition: CreateProc.cs:147
const string MAX_CONCURRENCY_PER_NODE
The maximum number of concurrent instances of the proc that will be executed per node.
Definition: CreateProc.cs:52
A set of results returned by Kinetica.createProc.
Definition: CreateProc.cs:240
string proc_name
Value of proc_name.
Definition: CreateProc.cs:244
IDictionary< string, byte[]> files
A map of the files that make up the proc.
Definition: CreateProc.cs:103
IList< string > args
An array of command-line arguments that will be passed to command when the proc is executed.
Definition: CreateProc.cs:122
IDictionary< string, string > info
Additional information.
Definition: CreateProc.cs:247
const string DISTRIBUTED
Input table data will be divided into data segments that are distributed across all nodes in the clus...
Definition: CreateProc.cs:31
IDictionary< string, string > options
Optional parameters.
Definition: CreateProc.cs:143