co.cask.cdap.data2.transaction.stream

Class StreamConfig

java.lang.Object

co.cask.cdap.data2.transaction.stream.StreamConfig

public final class StreamConfig
extends Object

Represents the configuration of a stream. This class needs to be GSON serializable.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StreamConfig.Builder A builder to help building instance of StreamConfig.

Field Summary

Fields

Modifier and Type	Field and Description
static co.cask.cdap.api.data.format.FormatSpecification	DEFAULT_STREAM_FORMAT

Constructor Summary

Constructors

Constructor and Description
StreamConfig(Id.Stream streamId, long partitionDuration, long indexInterval, long ttl, Location location, co.cask.cdap.api.data.format.FormatSpecification format, int notificationThresholdMB)

Method Summary

Methods

Modifier and Type	Method and Description
static StreamConfig.Builder	builder(StreamConfig config)
co.cask.cdap.api.data.format.FormatSpecification	getFormat()
long	getIndexInterval()
Location	getLocation()
int	getNotificationThresholdMB()
long	getPartitionDuration()
Id.Stream	getStreamId()
long	getTTL()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_STREAM_FORMAT

public static final co.cask.cdap.api.data.format.FormatSpecification DEFAULT_STREAM_FORMAT

Constructor Detail

StreamConfig

public StreamConfig(Id.Stream streamId,
            long partitionDuration,
            long indexInterval,
            long ttl,
            Location location,
            co.cask.cdap.api.data.format.FormatSpecification format,
            int notificationThresholdMB)

Method Detail

getStreamId

public Id.Stream getStreamId()

Returns:

Id of the stream.

getPartitionDuration

public long getPartitionDuration()

Returns:

The duration in milliseconds that one partition in this stream contains.

getIndexInterval

public long getIndexInterval()

Returns:

The time interval in milliseconds that a new index entry would be created in the stream.

getTTL

public long getTTL()

Returns:

The time to live in milliseconds for events in this stream.

getLocation

public Location getLocation()

Returns:

The location of the stream.

getFormat

public co.cask.cdap.api.data.format.FormatSpecification getFormat()

Returns:

The format of the stream body.

getNotificationThresholdMB

public int getNotificationThresholdMB()

Returns:

The threshold of data, in MB, that the stream has to ingest for a notification to be sent.

toString

public String toString()

Overrides:

toString in class Object

builder

public static StreamConfig.Builder builder(StreamConfig config)