Help us shape the future of Go! Take the 2026 Go Developer Survey

network

package
v2.17.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 25, 2026 License: BSD-3-Clause Imports: 41 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func RegisterNetworks

func RegisterNetworks(api huma.API, networkSvc *NetworkService, dockerSvc *docker.DockerClientService, activitySvc *activity.ActivityService, appCtx handlerutil.ActivityAppContext)

RegisterNetworks registers network endpoints.

Types

type ConnectContainerInput added in v2.9.0

type ConnectContainerInput struct {
	EnvironmentID string `path:"id" doc:"Environment ID"`
	NetworkID     string `path:"networkId" doc:"Network ID"`
	Body          networktypes.ConnectContainerRequest
}

type CreateNetworkInput

type CreateNetworkInput struct {
	EnvironmentID string `path:"id" doc:"Environment ID"`
	Body          networktypes.CreateRequest
}

type DeleteNetworkInput

type DeleteNetworkInput struct {
	EnvironmentID string `path:"id" doc:"Environment ID"`
	NetworkID     string `path:"networkId" doc:"Network ID"`
}

type DisconnectContainerInput added in v2.9.0

type DisconnectContainerInput struct {
	EnvironmentID string `path:"id" doc:"Environment ID"`
	NetworkID     string `path:"networkId" doc:"Network ID"`
	Body          networktypes.DisconnectContainerRequest
}

type GetNetworkCountsInput

type GetNetworkCountsInput struct {
	EnvironmentID string `path:"id" doc:"Environment ID"`
}

type GetNetworkInput

type GetNetworkInput struct {
	EnvironmentID string `path:"id" doc:"Environment ID"`
	NetworkID     string `path:"networkId" doc:"Network ID"`
	Sort          string `query:"sort" default:"name"`
	Order         string `query:"order" default:"asc"`
}

type GetNetworkTopologyInput

type GetNetworkTopologyInput struct {
	EnvironmentID string `path:"id" doc:"Environment ID"`
}

type ListNetworksInput

type ListNetworksInput struct {
	EnvironmentID string `path:"id" doc:"Environment ID"`
	Search        string `query:"search" doc:"Search query"`
	Sort          string `query:"sort" doc:"Column to sort by"`
	Order         string `query:"order" default:"asc" doc:"Sort direction (asc or desc)"`
	Start         int    `query:"start" default:"0" doc:"Start index for pagination"`
	Limit         int    `query:"limit" default:"20" doc:"Number of items per page"`
	InUse         string `query:"inUse" doc:"Filter by in-use status (true/false)"`
}

type NetworkHandler

type NetworkHandler struct {
	// contains filtered or unexported fields
}

func (*NetworkHandler) ConnectContainer added in v2.9.0

func (*NetworkHandler) CreateNetwork

func (*NetworkHandler) DeleteNetwork

func (*NetworkHandler) DisconnectContainer added in v2.9.0

func (*NetworkHandler) GetNetwork

func (*NetworkHandler) GetNetworkCounts

func (*NetworkHandler) GetNetworkTopology

func (*NetworkHandler) ListNetworks

func (h *NetworkHandler) ListNetworks(ctx context.Context, input *ListNetworksInput) (*ListNetworksOutput, error)

func (*NetworkHandler) PruneNetworks

type NetworkService

type NetworkService struct {
	// contains filtered or unexported fields
}

func NewNetworkService

func NewNetworkService(db *database.DB, dockerService *dockerInternal.DockerClientService, eventService *event.EventService) *NetworkService

func (*NetworkService) AggregateNetworks added in v2.16.1

func (*NetworkService) ConnectContainer added in v2.9.0

func (s *NetworkService) ConnectContainer(ctx context.Context, networkID string, req networktypes.ConnectContainerRequest, user usertypes.Actor) error

ConnectContainer connects a container to a network without recreating it.

func (*NetworkService) CreateNetwork

func (*NetworkService) DisconnectContainer added in v2.9.0

func (s *NetworkService) DisconnectContainer(ctx context.Context, networkID string, req networktypes.DisconnectContainerRequest, user usertypes.Actor) error

DisconnectContainer disconnects a container from a network.

func (*NetworkService) GetNetworkByID

func (s *NetworkService) GetNetworkByID(ctx context.Context, id string) (*network.Inspect, error)

func (*NetworkService) GetNetworkTopology

func (s *NetworkService) GetNetworkTopology(ctx context.Context) (*networktypes.Topology, error)

GetNetworkTopology returns a short-TTL cached topology shared by all callers; it must not be mutated.

func (*NetworkService) PruneNetworks

func (s *NetworkService) PruneNetworks(ctx context.Context) (*network.PruneReport, error)

func (*NetworkService) RemoveNetwork

func (s *NetworkService) RemoveNetwork(ctx context.Context, id string, user usertypes.Actor) error

type PruneNetworksInput

type PruneNetworksInput struct {
	EnvironmentID string `path:"id" doc:"Environment ID"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL