Package com.gpudb.protocol

Class KillProcRequest

  • All Implemented Interfaces:
    org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
    public class KillProcRequest
extends Object
implements org.apache.avro.generic.IndexedRecord
    A set of parameters for GPUdb.killProc.

    Kills a running proc instance.

    • Constructor Detail

      • KillProcRequest

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

      • KillProcRequest

        public KillProcRequest​(String runId,
                       Map<String,​String> options)
        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: If runId is specified, kill the proc instance that has a matching run ID and a matching run tag that was provided to GPUdb.executeProc. If runId is not specified, kill the proc instance(s) where a matching run tag was provided to GPUdb.executeProc. The default value is ''.
        • CLEAR_EXECUTE_AT_STARTUP: If TRUE, 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 from GPUdb.executeProc and can be retrieved using GPUdb.showProc. Supported values: 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.

      • getRunId

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

      • setRunId

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

      • getOptions

        public Map<String,​String> getOptions()
        Optional parameters. The default value is an empty Map.
        Returns:
        The current value of options.

      • setOptions

        public KillProcRequest setOptions​(Map<String,​String> options)
        Optional parameters. 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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object