Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
kinetica.DropEnvironmentRequest Class Reference

A set of parameters for Kinetica.dropEnvironment(string,IDictionary{string, string}). More...

+ Inheritance diagram for kinetica.DropEnvironmentRequest:
+ Collaboration diagram for kinetica.DropEnvironmentRequest:

Classes

struct  Options
 Optional parameters. More...
 

Public Member Functions

 DropEnvironmentRequest ()
 Constructs a DropEnvironmentRequest object with default parameters. More...
 
 DropEnvironmentRequest (string environment_name, IDictionary< string, string > options=null)
 Constructs a DropEnvironmentRequest object with the specified parameters. More...
 
- Public Member Functions inherited from kinetica.KineticaData
 KineticaData (KineticaType type)
 Constructor from Kinetica Type More...
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type More...
 
object Get (int fieldPos)
 Retrieve a specific property from this object More...
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object More...
 

Properties

string environment_name [get, set]
 Name of the environment to be dropped. More...
 
IDictionary< string, string > options [get, set]
 Optional parameters. More...
 
- Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class More...
 

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. More...
 

Detailed Description

A set of parameters for Kinetica.dropEnvironment(string,IDictionary{string, string}).


Drop an existing user-defined function (UDF) environment.

Definition at line 20 of file DropEnvironment.cs.

Constructor & Destructor Documentation

kinetica.DropEnvironmentRequest.DropEnvironmentRequest ( )
inline

Constructs a DropEnvironmentRequest object with default parameters.

Definition at line 117 of file DropEnvironment.cs.

kinetica.DropEnvironmentRequest.DropEnvironmentRequest ( string  environment_name,
IDictionary< string, string >  options = null 
)
inline

Constructs a DropEnvironmentRequest object with the specified parameters.

Parameters
environment_nameName of the environment to be dropped. Must be an existing environment.
optionsOptional parameters.
  • NO_ERROR_IF_NOT_EXISTS: If true and if the environment specified in does not exist, no error is returned. If false and if the environment specified in does not exist, then an error is returned. Supported values: The default value is FALSE.
The default value is an empty Dictionary.

Definition at line 153 of file DropEnvironment.cs.

Property Documentation

string kinetica.DropEnvironmentRequest.environment_name
getset

Name of the environment to be dropped.

Must be an existing environment.

Definition at line 82 of file DropEnvironment.cs.

IDictionary<string, string> kinetica.DropEnvironmentRequest.options
getset

Optional parameters.

  • NO_ERROR_IF_NOT_EXISTS: If true and if the environment specified in does not exist, no error is returned. If false and if the environment specified in does not exist, then an error is returned. Supported values: The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 112 of file DropEnvironment.cs.


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