ContainerState
Table of Contents
- $dead : bool|null
- $error : string|null
- $exitCode : int|null
- The last exit code of this container.
- $finishedAt : string|null
- The time when this container last exited.
- $health : Health|null
- Health stores information about the container's healthcheck results.
- $oOMKilled : bool|null
- Whether this container has been killed because it ran out of memory.
- $paused : bool|null
- Whether this container is paused.
- $pid : int|null
- The process ID of this container.
- $restarting : bool|null
- Whether this container is restarting.
- $running : bool|null
- Whether this container is running.
- $startedAt : string|null
- The time when this container was last started.
- $status : string|null
- String representation of the container state. Can be one of "created",.
- getDead() : bool|null
- getError() : string|null
- getExitCode() : int|null
- The last exit code of this container.
- getFinishedAt() : string|null
- The time when this container last exited.
- getHealth() : Health|null
- Health stores information about the container's healthcheck results.
- getOOMKilled() : bool|null
- Whether this container has been killed because it ran out of memory.
- getPaused() : bool|null
- Whether this container is paused.
- getPid() : int|null
- The process ID of this container.
- getRestarting() : bool|null
- Whether this container is restarting.
- getRunning() : bool|null
- Whether this container is running.
- getStartedAt() : string|null
- The time when this container was last started.
- getStatus() : string|null
- String representation of the container state. Can be one of "created",.
- setDead() : self
- setError() : self
- setExitCode() : self
- The last exit code of this container.
- setFinishedAt() : self
- The time when this container last exited.
- setHealth() : self
- Health stores information about the container's healthcheck results.
- setOOMKilled() : self
- Whether this container has been killed because it ran out of memory.
- setPaused() : self
- Whether this container is paused.
- setPid() : self
- The process ID of this container.
- setRestarting() : self
- Whether this container is restarting.
- setRunning() : self
- Whether this container is running.
- setStartedAt() : self
- The time when this container was last started.
- setStatus() : self
- String representation of the container state. Can be one of "created",.
Properties
$dead
protected
bool|null
$dead
$error
protected
string|null
$error
$exitCode
The last exit code of this container.
protected
int|null
$exitCode
$finishedAt
The time when this container last exited.
protected
string|null
$finishedAt
$health
Health stores information about the container's healthcheck results.
protected
Health|null
$health
$oOMKilled
Whether this container has been killed because it ran out of memory.
protected
bool|null
$oOMKilled
$paused
Whether this container is paused.
protected
bool|null
$paused
$pid
The process ID of this container.
protected
int|null
$pid
$restarting
Whether this container is restarting.
protected
bool|null
$restarting
$running
Whether this container is running.
protected
bool|null
$running
$startedAt
The time when this container was last started.
protected
string|null
$startedAt
$status
String representation of the container state. Can be one of "created",.
protected
string|null
$status
Methods
getDead()
public
getDead() : bool|null
Return values
bool|null —getError()
public
getError() : string|null
Return values
string|null —getExitCode()
The last exit code of this container.
public
getExitCode() : int|null
Return values
int|null —getFinishedAt()
The time when this container last exited.
public
getFinishedAt() : string|null
Return values
string|null —getHealth()
Health stores information about the container's healthcheck results.
public
getHealth() : Health|null
Return values
Health|null —getOOMKilled()
Whether this container has been killed because it ran out of memory.
public
getOOMKilled() : bool|null
Return values
bool|null —getPaused()
Whether this container is paused.
public
getPaused() : bool|null
Return values
bool|null —getPid()
The process ID of this container.
public
getPid() : int|null
Return values
int|null —getRestarting()
Whether this container is restarting.
public
getRestarting() : bool|null
Return values
bool|null —getRunning()
Whether this container is running.
public
getRunning() : bool|null
Use the Status field instead to determine if a container's state is "running".
Return values
bool|null —getStartedAt()
The time when this container was last started.
public
getStartedAt() : string|null
Return values
string|null —getStatus()
String representation of the container state. Can be one of "created",.
public
getStatus() : string|null
"running", "paused", "restarting", "removing", "exited", or "dead".
Return values
string|null —setDead()
public
setDead(bool|null $dead) : self
Parameters
- $dead : bool|null
Return values
self —setError()
public
setError(string|null $error) : self
Parameters
- $error : string|null
Return values
self —setExitCode()
The last exit code of this container.
public
setExitCode(int|null $exitCode) : self
Parameters
- $exitCode : int|null
Return values
self —setFinishedAt()
The time when this container last exited.
public
setFinishedAt(string|null $finishedAt) : self
Parameters
- $finishedAt : string|null
Return values
self —setHealth()
Health stores information about the container's healthcheck results.
public
setHealth(Health|null $health) : self
Parameters
- $health : Health|null
Return values
self —setOOMKilled()
Whether this container has been killed because it ran out of memory.
public
setOOMKilled(bool|null $oOMKilled) : self
Parameters
- $oOMKilled : bool|null
Return values
self —setPaused()
Whether this container is paused.
public
setPaused(bool|null $paused) : self
Parameters
- $paused : bool|null
Return values
self —setPid()
The process ID of this container.
public
setPid(int|null $pid) : self
Parameters
- $pid : int|null
Return values
self —setRestarting()
Whether this container is restarting.
public
setRestarting(bool|null $restarting) : self
Parameters
- $restarting : bool|null
Return values
self —setRunning()
Whether this container is running.
public
setRunning(bool|null $running) : self
Use the Status field instead to determine if a container's state is "running".
Parameters
- $running : bool|null
Return values
self —setStartedAt()
The time when this container was last started.
public
setStartedAt(string|null $startedAt) : self
Parameters
- $startedAt : string|null
Return values
self —setStatus()
String representation of the container state. Can be one of "created",.
public
setStatus(string|null $status) : self
"running", "paused", "restarting", "removing", "exited", or "dead".
Parameters
- $status : string|null