Package com.gpudb.protocol
Class KillProcRequest
java.lang.Object
com.gpudb.protocol.KillProcRequest
All Implemented Interfaces:
org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecordA set of parameters for
GPUdb.killProc.
Kills a running proc instance.
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA set of string constants for theKillProcRequestparameteroptions.Constructor Summary
ConstructorsConstructorDescriptionConstructs a KillProcRequest object with default parameters.KillProcRequest(String runId, Map<String, String> options) Constructs a KillProcRequest 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.Optional parameters.getRunId()The run ID of a running proc instance.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.setOptions(Map<String, String> options) Optional parameters.The run ID of a running proc instance.toString()
Constructor Details
KillProcRequest
Constructs a KillProcRequest object with the specified parameters.Parameters:runId- The run ID of a running proc instance. If a proc with a matching run ID is not found or the proc instance has already completed, no procs will be killed. If not specified, all running proc instances will be killed. The default value is ”.options- Optional parameters.RUN_TAG: IfrunIdis specified, kill the proc instance that has a matching run ID and a matching run tag that was provided toGPUdb.executeProc. IfrunIdis not specified, kill the proc instance(s) where a matching run tag was provided toGPUdb.executeProc. The default value is ”.CLEAR_EXECUTE_AT_STARTUP: IfTRUE, kill and remove the instance of the proc matching the auto-start run ID that was created to run when the database is started. The auto-start run ID was returned fromGPUdb.executeProcand can be retrieved usingGPUdb.showProc. Supported values:The default value isFALSE.
Map.
Method Details
setRunId
The run ID of a running proc instance. If a proc with a matching run ID is not found or the proc instance has already completed, no procs will be killed. If not specified, all running proc instances will be killed. The default value is ”.Parameters:runId- The new value forrunId.Returns:thisto mimic the builder pattern.getOptions
Optional parameters.RUN_TAG: IfrunIdis specified, kill the proc instance that has a matching run ID and a matching run tag that was provided toGPUdb.executeProc. IfrunIdis not specified, kill the proc instance(s) where a matching run tag was provided toGPUdb.executeProc. The default value is ”.CLEAR_EXECUTE_AT_STARTUP: IfTRUE, kill and remove the instance of the proc matching the auto-start run ID that was created to run when the database is started. The auto-start run ID was returned fromGPUdb.executeProcand can be retrieved usingGPUdb.showProc. Supported values:The default value isFALSE.
Map.Returns:The current value ofoptions.setOptions
Optional parameters.RUN_TAG: IfrunIdis specified, kill the proc instance that has a matching run ID and a matching run tag that was provided toGPUdb.executeProc. IfrunIdis not specified, kill the proc instance(s) where a matching run tag was provided toGPUdb.executeProc. The default value is ”.CLEAR_EXECUTE_AT_STARTUP: IfTRUE, kill and remove the instance of the proc matching the auto-start run ID that was created to run when the database is started. The auto-start run ID was returned fromGPUdb.executeProcand can be retrieved usingGPUdb.showProc. Supported values:The default value isFALSE.
Map.Parameters:options- The new value foroptions.Returns:thisto mimic the builder pattern.