com.gpudb.protocol

Class CreateEnvironmentRequest

java.lang.Object

com.gpudb.protocol.CreateEnvironmentRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

public class CreateEnvironmentRequest
extends Object
implements org.apache.avro.generic.IndexedRecord

A set of parameters for GPUdb.createEnvironment(CreateEnvironmentRequest).

Creates a new environment which can be used by user-defined functions (UDF).

Constructor Summary

Constructors

Constructor and Description
CreateEnvironmentRequest() Constructs a CreateEnvironmentRequest object with default parameters.
CreateEnvironmentRequest(String environmentName, Map<String,String> options) Constructs a CreateEnvironmentRequest object with the specified parameters.

Method Summary

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.
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.
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.
CreateEnvironmentRequest	setEnvironmentName(String environmentName)
CreateEnvironmentRequest	setOptions(Map<String,String> options)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateEnvironmentRequest

public CreateEnvironmentRequest()

Constructs a CreateEnvironmentRequest object with default parameters.

CreateEnvironmentRequest

public CreateEnvironmentRequest(String environmentName,
                                Map<String,String> options)

Constructs a CreateEnvironmentRequest object with the specified parameters.

Parameters:

environmentName - Name of the environment to be created.

options - Optional parameters. 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 created.

setEnvironmentName

public CreateEnvironmentRequest setEnvironmentName(String environmentName)

Parameters:

environmentName - Name of the environment to be created.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

Optional parameters. The default value is an empty Map.

setOptions

public CreateEnvironmentRequest setOptions(Map<String,String> options)

Parameters:

options - Optional parameters. 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