io.nats.client.api

Class ClusterInfo

java.lang.Object

io.nats.client.api.ClusterInfo

public class ClusterInfo
extends java.lang.Object

Information about the cluster a stream is part of.

Method Summary

Modifier and Type	Method and Description
@Nullable java.lang.String	getLeader() The server name of the RAFT leader
@Nullable java.time.ZonedDateTime	getLeaderSince() The time that it was elected as leader, absent when not the leader
@Nullable java.lang.String	getName() The cluster name.
@Nullable java.lang.String	getRaftGroup() In clustered environments the name of the Raft group managing the asset
@Nullable java.util.List<Replica>	getReplicas() The members of the RAFT cluster.
@Nullable java.lang.String	getTrafficAccount() The account where the replication traffic goes over.
boolean	isSystemAccount() Indicates if the traffic_account is the system account.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getName

public @Nullable java.lang.String getName()

The cluster name. Technically can be null

Returns:

the cluster or null

getRaftGroup

public @Nullable java.lang.String getRaftGroup()

In clustered environments the name of the Raft group managing the asset

Returns:

the raft group name or null

getLeader

public @Nullable java.lang.String getLeader()

The server name of the RAFT leader

Returns:

the leader or null

getLeaderSince

public @Nullable java.time.ZonedDateTime getLeaderSince()

The time that it was elected as leader, absent when not the leader

Returns:

the time or null

isSystemAccount

public boolean isSystemAccount()

Indicates if the traffic_account is the system account. When true, replication traffic goes over the system account.

Returns:

true if the traffic_account is the system account

getTrafficAccount

public @Nullable java.lang.String getTrafficAccount()

The account where the replication traffic goes over.

Returns:

the traffic account or null

getReplicas

public @Nullable java.util.List<Replica> getReplicas()

The members of the RAFT cluster. May be null if there are no replicas.

Returns:

the replicas or null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object