Skip to main content
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.IndexedRecord
public class ShowProcStatusRequest extends Object implements org.apache.avro.generic.IndexedRecord
A 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).

  • ​
    Constructor Details

    • ​
      ShowProcStatusRequest

      public ShowProcStatusRequest()
      Constructs a ShowProcStatusRequest object with default parameters.

    • ​
      ShowProcStatusRequest

      public ShowProcStatusRequest(String runId, Map<String,String> options)
      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 to TRUE, 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 is FALSE.
      • RUN_TAG: If runId is specified, return the status for a proc instance that has a matching run ID and a matching run tag that was provided to GPUdb.executeProc. If runId is not specified, return statuses for all proc instances where a matching run tag was provided to GPUdb.executeProc. The default value is ”.
      The default value is an empty Map.

  • ​
    Method Details

    • ​
      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.

    • ​
      getRunId

      public String getRunId()
      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 ”.
      Returns:
      The current value of runId.

    • ​
      setRunId

      public ShowProcStatusRequest setRunId(String 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 ”.
      Parameters:
      runId - The new value for runId.
      Returns:
      this to mimic the builder pattern.

    • ​
      getOptions

      public Map<String,String> getOptions()
      Optional parameters.
      • CLEAR_COMPLETE: If set to TRUE, 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 is FALSE.
      • RUN_TAG: If runId is specified, return the status for a proc instance that has a matching run ID and a matching run tag that was provided to GPUdb.executeProc. If runId is not specified, return statuses for all proc instances where a matching run tag was provided to GPUdb.executeProc. The default value is ”.
      The default value is an empty Map.
      Returns:
      The current value of options.

    • ​
      setOptions

      public ShowProcStatusRequest setOptions(Map<String,String> options)
      Optional parameters.
      • CLEAR_COMPLETE: If set to TRUE, 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 is FALSE.
      • RUN_TAG: If runId is specified, return the status for a proc instance that has a matching run ID and a matching run tag that was provided to GPUdb.executeProc. If runId is not specified, return statuses for all proc instances where a matching run tag was provided to GPUdb.executeProc. The default value is ”.
      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