ShowTableRequest (Kinetica Java API 5.2.0 API)

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

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
```
public class ShowTableRequest
extends Object
implements org.apache.avro.generic.IndexedRecord
```
A set of parameters for GPUdb.showTable(ShowTableRequest).

Retrieves detailed information about a particular GPUdb table, specified in tableName. If the supplied tableName is a collection, the call returns a list of tables contained in the collection, and for each table it returns the description, type id, schema, type label, type properties, and additional information including TTL. If tableName is empty it will return all top-level tables including all collections and top-level child tables (i.e. tables with no parent).

     If the option 'get_sizes' is set to 'true' then the sizes (objects and elements) of each table are returned (in sizes and fullSizes), along with the total number of objects in the requested table (in totalSize and totalFullSize).

     If the option 'show_children' is set to 'false' then for a collection it only returns information about the collection itself, not about the child tables. If 'show_children' is set to 'true' then it will return information about each of the children, but not the collection.

     Running with 'show_children' = 'true' on a child table will return an error.

     Running with 'show_children' = 'false' with tableName empty will return an error.

If the requested table is blank, then information is returned about all top-level tables including collections.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ShowTableRequest.Options
Optional parameters.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ShowTableRequest.Options` Optional parameters.

Constructor Summary

Constructors
Constructor and Description
`ShowTableRequest()` Constructs a ShowTableRequest object with default parameters.
`ShowTableRequest(String tableName, Map<String,String> options)` Constructs a ShowTableRequest object with the specified 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.
`Map<String,String>`	`getOptions()`
`org.apache.avro.Schema`	`getSchema()` This method supports the Avro framework and is not intended to be called directly by the user.
`String`	`getTableName()`
`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.
`ShowTableRequest`	`setOptions(Map<String,String> options)`
`ShowTableRequest`	`setTableName(String tableName)`
`String`	`toString()`

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

- Constructor Detail
  - ShowTableRequest
```
public ShowTableRequest()
```
    Constructs a ShowTableRequest object with default parameters.
  - ShowTableRequest
```
public ShowTableRequest(String tableName,
                        Map<String,String> options)
```
    Constructs a ShowTableRequest object with the specified parameters.
    Parameters:
    
    tableName - Name of the table for which to retrieve the information. If blank then information about all collections and top-level tables is returned.
    options - Optional parameters.
    
    get_sizes: If 'true' then the table sizes will be returned; otherwise they will be returned blank. Values: true, false.
    show_children: If tableName is a collection, then 'true' will return information about the children of the collection, and 'false' will return information about the collection itself. If tableName is a child table, 'show_children' must be 'false'. If tableName is empty then 'show_children' must be 'true'. Values: true, false.
- 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:
    
    Name of the table for which to retrieve the information. If blank then information about all collections and top-level tables is returned.
  - setTableName
```
public ShowTableRequest setTableName(String tableName)
```
    Parameters:
    
    tableName - Name of the table for which to retrieve the information. If blank then information about all collections and top-level tables is returned.
    
    Returns:
    
    this to mimic the builder pattern.
  - getOptions
```
public Map<String,String> getOptions()
```
    Returns:
    Optional parameters.
    
    get_sizes: If 'true' then the table sizes will be returned; otherwise they will be returned blank. Values: true, false.
    show_children: If tableName is a collection, then 'true' will return information about the children of the collection, and 'false' will return information about the collection itself. If tableName is a child table, 'show_children' must be 'false'. If tableName is empty then 'show_children' must be 'true'. Values: true, false.
  - setOptions
```
public ShowTableRequest setOptions(Map<String,String> options)
```
    Parameters:
    options - Optional parameters.
    
    get_sizes: If 'true' then the table sizes will be returned; otherwise they will be returned blank. Values: true, false.
    show_children: If tableName is a collection, then 'true' will return information about the children of the collection, and 'false' will return information about the collection itself. If tableName is a child table, 'show_children' must be 'false'. If tableName is empty then 'show_children' must be 'true'. Values: true, false.
    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 ShowTableRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ShowTableRequest

ShowTableRequest

Method Detail

getClassSchema

getTableName

setTableName

getOptions

setOptions

getSchema

get

put

equals

toString

hashCode