Package com.gpudb.protocol
Class ShowEnvironmentRequest
java.lang.Object
com.gpudb.protocol.ShowEnvironmentRequest
All Implemented Interfaces:
org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecordA 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 ClassesModifier and TypeClassDescriptionstatic final classA set of string constants for theShowEnvironmentRequestparameteroptions.Constructor Summary
ConstructorsConstructorDescriptionConstructs 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 TypeMethodDescriptionbooleanget(int index) This method supports the Avro framework and is not intended to be called directly by the user.static org.apache.avro.SchemaThis method supports the Avro framework and is not intended to be called directly by the user.Name of the environment on which to retrieve information.Optional parameters.org.apache.avro.SchemaThis method supports the Avro framework and is not intended to be called directly by the user.inthashCode()voidThis method supports the Avro framework and is not intended to be called directly by the user.setEnvironmentName(String environmentName) Name of the environment on which to retrieve information.setOptions(Map<String, String> options) Optional parameters.toString()
Constructor Details
ShowEnvironmentRequest
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: IfTRUEand if the environment specified inenvironmentNamedoes not exist, no error is returned. IfFALSEand if the environment specified inenvironmentNamedoes not exist, then an error is returned. Supported values:The default value isFALSE.SHOW_NAMES_ONLY: IfTRUEonly return the names of the installed environments and omit package listing. Supported values:The default value isFALSE.
Map.
Method Details
setEnvironmentName
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 forenvironmentName.Returns:thisto mimic the builder pattern.getOptions
Optional parameters.NO_ERROR_IF_NOT_EXISTS: IfTRUEand if the environment specified inenvironmentNamedoes not exist, no error is returned. IfFALSEand if the environment specified inenvironmentNamedoes not exist, then an error is returned. Supported values:The default value isFALSE.SHOW_NAMES_ONLY: IfTRUEonly return the names of the installed environments and omit package listing. Supported values:The default value isFALSE.
Map.Returns:The current value ofoptions.setOptions
Optional parameters.NO_ERROR_IF_NOT_EXISTS: IfTRUEand if the environment specified inenvironmentNamedoes not exist, no error is returned. IfFALSEand if the environment specified inenvironmentNamedoes not exist, then an error is returned. Supported values:The default value isFALSE.SHOW_NAMES_ONLY: IfTRUEonly return the names of the installed environments and omit package listing. Supported values:The default value isFALSE.
Map.Parameters:options- The new value foroptions.Returns:thisto mimic the builder pattern.