kinetica.AlterEnvironmentRequest

A set of parameters for Kinetica.alterEnvironment. More…

Inheritance diagram for kinetica.AlterEnvironmentRequest:

Collaboration diagram for kinetica.AlterEnvironmentRequest:

Classes
struct	Action
	A set of string constants for the parameter AlterEnvironmentRequest.action. More…

struct	Options
	A set of string constants for the parameter AlterEnvironmentRequest.options. More…

Public Member Functions
	AlterEnvironmentRequest ()
	Constructs an AlterEnvironmentRequest object with default parameters.

	AlterEnvironmentRequest (string environment_name, string action, string _value, IDictionary< string, string > options=null)
	Constructs an AlterEnvironmentRequest object with the specified parameters.

	AlterEnvironmentRequest ()
	Constructs an AlterEnvironmentRequest object with default parameters.

	AlterEnvironmentRequest (string environment_name, string action, string _value, IDictionary< string, string > options=null)
	Constructs an AlterEnvironmentRequest object with the specified parameters.

Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type.

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type.

object	Get (int fieldPos)
	Retrieve a specific property from this object.

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object.

	KineticaData (KineticaType type)
	Constructor from Kinetica Type.

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type.

object	Get (int fieldPos)
	Retrieve a specific property from this object.

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object.

Properties
string	environment_name `[get, set]`
	Name of the environment to be altered.

string	action `[get, set]`
	Modification operation to be applied.

string	_value `[get, set]`
	The value of the modification, depending on AlterEnvironmentRequest.action.

IDictionary< string, string >	options = new Dictionary<string, string>() `[get, set]`
	Optional parameters.

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class.

Additional Inherited Members
Static Public Member Functions inherited from kinetica.KineticaData
static ? RecordSchema	SchemaFromType (System.Type t, KineticaType? ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType.

static ? RecordSchema	SchemaFromType (System.Type t, KineticaType? ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType.

Detailed Description

A set of parameters for Kinetica.alterEnvironment.

Alters an existing environment which can be referenced by a user-defined function (UDF).

Definition at line 17 of file AlterEnvironment.cs.

Constructor & Destructor Documentation

◆ AlterEnvironmentRequest() [1/4]

kinetica.AlterEnvironmentRequest.AlterEnvironmentRequest ( )

inline

Constructs an AlterEnvironmentRequest object with default parameters.

Definition at line 143 of file AlterEnvironment.cs.

◆ AlterEnvironmentRequest() [2/4]

kinetica.AlterEnvironmentRequest.AlterEnvironmentRequest	(	string	environment_name,
		string	action,
		string	_value,
		IDictionary< string, string >	options = null )

inline

Constructs an AlterEnvironmentRequest object with the specified parameters.

Parameters

environment_name	Name of the environment to be altered.
action	Modification operation to be applied. Supported values: INSTALL_PACKAGE: Install a python package from PyPI, an external data source or KiFS. INSTALL_REQUIREMENTS: Install packages from a requirements file. UNINSTALL_PACKAGE: Uninstall a python package. UNINSTALL_REQUIREMENTS: Uninstall packages from a requirements file. RESET: Uninstalls all packages in the environment and resets it to the original state at time of creation. REBUILD: Recreates the environment and re-installs all packages, upgrades the packages if necessary based on dependencies.
_value	The value of the modification, depending on action . For example, if action is INSTALL_PACKAGE, this would be the python package name. If action is INSTALL_REQUIREMENTS, this would be the path of a requirements file from which to install packages. If an external data source is specified in DATASOURCE_NAME, this can be the path to a wheel file or source archive. Alternatively, if installing from a file (wheel or source archive), the value may be a reference to a file in KiFS.
options	Optional parameters. DATASOURCE_NAME: Name of an existing external data source from which packages specified in _value can be loaded. The default value is an empty Dictionary.

Definition at line 223 of file AlterEnvironment.cs.

◆ AlterEnvironmentRequest() [3/4]

kinetica.AlterEnvironmentRequest.AlterEnvironmentRequest ( )

inline

Constructs an AlterEnvironmentRequest object with default parameters.

Definition at line 143 of file AlterEnvironment.cs.

◆ AlterEnvironmentRequest() [4/4]

kinetica.AlterEnvironmentRequest.AlterEnvironmentRequest	(	string	environment_name,
		string	action,
		string	_value,
		IDictionary< string, string >	options = null )

inline

Constructs an AlterEnvironmentRequest object with the specified parameters.

Parameters

environment_name	Name of the environment to be altered.
action	Modification operation to be applied. Supported values: INSTALL_PACKAGE: Install a python package from PyPI, an external data source or KiFS. INSTALL_REQUIREMENTS: Install packages from a requirements file. UNINSTALL_PACKAGE: Uninstall a python package. UNINSTALL_REQUIREMENTS: Uninstall packages from a requirements file. RESET: Uninstalls all packages in the environment and resets it to the original state at time of creation. REBUILD: Recreates the environment and re-installs all packages, upgrades the packages if necessary based on dependencies.
_value	The value of the modification, depending on action . For example, if action is INSTALL_PACKAGE, this would be the python package name. If action is INSTALL_REQUIREMENTS, this would be the path of a requirements file from which to install packages. If an external data source is specified in DATASOURCE_NAME, this can be the path to a wheel file or source archive. Alternatively, if installing from a file (wheel or source archive), the value may be a reference to a file in KiFS.
options	Optional parameters. DATASOURCE_NAME: Name of an existing external data source from which packages specified in _value can be loaded. The default value is an empty Dictionary.

Definition at line 223 of file AlterEnvironment.cs.

Property Documentation

◆ _value

string kinetica.AlterEnvironmentRequest._value

getset

The value of the modification, depending on AlterEnvironmentRequest.action.

For example, if AlterEnvironmentRequest.action is INSTALL_PACKAGE, this would be the python package name.

If AlterEnvironmentRequest.action is INSTALL_REQUIREMENTS, this would be the path of a requirements file from which to install packages.

If an external data source is specified in DATASOURCE_NAME, this can be the path to a wheel file or source archive. Alternatively, if installing from a file (wheel or source archive), the value may be a reference to a file in KiFS.

Definition at line 124 of file AlterEnvironment.cs.

◆ action

string kinetica.AlterEnvironmentRequest.action

getset

Modification operation to be applied.

Supported values:

INSTALL_PACKAGE: Install a python package from PyPI, an external data source or KiFS.
INSTALL_REQUIREMENTS: Install packages from a requirements file.
UNINSTALL_PACKAGE: Uninstall a python package.
UNINSTALL_REQUIREMENTS: Uninstall packages from a requirements file.
RESET: Uninstalls all packages in the environment and resets it to the original state at time of creation.
REBUILD: Recreates the environment and re-installs all packages, upgrades the packages if necessary based on dependencies.

Definition at line 106 of file AlterEnvironment.cs.

◆ environment_name

string kinetica.AlterEnvironmentRequest.environment_name

getset

Name of the environment to be altered.

Definition at line 58 of file AlterEnvironment.cs.

◆ options

IDictionary< string, string > kinetica.AlterEnvironmentRequest.options = new Dictionary<string, string>()

getset

Optional parameters.

DATASOURCE_NAME: Name of an existing external data source from which packages specified in AlterEnvironmentRequest._value can be loaded.

The default value is an empty Dictionary.

Definition at line 139 of file AlterEnvironment.cs.

The documentation for this class was generated from the following files:

_build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/AlterEnvironment.cs
Kinetica/Protocol/AlterEnvironment.cs

​ Classes

​ Public Member Functions

​ Properties

​ Additional Inherited Members

​Detailed Description

​Constructor & Destructor Documentation

​◆ AlterEnvironmentRequest() [1/4]

​◆ AlterEnvironmentRequest() [2/4]

​◆ AlterEnvironmentRequest() [3/4]

​◆ AlterEnvironmentRequest() [4/4]

​Property Documentation

​◆ _value

​◆ action

​◆ environment_name

​◆ options

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AlterEnvironmentRequest() [1/4]

◆ AlterEnvironmentRequest() [2/4]

◆ AlterEnvironmentRequest() [3/4]

◆ AlterEnvironmentRequest() [4/4]

Property Documentation

◆ _value

◆ action

◆ environment_name

◆ options