package
0.0.0-20250130204033-e82d90384e5b
Repository: https://github.com/laurentgoderre/moby.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
Package backend includes types to send information to server backends.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Package filters provides tools for encoding a mapping of keys to a set of multiple values.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

NewHijackedResponse initializes a [HijackedResponse] type.

# Constants

BuildCacheObject represents a build-cache DiskUsageObject.
BuilderBuildKit is builder based on moby/buildkit project.
BuilderV1 is the first generation builder in docker daemon.
ContainerObject represents a container DiskUsageObject.
Deprecated: use [container.Healthy].
ImageObject represents an image DiskUsageObject.
MediaTypeMultiplexedStream is vendor specific MIME-Type set for stdin/stdout/stderr multiplexed streams.
MediaTypeRawStream is vendor specific MIME-Type set for raw TTY streams.
Deprecated: use [container.NoHealthcheck].
Values for RegistryAuthFrom in ServiceUpdateOptions.
Values for RegistryAuthFrom in ServiceUpdateOptions.
Deprecated: use [container.Starting].
Deprecated: use [container.Unhealthy].
VolumeObject represents a volume DiskUsageObject.

# Structs

BuildCache contains information about a build cache record.
BuildCachePruneOptions hold parameters to prune the build cache.
BuildCachePruneReport contains the response for Engine API: POST "/build/prune".
BuildResult contains the image id of a successful build.
ComponentVersion describes the version information for a specific component.
ConfigCreateResponse contains the information returned to a client on the creation of a new config.
ConfigListOptions holds parameters to list configs.
DiskUsage contains response of Engine API: GET "/system/df".
DiskUsageOptions holds parameters for system disk usage query.
ErrorResponse Represents an error.
HijackedResponse holds connection information for a hijacked request.
IDResponse Response to an API call that returns just an Id swagger:model IdResponse.
ImageBuildOptions holds the information necessary to build images.
ImageBuildOutput defines configuration for exporting a build result.
ImageBuildResponse holds information returned by a server after building an image.
NodeListOptions holds parameters to list nodes with.
NodeRemoveOptions holds parameters to remove nodes with.
Ping contains response of Engine API: GET "/_ping".
Plugin A plugin for the Engine API swagger:model Plugin.
PluginConfig The config of a plugin.
PluginConfigArgs plugin config args swagger:model PluginConfigArgs.
PluginConfigInterface The interface between Docker and the plugin swagger:model PluginConfigInterface.
PluginConfigLinux plugin config linux swagger:model PluginConfigLinux.
PluginConfigNetwork plugin config network swagger:model PluginConfigNetwork.
PluginConfigRootfs plugin config rootfs swagger:model PluginConfigRootfs.
PluginConfigUser plugin config user swagger:model PluginConfigUser.
PluginCreateOptions hold all options to plugin create.
PluginDevice plugin device swagger:model PluginDevice.
PluginDisableOptions holds parameters to disable plugins.
PluginEnableOptions holds parameters to enable plugins.
PluginEnv plugin env swagger:model PluginEnv.
PluginInstallOptions holds parameters to install a plugin.
PluginInterfaceType plugin interface type swagger:model PluginInterfaceType.
PluginMount plugin mount swagger:model PluginMount.
PluginPrivilege describes a permission the user has to accept upon installing a plugin.
PluginRemoveOptions holds parameters to remove plugins.
PluginSettings Settings that can be modified by users.
PushResult contains the tag, manifest digest, and manifest size from the push.
SecretCreateResponse contains the information returned to a client on the creation of a new secret.
SecretListOptions holds parameters to list secrets.
ServiceCreateOptions contains the options to use when creating a service.
ServiceInspectOptions holds parameters related to the "service inspect" operation.
ServiceListOptions holds parameters to list services with.
ServiceUpdateOptions contains the options to be used for updating services.
SwarmUnlockKeyResponse contains the response for Engine API: GET /swarm/unlockkey.
TaskListOptions holds parameters to list tasks with.
Version contains response of Engine API: GET "/version".

# Interfaces

CloseWriter is an interface that implements structs that close input streams to prevent from writing.

# Type aliases

BuilderVersion sets the version of underlying builder to use.
Container contains response of Engine API: GET "/containers/json" Deprecated: use [container.Summary].
ContainerJSON is the response for the GET "/containers/{name:.*}/json" endpoint.
ContainerJSONBase contains response of Engine API GET "/containers/{name:.*}/json" for API version 1.18 and older.
ContainerState stores container's running state Deprecated: use [container.State].
DefaultNetworkSettings holds network information during the 2 release deprecation period.
DiskUsageObject represents an object type used for disk usage query filtering.
GraphDriverData Information about the storage driver used to store the container's and image's filesystem.
Health stores information about the container's healthcheck results.
HealthcheckResult stores information about a single run of a healthcheck probe.
ImageInspect contains response of Engine API: GET "/images/{name:.*}/json" Deprecated: use [image.InspectResponse].
MountPoint represents a mount point configuration inside the container.
NetworkSettings exposes the network settings in the api.
NetworkSettingsBase holds networking state for a container when inspecting it.
PluginPrivileges is a list of PluginPrivilege.
PluginsListResponse contains the response for the Engine API.
Port An open port on a container Deprecated: use [container.Port].
RequestPrivilegeFunc is a function interface that clients can supply to retry operations after getting an authorization error.
RootFS returns Image's RootFS description including the layer IDs.
SummaryNetworkSettings provides a summary of container's networks in /containers/json.