Documentation

ContainersIdExecPostBody

Table of Contents

$attachStderr  : bool|null
Attach to `stderr` of the exec command.
$attachStdin  : bool|null
Attach to `stdin` of the exec command.
$attachStdout  : bool|null
Attach to `stdout` of the exec command.
$cmd  : array<string|int, string>|null
Command to run, as a string or array of strings.
$detachKeys  : string|null
Override the key sequence for detaching a container. Format is.
$env  : array<string|int, string>|null
A list of environment variables in the form `["VAR=value", ...]`.
$privileged  : bool|null
Runs the exec process with extended privileges.
$tty  : bool|null
Allocate a pseudo-TTY.
$user  : string|null
The user, and optionally, group to run the exec process inside.
$workingDir  : string|null
The working directory for the exec process inside the container.
getAttachStderr()  : bool|null
Attach to `stderr` of the exec command.
getAttachStdin()  : bool|null
Attach to `stdin` of the exec command.
getAttachStdout()  : bool|null
Attach to `stdout` of the exec command.
getCmd()  : array<string|int, string>|null
Command to run, as a string or array of strings.
getDetachKeys()  : string|null
Override the key sequence for detaching a container. Format is.
getEnv()  : array<string|int, string>|null
A list of environment variables in the form `["VAR=value", ...]`.
getPrivileged()  : bool|null
Runs the exec process with extended privileges.
getTty()  : bool|null
Allocate a pseudo-TTY.
getUser()  : string|null
The user, and optionally, group to run the exec process inside.
getWorkingDir()  : string|null
The working directory for the exec process inside the container.
setAttachStderr()  : self
Attach to `stderr` of the exec command.
setAttachStdin()  : self
Attach to `stdin` of the exec command.
setAttachStdout()  : self
Attach to `stdout` of the exec command.
setCmd()  : self
Command to run, as a string or array of strings.
setDetachKeys()  : self
Override the key sequence for detaching a container. Format is.
setEnv()  : self
A list of environment variables in the form `["VAR=value", ...]`.
setPrivileged()  : self
Runs the exec process with extended privileges.
setTty()  : self
Allocate a pseudo-TTY.
setUser()  : self
The user, and optionally, group to run the exec process inside.
setWorkingDir()  : self
The working directory for the exec process inside the container.

Properties

$detachKeys

Override the key sequence for detaching a container. Format is.

protected string|null $detachKeys

$env

A list of environment variables in the form `["VAR=value", ...]`.

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

$workingDir

The working directory for the exec process inside the container.

protected string|null $workingDir

Methods

getAttachStderr()

Attach to `stderr` of the exec command.

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

getAttachStdin()

Attach to `stdin` of the exec command.

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

getAttachStdout()

Attach to `stdout` of the exec command.

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

getCmd()

Command to run, as a string or array of strings.

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

getDetachKeys()

Override the key sequence for detaching a container. Format is.

public getDetachKeys() : string|null

is one of: a-z, @, ^, [, , or _.

Return values
string|null

getEnv()

A list of environment variables in the form `["VAR=value", ...]`.

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

getPrivileged()

Runs the exec process with extended privileges.

public getPrivileged() : bool|null
Return values
bool|null

getUser()

The user, and optionally, group to run the exec process inside.

public getUser() : string|null

or uid:gid.

Return values
string|null

getWorkingDir()

The working directory for the exec process inside the container.

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

setAttachStderr()

Attach to `stderr` of the exec command.

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

setAttachStdin()

Attach to `stdin` of the exec command.

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

setAttachStdout()

Attach to `stdout` of the exec command.

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

setCmd()

Command to run, as a string or array of strings.

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

setDetachKeys()

Override the key sequence for detaching a container. Format is.

public setDetachKeys(string|null $detachKeys) : self

is one of: a-z, @, ^, [, , or _.

Parameters
$detachKeys : string|null
Return values
self

setEnv()

A list of environment variables in the form `["VAR=value", ...]`.

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

setPrivileged()

Runs the exec process with extended privileges.

public setPrivileged(bool|null $privileged) : self
Parameters
$privileged : bool|null
Return values
self

setTty()

Allocate a pseudo-TTY.

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

setUser()

The user, and optionally, group to run the exec process inside.

public setUser(string|null $user) : self

or uid:gid.

Parameters
$user : string|null
Return values
self

setWorkingDir()

The working directory for the exec process inside the container.

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

Search results