ShowGraphResponse (Kinetica Java API 7.1.10.4 API)

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

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
```
public class ShowGraphResponse
extends Object
implements org.apache.avro.generic.IndexedRecord
```
A set of results returned by GPUdb.showGraph(ShowGraphRequest).

Constructor Summary

Constructors
Constructor and Description

ShowGraphResponse()
Constructs a ShowGraphResponse object with default parameters.

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

Method Summary

All Methods Static Methods Instance Methods Concrete 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.
`static org.apache.avro.Schema`	`getClassSchema()` This method supports the Avro framework and is not intended to be called directly by the user.
`List<Boolean>`	`getDirected()`
`List<String>`	`getGraphNames()`
`List<String>`	`getGraphOwnerResourceGroups()`
`List<String>`	`getGraphOwnerUserNames()`
`List<Integer>`	`getGraphServerIds()`
`List<Boolean>`	`getHasInsertTableMonitor()`
`Map<String,String>`	`getInfo()`
`List<Boolean>`	`getIsPartitioned()`
`List<Boolean>`	`getIsPersisted()`
`List<Boolean>`	`getIsSyncDb()`
`List<Integer>`	`getLoad()`
`List<Long>`	`getMemory()`
`List<Long>`	`getNumBytes()`
`List<Long>`	`getNumEdges()`
`List<Long>`	`getNumNodes()`
`List<String>`	`getOriginalRequest()`
`List<Long>`	`getResourceCapacity()`
`boolean`	`getResult()`
`org.apache.avro.Schema`	`getSchema()` This method supports the Avro framework and is not intended to be called directly by the user.
`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.
`ShowGraphResponse`	`setDirected(List<Boolean> directed)`
`ShowGraphResponse`	`setGraphNames(List<String> graphNames)`
`ShowGraphResponse`	`setGraphOwnerResourceGroups(List<String> graphOwnerResourceGroups)`
`ShowGraphResponse`	`setGraphOwnerUserNames(List<String> graphOwnerUserNames)`
`ShowGraphResponse`	`setGraphServerIds(List<Integer> graphServerIds)`
`ShowGraphResponse`	`setHasInsertTableMonitor(List<Boolean> hasInsertTableMonitor)`
`ShowGraphResponse`	`setInfo(Map<String,String> info)`
`ShowGraphResponse`	`setIsPartitioned(List<Boolean> isPartitioned)`
`ShowGraphResponse`	`setIsPersisted(List<Boolean> isPersisted)`
`ShowGraphResponse`	`setIsSyncDb(List<Boolean> isSyncDb)`
`ShowGraphResponse`	`setLoad(List<Integer> load)`
`ShowGraphResponse`	`setMemory(List<Long> memory)`
`ShowGraphResponse`	`setNumBytes(List<Long> numBytes)`
`ShowGraphResponse`	`setNumEdges(List<Long> numEdges)`
`ShowGraphResponse`	`setNumNodes(List<Long> numNodes)`
`ShowGraphResponse`	`setOriginalRequest(List<String> originalRequest)`
`ShowGraphResponse`	`setResourceCapacity(List<Long> resourceCapacity)`
`ShowGraphResponse`	`setResult(boolean result)`
`String`	`toString()`

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

- Constructor Detail
  - ShowGraphResponse
```
public ShowGraphResponse()
```
    Constructs a ShowGraphResponse 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.
  - getResult
```
public boolean getResult()
```
    Returns:
    
    Indicates a success. This call will fail if the graph specified in the request does not exist.
  - setResult
```
public ShowGraphResponse setResult(boolean result)
```
    Parameters:
    
    result - Indicates a success. This call will fail if the graph specified in the request does not exist.
    
    Returns:
    
    this to mimic the builder pattern.
  - getLoad
```
public List<Integer> getLoad()
```
    Returns:
    
    A percentage approximating the current computational load on the server.
  - setLoad
```
public ShowGraphResponse setLoad(List<Integer> load)
```
    Parameters:
    
    load - A percentage approximating the current computational load on the server.
    
    Returns:
    
    this to mimic the builder pattern.
  - getMemory
```
public List<Long> getMemory()
```
    Returns:
    
    Available memory.
  - setMemory
```
public ShowGraphResponse setMemory(List<Long> memory)
```
    Parameters:
    
    memory - Available memory.
    
    Returns:
    
    this to mimic the builder pattern.
  - getGraphNames
```
public List<String> getGraphNames()
```
    Returns:
    
    Name(s) of the graph(s).
  - setGraphNames
```
public ShowGraphResponse setGraphNames(List<String> graphNames)
```
    Parameters:
    
    graphNames - Name(s) of the graph(s).
    
    Returns:
    
    this to mimic the builder pattern.
  - getGraphServerIds
```
public List<Integer> getGraphServerIds()
```
    Returns:
    
    Id(s) of the graph(s).
  - setGraphServerIds
```
public ShowGraphResponse setGraphServerIds(List<Integer> graphServerIds)
```
    Parameters:
    
    graphServerIds - Id(s) of the graph(s).
    
    Returns:
    
    this to mimic the builder pattern.
  - getGraphOwnerUserNames
```
public List<String> getGraphOwnerUserNames()
```
    Returns:
    
    Owner of the graph(s) and associated solution table(s).
  - setGraphOwnerUserNames
```
public ShowGraphResponse setGraphOwnerUserNames(List<String> graphOwnerUserNames)
```
    Parameters:
    
    graphOwnerUserNames - Owner of the graph(s) and associated solution table(s).
    
    Returns:
    
    this to mimic the builder pattern.
  - getGraphOwnerResourceGroups
```
public List<String> getGraphOwnerResourceGroups()
```
    Returns:
    
    Owner of the resource groups(s) of the graph(s).
  - setGraphOwnerResourceGroups
```
public ShowGraphResponse setGraphOwnerResourceGroups(List<String> graphOwnerResourceGroups)
```
    Parameters:
    
    graphOwnerResourceGroups - Owner of the resource groups(s) of the graph(s).
    
    Returns:
    
    this to mimic the builder pattern.
  - getDirected
```
public List<Boolean> getDirected()
```
    Returns:
    
    Whether or not the edges of the graph have directions (bi-directional edges can still exist in directed graphs). Consult Directed Graphs for more details.
  - setDirected
```
public ShowGraphResponse setDirected(List<Boolean> directed)
```
    Parameters:
    
    directed - Whether or not the edges of the graph have directions (bi-directional edges can still exist in directed graphs). Consult Directed Graphs for more details.
    
    Returns:
    
    this to mimic the builder pattern.
  - getNumNodes
```
public List<Long> getNumNodes()
```
    Returns:
    
    Total number of nodes in the graph.
  - setNumNodes
```
public ShowGraphResponse setNumNodes(List<Long> numNodes)
```
    Parameters:
    
    numNodes - Total number of nodes in the graph.
    
    Returns:
    
    this to mimic the builder pattern.
  - getNumEdges
```
public List<Long> getNumEdges()
```
    Returns:
    
    Total number of edges in the graph.
  - setNumEdges
```
public ShowGraphResponse setNumEdges(List<Long> numEdges)
```
    Parameters:
    
    numEdges - Total number of edges in the graph.
    
    Returns:
    
    this to mimic the builder pattern.
  - getNumBytes
```
public List<Long> getNumBytes()
```
    Returns:
    
    Memory this graph uses in bytes.
  - setNumBytes
```
public ShowGraphResponse setNumBytes(List<Long> numBytes)
```
    Parameters:
    
    numBytes - Memory this graph uses in bytes.
    
    Returns:
    
    this to mimic the builder pattern.
  - getResourceCapacity
```
public List<Long> getResourceCapacity()
```
    Returns:
    
    Memory this graph uses in bytes.
  - setResourceCapacity
```
public ShowGraphResponse setResourceCapacity(List<Long> resourceCapacity)
```
    Parameters:
    
    resourceCapacity - Memory this graph uses in bytes.
    
    Returns:
    
    this to mimic the builder pattern.
  - getIsPersisted
```
public List<Boolean> getIsPersisted()
```
    Returns:
    
    Shows whether or not the graph is persisted (saved and loaded on launch).
  - setIsPersisted
```
public ShowGraphResponse setIsPersisted(List<Boolean> isPersisted)
```
    Parameters:
    
    isPersisted - Shows whether or not the graph is persisted (saved and loaded on launch).
    
    Returns:
    
    this to mimic the builder pattern.
  - getIsPartitioned
```
public List<Boolean> getIsPartitioned()
```
    Returns:
    
    Indicated if the graph data is distributed across all available servers.
  - setIsPartitioned
```
public ShowGraphResponse setIsPartitioned(List<Boolean> isPartitioned)
```
    Parameters:
    
    isPartitioned - Indicated if the graph data is distributed across all available servers.
    
    Returns:
    
    this to mimic the builder pattern.
  - getIsSyncDb
```
public List<Boolean> getIsSyncDb()
```
    Returns:
    
    Shows whether or not the graph is linked to the original tables that created it, and will potentially be re-created instead loaded from persist on launch.
  - setIsSyncDb
```
public ShowGraphResponse setIsSyncDb(List<Boolean> isSyncDb)
```
    Parameters:
    
    isSyncDb - Shows whether or not the graph is linked to the original tables that created it, and will potentially be re-created instead loaded from persist on launch.
    
    Returns:
    
    this to mimic the builder pattern.
  - getHasInsertTableMonitor
```
public List<Boolean> getHasInsertTableMonitor()
```
    Returns:
    
    Shows whether or not the graph has an insert table monitor attached to it.
  - setHasInsertTableMonitor
```
public ShowGraphResponse setHasInsertTableMonitor(List<Boolean> hasInsertTableMonitor)
```
    Parameters:
    
    hasInsertTableMonitor - Shows whether or not the graph has an insert table monitor attached to it.
    
    Returns:
    
    this to mimic the builder pattern.
  - getOriginalRequest
```
public List<String> getOriginalRequest()
```
    Returns:
    
    The original client request used to create the graph (before any expression evaluation or separator processing).
  - setOriginalRequest
```
public ShowGraphResponse setOriginalRequest(List<String> originalRequest)
```
    Parameters:
    
    originalRequest - The original client request used to create the graph (before any expression evaluation or separator processing).
    
    Returns:
    
    this to mimic the builder pattern.
  - getInfo
```
public Map<String,String> getInfo()
```
    Returns:
    
    Additional information.
  - setInfo
```
public ShowGraphResponse setInfo(Map<String,String> info)
```
    Parameters:
    
    info - Additional information.
    
    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 ShowGraphResponse

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ShowGraphResponse

Method Detail

getClassSchema

getResult

setResult

getLoad

setLoad

getMemory

setMemory

getGraphNames

setGraphNames

getGraphServerIds

setGraphServerIds

getGraphOwnerUserNames

setGraphOwnerUserNames

getGraphOwnerResourceGroups

setGraphOwnerResourceGroups

getDirected

setDirected

getNumNodes

setNumNodes

getNumEdges

setNumEdges

getNumBytes

setNumBytes

getResourceCapacity

setResourceCapacity

getIsPersisted

setIsPersisted

getIsPartitioned

setIsPartitioned

getIsSyncDb

setIsSyncDb

getHasInsertTableMonitor

setHasInsertTableMonitor

getOriginalRequest

setOriginalRequest

getInfo

setInfo

getSchema

get

put

equals

toString

hashCode