public class ShowTableRequest extends Object implements org.apache.avro.generic.IndexedRecord
GPUdb.showTable(ShowTableRequest)
.
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).
sizes
and fullSizes
), along with the total number of objects in the requested table (in
totalSize
and totalFullSize
).
tableName
empty will return an error.
Modifier and Type | Class and Description |
---|---|
static class |
ShowTableRequest.Options
Optional parameters.
|
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.
|
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() |
public ShowTableRequest()
public ShowTableRequest(String tableName, Map<String,String> options)
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.
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.
public static org.apache.avro.Schema getClassSchema()
public String getTableName()
public ShowTableRequest setTableName(String tableName)
tableName
- Name of the table for which to retrieve the information. If blank then information about all collections
and top-level tables is returned.this
to mimic the builder pattern.public Map<String,String> getOptions()
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.
public ShowTableRequest setOptions(Map<String,String> options)
options
- Optional parameters.
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.
this
to mimic the builder pattern.public org.apache.avro.Schema getSchema()
getSchema
in interface org.apache.avro.generic.GenericContainer
public Object get(int index)
get
in interface org.apache.avro.generic.IndexedRecord
index
- the position of the field to getIndexOutOfBoundsException
public void put(int index, Object value)
put
in interface org.apache.avro.generic.IndexedRecord
index
- the position of the field to setvalue
- the value to setIndexOutOfBoundsException
Copyright © 2016. All rights reserved.