io.nats.client.api

Class StreamInfo

java.lang.Object

io.nats.client.api.ApiResponse<StreamInfo>

io.nats.client.api.StreamInfo

public class StreamInfo
extends ApiResponse<StreamInfo>

The StreamInfo class contains information about a JetStream stream.

Field Summary

Fields inherited from class io.nats.client.api.ApiResponse

NO_TYPE, PARSE_ERROR_TYPE

Constructor Summary

Constructors

Constructor and Description
StreamInfo(@NonNull io.nats.client.support.JsonValue vStreamInfo) Construct a StreamInfo instance from a JsonValue
StreamInfo(@NonNull Message msg) Construct a StreamInfo instance from a message

Method Summary

Modifier and Type	Method and Description
@Nullable java.util.List<StreamAlternate>	getAlternates() Gets the stream alternates
@Nullable ClusterInfo	getClusterInfo() Gets the cluster info
@NonNull StreamConfiguration	getConfig() Gets the stream configuration.
@NonNull StreamConfiguration	getConfiguration() Gets the stream configuration.
@NonNull java.time.ZonedDateTime	getCreateTime() Gets the creation time of the stream.
@Nullable MirrorInfo	getMirrorInfo() Gets the mirror info
@Nullable java.util.List<SourceInfo>	getSourceInfos() Gets the source info
@NonNull StreamState	getStreamState() Gets the stream state.
@Nullable java.time.ZonedDateTime	getTimestamp() Gets the server time the info was gathered
java.lang.String	toString()

Methods inherited from class io.nats.client.api.ApiResponse

getApiErrorCode, getDescription, getError, getErrorCode, getErrorObject, getJv, getType, hasError, throwOnHasError

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StreamInfo

public StreamInfo(@NonNull Message msg)

Construct a StreamInfo instance from a message

Parameters:

msg - the message

StreamInfo

public StreamInfo(@NonNull io.nats.client.support.JsonValue vStreamInfo)

Construct a StreamInfo instance from a JsonValue

Parameters:

vStreamInfo - the JsonValue

Method Detail

getConfiguration

public @NonNull StreamConfiguration getConfiguration()

Gets the stream configuration. Same as getConfig

Returns:

the stream configuration.

getConfig

public @NonNull StreamConfiguration getConfig()

Gets the stream configuration. Same as getConfiguration

Returns:

the stream configuration.

getStreamState

public @NonNull StreamState getStreamState()

Gets the stream state.

Returns:

the stream state

getCreateTime

public @NonNull java.time.ZonedDateTime getCreateTime()

Gets the creation time of the stream.

Returns:

the creation date and time.

getMirrorInfo

public @Nullable MirrorInfo getMirrorInfo()

Gets the mirror info

Returns:

the mirror info

getSourceInfos

public @Nullable java.util.List<SourceInfo> getSourceInfos()

Gets the source info

Returns:

the source info

getClusterInfo

public @Nullable ClusterInfo getClusterInfo()

Gets the cluster info

Returns:

the cluster info

getAlternates

public @Nullable java.util.List<StreamAlternate> getAlternates()

Gets the stream alternates

Returns:

the stream alternates

getTimestamp

public @Nullable java.time.ZonedDateTime getTimestamp()

Gets the server time the info was gathered

Returns:

the server gathered timed

toString

public java.lang.String toString()

Overrides:

toString in class ApiResponse<StreamInfo>