Documentation ¶
Overview ¶
Package network is a generated protocol buffer package.
It is generated from these files:
pb/moby/network/network.proto
It has these top-level messages:
Address IPAM IPAMConfig EndpointIPAMConfig PeerInfo EndpointSettings Task ServiceInfo NetworkingConfig ConfigReference
Index ¶
- Constants
- Variables
- type Address
- type ConfigReference
- func (m *ConfigReference) DeepCopyChecked() (*ConfigReference, []error)
- func (*ConfigReference) Descriptor() ([]byte, []int)
- func (m *ConfigReference) ExportIntoDockerApiType() (tgt networktypes.ConfigReference)
- func (m *ConfigReference) GetNetwork() string
- func (*ConfigReference) ProtoMessage()
- func (m *ConfigReference) Reset()
- func (m *ConfigReference) String() string
- type EndpointIPAMConfig
- func (*EndpointIPAMConfig) Descriptor() ([]byte, []int)
- func (m *EndpointIPAMConfig) GetIpv4Address() string
- func (m *EndpointIPAMConfig) GetIpv6Address() string
- func (m *EndpointIPAMConfig) GetLinkLocalIps() []string
- func (*EndpointIPAMConfig) ProtoMessage()
- func (m *EndpointIPAMConfig) Reset()
- func (m *EndpointIPAMConfig) String() string
- type EndpointSettings
- func (*EndpointSettings) Descriptor() ([]byte, []int)
- func (m *EndpointSettings) GetAliases() []string
- func (m *EndpointSettings) GetDriverOpts() map[string]string
- func (m *EndpointSettings) GetEndpointId() string
- func (m *EndpointSettings) GetGateway() string
- func (m *EndpointSettings) GetGlobalIpv6Address() string
- func (m *EndpointSettings) GetGlobalIpv6PrefixLen() int32
- func (m *EndpointSettings) GetIpAddress() string
- func (m *EndpointSettings) GetIpPrefixLen() int32
- func (m *EndpointSettings) GetIpamConfig() *EndpointIPAMConfig
- func (m *EndpointSettings) GetIpv6Gateway() string
- func (m *EndpointSettings) GetLinks() []string
- func (m *EndpointSettings) GetMacAddress() string
- func (m *EndpointSettings) GetNetworkId() string
- func (*EndpointSettings) ProtoMessage()
- func (m *EndpointSettings) Reset()
- func (m *EndpointSettings) String() string
- type IPAM
- func (m *IPAM) DeepCopyChecked() (*IPAM, []error)
- func (*IPAM) Descriptor() ([]byte, []int)
- func (m *IPAM) ExportIntoDockerApiTypes() (tgt networktypes.IPAM)
- func (m *IPAM) GetConfig() []*IPAMConfig
- func (m *IPAM) GetDriver() string
- func (m *IPAM) GetOptions() map[string]string
- func (*IPAM) ProtoMessage()
- func (m *IPAM) Reset()
- func (m *IPAM) String() string
- type IPAMConfig
- func (*IPAMConfig) Descriptor() ([]byte, []int)
- func (m *IPAMConfig) GetAuxAddress() map[string]string
- func (m *IPAMConfig) GetGateway() string
- func (m *IPAMConfig) GetIpRange() string
- func (m *IPAMConfig) GetSubnet() string
- func (*IPAMConfig) ProtoMessage()
- func (m *IPAMConfig) Reset()
- func (m *IPAMConfig) String() string
- type NetworkingConfig
- func (m *NetworkingConfig) DeepCopyChecked() (*NetworkingConfig, []error)
- func (*NetworkingConfig) Descriptor() ([]byte, []int)
- func (m *NetworkingConfig) ExportIntoDockerApiType() (tgt *networktypes.NetworkingConfig)
- func (m *NetworkingConfig) GetEndpointsConfig() map[string]*EndpointSettings
- func (*NetworkingConfig) ProtoMessage()
- func (m *NetworkingConfig) Reset()
- func (m *NetworkingConfig) String() string
- type PeerInfo
- type ServiceInfo
- func (*ServiceInfo) Descriptor() ([]byte, []int)
- func (m *ServiceInfo) GetLocalLbIndex() int32
- func (m *ServiceInfo) GetPorts() []string
- func (m *ServiceInfo) GetTasks() []*Task
- func (m *ServiceInfo) GetVip() string
- func (*ServiceInfo) ProtoMessage()
- func (m *ServiceInfo) Reset()
- func (m *ServiceInfo) String() string
- type Task
Constants ¶
Variables ¶
Functions ¶
This section is empty.
Types ¶
type Address ¶
type Address struct { // Addr string Addr string `protobuf:"bytes,1,opt,name=addr,proto3" json:"addr,omitempty"` // PrefixLen int PrefixLen int32 `protobuf:"varint,2,opt,name=prefix_len,json=prefixLen,proto3" json:"prefix_len,omitempty"` }
Address represents an IP address type Address struct
func (*Address) Descriptor ¶
func (*Address) GetPrefixLen ¶
func (*Address) ProtoMessage ¶
func (*Address) ProtoMessage()
type ConfigReference ¶
type ConfigReference struct { // Network string Network string `protobuf:"bytes,1,opt,name=network,proto3" json:"network,omitempty"` }
ConfigReference specifies the source which provides a network's cconfiguration type ConfigReference struct
func (*ConfigReference) DeepCopyChecked ¶
func (m *ConfigReference) DeepCopyChecked() (*ConfigReference, []error)
func (*ConfigReference) Descriptor ¶
func (*ConfigReference) Descriptor() ([]byte, []int)
func (*ConfigReference) ExportIntoDockerApiType ¶
func (m *ConfigReference) ExportIntoDockerApiType() (tgt networktypes.ConfigReference)
func (*ConfigReference) GetNetwork ¶
func (m *ConfigReference) GetNetwork() string
func (*ConfigReference) ProtoMessage ¶
func (*ConfigReference) ProtoMessage()
func (*ConfigReference) Reset ¶
func (m *ConfigReference) Reset()
func (*ConfigReference) String ¶
func (m *ConfigReference) String() string
type EndpointIPAMConfig ¶
type EndpointIPAMConfig struct { // IPv4Address string `json:",omitempty"` Ipv4Address string `protobuf:"bytes,1,opt,name=ipv4_address,json=ipv4Address,proto3" json:"ipv4_address,omitempty"` // IPv6Address string `json:",omitempty"` Ipv6Address string `protobuf:"bytes,2,opt,name=ipv6_address,json=ipv6Address,proto3" json:"ipv6_address,omitempty"` // LinkLocalIPs []string `json:",omitempty"` LinkLocalIps []string `protobuf:"bytes,3,rep,name=link_local_ips,json=linkLocalIps" json:"link_local_ips,omitempty"` }
EndpointIPAMConfig represents IPAM configurations for the endpoint type EndpointIPAMConfig struct
func (*EndpointIPAMConfig) Descriptor ¶
func (*EndpointIPAMConfig) Descriptor() ([]byte, []int)
func (*EndpointIPAMConfig) GetIpv4Address ¶
func (m *EndpointIPAMConfig) GetIpv4Address() string
func (*EndpointIPAMConfig) GetIpv6Address ¶
func (m *EndpointIPAMConfig) GetIpv6Address() string
func (*EndpointIPAMConfig) GetLinkLocalIps ¶
func (m *EndpointIPAMConfig) GetLinkLocalIps() []string
func (*EndpointIPAMConfig) ProtoMessage ¶
func (*EndpointIPAMConfig) ProtoMessage()
func (*EndpointIPAMConfig) Reset ¶
func (m *EndpointIPAMConfig) Reset()
func (*EndpointIPAMConfig) String ¶
func (m *EndpointIPAMConfig) String() string
type EndpointSettings ¶
type EndpointSettings struct { // IPAMConfig *EndpointIPAMConfig // Configurations IpamConfig *EndpointIPAMConfig `protobuf:"bytes,1,opt,name=ipam_config,json=ipamConfig" json:"ipam_config,omitempty"` // Links []string Links []string `protobuf:"bytes,2,rep,name=links" json:"links,omitempty"` // Aliases []string Aliases []string `protobuf:"bytes,3,rep,name=aliases" json:"aliases,omitempty"` // NetworkID string // Operational data NetworkId string `protobuf:"bytes,4,opt,name=network_id,json=networkId,proto3" json:"network_id,omitempty"` // EndpointID string EndpointId string `protobuf:"bytes,5,opt,name=endpoint_id,json=endpointId,proto3" json:"endpoint_id,omitempty"` // Gateway string Gateway string `protobuf:"bytes,6,opt,name=gateway,proto3" json:"gateway,omitempty"` // IPAddress string IpAddress string `protobuf:"bytes,7,opt,name=ip_address,json=ipAddress,proto3" json:"ip_address,omitempty"` // IPPrefixLen int IpPrefixLen int32 `protobuf:"varint,8,opt,name=ip_prefix_len,json=ipPrefixLen,proto3" json:"ip_prefix_len,omitempty"` // IPv6Gateway string Ipv6Gateway string `protobuf:"bytes,9,opt,name=ipv6_gateway,json=ipv6Gateway,proto3" json:"ipv6_gateway,omitempty"` // GlobalIPv6Address string GlobalIpv6Address string `protobuf:"bytes,10,opt,name=global_ipv6_address,json=globalIpv6Address,proto3" json:"global_ipv6_address,omitempty"` // GlobalIPv6PrefixLen int GlobalIpv6PrefixLen int32 `protobuf:"varint,11,opt,name=global_ipv6_prefix_len,json=globalIpv6PrefixLen,proto3" json:"global_ipv6_prefix_len,omitempty"` // MacAddress string MacAddress string `protobuf:"bytes,12,opt,name=mac_address,json=macAddress,proto3" json:"mac_address,omitempty"` // DriverOpts map[string]string DriverOpts map[string]string `` /* 173-byte string literal not displayed */ }
EndpointSettings stores the network endpoint details type EndpointSettings struct
func (*EndpointSettings) Descriptor ¶
func (*EndpointSettings) Descriptor() ([]byte, []int)
func (*EndpointSettings) GetAliases ¶
func (m *EndpointSettings) GetAliases() []string
func (*EndpointSettings) GetDriverOpts ¶
func (m *EndpointSettings) GetDriverOpts() map[string]string
func (*EndpointSettings) GetEndpointId ¶
func (m *EndpointSettings) GetEndpointId() string
func (*EndpointSettings) GetGateway ¶
func (m *EndpointSettings) GetGateway() string
func (*EndpointSettings) GetGlobalIpv6Address ¶
func (m *EndpointSettings) GetGlobalIpv6Address() string
func (*EndpointSettings) GetGlobalIpv6PrefixLen ¶
func (m *EndpointSettings) GetGlobalIpv6PrefixLen() int32
func (*EndpointSettings) GetIpAddress ¶
func (m *EndpointSettings) GetIpAddress() string
func (*EndpointSettings) GetIpPrefixLen ¶
func (m *EndpointSettings) GetIpPrefixLen() int32
func (*EndpointSettings) GetIpamConfig ¶
func (m *EndpointSettings) GetIpamConfig() *EndpointIPAMConfig
func (*EndpointSettings) GetIpv6Gateway ¶
func (m *EndpointSettings) GetIpv6Gateway() string
func (*EndpointSettings) GetLinks ¶
func (m *EndpointSettings) GetLinks() []string
func (*EndpointSettings) GetMacAddress ¶
func (m *EndpointSettings) GetMacAddress() string
func (*EndpointSettings) GetNetworkId ¶
func (m *EndpointSettings) GetNetworkId() string
func (*EndpointSettings) ProtoMessage ¶
func (*EndpointSettings) ProtoMessage()
func (*EndpointSettings) Reset ¶
func (m *EndpointSettings) Reset()
func (*EndpointSettings) String ¶
func (m *EndpointSettings) String() string
type IPAM ¶
type IPAM struct { // Driver string Driver string `protobuf:"bytes,1,opt,name=driver,proto3" json:"driver,omitempty"` // Options map[string]string //Per network IPAM driver options Options map[string]string `` /* 148-byte string literal not displayed */ // Config []IPAMConfig Config []*IPAMConfig `protobuf:"bytes,3,rep,name=config" json:"config,omitempty"` }
IPAM represents IP Address Management type IPAM struct
func (*IPAM) DeepCopyChecked ¶
func (*IPAM) Descriptor ¶
func (*IPAM) ExportIntoDockerApiTypes ¶
func (m *IPAM) ExportIntoDockerApiTypes() (tgt networktypes.IPAM)
func (*IPAM) GetConfig ¶
func (m *IPAM) GetConfig() []*IPAMConfig
func (*IPAM) GetOptions ¶
func (*IPAM) ProtoMessage ¶
func (*IPAM) ProtoMessage()
type IPAMConfig ¶
type IPAMConfig struct { // Subnet string `json:",omitempty"` Subnet string `protobuf:"bytes,1,opt,name=subnet,proto3" json:"subnet,omitempty"` // IPRange string `json:",omitempty"` IpRange string `protobuf:"bytes,2,opt,name=ip_range,json=ipRange,proto3" json:"ip_range,omitempty"` // Gateway string `json:",omitempty"` Gateway string `protobuf:"bytes,3,opt,name=gateway,proto3" json:"gateway,omitempty"` // AuxAddress map[string]string `json:"AuxiliaryAddresses,omitempty" AuxAddress map[string]string `` /* 172-byte string literal not displayed */ }
IPAMConfig represents IPAM configurations type IPAMConfig struct
func (*IPAMConfig) Descriptor ¶
func (*IPAMConfig) Descriptor() ([]byte, []int)
func (*IPAMConfig) GetAuxAddress ¶
func (m *IPAMConfig) GetAuxAddress() map[string]string
func (*IPAMConfig) GetGateway ¶
func (m *IPAMConfig) GetGateway() string
func (*IPAMConfig) GetIpRange ¶
func (m *IPAMConfig) GetIpRange() string
func (*IPAMConfig) GetSubnet ¶
func (m *IPAMConfig) GetSubnet() string
func (*IPAMConfig) ProtoMessage ¶
func (*IPAMConfig) ProtoMessage()
func (*IPAMConfig) Reset ¶
func (m *IPAMConfig) Reset()
func (*IPAMConfig) String ¶
func (m *IPAMConfig) String() string
type NetworkingConfig ¶
type NetworkingConfig struct { // EndpointsConfig map[string]*EndpointSettings // Endpoint configs for each connecting network EndpointsConfig map[string]*EndpointSettings `` /* 180-byte string literal not displayed */ }
NetworkingConfig represents the container's networking configuration for each of its interfaces Carries the networking configs specified in the 'docker run' and 'docker network connect' commands type NetworkingConfig struct
func (*NetworkingConfig) DeepCopyChecked ¶
func (m *NetworkingConfig) DeepCopyChecked() (*NetworkingConfig, []error)
func (*NetworkingConfig) Descriptor ¶
func (*NetworkingConfig) Descriptor() ([]byte, []int)
func (*NetworkingConfig) ExportIntoDockerApiType ¶
func (m *NetworkingConfig) ExportIntoDockerApiType() (tgt *networktypes.NetworkingConfig)
func (*NetworkingConfig) GetEndpointsConfig ¶
func (m *NetworkingConfig) GetEndpointsConfig() map[string]*EndpointSettings
func (*NetworkingConfig) ProtoMessage ¶
func (*NetworkingConfig) ProtoMessage()
func (*NetworkingConfig) Reset ¶
func (m *NetworkingConfig) Reset()
func (*NetworkingConfig) String ¶
func (m *NetworkingConfig) String() string
type PeerInfo ¶
type PeerInfo struct { // Name string Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // IP string Ip string `protobuf:"bytes,2,opt,name=ip,proto3" json:"ip,omitempty"` }
PeerInfo represents one peer of an overlay network type PeerInfo struct
func (*PeerInfo) Descriptor ¶
func (*PeerInfo) ProtoMessage ¶
func (*PeerInfo) ProtoMessage()
type ServiceInfo ¶
type ServiceInfo struct { // VIP string Vip string `protobuf:"bytes,1,opt,name=vip,proto3" json:"vip,omitempty"` // Ports []string Ports []string `protobuf:"bytes,2,rep,name=ports" json:"ports,omitempty"` // LocalLBIndex int LocalLbIndex int32 `protobuf:"varint,3,opt,name=local_lb_index,json=localLbIndex,proto3" json:"local_lb_index,omitempty"` // Tasks []Task Tasks []*Task `protobuf:"bytes,4,rep,name=tasks" json:"tasks,omitempty"` }
ServiceInfo represents service parameters with the list of service's tasks type ServiceInfo struct
func (*ServiceInfo) Descriptor ¶
func (*ServiceInfo) Descriptor() ([]byte, []int)
func (*ServiceInfo) GetLocalLbIndex ¶
func (m *ServiceInfo) GetLocalLbIndex() int32
func (*ServiceInfo) GetPorts ¶
func (m *ServiceInfo) GetPorts() []string
func (*ServiceInfo) GetTasks ¶
func (m *ServiceInfo) GetTasks() []*Task
func (*ServiceInfo) GetVip ¶
func (m *ServiceInfo) GetVip() string
func (*ServiceInfo) ProtoMessage ¶
func (*ServiceInfo) ProtoMessage()
func (*ServiceInfo) Reset ¶
func (m *ServiceInfo) Reset()
func (*ServiceInfo) String ¶
func (m *ServiceInfo) String() string
type Task ¶
type Task struct { // Name string Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // EndpointID string EndpointId string `protobuf:"bytes,2,opt,name=endpoint_id,json=endpointId,proto3" json:"endpoint_id,omitempty"` // EndpointIP string EndpointIp string `protobuf:"bytes,3,opt,name=endpoint_ip,json=endpointIp,proto3" json:"endpoint_ip,omitempty"` // Info map[string]string Info map[string]string `` /* 142-byte string literal not displayed */ }
Task carries the information about one backend task type Task struct
func (*Task) Descriptor ¶
func (*Task) GetEndpointId ¶
func (*Task) GetEndpointIp ¶
func (*Task) ProtoMessage ¶
func (*Task) ProtoMessage()