SwarmInfo

@Serializable
data class SwarmInfo(val nodeID: String? = "", val nodeAddr: String? = "", val localNodeState: LocalNodeState? = LocalNodeState.EMPTY, val controlAvailable: Boolean? = false, val error: String? = "", val remoteManagers: List<PeerNode>? = null, val nodes: Int? = null, val managers: Int? = null, val cluster: ClusterInfo? = null)

Represents generic information about swarm.

Parameters

nodeID

Unique identifier of for this node in the swarm.

nodeAddr

IP address at which this node can be reached by other nodes in the swarm.

localNodeState
controlAvailable
error
remoteManagers

List of ID's and addresses of other managers in the swarm.

nodes

Total number of nodes in the swarm.

managers

Total number of managers in the swarm.

cluster

Constructors

Link copied to clipboard
constructor(nodeID: String? = "", nodeAddr: String? = "", localNodeState: LocalNodeState? = LocalNodeState.EMPTY, controlAvailable: Boolean? = false, error: String? = "", remoteManagers: List<PeerNode>? = null, nodes: Int? = null, managers: Int? = null, cluster: ClusterInfo? = null)

Properties

Link copied to clipboard
@SerialName(value = "Cluster")
val cluster: ClusterInfo?
Link copied to clipboard
@SerialName(value = "ControlAvailable")
val controlAvailable: Boolean?
Link copied to clipboard
@SerialName(value = "Error")
val error: String?
Link copied to clipboard
@SerialName(value = "LocalNodeState")
val localNodeState: LocalNodeState?
Link copied to clipboard
@SerialName(value = "Managers")
val managers: Int?
Link copied to clipboard
@SerialName(value = "NodeAddr")
val nodeAddr: String?
Link copied to clipboard
@SerialName(value = "NodeID")
val nodeID: String?
Link copied to clipboard
@SerialName(value = "Nodes")
val nodes: Int?
Link copied to clipboard
@SerialName(value = "RemoteManagers")
val remoteManagers: List<PeerNode>?