Documentation

ContainerSummaryItem

Table of Contents

$command  : string|null
Command to run when starting the container.
$created  : int|null
When the container was created.
$hostConfig  : ContainerSummaryItemHostConfig|null
$id  : string|null
The ID of this container.
$image  : string|null
The name of the image used when creating this container.
$imageID  : string|null
The ID of the image that this container was created from.
$labels  : array<string|int, string>|null
User-defined key/value metadata.
$mounts  : array<string|int, Mount>|null
$names  : array<string|int, string>|null
The names that this container has been given.
$networkSettings  : ContainerSummaryItemNetworkSettings|null
A summary of the container's network settings.
$ports  : array<string|int, Port>|null
The ports exposed by this container.
$sizeRootFs  : int|null
The total size of all the files in this container.
$sizeRw  : int|null
The size of files that have been created or changed by this container.
$state  : string|null
The state of this container (e.g. `Exited`).
$status  : string|null
Additional human-readable status of this container (e.g. `Exit 0`).
getCommand()  : string|null
Command to run when starting the container.
getCreated()  : int|null
When the container was created.
getHostConfig()  : ContainerSummaryItemHostConfig|null
getId()  : string|null
The ID of this container.
getImage()  : string|null
The name of the image used when creating this container.
getImageID()  : string|null
The ID of the image that this container was created from.
getLabels()  : array<string|int, string>|null
User-defined key/value metadata.
getMounts()  : array<string|int, Mount>|null
getNames()  : array<string|int, string>|null
The names that this container has been given.
getNetworkSettings()  : ContainerSummaryItemNetworkSettings|null
A summary of the container's network settings.
getPorts()  : array<string|int, Port>|null
The ports exposed by this container.
getSizeRootFs()  : int|null
The total size of all the files in this container.
getSizeRw()  : int|null
The size of files that have been created or changed by this container.
getState()  : string|null
The state of this container (e.g. `Exited`).
getStatus()  : string|null
Additional human-readable status of this container (e.g. `Exit 0`).
setCommand()  : self
Command to run when starting the container.
setCreated()  : self
When the container was created.
setHostConfig()  : self
setId()  : self
The ID of this container.
setImage()  : self
The name of the image used when creating this container.
setImageID()  : self
The ID of the image that this container was created from.
setLabels()  : self
User-defined key/value metadata.
setMounts()  : self
setNames()  : self
The names that this container has been given.
setNetworkSettings()  : self
A summary of the container's network settings.
setPorts()  : self
The ports exposed by this container.
setSizeRootFs()  : self
The total size of all the files in this container.
setSizeRw()  : self
The size of files that have been created or changed by this container.
setState()  : self
The state of this container (e.g. `Exited`).
setStatus()  : self
Additional human-readable status of this container (e.g. `Exit 0`).

Properties

$image

The name of the image used when creating this container.

protected string|null $image

$imageID

The ID of the image that this container was created from.

protected string|null $imageID

$labels

User-defined key/value metadata.

protected array<string|int, string>|null $labels

$names

The names that this container has been given.

protected array<string|int, string>|null $names

$sizeRootFs

The total size of all the files in this container.

protected int|null $sizeRootFs

$sizeRw

The size of files that have been created or changed by this container.

protected int|null $sizeRw

$status

Additional human-readable status of this container (e.g. `Exit 0`).

protected string|null $status

Methods

getCommand()

Command to run when starting the container.

public getCommand() : string|null
Return values
string|null —

getCreated()

When the container was created.

public getCreated() : int|null
Return values
int|null —

getId()

The ID of this container.

public getId() : string|null
Return values
string|null —

getImage()

The name of the image used when creating this container.

public getImage() : string|null
Return values
string|null —

getImageID()

The ID of the image that this container was created from.

public getImageID() : string|null
Return values
string|null —

getLabels()

User-defined key/value metadata.

public getLabels() : array<string|int, string>|null
Return values
array<string|int, string>|null —

getNames()

The names that this container has been given.

public getNames() : array<string|int, string>|null
Return values
array<string|int, string>|null —

getPorts()

The ports exposed by this container.

public getPorts() : array<string|int, Port>|null
Return values
array<string|int, Port>|null —

getSizeRootFs()

The total size of all the files in this container.

public getSizeRootFs() : int|null
Return values
int|null —

getSizeRw()

The size of files that have been created or changed by this container.

public getSizeRw() : int|null
Return values
int|null —

getState()

The state of this container (e.g. `Exited`).

public getState() : string|null
Return values
string|null —

getStatus()

Additional human-readable status of this container (e.g. `Exit 0`).

public getStatus() : string|null
Return values
string|null —

setCommand()

Command to run when starting the container.

public setCommand(string|null $command) : self
Parameters
$command : string|null
Return values
self —

setCreated()

When the container was created.

public setCreated(int|null $created) : self
Parameters
$created : int|null
Return values
self —

setId()

The ID of this container.

public setId(string|null $id) : self
Parameters
$id : string|null
Return values
self —

setImage()

The name of the image used when creating this container.

public setImage(string|null $image) : self
Parameters
$image : string|null
Return values
self —

setImageID()

The ID of the image that this container was created from.

public setImageID(string|null $imageID) : self
Parameters
$imageID : string|null
Return values
self —

setLabels()

User-defined key/value metadata.

public setLabels(array<string|int, string>|null $labels) : self
Parameters
$labels : array<string|int, string>|null
Return values
self —

setMounts()

public setMounts(array<string|int, Mount>|null $mounts) : self
Parameters
$mounts : array<string|int, Mount>|null
Return values
self —

setNames()

The names that this container has been given.

public setNames(array<string|int, string>|null $names) : self
Parameters
$names : array<string|int, string>|null
Return values
self —

setPorts()

The ports exposed by this container.

public setPorts(array<string|int, Port>|null $ports) : self
Parameters
$ports : array<string|int, Port>|null
Return values
self —

setSizeRootFs()

The total size of all the files in this container.

public setSizeRootFs(int|null $sizeRootFs) : self
Parameters
$sizeRootFs : int|null
Return values
self —

setSizeRw()

The size of files that have been created or changed by this container.

public setSizeRw(int|null $sizeRw) : self
Parameters
$sizeRw : int|null
Return values
self —

setState()

The state of this container (e.g. `Exited`).

public setState(string|null $state) : self
Parameters
$state : string|null
Return values
self —

setStatus()

Additional human-readable status of this container (e.g. `Exit 0`).

public setStatus(string|null $status) : self
Parameters
$status : string|null
Return values
self —

Search results