CreateJoinTableRequest (Kinetica Java API 5.2.0 API)

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

All Implemented Interfaces:

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

Creates a table that is the result of a SQL JOIN. For details see: join concept documentation.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CreateJoinTableRequest.Options
Optional parameters.

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

Constructor Summary

Constructors
Constructor and Description
`CreateJoinTableRequest()` Constructs a CreateJoinTableRequest object with default parameters.
`CreateJoinTableRequest(String joinTableName, List<String> tableNames, List<String> aliases, String expression, List<String> expressions, Map<String,String> options)` Constructs a CreateJoinTableRequest 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.
`List<String>`	`getAliases()`
`static org.apache.avro.Schema`	`getClassSchema()` This method supports the Avro framework and is not intended to be called directly by the user.
`String`	`getExpression()`
`List<String>`	`getExpressions()`
`String`	`getJoinTableName()`
`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.
`List<String>`	`getTableNames()`
`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.
`CreateJoinTableRequest`	`setAliases(List<String> aliases)`
`CreateJoinTableRequest`	`setExpression(String expression)`
`CreateJoinTableRequest`	`setExpressions(List<String> expressions)`
`CreateJoinTableRequest`	`setJoinTableName(String joinTableName)`
`CreateJoinTableRequest`	`setOptions(Map<String,String> options)`
`CreateJoinTableRequest`	`setTableNames(List<String> tableNames)`
`String`	`toString()`

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

- Constructor Detail
  - CreateJoinTableRequest
```
public CreateJoinTableRequest()
```
    Constructs a CreateJoinTableRequest object with default parameters.
  - CreateJoinTableRequest
```
public CreateJoinTableRequest(String joinTableName,
                              List<String> tableNames,
                              List<String> aliases,
                              String expression,
                              List<String> expressions,
                              Map<String,String> options)
```
    Constructs a CreateJoinTableRequest object with the specified parameters.
    Parameters:
    
    joinTableName - Name of the join table to be created. Must not be the name of a currently existing GPUdb table or join table. Cannot be an empty string.
    
    tableNames - The list of table names making up the joined set. Corresponds to a SQL statement FROM clause
    
    aliases - The list of aliases for each of the corresponding tables.
    
    expression - An optional expression GPUdb uses to combine and filter the joined set. Corresponds to a SQL statement WHERE clause. For details see: expressions.
    
    expressions - An optional list of expressions GPUdb uses to combine and filter the joined set. Corresponds to a SQL statement WHERE clause. For details see: expressions.
    options - Optional parameters.
    
    collection_name: Name of a collection in GPUdb to which the join table is to be assigned as a child table. If empty, then the join table will be a top level table.
    max_query_dimensions: The maximum number of tables in a joined table that can be accessed by a query and are not equated by a foreign-key to primary-key equality predicate
    optimize_lookups: Use the applied filters to precalculate the lookup table to get data from the primary key sets
    refresh_method: Method by which the join table can be refreshed when underlying member tables have changed. Values: manual, on_query, on_insert.
    refresh: Do a manual refresh of the join table if it exists - throws an error otherwise Values: no_refresh, refresh, full_refresh.
- 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.
  - getJoinTableName
```
public String getJoinTableName()
```
    Returns:
    
    Name of the join table to be created. Must not be the name of a currently existing GPUdb table or join table. Cannot be an empty string.
  - setJoinTableName
```
public CreateJoinTableRequest setJoinTableName(String joinTableName)
```
    Parameters:
    
    joinTableName - Name of the join table to be created. Must not be the name of a currently existing GPUdb table or join table. Cannot be an empty string.
    
    Returns:
    
    this to mimic the builder pattern.
  - getTableNames
```
public List<String> getTableNames()
```
    Returns:
    
    The list of table names making up the joined set. Corresponds to a SQL statement FROM clause
  - setTableNames
```
public CreateJoinTableRequest setTableNames(List<String> tableNames)
```
    Parameters:
    
    tableNames - The list of table names making up the joined set. Corresponds to a SQL statement FROM clause
    
    Returns:
    
    this to mimic the builder pattern.
  - getAliases
```
public List<String> getAliases()
```
    Returns:
    
    The list of aliases for each of the corresponding tables.
  - setAliases
```
public CreateJoinTableRequest setAliases(List<String> aliases)
```
    Parameters:
    
    aliases - The list of aliases for each of the corresponding tables.
    
    Returns:
    
    this to mimic the builder pattern.
  - getExpression
```
public String getExpression()
```
    Returns:
    
    An optional expression GPUdb uses to combine and filter the joined set. Corresponds to a SQL statement WHERE clause. For details see: expressions.
  - setExpression
```
public CreateJoinTableRequest setExpression(String expression)
```
    Parameters:
    
    expression - An optional expression GPUdb uses to combine and filter the joined set. Corresponds to a SQL statement WHERE clause. For details see: expressions.
    
    Returns:
    
    this to mimic the builder pattern.
  - getExpressions
```
public List<String> getExpressions()
```
    Returns:
    
    An optional list of expressions GPUdb uses to combine and filter the joined set. Corresponds to a SQL statement WHERE clause. For details see: expressions.
  - setExpressions
```
public CreateJoinTableRequest setExpressions(List<String> expressions)
```
    Parameters:
    
    expressions - An optional list of expressions GPUdb uses to combine and filter the joined set. Corresponds to a SQL statement WHERE clause. For details see: expressions.
    
    Returns:
    
    this to mimic the builder pattern.
  - getOptions
```
public Map<String,String> getOptions()
```
    Returns:
    Optional parameters.
    
    collection_name: Name of a collection in GPUdb to which the join table is to be assigned as a child table. If empty, then the join table will be a top level table.
    max_query_dimensions: The maximum number of tables in a joined table that can be accessed by a query and are not equated by a foreign-key to primary-key equality predicate
    optimize_lookups: Use the applied filters to precalculate the lookup table to get data from the primary key sets
    refresh_method: Method by which the join table can be refreshed when underlying member tables have changed. Values: manual, on_query, on_insert.
    refresh: Do a manual refresh of the join table if it exists - throws an error otherwise Values: no_refresh, refresh, full_refresh.
  - setOptions
```
public CreateJoinTableRequest setOptions(Map<String,String> options)
```
    Parameters:
    options - Optional parameters.
    
    collection_name: Name of a collection in GPUdb to which the join table is to be assigned as a child table. If empty, then the join table will be a top level table.
    max_query_dimensions: The maximum number of tables in a joined table that can be accessed by a query and are not equated by a foreign-key to primary-key equality predicate
    optimize_lookups: Use the applied filters to precalculate the lookup table to get data from the primary key sets
    refresh_method: Method by which the join table can be refreshed when underlying member tables have changed. Values: manual, on_query, on_insert.
    refresh: Do a manual refresh of the join table if it exists - throws an error otherwise Values: no_refresh, refresh, full_refresh.
    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 CreateJoinTableRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CreateJoinTableRequest

CreateJoinTableRequest

Method Detail

getClassSchema

getJoinTableName

setJoinTableName

getTableNames

setTableNames

getAliases

setAliases

getExpression

setExpression

getExpressions

setExpressions

getOptions

setOptions

getSchema

get

put

equals

toString

hashCode