AlterEnvironmentRequest (Kinetica Java API 7.1.10.4 API)

java.lang.Object
- com.gpudb.protocol.AlterEnvironmentRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
```
public class AlterEnvironmentRequest
extends Object
implements org.apache.avro.generic.IndexedRecord
```
A set of parameters for GPUdb.alterEnvironment(AlterEnvironmentRequest).
Alters an existing environment which can be referenced by a user-defined function (UDF).

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AlterEnvironmentRequest.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.
`static class`	`AlterEnvironmentRequest.Options` Optional parameters.

Constructor Summary

Constructors
Constructor and Description
`AlterEnvironmentRequest()` Constructs an AlterEnvironmentRequest object with default parameters.
`AlterEnvironmentRequest(String environmentName, String action, String value, Map<String,String> options)` Constructs an AlterEnvironmentRequest object with the specified parameters.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Object`	`get(int index)` This method supports the Avro framework and is not intended to be called directly by the user.
`String`	`getAction()`
`static org.apache.avro.Schema`	`getClassSchema()` This method supports the Avro framework and is not intended to be called directly by the user.
`String`	`getEnvironmentName()`
`Map<String,String>`	`getOptions()`
`org.apache.avro.Schema`	`getSchema()` This method supports the Avro framework and is not intended to be called directly by the user.
`String`	`getValue()`
`int`	`hashCode()`
`void`	`put(int index, Object value)` This method supports the Avro framework and is not intended to be called directly by the user.
`AlterEnvironmentRequest`	`setAction(String action)`
`AlterEnvironmentRequest`	`setEnvironmentName(String environmentName)`
`AlterEnvironmentRequest`	`setOptions(Map<String,String> options)`
`AlterEnvironmentRequest`	`setValue(String value)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AlterEnvironmentRequest
```
public AlterEnvironmentRequest()
```
    Constructs an AlterEnvironmentRequest object with default parameters.
  - AlterEnvironmentRequest
```
public AlterEnvironmentRequest(String environmentName,
                               String action,
                               String value,
                               Map<String,String> options)
```
    Constructs an AlterEnvironmentRequest object with the specified parameters.
    Parameters:
    
    environmentName - 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 Map.
- Method Detail
  - getClassSchema
```
public static org.apache.avro.Schema getClassSchema()
```
    This method supports the Avro framework and is not intended to be called directly by the user.
    
    Returns:
    
    the schema for the class.
  - getEnvironmentName
```
public String getEnvironmentName()
```
    Returns:
    
    Name of the environment to be altered.
  - setEnvironmentName
```
public AlterEnvironmentRequest setEnvironmentName(String environmentName)
```
    Parameters:
    
    environmentName - Name of the environment to be altered.
    
    Returns:
    
    this to mimic the builder pattern.
  - getAction
```
public String getAction()
```
    Returns:
    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
  - setAction
```
public AlterEnvironmentRequest setAction(String action)
```
    Parameters:
    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
    Returns:
    
    this to mimic the builder pattern.
  - getValue
```
public String getValue()
```
    Returns:
    
    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.
  - setValue
```
public AlterEnvironmentRequest setValue(String value)
```
    Parameters:
    
    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.
    
    Returns:
    
    this to mimic the builder pattern.
  - getOptions
```
public Map<String,String> getOptions()
```
    Returns:
    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 Map.
  - setOptions
```
public AlterEnvironmentRequest setOptions(Map<String,String> options)
```
    Parameters:
    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 Map.
    Returns:
    
    this to mimic the builder pattern.
  - getSchema
```
public org.apache.avro.Schema getSchema()
```
    This method supports the Avro framework and is not intended to be called directly by the user.
    
    Specified by:
    
    getSchema in interface org.apache.avro.generic.GenericContainer
    
    Returns:
    
    the schema object describing this class.
  - get
```
public Object get(int index)
```
    This method supports the Avro framework and is not intended to be called directly by the user.
    
    Specified by:
    
    get in interface org.apache.avro.generic.IndexedRecord
    
    Parameters:
    
    index - the position of the field to get
    
    Returns:
    
    value of the field with the given index.
    
    Throws:
    
    IndexOutOfBoundsException
  - put
```
public void put(int index,
                Object value)
```
    This method supports the Avro framework and is not intended to be called directly by the user.
    
    Specified by:
    
    put in interface org.apache.avro.generic.IndexedRecord
    
    Parameters:
    
    index - the position of the field to set
    
    value - the value to set
    
    Throws:
    
    IndexOutOfBoundsException
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class AlterEnvironmentRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AlterEnvironmentRequest

AlterEnvironmentRequest

Method Detail

getClassSchema

getEnvironmentName

setEnvironmentName

getAction

setAction

getValue

setValue

getOptions

setOptions

getSchema

get

put

equals

toString

hashCode