Package io.pravega.client.admin

Class StreamInfo

java.lang.Object

io.pravega.client.admin.StreamInfo

@Beta
public class StreamInfo
extends java.lang.Object

This class is used to represent Stream information. It currently includes:

• Scope of stream.
• Name of stream.
• StreamCut which represents the current TAIL of the stream.
• StreamCut which represents the current HEAD of the stream.
• Flag which is set to True if the stream is Sealed.

Constructor Summary

Constructors

Constructor	Description
StreamInfo(java.lang.String scope, java.lang.String streamName, StreamConfiguration streamConfiguration, StreamCut tailStreamCut, StreamCut headStreamCut, boolean sealed)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(java.lang.Object other)
boolean	equals(java.lang.Object o)
StreamCut	getHeadStreamCut()	StreamCut representing the current HEAD of the stream.
java.lang.String	getScope()	Scope name of the stream.
StreamConfiguration	getStreamConfiguration()	Stream Configuration.
java.lang.String	getStreamName()	Stream name.
StreamCut	getTailStreamCut()	StreamCut representing the current TAIL of the stream.
int	hashCode()
boolean	isSealed()	Indicates whether the Stream is sealed (true) or not (false).
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamInfo

@ConstructorProperties({"scope","streamName","streamConfiguration","tailStreamCut","headStreamCut","sealed"})
public StreamInfo(java.lang.String scope,
                  java.lang.String streamName,
                  StreamConfiguration streamConfiguration,
                  StreamCut tailStreamCut,
                  StreamCut headStreamCut,
                  boolean sealed)

Method Detail

getScope

public java.lang.String getScope()

Scope name of the stream.

Returns:

Scope name of the stream.

getStreamName

public java.lang.String getStreamName()

Stream name.

Returns:

Stream name.

getStreamConfiguration

public StreamConfiguration getStreamConfiguration()

Stream Configuration. This includes the ScalingPolicy, RetentionPolicy and the tags associated with the stream.

Returns:

Stream configuration.

getTailStreamCut

public StreamCut getTailStreamCut()

StreamCut representing the current TAIL of the stream.

Returns:

StreamCut representing the current TAIL of the stream.

getHeadStreamCut

public StreamCut getHeadStreamCut()

StreamCut representing the current HEAD of the stream.

Returns:

StreamCut representing the current HEAD of the stream.

isSealed

public boolean isSealed()

Indicates whether the Stream is sealed (true) or not (false). If a stream is sealed, then no further Events can be written to it.

Returns:

Indicates whether the Stream is sealed (true) or not (false).

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