Documentation
¶
Overview ¶
Package types catalogs github.com/moby/moby/api/types/network for wrapping by containerkit.
Code generated by go run ./tools/gencatalog; DO NOT EDIT.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/network
Each identifier keeps the exact upstream type name. Domain isolation lives in the import path (internal/engine/network/types), not in renamed aliases.
Index ¶
- type ConfigReference
- type ConnectRequest
- type CreateRequest
- type CreateResponse
- type DisconnectRequest
- type EndpointIPAMConfig
- type EndpointResource
- type EndpointSettings
- type HardwareAddr
- type IPAM
- type IPAMConfig
- type IPAMStatus
- type IPProtocol
- type Inspect
- type Network
- type NetworkingConfig
- type PeerInfo
- type Port
- type PortBinding
- type PortMap
- type PortRange
- type PortSet
- type PruneReport
- type ServiceInfo
- type Status
- type SubnetStatus
- type SubnetStatuses
- type Summary
- type Task
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ConfigReference ¶
type ConfigReference = network.ConfigReference
ConfigReference wraps network.ConfigReference.
ConfigReference The config-only network source to provide the configuration for this network.
swagger:model ConfigReference
Source: https://pkg.go.dev/github.com/moby/moby/api/types/network#ConfigReference GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/network/config_reference.go Kind: struct Usecase: wrap the Engine API type ConfigReference from network.
type ConnectRequest ¶
type ConnectRequest = network.ConnectRequest
ConnectRequest wraps network.ConnectRequest.
ConnectRequest NetworkConnectRequest represents the data to be used to connect a container to a network.
swagger:model ConnectRequest
Source: https://pkg.go.dev/github.com/moby/moby/api/types/network#ConnectRequest GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/network/connect_request.go Kind: struct Usecase: wrap the Engine API type ConnectRequest from network.
type CreateRequest ¶
type CreateRequest = network.CreateRequest
CreateRequest wraps network.CreateRequest.
CreateRequest is the request message sent to the server for network create call.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/network#CreateRequest GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/network/network_types.go Kind: struct Usecase: wrap the Engine API type CreateRequest from network.
type CreateResponse ¶
type CreateResponse = network.CreateResponse
CreateResponse wraps network.CreateResponse.
CreateResponse NetworkCreateResponse ¶
OK response to NetworkCreate operation ¶
swagger:model CreateResponse
Source: https://pkg.go.dev/github.com/moby/moby/api/types/network#CreateResponse GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/network/create_response.go Kind: struct Usecase: wrap the Engine API type CreateResponse from network.
type DisconnectRequest ¶
type DisconnectRequest = network.DisconnectRequest
DisconnectRequest wraps network.DisconnectRequest.
DisconnectRequest NetworkDisconnectRequest represents the data to be used to disconnect a container from a network.
swagger:model DisconnectRequest
Source: https://pkg.go.dev/github.com/moby/moby/api/types/network#DisconnectRequest GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/network/disconnect_request.go Kind: struct Usecase: wrap the Engine API type DisconnectRequest from network.
type EndpointIPAMConfig ¶
type EndpointIPAMConfig = network.EndpointIPAMConfig
EndpointIPAMConfig wraps network.EndpointIPAMConfig.
EndpointIPAMConfig represents IPAM configurations for the endpoint ¶
Source: https://pkg.go.dev/github.com/moby/moby/api/types/network#EndpointIPAMConfig GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/network/endpoint.go Kind: struct References: net/netip.Addr Usecase: wrap the Engine API type EndpointIPAMConfig from network.
type EndpointResource ¶
type EndpointResource = network.EndpointResource
EndpointResource wraps network.EndpointResource.
EndpointResource contains network resources allocated and used for a container in a network.
swagger:model EndpointResource
Source: https://pkg.go.dev/github.com/moby/moby/api/types/network#EndpointResource GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/network/endpoint_resource.go Kind: struct References: net/netip.Prefix Usecase: wrap the Engine API type EndpointResource from network.
type EndpointSettings ¶
type EndpointSettings = network.EndpointSettings
EndpointSettings wraps network.EndpointSettings.
EndpointSettings stores the network endpoint details ¶
Source: https://pkg.go.dev/github.com/moby/moby/api/types/network#EndpointSettings GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/network/endpoint.go Kind: struct References: net/netip.Addr Usecase: wrap the Engine API type EndpointSettings from network.
type HardwareAddr ¶
type HardwareAddr = network.HardwareAddr
HardwareAddr wraps network.HardwareAddr.
A HardwareAddr represents a physical hardware address. It implements encoding.TextMarshaler and encoding.TextUnmarshaler in the absence of go.dev/issue/29678.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/network#HardwareAddr GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/network/hwaddr.go Kind: named:net.HardwareAddr Underlying: net.HardwareAddr References: net.HardwareAddr Usecase: wrap the Engine API type HardwareAddr from network.
type IPAM ¶
IPAM wraps network.IPAM.
IPAM represents IP Address Management ¶
Source: https://pkg.go.dev/github.com/moby/moby/api/types/network#IPAM GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/network/ipam.go Kind: struct Usecase: wrap the Engine API type IPAM from network.
type IPAMConfig ¶
type IPAMConfig = network.IPAMConfig
IPAMConfig wraps network.IPAMConfig.
IPAMConfig represents IPAM configurations ¶
Source: https://pkg.go.dev/github.com/moby/moby/api/types/network#IPAMConfig GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/network/ipam.go Kind: struct References: net/netip.Addr, net/netip.Prefix Usecase: wrap the Engine API type IPAMConfig from network.
type IPAMStatus ¶
type IPAMStatus = network.IPAMStatus
IPAMStatus wraps network.IPAMStatus.
IPAMStatus IPAM status ¶
swagger:model IPAMStatus
Source: https://pkg.go.dev/github.com/moby/moby/api/types/network#IPAMStatus GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/network/ipam_status.go Kind: struct Usecase: wrap the Engine API type IPAMStatus from network.
type IPProtocol ¶
type IPProtocol = network.IPProtocol
IPProtocol wraps network.IPProtocol.
IPProtocol represents a network protocol for a port.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/network#IPProtocol GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/network/port.go Kind: named:string Underlying: string Usecase: wrap the Engine API type IPProtocol from network.
type Inspect ¶
Inspect wraps network.Inspect.
Inspect The body of the "get network" http response message.
swagger:model Inspect
Source: https://pkg.go.dev/github.com/moby/moby/api/types/network#Inspect GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/network/inspect.go Kind: struct Usecase: wrap the Engine API type Inspect from network.
type Network ¶
Network wraps network.Network.
Network network ¶
swagger:model Network
Source: https://pkg.go.dev/github.com/moby/moby/api/types/network#Network GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/network/network.go Kind: struct References: time.Time Usecase: wrap the Engine API type Network from network.
type NetworkingConfig ¶
type NetworkingConfig = network.NetworkingConfig
NetworkingConfig wraps network.NetworkingConfig.
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
Source: https://pkg.go.dev/github.com/moby/moby/api/types/network#NetworkingConfig GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/network/network_types.go Kind: struct Usecase: wrap the Engine API type NetworkingConfig from network.
type PeerInfo ¶
PeerInfo wraps network.PeerInfo.
PeerInfo represents one peer of an overlay network.
swagger:model PeerInfo
Source: https://pkg.go.dev/github.com/moby/moby/api/types/network#PeerInfo GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/network/peer_info.go Kind: struct References: net/netip.Addr Usecase: wrap the Engine API type PeerInfo from network.
type Port ¶
Port wraps network.Port.
Port is a type representing a single port number and protocol in the format "<portnum>/[<proto>]".
The zero port value, i.e. Port{}, is invalid; use [ParsePort] to create a valid Port value.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/network#Port GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/network/port.go Kind: struct References: unique.Handle Usecase: wrap the Engine API type Port from network.
type PortBinding ¶
type PortBinding = network.PortBinding
PortBinding wraps network.PortBinding.
PortBinding represents a binding between a Host IP address and a Host Port.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/network#PortBinding GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/network/port.go Kind: struct References: net/netip.Addr Usecase: wrap the Engine API type PortBinding from network.
type PortMap ¶
PortMap wraps network.PortMap.
PortMap is a collection of PortBinding indexed by Port.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/network#PortMap GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/network/port.go Kind: map Underlying: map[Port][]PortBinding Usecase: wrap the Engine API type PortMap from network.
type PortRange ¶
PortRange wraps network.PortRange.
PortRange represents a range of port numbers and a protocol in the format "8000-9000/tcp".
The zero port range value, i.e. PortRange{}, is invalid; use [ParsePortRange] to create a valid PortRange value.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/network#PortRange GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/network/port.go Kind: struct References: unique.Handle Usecase: wrap the Engine API type PortRange from network.
type PortSet ¶
PortSet wraps network.PortSet.
PortSet is a collection of structs indexed by Port.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/network#PortSet GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/network/port.go Kind: map Underlying: map[Port]struct{} Usecase: wrap the Engine API type PortSet from network.
type PruneReport ¶
type PruneReport = network.PruneReport
PruneReport wraps network.PruneReport.
PruneReport contains the response for Engine API: POST "/networks/prune"
Source: https://pkg.go.dev/github.com/moby/moby/api/types/network#PruneReport GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/network/network_types.go Kind: struct Usecase: wrap the Engine API type PruneReport from network.
type ServiceInfo ¶
type ServiceInfo = network.ServiceInfo
ServiceInfo wraps network.ServiceInfo.
ServiceInfo represents service parameters with the list of service's tasks ¶
swagger:model ServiceInfo
Source: https://pkg.go.dev/github.com/moby/moby/api/types/network#ServiceInfo GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/network/service_info.go Kind: struct References: net/netip.Addr Usecase: wrap the Engine API type ServiceInfo from network.
type Status ¶
Status wraps network.Status.
Status provides runtime information about the network such as the number of allocated IPs.
swagger:model Status
Source: https://pkg.go.dev/github.com/moby/moby/api/types/network#Status GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/network/status.go Kind: struct Usecase: wrap the Engine API type Status from network.
type SubnetStatus ¶
type SubnetStatus = network.SubnetStatus
SubnetStatus wraps network.SubnetStatus.
SubnetStatus subnet status ¶
swagger:model SubnetStatus
Source: https://pkg.go.dev/github.com/moby/moby/api/types/network#SubnetStatus GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/network/subnet_status.go Kind: struct Usecase: wrap the Engine API type SubnetStatus from network.
type SubnetStatuses ¶
type SubnetStatuses = network.SubnetStatuses
SubnetStatuses wraps network.SubnetStatuses.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/network#SubnetStatuses GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/network/ipam.go Kind: map Underlying: map[netip.Prefix]SubnetStatus References: net/netip.Prefix Usecase: wrap the Engine API type SubnetStatuses from network.
type Summary ¶
Summary wraps network.Summary.
Summary Network list response item ¶
swagger:model Summary
Source: https://pkg.go.dev/github.com/moby/moby/api/types/network#Summary GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/network/summary.go Kind: struct Usecase: wrap the Engine API type Summary from network.
type Task ¶
Task wraps network.Task.
Task carries the information about one backend task ¶
swagger:model Task
Source: https://pkg.go.dev/github.com/moby/moby/api/types/network#Task GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/network/task.go Kind: struct References: net/netip.Addr Usecase: wrap the Engine API type Task from network.