ClusterInfo

@Serializable
data class ClusterInfo(val ID: String? = null, val version: ObjectVersion? = null, val createdAt: String? = null, val updatedAt: String? = null, val spec: SwarmSpec? = null, val tlSInfo: TLSInfo? = null, val rootRotationInProgress: Boolean? = null, val dataPathPort: Int? = null, val defaultAddrPool: List<String>? = null, val subnetSize: Int? = null)

ClusterInfo represents information about the swarm as is returned by the \"/info\" endpoint. Join-tokens are not included.

Parameters

ID

The ID of the swarm.

version
createdAt

Date and time at which the swarm was initialised in RFC 3339 format with nano-seconds.

updatedAt

Date and time at which the swarm was last updated in RFC 3339 format with nano-seconds.

spec
tlSInfo
rootRotationInProgress

Whether there is currently a root CA rotation in progress for the swarm

dataPathPort

DataPathPort specifies the data path port number for data traffic. Acceptable port range is 1024 to 49151. If no port is set or is set to 0, the default port (4789) is used.

defaultAddrPool

Default Address Pool specifies default subnet pools for global scope networks.

subnetSize

SubnetSize specifies the subnet size of the networks created from the default subnet pool.

Constructors

Link copied to clipboard
constructor(ID: String? = null, version: ObjectVersion? = null, createdAt: String? = null, updatedAt: String? = null, spec: SwarmSpec? = null, tlSInfo: TLSInfo? = null, rootRotationInProgress: Boolean? = null, dataPathPort: Int? = null, defaultAddrPool: List<String>? = null, subnetSize: Int? = null)

Properties

Link copied to clipboard
@SerialName(value = "CreatedAt")
val createdAt: String?
Link copied to clipboard
@SerialName(value = "DataPathPort")
val dataPathPort: Int?
Link copied to clipboard
@SerialName(value = "DefaultAddrPool")
val defaultAddrPool: List<String>?
Link copied to clipboard
@SerialName(value = "ID")
val ID: String?
Link copied to clipboard
@SerialName(value = "RootRotationInProgress")
val rootRotationInProgress: Boolean?
Link copied to clipboard
@SerialName(value = "Spec")
val spec: SwarmSpec?
Link copied to clipboard
@SerialName(value = "SubnetSize")
val subnetSize: Int?
Link copied to clipboard
@SerialName(value = "TLSInfo")
val tlSInfo: TLSInfo?
Link copied to clipboard
@SerialName(value = "UpdatedAt")
val updatedAt: String?
Link copied to clipboard
@SerialName(value = "Version")
val version: ObjectVersion?