ShowProcStatusResponse (Kinetica Java API 6.1.0 API)

java.lang.Object
- com.gpudb.protocol.ShowProcStatusResponse

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
```
public class ShowProcStatusResponse
extends Object
implements org.apache.avro.generic.IndexedRecord
```
A set of results returned by GPUdb.showProcStatus(ShowProcStatusRequest).

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ShowProcStatusResponse.OverallStatuses` Overall statuses for the returned run IDs.
`static class`	`ShowProcStatusResponse.Statuses` Statuses for the returned run IDs, grouped by data segment ID.

Constructor Summary

Constructors
Constructor and Description

ShowProcStatusResponse()
Constructs a ShowProcStatusResponse object with default parameters.

Constructors
Constructor and Description
`ShowProcStatusResponse()` Constructs a ShowProcStatusResponse object with default parameters.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Object`	`get(int index)` This method supports the Avro framework and is not intended to be called directly by the user.
`Map<String,Map<String,ByteBuffer>>`	`getBinParams()`
`Map<String,Map<String,Map<String,ByteBuffer>>>`	`getBinResults()`
`static org.apache.avro.Schema`	`getClassSchema()` This method supports the Avro framework and is not intended to be called directly by the user.
`Map<String,Map<String,List<String>>>`	`getInputColumnNames()`
`Map<String,List<String>>`	`getInputTableNames()`
`Map<String,Map<String,String>>`	`getMessages()`
`Map<String,Map<String,String>>`	`getOptions()`
`Map<String,List<String>>`	`getOutputTableNames()`
`Map<String,String>`	`getOverallStatuses()`
`Map<String,Map<String,String>>`	`getParams()`
`Map<String,String>`	`getProcNames()`
`Map<String,Map<String,Map<String,String>>>`	`getResults()`
`org.apache.avro.Schema`	`getSchema()` This method supports the Avro framework and is not intended to be called directly by the user.
`Map<String,Map<String,String>>`	`getStatuses()`
`Map<String,Map<String,Map<String,Long>>>`	`getTimings()`
`int`	`hashCode()`
`void`	`put(int index, Object value)` This method supports the Avro framework and is not intended to be called directly by the user.
`ShowProcStatusResponse`	`setBinParams(Map<String,Map<String,ByteBuffer>> binParams)`
`ShowProcStatusResponse`	`setBinResults(Map<String,Map<String,Map<String,ByteBuffer>>> binResults)`
`ShowProcStatusResponse`	`setInputColumnNames(Map<String,Map<String,List<String>>> inputColumnNames)`
`ShowProcStatusResponse`	`setInputTableNames(Map<String,List<String>> inputTableNames)`
`ShowProcStatusResponse`	`setMessages(Map<String,Map<String,String>> messages)`
`ShowProcStatusResponse`	`setOptions(Map<String,Map<String,String>> options)`
`ShowProcStatusResponse`	`setOutputTableNames(Map<String,List<String>> outputTableNames)`
`ShowProcStatusResponse`	`setOverallStatuses(Map<String,String> overallStatuses)`
`ShowProcStatusResponse`	`setParams(Map<String,Map<String,String>> params)`
`ShowProcStatusResponse`	`setProcNames(Map<String,String> procNames)`
`ShowProcStatusResponse`	`setResults(Map<String,Map<String,Map<String,String>>> results)`
`ShowProcStatusResponse`	`setStatuses(Map<String,Map<String,String>> statuses)`
`ShowProcStatusResponse`	`setTimings(Map<String,Map<String,Map<String,Long>>> timings)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ShowProcStatusResponse
```
public ShowProcStatusResponse()
```
    Constructs a ShowProcStatusResponse object with default parameters.
- 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.
  - getProcNames
```
public Map<String,String> getProcNames()
```
    Returns:
    The proc names corresponding to the returned run IDs.
  - setProcNames
```
public ShowProcStatusResponse setProcNames(Map<String,String> procNames)
```
    Parameters:
    procNames - The proc names corresponding to the returned run IDs.
    
    Returns:
    this to mimic the builder pattern.
  - getParams
```
public Map<String,Map<String,String>> getParams()
```
    Returns:
    The string params passed to GPUdb.executeProc(ExecuteProcRequest) for the returned run IDs.
  - setParams
```
public ShowProcStatusResponse setParams(Map<String,Map<String,String>> params)
```
    Parameters:
    params - The string params passed to GPUdb.executeProc(ExecuteProcRequest) for the returned run IDs.
    
    Returns:
    this to mimic the builder pattern.
  - getBinParams
```
public Map<String,Map<String,ByteBuffer>> getBinParams()
```
    Returns:
    The binary params passed to GPUdb.executeProc(ExecuteProcRequest) for the returned run IDs.
  - setBinParams
```
public ShowProcStatusResponse setBinParams(Map<String,Map<String,ByteBuffer>> binParams)
```
    Parameters:
    binParams - The binary params passed to GPUdb.executeProc(ExecuteProcRequest) for the returned run IDs.
    
    Returns:
    this to mimic the builder pattern.
  - getInputTableNames
```
public Map<String,List<String>> getInputTableNames()
```
    Returns:
    The input table names passed to GPUdb.executeProc(ExecuteProcRequest) for the returned run IDs.
  - setInputTableNames
```
public ShowProcStatusResponse setInputTableNames(Map<String,List<String>> inputTableNames)
```
    Parameters:
    inputTableNames - The input table names passed to GPUdb.executeProc(ExecuteProcRequest) for the returned run IDs.
    
    Returns:
    this to mimic the builder pattern.
  - getInputColumnNames
```
public Map<String,Map<String,List<String>>> getInputColumnNames()
```
    Returns:
    The input column names passed to GPUdb.executeProc(ExecuteProcRequest) for the returned run IDs, supplemented with the column names for input tables not included in the input column name map.
  - setInputColumnNames
```
public ShowProcStatusResponse setInputColumnNames(Map<String,Map<String,List<String>>> inputColumnNames)
```
    Parameters:
    inputColumnNames - The input column names passed to GPUdb.executeProc(ExecuteProcRequest) for the returned run IDs, supplemented with the column names for input tables not included in the input column name map.
    
    Returns:
    this to mimic the builder pattern.
  - getOutputTableNames
```
public Map<String,List<String>> getOutputTableNames()
```
    Returns:
    The output table names passed to GPUdb.executeProc(ExecuteProcRequest) for the returned run IDs.
  - setOutputTableNames
```
public ShowProcStatusResponse setOutputTableNames(Map<String,List<String>> outputTableNames)
```
    Parameters:
    outputTableNames - The output table names passed to GPUdb.executeProc(ExecuteProcRequest) for the returned run IDs.
    
    Returns:
    this to mimic the builder pattern.
  - getOptions
```
public Map<String,Map<String,String>> getOptions()
```
    Returns:
    The optional parameters passed to GPUdb.executeProc(ExecuteProcRequest) for the returned run IDs.
  - setOptions
```
public ShowProcStatusResponse setOptions(Map<String,Map<String,String>> options)
```
    Parameters:
    options - The optional parameters passed to GPUdb.executeProc(ExecuteProcRequest) for the returned run IDs.
    
    Returns:
    this to mimic the builder pattern.
  - getOverallStatuses
```
public Map<String,String> getOverallStatuses()
```
    Returns:
    Overall statuses for the returned run IDs. Note that these are rollups and individual statuses may differ between data segments for the same run ID; see statuses and messages for statuses from individual data segments. Valid values are:
    
    RUNNING: The proc instance is currently running.
    COMPLETE: The proc instance completed with no errors.
    KILLED: The proc instance was killed before completion.
    ERROR: The proc instance failed with an error.
  - setOverallStatuses
```
public ShowProcStatusResponse setOverallStatuses(Map<String,String> overallStatuses)
```
    Parameters:
    overallStatuses - Overall statuses for the returned run IDs. Note that these are rollups and individual statuses may differ between data segments for the same run ID; see statuses and messages for statuses from individual data segments. Valid values are:
    
    RUNNING: The proc instance is currently running.
    COMPLETE: The proc instance completed with no errors.
    KILLED: The proc instance was killed before completion.
    ERROR: The proc instance failed with an error.
    Returns:
    this to mimic the builder pattern.
  - getStatuses
```
public Map<String,Map<String,String>> getStatuses()
```
    Returns:
    Statuses for the returned run IDs, grouped by data segment ID. Valid values are:
  - setStatuses
```
public ShowProcStatusResponse setStatuses(Map<String,Map<String,String>> statuses)
```
    Parameters:
    statuses - Statuses for the returned run IDs, grouped by data segment ID. Valid values are:
    Returns:
    this to mimic the builder pattern.
  - getMessages
```
public Map<String,Map<String,String>> getMessages()
```
    Returns:
    Messages containing additional status information for the returned run IDs, grouped by data segment ID.
  - setMessages
```
public ShowProcStatusResponse setMessages(Map<String,Map<String,String>> messages)
```
    Parameters:
    messages - Messages containing additional status information for the returned run IDs, grouped by data segment ID.
    
    Returns:
    this to mimic the builder pattern.
  - getResults
```
public Map<String,Map<String,Map<String,String>>> getResults()
```
    Returns:
    String results for the returned run IDs, grouped by data segment ID.
  - setResults
```
public ShowProcStatusResponse setResults(Map<String,Map<String,Map<String,String>>> results)
```
    Parameters:
    results - String results for the returned run IDs, grouped by data segment ID.
    
    Returns:
    this to mimic the builder pattern.
  - getBinResults
```
public Map<String,Map<String,Map<String,ByteBuffer>>> getBinResults()
```
    Returns:
    Binary results for the returned run IDs, grouped by data segment ID.
  - setBinResults
```
public ShowProcStatusResponse setBinResults(Map<String,Map<String,Map<String,ByteBuffer>>> binResults)
```
    Parameters:
    binResults - Binary results for the returned run IDs, grouped by data segment ID.
    
    Returns:
    this to mimic the builder pattern.
  - getTimings
```
public Map<String,Map<String,Map<String,Long>>> getTimings()
```
    Returns:
    Timing information for the returned run IDs, grouped by data segment ID.
  - setTimings
```
public ShowProcStatusResponse setTimings(Map<String,Map<String,Map<String,Long>>> timings)
```
    Parameters:
    timings - Timing information for the returned run IDs, grouped by data segment ID.
    
    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

Class ShowProcStatusResponse

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ShowProcStatusResponse

Method Detail

getClassSchema

getProcNames

setProcNames

getParams

setParams

getBinParams

setBinParams

getInputTableNames

setInputTableNames

getInputColumnNames

setInputColumnNames

getOutputTableNames

setOutputTableNames

getOptions

setOptions

getOverallStatuses

setOverallStatuses

getStatuses

setStatuses

getMessages

setMessages

getResults

setResults

getBinResults

setBinResults

getTimings

setTimings

getSchema

get

put

equals

toString

hashCode