ShowTableResponse (Kinetica Java API 7.1.10.4 API)

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

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
```
public class ShowTableResponse
extends Object
implements org.apache.avro.generic.IndexedRecord
```
A set of results returned by GPUdb.showTable(ShowTableRequest).

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ShowTableResponse.AdditionalInfo` Additional information about the respective tables in `tableNames`.
`static class`	`ShowTableResponse.TableDescriptions` List of descriptions for the respective tables in `tableNames`.

Constructor Summary

Constructors
Constructor and Description

ShowTableResponse()
Constructs a ShowTableResponse object with default parameters.

Constructors
Constructor and Description
`ShowTableResponse()` Constructs a ShowTableResponse 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.
`List<Map<String,String>>`	`getAdditionalInfo()`
`static org.apache.avro.Schema`	`getClassSchema()` This method supports the Avro framework and is not intended to be called directly by the user.
`List<Long>`	`getFullSizes()`
`Map<String,String>`	`getInfo()`
`List<Double>`	`getJoinSizes()`
`List<Map<String,List<String>>>`	`getProperties()`
`org.apache.avro.Schema`	`getSchema()` This method supports the Avro framework and is not intended to be called directly by the user.
`List<Long>`	`getSizes()`
`List<List<String>>`	`getTableDescriptions()`
`String`	`getTableName()`
`List<String>`	`getTableNames()`
`long`	`getTotalFullSize()`
`long`	`getTotalSize()`
`List<String>`	`getTypeIds()`
`List<String>`	`getTypeLabels()`
`List<String>`	`getTypeSchemas()`
`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.
`ShowTableResponse`	`setAdditionalInfo(List<Map<String,String>> additionalInfo)`
`ShowTableResponse`	`setFullSizes(List<Long> fullSizes)`
`ShowTableResponse`	`setInfo(Map<String,String> info)`
`ShowTableResponse`	`setJoinSizes(List<Double> joinSizes)`
`ShowTableResponse`	`setProperties(List<Map<String,List<String>>> properties)`
`ShowTableResponse`	`setSizes(List<Long> sizes)`
`ShowTableResponse`	`setTableDescriptions(List<List<String>> tableDescriptions)`
`ShowTableResponse`	`setTableName(String tableName)`
`ShowTableResponse`	`setTableNames(List<String> tableNames)`
`ShowTableResponse`	`setTotalFullSize(long totalFullSize)`
`ShowTableResponse`	`setTotalSize(long totalSize)`
`ShowTableResponse`	`setTypeIds(List<String> typeIds)`
`ShowTableResponse`	`setTypeLabels(List<String> typeLabels)`
`ShowTableResponse`	`setTypeSchemas(List<String> typeSchemas)`
`String`	`toString()`

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

- Constructor Detail
  - ShowTableResponse
```
public ShowTableResponse()
```
    Constructs a ShowTableResponse 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.
  - getTableName
```
public String getTableName()
```
    Returns:
    
    Value of tableName.
  - setTableName
```
public ShowTableResponse setTableName(String tableName)
```
    Parameters:
    
    tableName - Value of tableName.
    
    Returns:
    
    this to mimic the builder pattern.
  - getTableNames
```
public List<String> getTableNames()
```
    Returns:
    
    If tableName is a table or view, then the single element of the array is tableName. If tableName is a schema and show_children is set to true, then this array is populated with the names of all tables and views in the given schema; if show_children is false, then this array will only include the schema name itself. If tableName is an empty string, then the array contains the names of all tables in the user's default schema.
  - setTableNames
```
public ShowTableResponse setTableNames(List<String> tableNames)
```
    Parameters:
    
    tableNames - If tableName is a table or view, then the single element of the array is tableName. If tableName is a schema and show_children is set to true, then this array is populated with the names of all tables and views in the given schema; if show_children is false, then this array will only include the schema name itself. If tableName is an empty string, then the array contains the names of all tables in the user's default schema.
    
    Returns:
    
    this to mimic the builder pattern.
  - getTableDescriptions
```
public List<List<String>> getTableDescriptions()
```
    Returns:
    List of descriptions for the respective tables in tableNames. Supported values:
    
    COLLECTION
    JOIN
    LOGICAL_EXTERNAL_TABLE
    LOGICAL_VIEW
    MATERIALIZED_EXTERNAL_TABLE
    MATERIALIZED_VIEW
    MATERIALIZED_VIEW_MEMBER
    MATERIALIZED_VIEW_UNDER_CONSTRUCTION
    REPLICATED
    RESULT_TABLE
    SCHEMA
    VIEW
  - setTableDescriptions
```
public ShowTableResponse setTableDescriptions(List<List<String>> tableDescriptions)
```
    Parameters:
    tableDescriptions - List of descriptions for the respective tables in tableNames. Supported values:
    
    COLLECTION
    JOIN
    LOGICAL_EXTERNAL_TABLE
    LOGICAL_VIEW
    MATERIALIZED_EXTERNAL_TABLE
    MATERIALIZED_VIEW
    MATERIALIZED_VIEW_MEMBER
    MATERIALIZED_VIEW_UNDER_CONSTRUCTION
    REPLICATED
    RESULT_TABLE
    SCHEMA
    VIEW
    Returns:
    
    this to mimic the builder pattern.
  - getTypeIds
```
public List<String> getTypeIds()
```
    Returns:
    
    Type ids of the respective tables in tableNames.
  - setTypeIds
```
public ShowTableResponse setTypeIds(List<String> typeIds)
```
    Parameters:
    
    typeIds - Type ids of the respective tables in tableNames.
    
    Returns:
    
    this to mimic the builder pattern.
  - getTypeSchemas
```
public List<String> getTypeSchemas()
```
    Returns:
    
    Type schemas of the respective tables in tableNames.
  - setTypeSchemas
```
public ShowTableResponse setTypeSchemas(List<String> typeSchemas)
```
    Parameters:
    
    typeSchemas - Type schemas of the respective tables in tableNames.
    
    Returns:
    
    this to mimic the builder pattern.
  - getTypeLabels
```
public List<String> getTypeLabels()
```
    Returns:
    
    Type labels of the respective tables in tableNames.
  - setTypeLabels
```
public ShowTableResponse setTypeLabels(List<String> typeLabels)
```
    Parameters:
    
    typeLabels - Type labels of the respective tables in tableNames.
    
    Returns:
    
    this to mimic the builder pattern.
  - getProperties
```
public List<Map<String,List<String>>> getProperties()
```
    Returns:
    
    Property maps of the respective tables in tableNames.
  - setProperties
```
public ShowTableResponse setProperties(List<Map<String,List<String>>> properties)
```
    Parameters:
    
    properties - Property maps of the respective tables in tableNames.
    
    Returns:
    
    this to mimic the builder pattern.
  - getAdditionalInfo
```
public List<Map<String,String>> getAdditionalInfo()
```
    Returns:
    Additional information about the respective tables in tableNames. Supported values:
  - setAdditionalInfo
```
public ShowTableResponse setAdditionalInfo(List<Map<String,String>> additionalInfo)
```
    Parameters:
    additionalInfo - Additional information about the respective tables in tableNames. Supported values:
    Returns:
    
    this to mimic the builder pattern.
  - getSizes
```
public List<Long> getSizes()
```
    Returns:
    
    If get_sizes is true, an array containing the number of records of each corresponding table in tableNames. Otherwise, an empty array.
  - setSizes
```
public ShowTableResponse setSizes(List<Long> sizes)
```
    Parameters:
    
    sizes - If get_sizes is true, an array containing the number of records of each corresponding table in tableNames. Otherwise, an empty array.
    
    Returns:
    
    this to mimic the builder pattern.
  - getFullSizes
```
public List<Long> getFullSizes()
```
    Returns:
    
    If get_sizes is true, an array containing the number of records of each corresponding table in tableNames (same values as sizes). Otherwise, an empty array.
  - setFullSizes
```
public ShowTableResponse setFullSizes(List<Long> fullSizes)
```
    Parameters:
    
    fullSizes - If get_sizes is true, an array containing the number of records of each corresponding table in tableNames (same values as sizes). Otherwise, an empty array.
    
    Returns:
    
    this to mimic the builder pattern.
  - getJoinSizes
```
public List<Double> getJoinSizes()
```
    Returns:
    
    If get_sizes is true, an array containing the number of unfiltered records in the cross product of the sub-tables of each corresponding join-table in tableNames. For simple tables, this number will be the same as sizes. For join-tables, this value gives the number of joined-table rows that must be processed by any aggregate functions operating on the table. Otherwise, (if get_sizes is false), an empty array.
  - setJoinSizes
```
public ShowTableResponse setJoinSizes(List<Double> joinSizes)
```
    Parameters:
    
    joinSizes - If get_sizes is true, an array containing the number of unfiltered records in the cross product of the sub-tables of each corresponding join-table in tableNames. For simple tables, this number will be the same as sizes. For join-tables, this value gives the number of joined-table rows that must be processed by any aggregate functions operating on the table. Otherwise, (if get_sizes is false), an empty array.
    
    Returns:
    
    this to mimic the builder pattern.
  - getTotalSize
```
public long getTotalSize()
```
    Returns:
    
    If get_sizes is true, the sum of the elements of sizes. Otherwise, -1.
  - setTotalSize
```
public ShowTableResponse setTotalSize(long totalSize)
```
    Parameters:
    
    totalSize - If get_sizes is true, the sum of the elements of sizes. Otherwise, -1.
    
    Returns:
    
    this to mimic the builder pattern.
  - getTotalFullSize
```
public long getTotalFullSize()
```
    Returns:
    
    If get_sizes is true, the sum of the elements of fullSizes (same value as totalSize). Otherwise, -1.
  - setTotalFullSize
```
public ShowTableResponse setTotalFullSize(long totalFullSize)
```
    Parameters:
    
    totalFullSize - If get_sizes is true, the sum of the elements of fullSizes (same value as totalSize). Otherwise, -1.
    
    Returns:
    
    this to mimic the builder pattern.
  - getInfo
```
public Map<String,String> getInfo()
```
    Returns:
    
    Additional information.
  - setInfo
```
public ShowTableResponse 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 ShowTableResponse

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ShowTableResponse

Method Detail

getClassSchema

getTableName

setTableName

getTableNames

setTableNames

getTableDescriptions

setTableDescriptions

getTypeIds

setTypeIds

getTypeSchemas

setTypeSchemas

getTypeLabels

setTypeLabels

getProperties

setProperties

getAdditionalInfo

setAdditionalInfo

getSizes

setSizes

getFullSizes

setFullSizes

getJoinSizes

setJoinSizes

getTotalSize

setTotalSize

getTotalFullSize

setTotalFullSize

getInfo

setInfo

getSchema

get

put

equals

toString

hashCode