org.apache.samza.table

Class TableSpec

java.lang.Object

org.apache.samza.table.TableSpec

All Implemented Interfaces:

java.io.Serializable

@InterfaceStability.Unstable
public class TableSpec
extends java.lang.Object
implements java.io.Serializable

TableSpec is a blueprint for creating, validating, or simply describing a table in the runtime environment. It is typically created indirectly by constructing an instance of TableDescriptor, and then invoke BaseTableDescriptor.getTableSpec(). It has specific attributes for common behaviors that Samza uses. It has the table provider factory, which provides the actual table implementation. It also includes a map of configurations which may be implementation-specific. It is immutable by design.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TableSpec() Default constructor
TableSpec(java.lang.String tableId, KVSerde serde, java.lang.String tableProviderFactoryClassName, java.util.Map<java.lang.String,java.lang.String> config) Constructs a TableSpec
TableSpec(java.lang.String tableId, KVSerde serde, java.lang.String tableProviderFactoryClassName, java.util.Map<java.lang.String,java.lang.String> config, java.util.List<java.lang.String> sideInputs, SideInputsProcessor sideInputsProcessor) Constructs a TableSpec

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.util.Map<java.lang.String,java.lang.String>	getConfig() Get implementation configuration for the table
java.lang.String	getId() Get the Id of the table
<K,V> KVSerde<K,V>	getSerde() Get the serde
java.util.List<java.lang.String>	getSideInputs() Get the list of side inputs for the table.
SideInputsProcessor	getSideInputsProcessor() Get the SideInputsProcessor associated with the table.
java.lang.String	getTableProviderFactoryClassName() Get the class name of the table provider factory
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TableSpec

public TableSpec()

Default constructor

TableSpec

public TableSpec(java.lang.String tableId,
                 KVSerde serde,
                 java.lang.String tableProviderFactoryClassName,
                 java.util.Map<java.lang.String,java.lang.String> config)

Constructs a TableSpec

Parameters:

tableId - Id of the table

tableProviderFactoryClassName - table provider factory

serde - the serde

config - implementation specific configuration

TableSpec

public TableSpec(java.lang.String tableId,
                 KVSerde serde,
                 java.lang.String tableProviderFactoryClassName,
                 java.util.Map<java.lang.String,java.lang.String> config,
                 java.util.List<java.lang.String> sideInputs,
                 SideInputsProcessor sideInputsProcessor)

Constructs a TableSpec

Parameters:

tableId - Id of the table

tableProviderFactoryClassName - table provider factory

serde - the serde

config - implementation specific configuration

sideInputs - list of side inputs for the table

sideInputsProcessor - side input processor for the table

Method Detail

getId

public java.lang.String getId()

Get the Id of the table

Returns:

Id of the table

getSerde

public <K,V> KVSerde<K,V> getSerde()

Get the serde

Type Parameters:

K - the type of the key

V - the type of the value

Returns:

the key serde

getTableProviderFactoryClassName

public java.lang.String getTableProviderFactoryClassName()

Get the class name of the table provider factory

Returns:

class name of the table provider factory

getConfig

public java.util.Map<java.lang.String,java.lang.String> getConfig()

Get implementation configuration for the table

Returns:

configuration for the table

getSideInputs

public java.util.List<java.lang.String> getSideInputs()

Get the list of side inputs for the table.

Returns:

a List of side input streams

getSideInputsProcessor

public SideInputsProcessor getSideInputsProcessor()

Get the SideInputsProcessor associated with the table.

Returns:

a SideInputsProcessor

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object