Skip to main content
Package com.gpudb.protocol

​
Class ShowProcRequest

java.lang.Object
com.gpudb.protocol.ShowProcRequest
All Implemented Interfaces:
org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
public class ShowProcRequest extends Object implements org.apache.avro.generic.IndexedRecord
A set of parameters for GPUdb.showProc.

Shows information about a proc.

  • ​
    Constructor Details

    • ​
      ShowProcRequest

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

    • ​
      ShowProcRequest

      public ShowProcRequest(String procName, Map<String,String> options)
      Constructs a ShowProcRequest object with the specified parameters.
      Parameters:
      procName - Name of the proc to show information about. If specified, must be the name of a currently existing proc. If not specified, information about all procs will be returned. The default value is ”.
      options - Optional parameters.
      • INCLUDE_FILES: If set to TRUE, the files that make up the proc will be returned. If set to FALSE, the files will not be returned. Supported values:The default value is FALSE.
      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.

    • ​
      getProcName

      public String getProcName()
      Name of the proc to show information about. If specified, must be the name of a currently existing proc. If not specified, information about all procs will be returned. The default value is ”.
      Returns:
      The current value of procName.

    • ​
      setProcName

      public ShowProcRequest setProcName(String procName)
      Name of the proc to show information about. If specified, must be the name of a currently existing proc. If not specified, information about all procs will be returned. The default value is ”.
      Parameters:
      procName - The new value for procName.
      Returns:
      this to mimic the builder pattern.

    • ​
      getOptions

      public Map<String,String> getOptions()
      Optional parameters.
      • INCLUDE_FILES: If set to TRUE, the files that make up the proc will be returned. If set to FALSE, the files will not be returned. Supported values:The default value is FALSE.
      The default value is an empty Map.
      Returns:
      The current value of options.

    • ​
      setOptions

      public ShowProcRequest setOptions(Map<String,String> options)
      Optional parameters.
      • INCLUDE_FILES: If set to TRUE, the files that make up the proc will be returned. If set to FALSE, the files will not be returned. Supported values:The default value is FALSE.
      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