GPUdb C++ API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
gpudb::AlterEnvironmentRequest Struct Reference

A set of input parameters for const. More...

#include <gpudb/protocol/alter_environment.h>

Public Member Functions

 AlterEnvironmentRequest ()
 Constructs an AlterEnvironmentRequest object with default parameter values. More...
 
 AlterEnvironmentRequest (const std::string &environmentName_, const std::string &action_, const std::string &value_, const std::map< std::string, std::string > &options_)
 Constructs an AlterEnvironmentRequest object with the specified parameters. More...
 

Public Attributes

std::string environmentName
 
std::string action
 
std::string value
 
std::map< std::string,
std::string > 
options
 

Detailed Description

A set of input parameters for const.

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

Definition at line 20 of file alter_environment.h.

Constructor & Destructor Documentation

gpudb::AlterEnvironmentRequest::AlterEnvironmentRequest ( )
inline

Constructs an AlterEnvironmentRequest object with default parameter values.

Definition at line 27 of file alter_environment.h.

gpudb::AlterEnvironmentRequest::AlterEnvironmentRequest ( const std::string &  environmentName_,
const std::string &  action_,
const std::string &  value_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs an AlterEnvironmentRequest object with the specified parameters.

Parameters
[in]environmentName_Name of the environment to be altered.
[in]action_Modification operation to be applied
[in]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.
[in]options_Optional parameters.

Definition at line 87 of file alter_environment.h.

Member Data Documentation

std::string gpudb::AlterEnvironmentRequest::action

Definition at line 96 of file alter_environment.h.

std::string gpudb::AlterEnvironmentRequest::environmentName

Definition at line 95 of file alter_environment.h.

std::map<std::string, std::string> gpudb::AlterEnvironmentRequest::options

Definition at line 98 of file alter_environment.h.

std::string gpudb::AlterEnvironmentRequest::value

Definition at line 97 of file alter_environment.h.


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