Struct ContainerCreateBodyParam

pub struct ContainerCreateBodyParam {

    pub args_escaped: Option<bool>,
    pub attach_stderr: Option<bool>,
    pub attach_stdin: Option<bool>,
    pub attach_stdout: Option<bool>,
    pub cmd: Option<Vec<String>>,
    pub domainname: Option<String>,
    pub entrypoint: Option<Vec<String>>,
    pub env: Option<Vec<String>>,
    pub exposed_ports: Option<HashMap<String, Value>>,
    pub healthcheck: Option<HealthConfig>,
    pub host_config: Option<Value>,
    pub hostname: Option<String>,
    pub image: Option<String>,
    pub labels: Option<HashMap<String, String>>,
    pub mac_address: Option<String>,
    pub network_disabled: Option<bool>,
    pub networking_config: Option<NetworkingConfig>,
    pub on_build: Option<Vec<String>>,
    pub open_stdin: Option<bool>,
    pub shell: Option<Vec<String>>,
    pub stdin_once: Option<bool>,
    pub stop_signal: Option<String>,
    pub stop_timeout: Option<isize>,
    pub tty: Option<bool>,
    pub user: Option<String>,
    pub volumes: Option<HashMap<String, Value>>,
    pub working_dir: Option<String>,
}

Configuration for a container that is portable between hosts.

When used as ContainerConfig field in an image, ContainerConfig is an optional field containing the configuration of the container that was last committed when creating the image.

Previous versions of Docker builder used this field to store build cache, and it is not in active use anymore.

Fields

args_escaped: Option<bool>

Command is already escaped (Windows only)

attach_stderr: Option<bool>

Whether to attach to stderr.

attach_stdin: Option<bool>

Whether to attach to stdin.

attach_stdout: Option<bool>

Whether to attach to stdout.

cmd: Option<Vec<String>>

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

domainname: Option<String>

The domain name to use for the container.

entrypoint: Option<Vec<String>>

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

If the array consists of exactly one empty string ([""]) then the entry point is reset to system default (i.e., the entry point used by docker when there is no ENTRYPOINT instruction in the Dockerfile).

env: Option<Vec<String>>

A list of environment variables to set inside the container in the form ["VAR=value", ...]. A variable without = is removed from the environment, rather than to have an empty value.

exposed_ports: Option<HashMap<String, Value>>

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

{"<port>/<tcp|udp|sctp>": {}}

healthcheck: Option<HealthConfig>

host_config: Option<Value>

hostname: Option<String>

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

image: Option<String>

The name (or reference) of the image to use when creating the container, or which was used when the container was created.

labels: Option<HashMap<String, String>>

User-defined key/value metadata.

mac_address: Option<String>

MAC address of the container.

network_disabled: Option<bool>

Disable networking for the container.

networking_config: Option<NetworkingConfig>

on_build: Option<Vec<String>>

ONBUILD metadata that were defined in the image’s Dockerfile.

open_stdin: Option<bool>

Open stdin

shell: Option<Vec<String>>

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

stdin_once: Option<bool>

Close stdin after one attached client disconnects

stop_signal: Option<String>

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

stop_timeout: Option<isize>

Timeout to stop a container in seconds.

tty: Option<bool>

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

user: Option<String>

The user that commands are run as inside the container.

volumes: Option<HashMap<String, Value>>

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

working_dir: Option<String>

The working directory for commands to run in.

Trait Implementations

impl Clone for ContainerCreateBodyParam

fn clone(&self) -> ContainerCreateBodyParam

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ContainerCreateBodyParam

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ContainerCreateBodyParam

fn deserialize<__D>( __deserializer: __D, ) -> Result<ContainerCreateBodyParam, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ContainerCreateBodyParam

fn eq(&self, other: &ContainerCreateBodyParam) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ContainerCreateBodyParam

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ContainerCreateBodyParam