Package com.gpudb.protocol
Class ShowProcStatusRequest
java.lang.Object
com.gpudb.protocol.ShowProcStatusRequest
All Implemented Interfaces:
org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecordA set of parameters for
GPUdb.showProcStatus.
Shows the statuses of running or completed proc instances. Results are grouped by run ID (as returned from GPUdb.executeProc) and data segment ID (each invocation of the proc command on a data segment is assigned a data segment ID).
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA set of string constants for theShowProcStatusRequestparameteroptions.Constructor Summary
ConstructorsConstructorDescriptionConstructs a ShowProcStatusRequest object with default parameters.ShowProcStatusRequest(String runId, Map<String, String> options) Constructs a ShowProcStatusRequest 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 specific proc instance for which the status will be returned.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 specific proc instance for which the status will be returned.toString()
Constructor Details
ShowProcStatusRequest
Constructs a ShowProcStatusRequest object with the specified parameters.Parameters:runId- The run ID of a specific proc instance for which the status will be returned. If a proc with a matching run ID is not found, the response will be empty. If not specified, the statuses of all executed proc instances will be returned. The default value is ”.options- Optional parameters.CLEAR_COMPLETE: If set toTRUE, if a proc instance has completed (either successfully or unsuccessfully) then its status will be cleared and no longer returned in subsequent calls. Supported values:The default value isFALSE.RUN_TAG: IfrunIdis specified, return the status for a proc instance that has a matching run ID and a matching run tag that was provided toGPUdb.executeProc. IfrunIdis not specified, return statuses for all proc instances where a matching run tag was provided toGPUdb.executeProc. The default value is ”.
Map.
Method Details
setRunId
The run ID of a specific proc instance for which the status will be returned. If a proc with a matching run ID is not found, the response will be empty. If not specified, the statuses of all executed proc instances will be returned. The default value is ”.Parameters:runId- The new value forrunId.Returns:thisto mimic the builder pattern.getOptions
Optional parameters.CLEAR_COMPLETE: If set toTRUE, if a proc instance has completed (either successfully or unsuccessfully) then its status will be cleared and no longer returned in subsequent calls. Supported values:The default value isFALSE.RUN_TAG: IfrunIdis specified, return the status for a proc instance that has a matching run ID and a matching run tag that was provided toGPUdb.executeProc. IfrunIdis not specified, return statuses for all proc instances where a matching run tag was provided toGPUdb.executeProc. The default value is ”.
Map.Returns:The current value ofoptions.setOptions
Optional parameters.CLEAR_COMPLETE: If set toTRUE, if a proc instance has completed (either successfully or unsuccessfully) then its status will be cleared and no longer returned in subsequent calls. Supported values:The default value isFALSE.RUN_TAG: IfrunIdis specified, return the status for a proc instance that has a matching run ID and a matching run tag that was provided toGPUdb.executeProc. IfrunIdis not specified, return statuses for all proc instances where a matching run tag was provided toGPUdb.executeProc. The default value is ”.
Map.Parameters:options- The new value foroptions.Returns:thisto mimic the builder pattern.