Package io.pravega.client.stream

Class StreamConfiguration

java.lang.Object

io.pravega.client.stream.StreamConfiguration

All Implemented Interfaces:

java.io.Serializable

public class StreamConfiguration
extends java.lang.Object
implements java.io.Serializable

The configuration of a Stream.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StreamConfiguration.StreamConfigurationBuilder

Method Summary

Modifier and Type	Method	Description
static StreamConfiguration.StreamConfigurationBuilder	builder()
protected boolean	canEqual(java.lang.Object other)
boolean	equals(java.lang.Object o)
RetentionPolicy	getRetentionPolicy()	API to return retention policy.
long	getRolloverSizeBytes()	API to return segment rollover size.
ScalingPolicy	getScalingPolicy()	API to return scaling policy.
java.util.Set<java.lang.String>	getTags()	API to return the configured tags for the Stream.
long	getTimestampAggregationTimeout()	The duration after the last call to EventStreamWriter.noteTime(long) which the timestamp should be considered valid before it is forgotten.
int	hashCode()
static boolean	isTagOnlyChange(StreamConfiguration cfg1, StreamConfiguration cfg2)	Check if only the tags have been modified between the two StreamConfigurations.
StreamConfiguration.StreamConfigurationBuilder	toBuilder()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

isTagOnlyChange

public static boolean isTagOnlyChange(StreamConfiguration cfg1,
                                      StreamConfiguration cfg2)

Check if only the tags have been modified between the two StreamConfigurations.

Parameters:

cfg1 - StreamConfiguration.

cfg2 - StreamConfiguration.

Returns:

boolean indicating if it is a tag only change.

builder

public static StreamConfiguration.StreamConfigurationBuilder builder()

toBuilder

public StreamConfiguration.StreamConfigurationBuilder toBuilder()

getScalingPolicy

public ScalingPolicy getScalingPolicy()

API to return scaling policy.

Returns:

Scaling Policy for the Stream.

getRetentionPolicy

public RetentionPolicy getRetentionPolicy()

API to return retention policy. Also see: ReaderGroupConfig.StreamDataRetention

Returns:

Retention Policy for the Stream.

getTimestampAggregationTimeout

public long getTimestampAggregationTimeout()

The duration after the last call to EventStreamWriter.noteTime(long) which the timestamp should be considered valid before it is forgotten. Meaning that after this long of not calling EventStreamWriter.noteTime(long) the writer will be forgotten. If there are no known writers, readers that call EventStreamReader.getCurrentTimeWindow(Stream) will receive a `null` when they are at the corresponding position in the stream. which the timestamp should be considered valid before it is forgotten.

Returns:

The duration after the last call to EventStreamWriter.noteTime(long) which the timestamp should be considered valid before it is forgotten.

getTags

public java.util.Set<java.lang.String> getTags()

API to return the configured tags for the Stream.

Returns:

List of tag(s) for the Stream.

getRolloverSizeBytes

public long getRolloverSizeBytes()

API to return segment rollover size. The default value for this field is 0. If default value is passed down to the server, a non-zero value defined in the server will be used for the actual rollover size.

Returns:

Rollover size for the segment in this Stream.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

canEqual

protected boolean canEqual(java.lang.Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object