Documentation

ContainersCreatePostBody

Table of Contents

$argsEscaped  : bool|null
Command is already escaped (Windows only).
$attachStderr  : bool|null
Whether to attach to `stderr`.
$attachStdin  : bool|null
Whether to attach to `stdin`.
$attachStdout  : bool|null
Whether to attach to `stdout`.
$cmd  : array<string|int, string>|null
Command to run specified as a string or an array of strings.
$domainname  : string|null
The domain name to use for the container.
$entrypoint  : array<string|int, string>|null
The entry point for the container as a string or an array of strings.
$env  : array<string|int, string>|null
A list of environment variables to set inside the container in the.
$exposedPorts  : array<string|int, mixed>|null
An object mapping ports to an empty object in the form:.
$healthcheck  : HealthConfig|null
A test to perform to check that the container is healthy.
$hostConfig  : HostConfig|null
Container configuration that depends on the host we are running on.
$hostname  : string|null
The hostname to use for the container, as a valid RFC 1123 hostname.
$image  : string|null
The name of the image to use when creating the container/.
$labels  : array<string|int, string>|null
User-defined key/value metadata.
$macAddress  : string|null
MAC address of the container.
$networkDisabled  : bool|null
Disable networking for the container.
$networkingConfig  : NetworkingConfig|null
NetworkingConfig represents the container's networking configuration for.
$onBuild  : array<string|int, string>|null
`ONBUILD` metadata that were defined in the image's `Dockerfile`.
$openStdin  : bool|null
Open `stdin`.
$shell  : array<string|int, string>|null
Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.
$stdinOnce  : bool|null
Close `stdin` after one attached client disconnects.
$stopSignal  : string|null
Signal to stop a container as a string or unsigned integer.
$stopTimeout  : int|null
Timeout to stop a container in seconds.
$tty  : bool|null
Attach standard streams to a TTY, including `stdin` if it is not closed.
$user  : string|null
The user that commands are run as inside the container.
$volumes  : array<string|int, mixed>|null
An object mapping mount point paths inside the container to empty.
$workingDir  : string|null
The working directory for commands to run in.
getArgsEscaped()  : bool|null
Command is already escaped (Windows only).
getAttachStderr()  : bool|null
Whether to attach to `stderr`.
getAttachStdin()  : bool|null
Whether to attach to `stdin`.
getAttachStdout()  : bool|null
Whether to attach to `stdout`.
getCmd()  : array<string|int, string>|null
Command to run specified as a string or an array of strings.
getDomainname()  : string|null
The domain name to use for the container.
getEntrypoint()  : array<string|int, string>|null
The entry point for the container as a string or an array of strings.
getEnv()  : array<string|int, string>|null
A list of environment variables to set inside the container in the.
getExposedPorts()  : array<string|int, mixed>|null
An object mapping ports to an empty object in the form:.
getHealthcheck()  : HealthConfig|null
A test to perform to check that the container is healthy.
getHostConfig()  : HostConfig|null
Container configuration that depends on the host we are running on.
getHostname()  : string|null
The hostname to use for the container, as a valid RFC 1123 hostname.
getImage()  : string|null
The name of the image to use when creating the container/.
getLabels()  : array<string|int, string>|null
User-defined key/value metadata.
getMacAddress()  : string|null
MAC address of the container.
getNetworkDisabled()  : bool|null
Disable networking for the container.
getNetworkingConfig()  : NetworkingConfig|null
NetworkingConfig represents the container's networking configuration for.
getOnBuild()  : array<string|int, string>|null
`ONBUILD` metadata that were defined in the image's `Dockerfile`.
getOpenStdin()  : bool|null
Open `stdin`.
getShell()  : array<string|int, string>|null
Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.
getStdinOnce()  : bool|null
Close `stdin` after one attached client disconnects.
getStopSignal()  : string|null
Signal to stop a container as a string or unsigned integer.
getStopTimeout()  : int|null
Timeout to stop a container in seconds.
getTty()  : bool|null
Attach standard streams to a TTY, including `stdin` if it is not closed.
getUser()  : string|null
The user that commands are run as inside the container.
getVolumes()  : array<string|int, mixed>|null
An object mapping mount point paths inside the container to empty.
getWorkingDir()  : string|null
The working directory for commands to run in.
setArgsEscaped()  : self
Command is already escaped (Windows only).
setAttachStderr()  : self
Whether to attach to `stderr`.
setAttachStdin()  : self
Whether to attach to `stdin`.
setAttachStdout()  : self
Whether to attach to `stdout`.
setCmd()  : self
Command to run specified as a string or an array of strings.
setDomainname()  : self
The domain name to use for the container.
setEntrypoint()  : self
The entry point for the container as a string or an array of strings.
setEnv()  : self
A list of environment variables to set inside the container in the.
setExposedPorts()  : self
An object mapping ports to an empty object in the form:.
setHealthcheck()  : self
A test to perform to check that the container is healthy.
setHostConfig()  : self
Container configuration that depends on the host we are running on.
setHostname()  : self
The hostname to use for the container, as a valid RFC 1123 hostname.
setImage()  : self
The name of the image to use when creating the container/.
setLabels()  : self
User-defined key/value metadata.
setMacAddress()  : self
MAC address of the container.
setNetworkDisabled()  : self
Disable networking for the container.
setNetworkingConfig()  : self
NetworkingConfig represents the container's networking configuration for.
setOnBuild()  : self
`ONBUILD` metadata that were defined in the image's `Dockerfile`.
setOpenStdin()  : self
Open `stdin`.
setShell()  : self
Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.
setStdinOnce()  : self
Close `stdin` after one attached client disconnects.
setStopSignal()  : self
Signal to stop a container as a string or unsigned integer.
setStopTimeout()  : self
Timeout to stop a container in seconds.
setTty()  : self
Attach standard streams to a TTY, including `stdin` if it is not closed.
setUser()  : self
The user that commands are run as inside the container.
setVolumes()  : self
An object mapping mount point paths inside the container to empty.
setWorkingDir()  : self
The working directory for commands to run in.

Properties

$cmd

Command to run specified as a string or an array of strings.

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

$entrypoint

The entry point for the container as a string or an array of strings.

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

$env

A list of environment variables to set inside the container in the.

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

$exposedPorts

An object mapping ports to an empty object in the form:.

protected array<string|int, mixed>|null $exposedPorts

$hostname

The hostname to use for the container, as a valid RFC 1123 hostname.

protected string|null $hostname

$onBuild

`ONBUILD` metadata that were defined in the image's `Dockerfile`.

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

$shell

Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.

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

$stopSignal

Signal to stop a container as a string or unsigned integer.

protected string|null $stopSignal = 'SIGTERM'

$tty

Attach standard streams to a TTY, including `stdin` if it is not closed.

protected bool|null $tty = false

$volumes

An object mapping mount point paths inside the container to empty.

protected array<string|int, mixed>|null $volumes

Methods

getArgsEscaped()

Command is already escaped (Windows only).

public getArgsEscaped() : bool|null
Return values
bool|null —

getAttachStderr()

Whether to attach to `stderr`.

public getAttachStderr() : bool|null
Return values
bool|null —

getAttachStdin()

Whether to attach to `stdin`.

public getAttachStdin() : bool|null
Return values
bool|null —

getAttachStdout()

Whether to attach to `stdout`.

public getAttachStdout() : bool|null
Return values
bool|null —

getCmd()

Command to run specified as a string or an array of strings.

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

getDomainname()

The domain name to use for the container.

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

getEntrypoint()

The entry point for the container as a string or an array of strings.

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

getEnv()

A list of environment variables to set inside the container in the.

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

getExposedPorts()

An object mapping ports to an empty object in the form:.

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

getHostname()

The hostname to use for the container, as a valid RFC 1123 hostname.

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

getImage()

The name of the image to use when creating the container/.

public getImage() : 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 —

getMacAddress()

MAC address of the container.

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

getNetworkDisabled()

Disable networking for the container.

public getNetworkDisabled() : bool|null
Return values
bool|null —

getOnBuild()

`ONBUILD` metadata that were defined in the image's `Dockerfile`.

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

getShell()

Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.

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

getStdinOnce()

Close `stdin` after one attached client disconnects.

public getStdinOnce() : bool|null
Return values
bool|null —

getStopSignal()

Signal to stop a container as a string or unsigned integer.

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

getStopTimeout()

Timeout to stop a container in seconds.

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

getTty()

Attach standard streams to a TTY, including `stdin` if it is not closed.

public getTty() : bool|null
Return values
bool|null —

getUser()

The user that commands are run as inside the container.

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

getVolumes()

An object mapping mount point paths inside the container to empty.

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

getWorkingDir()

The working directory for commands to run in.

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

setArgsEscaped()

Command is already escaped (Windows only).

public setArgsEscaped(bool|null $argsEscaped) : self
Parameters
$argsEscaped : bool|null
Return values
self —

setAttachStderr()

Whether to attach to `stderr`.

public setAttachStderr(bool|null $attachStderr) : self
Parameters
$attachStderr : bool|null
Return values
self —

setAttachStdin()

Whether to attach to `stdin`.

public setAttachStdin(bool|null $attachStdin) : self
Parameters
$attachStdin : bool|null
Return values
self —

setAttachStdout()

Whether to attach to `stdout`.

public setAttachStdout(bool|null $attachStdout) : self
Parameters
$attachStdout : bool|null
Return values
self —

setCmd()

Command to run specified as a string or an array of strings.

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

setDomainname()

The domain name to use for the container.

public setDomainname(string|null $domainname) : self
Parameters
$domainname : string|null
Return values
self —

setEntrypoint()

The entry point for the container as a string or an array of strings.

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

setEnv()

A list of environment variables to set inside the container in the.

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

setExposedPorts()

An object mapping ports to an empty object in the form:.

public setExposedPorts(array<string|int, mixed>|null $exposedPorts) : self
Parameters
$exposedPorts : array<string|int, mixed>|null
Return values
self —

setHostConfig()

Container configuration that depends on the host we are running on.

public setHostConfig(HostConfig|null $hostConfig) : self
Parameters
$hostConfig : HostConfig|null
Return values
self —

setHostname()

The hostname to use for the container, as a valid RFC 1123 hostname.

public setHostname(string|null $hostname) : self
Parameters
$hostname : string|null
Return values
self —

setImage()

The name of the image to use when creating the container/.

public setImage(string|null $image) : self
Parameters
$image : 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 —

setMacAddress()

MAC address of the container.

public setMacAddress(string|null $macAddress) : self
Parameters
$macAddress : string|null
Return values
self —

setNetworkDisabled()

Disable networking for the container.

public setNetworkDisabled(bool|null $networkDisabled) : self
Parameters
$networkDisabled : bool|null
Return values
self —

setNetworkingConfig()

NetworkingConfig represents the container's networking configuration for.

public setNetworkingConfig(NetworkingConfig|null $networkingConfig) : self

and docker network connect commands.

Parameters
$networkingConfig : NetworkingConfig|null
Return values
self —

setOnBuild()

`ONBUILD` metadata that were defined in the image's `Dockerfile`.

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

setOpenStdin()

Open `stdin`.

public setOpenStdin(bool|null $openStdin) : self
Parameters
$openStdin : bool|null
Return values
self —

setShell()

Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.

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

setStdinOnce()

Close `stdin` after one attached client disconnects.

public setStdinOnce(bool|null $stdinOnce) : self
Parameters
$stdinOnce : bool|null
Return values
self —

setStopSignal()

Signal to stop a container as a string or unsigned integer.

public setStopSignal(string|null $stopSignal) : self
Parameters
$stopSignal : string|null
Return values
self —

setStopTimeout()

Timeout to stop a container in seconds.

public setStopTimeout(int|null $stopTimeout) : self
Parameters
$stopTimeout : int|null
Return values
self —

setTty()

Attach standard streams to a TTY, including `stdin` if it is not closed.

public setTty(bool|null $tty) : self
Parameters
$tty : bool|null
Return values
self —

setUser()

The user that commands are run as inside the container.

public setUser(string|null $user) : self
Parameters
$user : string|null
Return values
self —

setVolumes()

An object mapping mount point paths inside the container to empty.

public setVolumes(array<string|int, mixed>|null $volumes) : self
Parameters
$volumes : array<string|int, mixed>|null
Return values
self —

setWorkingDir()

The working directory for commands to run in.

public setWorkingDir(string|null $workingDir) : self
Parameters
$workingDir : string|null
Return values
self —

Search results