com.gpudb.protocol

Class ShowEnvironmentRequest

java.lang.Object

com.gpudb.protocol.ShowEnvironmentRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.showEnvironment.

Shows information about a specified user-defined function (UDF) environment or all environments. Returns detailed information about existing environments.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ShowEnvironmentRequest.Options A set of string constants for the ShowEnvironmentRequest parameter options.

Constructor Summary

Constructors

Constructor and Description
ShowEnvironmentRequest() Constructs a ShowEnvironmentRequest object with default parameters.
ShowEnvironmentRequest(String environmentName, Map<String,String> options) Constructs a ShowEnvironmentRequest 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() Name of the environment on which to retrieve information.
Map<String,String>	getOptions() Optional parameters.
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.
ShowEnvironmentRequest	setEnvironmentName(String environmentName) Name of the environment on which to retrieve information.
ShowEnvironmentRequest	setOptions(Map<String,String> options) Optional parameters.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ShowEnvironmentRequest

public ShowEnvironmentRequest()

Constructs a ShowEnvironmentRequest object with default parameters.

ShowEnvironmentRequest

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

Constructs a ShowEnvironmentRequest object with the specified parameters.

Parameters:

environmentName - Name of the environment on which to retrieve information. The name must refer to a currently existing environment. If '*' or an empty value is specified, information about all environments will be returned. The default value is ''.

options - Optional parameters.

• NO_ERROR_IF_NOT_EXISTS: If TRUE and if the environment specified in environmentName does not exist, no error is returned. If FALSE and if the environment specified in environmentName does not exist, then an error is returned. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SHOW_NAMES_ONLY: If TRUE only return the names of the installed environments and omit package listing. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

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()

Name of the environment on which to retrieve information. The name must refer to a currently existing environment. If '*' or an empty value is specified, information about all environments will be returned. The default value is ''.

Returns:

The current value of environmentName.

setEnvironmentName

public ShowEnvironmentRequest setEnvironmentName(String environmentName)

Name of the environment on which to retrieve information. The name must refer to a currently existing environment. If '*' or an empty value is specified, information about all environments will be returned. The default value is ''.

Parameters:

environmentName - The new value for environmentName.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Optional parameters.

• NO_ERROR_IF_NOT_EXISTS: If TRUE and if the environment specified in environmentName does not exist, no error is returned. If FALSE and if the environment specified in environmentName does not exist, then an error is returned. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SHOW_NAMES_ONLY: If TRUE only return the names of the installed environments and omit package listing. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Map.

Returns:

The current value of options.

setOptions

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

Optional parameters.

• NO_ERROR_IF_NOT_EXISTS: If TRUE and if the environment specified in environmentName does not exist, no error is returned. If FALSE and if the environment specified in environmentName does not exist, then an error is returned. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SHOW_NAMES_ONLY: If TRUE only return the names of the installed environments and omit package listing. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Map.

Parameters:

options - The new value for options.

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