Struct NetworkCreateRequest

pub struct NetworkCreateRequest {

    pub name: String,
    pub driver: Option<String>,
    pub scope: Option<String>,
    pub internal: Option<bool>,
    pub attachable: Option<bool>,
    pub ingress: Option<bool>,
    pub config_only: Option<bool>,
    pub config_from: Option<ConfigReference>,
    pub ipam: Option<Ipam>,
    pub enable_ipv4: Option<bool>,
    pub enable_ipv6: Option<bool>,
    pub options: Option<HashMap<String, String>>,
    pub labels: Option<HashMap<String, String>>,
}

Fields

name: String

The network’s name.

driver: Option<String>

Name of the network driver plugin to use.

scope: Option<String>

The level at which the network exists (e.g. swarm for cluster-wide or local for machine level).

internal: Option<bool>

Restrict external access to the network.

attachable: Option<bool>

Globally scoped network is manually attachable by regular containers from workers in swarm mode.

ingress: Option<bool>

Ingress network is the network which provides the routing-mesh in swarm mode.

config_only: Option<bool>

Creates a config-only network. Config-only networks are placeholder networks for network configurations to be used by other networks. Config-only networks cannot be used directly to run containers or services.

config_from: Option<ConfigReference>

Specifies the source which will provide the configuration for this network. The specified network must be an existing config-only network; see ConfigOnly.

ipam: Option<Ipam>

Optional custom IP scheme for the network.

enable_ipv4: Option<bool>

Enable IPv4 on the network.

enable_ipv6: Option<bool>

Enable IPv6 on the network.

options: Option<HashMap<String, String>>

Network specific options to be used by the drivers.

labels: Option<HashMap<String, String>>

User-defined key/value metadata.

Trait Implementations

impl Clone for NetworkCreateRequest

fn clone(&self) -> NetworkCreateRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NetworkCreateRequest

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

Formats the value using the given formatter.

impl Default for NetworkCreateRequest

fn default() -> NetworkCreateRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NetworkCreateRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> From<CreateNetworkOptions<T>> for NetworkCreateRequest

where T: Into<String> + Eq + Hash,

fn from(opts: CreateNetworkOptions<T>) -> Self

Converts to this type from the input type.

impl PartialEq for NetworkCreateRequest

fn eq(&self, other: &NetworkCreateRequest) -> 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 NetworkCreateRequest

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 NetworkCreateRequest