StreamletBase (Heron Api Documentation)

All Known Subinterfaces:

KVStreamlet<K,V>, Streamlet<R>

All Known Implementing Classes:

ConsumerStreamlet, CountByKeyAndWindowStreamlet, CountByKeyStreamlet, CustomStreamlet, FilterStreamlet, FlatMapStreamlet, GeneralReduceByKeyAndWindowStreamlet, GeneralReduceByKeyStreamlet, JoinStreamlet, KeyByStreamlet, KVStreamletShadow, LogStreamlet, MapStreamlet, ReduceByKeyAndWindowStreamlet, ReduceByKeyStreamlet, RemapStreamlet, SinkStreamlet, SourceStreamlet, SplitStreamlet, SpoutStreamlet, StreamletBaseImpl, StreamletImpl, StreamletShadow, SupplierStreamlet, TransformStreamlet, UnionStreamlet
```
public interface StreamletBase<R>
```
A Streamlet is a (potentially unbounded) ordered collection of tuples. The StreamletBase class contains basic information of a Streamlet such as name and partition count without the connection functions such as map() and filter().

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getName()`	Gets the name of the Streamlet.
`int`	`getNumPartitions()`	Gets the number of partitions of this Streamlet.
`StreamletBase<R>`	`setName(String sName)`	Sets the name of the BaseStreamlet.
`StreamletBase<R>`	`setNumPartitions(int numPartitions)`	Sets the number of partitions of the streamlet

- Method Detail
  - setName
```
StreamletBase<R> setName(String sName)
```
    Sets the name of the BaseStreamlet.
    
    Parameters:
    
    sName - The name given by the user for this BaseStreamlet
    
    Returns:
    
    Returns back the Streamlet with changed name
  - getName
```
String getName()
```
    Gets the name of the Streamlet.
    
    Returns:
    
    Returns the name of the Streamlet
  - setNumPartitions
```
StreamletBase<R> setNumPartitions(int numPartitions)
```
    Sets the number of partitions of the streamlet
    
    Parameters:
    
    numPartitions - The user assigned number of partitions
    
    Returns:
    
    Returns back the Streamlet with changed number of partitions
  - getNumPartitions
```
int getNumPartitions()
```
    Gets the number of partitions of this Streamlet.
    
    Returns:
    
    the number of partitions of this Streamlet