PluginConfig
Table of Contents
- $args : PluginConfigArgs|null
- $description : string|null
- $dockerVersion : string|null
- Docker Version used to create the plugin.
- $documentation : string|null
- $entrypoint : array<string|int, string>|null
- $env : array<string|int, PluginEnv>|null
- $interface : PluginConfigInterface|null
- The interface between Docker and the plugin.
- $ipcHost : bool|null
- $linux : PluginConfigLinux|null
- $mounts : array<string|int, PluginMount>|null
- $network : PluginConfigNetwork|null
- $pidHost : bool|null
- $propagatedMount : string|null
- $rootfs : PluginConfigRootfs|null
- $user : PluginConfigUser|null
- $workDir : string|null
- getArgs() : PluginConfigArgs|null
- getDescription() : string|null
- getDockerVersion() : string|null
- Docker Version used to create the plugin.
- getDocumentation() : string|null
- getEntrypoint() : array<string|int, string>|null
- getEnv() : array<string|int, PluginEnv>|null
- getInterface() : PluginConfigInterface|null
- The interface between Docker and the plugin.
- getIpcHost() : bool|null
- getLinux() : PluginConfigLinux|null
- getMounts() : array<string|int, PluginMount>|null
- getNetwork() : PluginConfigNetwork|null
- getPidHost() : bool|null
- getPropagatedMount() : string|null
- getRootfs() : PluginConfigRootfs|null
- getUser() : PluginConfigUser|null
- getWorkDir() : string|null
- setArgs() : self
- setDescription() : self
- setDockerVersion() : self
- Docker Version used to create the plugin.
- setDocumentation() : self
- setEntrypoint() : self
- setEnv() : self
- setInterface() : self
- The interface between Docker and the plugin.
- setIpcHost() : self
- setLinux() : self
- setMounts() : self
- setNetwork() : self
- setPidHost() : self
- setPropagatedMount() : self
- setRootfs() : self
- setUser() : self
- setWorkDir() : self
Properties
$args
protected
PluginConfigArgs|null
$args
$description
protected
string|null
$description
$dockerVersion
Docker Version used to create the plugin.
protected
string|null
$dockerVersion
$documentation
protected
string|null
$documentation
$entrypoint
protected
array<string|int, string>|null
$entrypoint
$env
protected
array<string|int, PluginEnv>|null
$env
$interface
The interface between Docker and the plugin.
protected
PluginConfigInterface|null
$interface
$ipcHost
protected
bool|null
$ipcHost
$linux
protected
PluginConfigLinux|null
$linux
$mounts
protected
array<string|int, PluginMount>|null
$mounts
$network
protected
PluginConfigNetwork|null
$network
$pidHost
protected
bool|null
$pidHost
$propagatedMount
protected
string|null
$propagatedMount
$rootfs
protected
PluginConfigRootfs|null
$rootfs
$user
protected
PluginConfigUser|null
$user
$workDir
protected
string|null
$workDir
Methods
getArgs()
public
getArgs() : PluginConfigArgs|null
Return values
PluginConfigArgs|null —getDescription()
public
getDescription() : string|null
Return values
string|null —getDockerVersion()
Docker Version used to create the plugin.
public
getDockerVersion() : string|null
Return values
string|null —getDocumentation()
public
getDocumentation() : string|null
Return values
string|null —getEntrypoint()
public
getEntrypoint() : array<string|int, string>|null
Return values
array<string|int, string>|null —getEnv()
public
getEnv() : array<string|int, PluginEnv>|null
Return values
array<string|int, PluginEnv>|null —getInterface()
The interface between Docker and the plugin.
public
getInterface() : PluginConfigInterface|null
Return values
PluginConfigInterface|null —getIpcHost()
public
getIpcHost() : bool|null
Return values
bool|null —getLinux()
public
getLinux() : PluginConfigLinux|null
Return values
PluginConfigLinux|null —getMounts()
public
getMounts() : array<string|int, PluginMount>|null
Return values
array<string|int, PluginMount>|null —getNetwork()
public
getNetwork() : PluginConfigNetwork|null
Return values
PluginConfigNetwork|null —getPidHost()
public
getPidHost() : bool|null
Return values
bool|null —getPropagatedMount()
public
getPropagatedMount() : string|null
Return values
string|null —getRootfs()
public
getRootfs() : PluginConfigRootfs|null
Return values
PluginConfigRootfs|null —getUser()
public
getUser() : PluginConfigUser|null
Return values
PluginConfigUser|null —getWorkDir()
public
getWorkDir() : string|null
Return values
string|null —setArgs()
public
setArgs(PluginConfigArgs|null $args) : self
Parameters
- $args : PluginConfigArgs|null
Return values
self —setDescription()
public
setDescription(string|null $description) : self
Parameters
- $description : string|null
Return values
self —setDockerVersion()
Docker Version used to create the plugin.
public
setDockerVersion(string|null $dockerVersion) : self
Parameters
- $dockerVersion : string|null
Return values
self —setDocumentation()
public
setDocumentation(string|null $documentation) : self
Parameters
- $documentation : string|null
Return values
self —setEntrypoint()
public
setEntrypoint(array<string|int, string>|null $entrypoint) : self
Parameters
- $entrypoint : array<string|int, string>|null
Return values
self —setEnv()
public
setEnv(array<string|int, PluginEnv>|null $env) : self
Parameters
- $env : array<string|int, PluginEnv>|null
Return values
self —setInterface()
The interface between Docker and the plugin.
public
setInterface(PluginConfigInterface|null $interface) : self
Parameters
- $interface : PluginConfigInterface|null
Return values
self —setIpcHost()
public
setIpcHost(bool|null $ipcHost) : self
Parameters
- $ipcHost : bool|null
Return values
self —setLinux()
public
setLinux(PluginConfigLinux|null $linux) : self
Parameters
- $linux : PluginConfigLinux|null
Return values
self —setMounts()
public
setMounts(array<string|int, PluginMount>|null $mounts) : self
Parameters
- $mounts : array<string|int, PluginMount>|null
Return values
self —setNetwork()
public
setNetwork(PluginConfigNetwork|null $network) : self
Parameters
- $network : PluginConfigNetwork|null
Return values
self —setPidHost()
public
setPidHost(bool|null $pidHost) : self
Parameters
- $pidHost : bool|null
Return values
self —setPropagatedMount()
public
setPropagatedMount(string|null $propagatedMount) : self
Parameters
- $propagatedMount : string|null
Return values
self —setRootfs()
public
setRootfs(PluginConfigRootfs|null $rootfs) : self
Parameters
- $rootfs : PluginConfigRootfs|null
Return values
self —setUser()
public
setUser(PluginConfigUser|null $user) : self
Parameters
- $user : PluginConfigUser|null
Return values
self —setWorkDir()
public
setWorkDir(string|null $workDir) : self
Parameters
- $workDir : string|null