package
0.12.0
Repository: https://github.com/runfinch/finch-daemon.git
Documentation: pkg.go.dev

# Functions

NewCreateNetworkRequest is a utility function for instantiating create network requests with both required and optional configuration.
WithAttachable enables/disables manual container attachment.
WithDriver configures the name of the network driver to use.
WithEnableIPv6 enables/disables Internet Protocol version 6 (IPv6) networking.
WithIngress enables/disables creating ingress network with routing-mesh in swarm mode.
WithInternal enables/disables internal-only access to the network.
WithIPAM configures the IP Address Management (IPAM) driver configuration and options.
WithLabels configures user-defined key-value metadata on a network.
WithOptions configures network driver specific options.

# Structs

AttachOptions defines the available options for the container attach call.
BuildResult contains the image id of a successful build From https://github.com/moby/moby/blob/v24.0.2/api/types/types.go#L774-L777.
ComponentVersion describes the version information for a specific component.
Container mimics a `docker container inspect` object.
ContainerConfig is from https://github.com/moby/moby/blob/v24.0.2/api/types/container/config.go#L64-L96.
No description provided by the author
HostConfig is from https://github.com/moby/moby/blob/v24.0.2/api/types/container/hostconfig.go#L376-L436.
No description provided by the author
CPUStats aggregates and wraps all CPU related info of container From https://github.com/moby/moby/blob/v24.0.2/api/types/stats.go#L42-L55.
ExecConfig is from https://github.com/moby/moby/blob/454b6a7cf5187d1153159e5fe07f4b25c7a95e7f/api/types/configs.go#L30-L45.
No description provided by the author
ExecInspect holds information about a running process started with docker exec.
ExecProcessConfig holds information about the exec process running on the host.
No description provided by the author
ExecStartCheck is from https://github.com/moby/moby/blob/454b6a7cf5187d1153159e5fe07f4b25c7a95e7f/api/types/types.go#L231-L240.
No description provided by the author
ImageSummary models a single item in the list response to /images/json in the Docker API.
IPAM is a data class for simple JSON marshalling/unmarshalling of IP Address Management (IPAM) network configuration.
LogConfig represents the logging configuration of the container.
LogsOptions defines the available options for the container logs call.
NetworkCreateRequest is a data class for simple JSON marshalling/unmarshalling of /networks/create messages into HTTP Post requests.
NetworkCreateResponse is a data class for simple JSON marshalling/unmarshalling of /networks/create messages into HTTP Post responses.
NetworkInspectResponse models a single network object in response to /networks/{id}.
PushResult contains the tag, manifest digest, and manifest size from the push.
PutArchiveOptions defines the parameters for [PutContainerArchive API](https://docs.docker.com/engine/api/v1.41/#tag/Container/operation/PutContainerArchive).
RestartPolicy represents the restart policies of the container.
Stats is Ultimate struct aggregating all types of stats of one container From https://github.com/moby/moby/blob/v24.0.2/api/types/stats.go#L152-L170.
StatsJSON is the JSON response for container stats api From https://github.com/moby/moby/blob/v24.0.2/api/types/stats.go#L172-L181.
VersionedRouter wraps the router to provide a router that can redirect routes to either a versioned path or a non-versioned path.
VersionInfo contains the response of /version api.
VolumesListResponse is the response object expected by GET /volumes https://docs.docker.com/engine/api/v1.40/#tag/Volume.

# Type aliases

NetworkCreateOption is a utility type for setting create network configuration on requests via options.
No description provided by the author