ClusterInfo
Table of Contents
- $createdAt : string|null
- Date and time at which the swarm was initialised in.
- $dataPathPort : int|null
- DataPathPort specifies the data path port number for data traffic.
- $defaultAddrPool : array<string|int, string>|null
- Default Address Pool specifies default subnet pools for global scope.
- $iD : string|null
- The ID of the swarm.
- $rootRotationInProgress : bool|null
- Whether there is currently a root CA rotation in progress for the swarm.
- $spec : SwarmSpec|null
- User modifiable swarm configuration.
- $subnetSize : int|null
- SubnetSize specifies the subnet size of the networks created from the.
- $tLSInfo : TLSInfo|null
- Information about the issuer of leaf TLS certificates and the trusted root.
- $updatedAt : string|null
- Date and time at which the swarm was last updated in.
- $version : ObjectVersion|null
- The version number of the object such as node, service, etc. This is needed.
- getCreatedAt() : string|null
- Date and time at which the swarm was initialised in.
- getDataPathPort() : int|null
- DataPathPort specifies the data path port number for data traffic.
- getDefaultAddrPool() : array<string|int, string>|null
- Default Address Pool specifies default subnet pools for global scope.
- getID() : string|null
- The ID of the swarm.
- getRootRotationInProgress() : bool|null
- Whether there is currently a root CA rotation in progress for the swarm.
- getSpec() : SwarmSpec|null
- User modifiable swarm configuration.
- getSubnetSize() : int|null
- SubnetSize specifies the subnet size of the networks created from the.
- getTLSInfo() : TLSInfo|null
- Information about the issuer of leaf TLS certificates and the trusted root.
- getUpdatedAt() : string|null
- Date and time at which the swarm was last updated in.
- getVersion() : ObjectVersion|null
- The version number of the object such as node, service, etc. This is needed.
- setCreatedAt() : self
- Date and time at which the swarm was initialised in.
- setDataPathPort() : self
- DataPathPort specifies the data path port number for data traffic.
- setDefaultAddrPool() : self
- Default Address Pool specifies default subnet pools for global scope.
- setID() : self
- The ID of the swarm.
- setRootRotationInProgress() : self
- Whether there is currently a root CA rotation in progress for the swarm.
- setSpec() : self
- User modifiable swarm configuration.
- setSubnetSize() : self
- SubnetSize specifies the subnet size of the networks created from the.
- setTLSInfo() : self
- Information about the issuer of leaf TLS certificates and the trusted root.
- setUpdatedAt() : self
- Date and time at which the swarm was last updated in.
- setVersion() : self
- The version number of the object such as node, service, etc. This is needed.
Properties
$createdAt
Date and time at which the swarm was initialised in.
protected
string|null
$createdAt
$dataPathPort
DataPathPort specifies the data path port number for data traffic.
protected
int|null
$dataPathPort
= 4789
$defaultAddrPool
Default Address Pool specifies default subnet pools for global scope.
protected
array<string|int, string>|null
$defaultAddrPool
$iD
The ID of the swarm.
protected
string|null
$iD
$rootRotationInProgress
Whether there is currently a root CA rotation in progress for the swarm.
protected
bool|null
$rootRotationInProgress
$spec
User modifiable swarm configuration.
protected
SwarmSpec|null
$spec
$subnetSize
SubnetSize specifies the subnet size of the networks created from the.
protected
int|null
$subnetSize
= 24
$tLSInfo
Information about the issuer of leaf TLS certificates and the trusted root.
protected
TLSInfo|null
$tLSInfo
$updatedAt
Date and time at which the swarm was last updated in.
protected
string|null
$updatedAt
$version
The version number of the object such as node, service, etc. This is needed.
protected
ObjectVersion|null
$version
Methods
getCreatedAt()
Date and time at which the swarm was initialised in.
public
getCreatedAt() : string|null
RFC 3339 format with nano-seconds.
Return values
string|null —getDataPathPort()
DataPathPort specifies the data path port number for data traffic.
public
getDataPathPort() : int|null
If no port is set or is set to 0, the default port (4789) is used.
Return values
int|null —getDefaultAddrPool()
Default Address Pool specifies default subnet pools for global scope.
public
getDefaultAddrPool() : array<string|int, string>|null
Return values
array<string|int, string>|null —getID()
The ID of the swarm.
public
getID() : string|null
Return values
string|null —getRootRotationInProgress()
Whether there is currently a root CA rotation in progress for the swarm.
public
getRootRotationInProgress() : bool|null
Return values
bool|null —getSpec()
User modifiable swarm configuration.
public
getSpec() : SwarmSpec|null
Return values
SwarmSpec|null —getSubnetSize()
SubnetSize specifies the subnet size of the networks created from the.
public
getSubnetSize() : int|null
default subnet pool.
Return values
int|null —getTLSInfo()
Information about the issuer of leaf TLS certificates and the trusted root.
public
getTLSInfo() : TLSInfo|null
CA certificate.
Return values
TLSInfo|null —getUpdatedAt()
Date and time at which the swarm was last updated in.
public
getUpdatedAt() : string|null
RFC 3339 format with nano-seconds.
Return values
string|null —getVersion()
The version number of the object such as node, service, etc. This is needed.
public
getVersion() : ObjectVersion|null
overwrite each other.
Return values
ObjectVersion|null —setCreatedAt()
Date and time at which the swarm was initialised in.
public
setCreatedAt(string|null $createdAt) : self
RFC 3339 format with nano-seconds.
Parameters
- $createdAt : string|null
Return values
self —setDataPathPort()
DataPathPort specifies the data path port number for data traffic.
public
setDataPathPort(int|null $dataPathPort) : self
If no port is set or is set to 0, the default port (4789) is used.
Parameters
- $dataPathPort : int|null
Return values
self —setDefaultAddrPool()
Default Address Pool specifies default subnet pools for global scope.
public
setDefaultAddrPool(array<string|int, string>|null $defaultAddrPool) : self
Parameters
- $defaultAddrPool : array<string|int, string>|null
Return values
self —setID()
The ID of the swarm.
public
setID(string|null $iD) : self
Parameters
- $iD : string|null
Return values
self —setRootRotationInProgress()
Whether there is currently a root CA rotation in progress for the swarm.
public
setRootRotationInProgress(bool|null $rootRotationInProgress) : self
Parameters
- $rootRotationInProgress : bool|null
Return values
self —setSpec()
User modifiable swarm configuration.
public
setSpec(SwarmSpec|null $spec) : self
Parameters
- $spec : SwarmSpec|null
Return values
self —setSubnetSize()
SubnetSize specifies the subnet size of the networks created from the.
public
setSubnetSize(int|null $subnetSize) : self
default subnet pool.
Parameters
- $subnetSize : int|null
Return values
self —setTLSInfo()
Information about the issuer of leaf TLS certificates and the trusted root.
public
setTLSInfo(TLSInfo|null $tLSInfo) : self
CA certificate.
Parameters
- $tLSInfo : TLSInfo|null
Return values
self —setUpdatedAt()
Date and time at which the swarm was last updated in.
public
setUpdatedAt(string|null $updatedAt) : self
RFC 3339 format with nano-seconds.
Parameters
- $updatedAt : string|null
Return values
self —setVersion()
The version number of the object such as node, service, etc. This is needed.
public
setVersion(ObjectVersion|null $version) : self
overwrite each other.
Parameters
- $version : ObjectVersion|null