types
packageThis package is not in the latest version of its module.
Details
Valid go.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Index¶
- Constants
- type BuildCachedeprecated
- type BuildCachePruneOptionsdeprecated
- type BuildCachePruneReportdeprecated
- type BuildResultdeprecated
- type BuilderVersiondeprecated
- type CloseWriter
- type ComponentVersion
- type ConfigCreateResponsedeprecated
- type ConfigListOptionsdeprecated
- type Containerdeprecated
- type ContainerJSONdeprecated
- type ContainerJSONBasedeprecated
- type ContainerStatedeprecated
- type DefaultNetworkSettingsdeprecated
- type DiskUsage
- type DiskUsageObject
- type DiskUsageOptions
- type ErrorResponse
- type GraphDriverDatadeprecated
- type Healthdeprecated
- type HealthcheckResultdeprecated
- type HijackedResponse
- type IDResponsedeprecated
- type ImageBuildOptionsdeprecated
- type ImageBuildOutputdeprecated
- type ImageBuildResponsedeprecated
- type ImageInspectdeprecated
- type MountPointdeprecated
- type NetworkSettingsdeprecated
- type NetworkSettingsBasedeprecated
- type NodeListOptionsdeprecated
- type NodeRemoveOptionsdeprecated
- type Ping
- type Plugin
- type PluginConfig
- type PluginConfigArgs
- type PluginConfigInterface
- type PluginConfigLinux
- type PluginConfigNetwork
- type PluginConfigRootfs
- type PluginConfigUser
- type PluginCreateOptions
- type PluginDevice
- type PluginDisableOptions
- type PluginEnableOptions
- type PluginEnv
- type PluginInstallOptions
- type PluginInterfaceType
- type PluginMount
- type PluginPrivilege
- type PluginPrivileges
- type PluginRemoveOptions
- type PluginSettings
- type PluginsListResponse
- type Portdeprecated
- type PushResult
- type RequestPrivilegeFuncdeprecated
- type RootFSdeprecated
- type SecretCreateResponsedeprecated
- type SecretListOptionsdeprecated
- type ServiceCreateOptionsdeprecated
- type ServiceInspectOptionsdeprecated
- type ServiceListOptionsdeprecated
- type ServiceUpdateOptionsdeprecated
- type SummaryNetworkSettingsdeprecated
- type SwarmUnlockKeyResponsedeprecated
- type TaskListOptionsdeprecated
- type Version
Constants¶
const (// MediaTypeRawStream is vendor specific MIME-Type set for raw TTY streamsMediaTypeRawStream = "application/vnd.docker.raw-stream"// MediaTypeMultiplexedStream is vendor specific MIME-Type set for stdin/stdout/stderr multiplexed streamsMediaTypeMultiplexedStream = "application/vnd.docker.multiplexed-stream")
const (NoHealthcheck =container.NoHealthcheck// Deprecated: use [container.NoHealthcheck].Starting =container.Starting// Deprecated: use [container.Starting].Healthy =container.Healthy// Deprecated: use [container.Healthy].Unhealthy =container.Unhealthy// Deprecated: use [container.Unhealthy].)
Health states
const (RegistryAuthFromSpec =swarm.RegistryAuthFromSpec// Deprecated: use [swarm.RegistryAuthFromSpec].RegistryAuthFromPreviousSpec =swarm.RegistryAuthFromPreviousSpec// Deprecated: use [swarm.RegistryAuthFromPreviousSpec].)
const (// BuilderV1 is the first generation builder in docker daemon//// Deprecated: use [build.BuilderV1].BuilderV1 =build.BuilderV1// BuilderBuildKit is builder based on moby/buildkit project//// Deprecated: use [build.BuilderBuildKit].BuilderBuildKit =build.BuilderBuildKit)
Variables¶
This section is empty.
Functions¶
This section is empty.
Types¶
typeBuildCachedeprecated
type BuildCache =build.CacheRecord
BuildCache contains information about a build cache record.
Deprecated: deprecated in API 1.49. Usebuild.CacheRecord instead.
typeBuildCachePruneOptionsdeprecated
type BuildCachePruneOptions =build.CachePruneOptions
BuildCachePruneOptions hold parameters to prune the build cache
Deprecated: usebuild.CachePruneOptions.
typeBuildCachePruneReportdeprecated
type BuildCachePruneReport =build.CachePruneReport
BuildCachePruneReport contains the response for Engine API:POST "/build/prune"
Deprecated: usebuild.CachePruneReport.
typeBuildResultdeprecated
BuildResult contains the image id of a successful build/
Deprecated: usebuild.Result.
typeBuilderVersiondeprecated
type BuilderVersion =build.BuilderVersion
BuilderVersion sets the version of underlying builder to use
Deprecated: usebuild.BuilderVersion.
typeCloseWriter¶added inv1.13.0
type CloseWriter interface {CloseWrite()error}CloseWriter is an interface that implements structsthat close input streams to prevent from writing.
typeComponentVersion¶
ComponentVersion describes the version information for a specific component.
typeConfigCreateResponsedeprecated
type ConfigCreateResponse =swarm.ConfigCreateResponse
ConfigCreateResponse contains the information returned to a clienton the creation of a new config.
Deprecated: useswarm.ConfigCreateResponse.
typeConfigListOptionsdeprecated
type ConfigListOptions =swarm.ConfigListOptions
ConfigListOptions holds parameters to list configs
Deprecated: useswarm.ConfigListOptions.
typeContainerdeprecatedadded inv1.7.0
Container contains response of Engine API:GET "/containers/json"
Deprecated: usecontainer.Summary.
typeContainerJSONdeprecatedadded inv1.7.0
type ContainerJSON =container.InspectResponse
ContainerJSON is the response for the GET "/containers/{name:.*}/json"endpoint.
Deprecated: usecontainer.InspectResponse. It will be removed in the next release.
typeContainerJSONBasedeprecatedadded inv1.7.0
type ContainerJSONBase =container.ContainerJSONBase
ContainerJSONBase contains response of Engine API GET "/containers/{name:.*}/json"for API version 1.18 and older.
Deprecated: usecontainer.InspectResponse orcontainer.ContainerJSONBase. It will be removed in the next release.
typeContainerStatedeprecatedadded inv1.7.0
ContainerState stores container's running state
Deprecated: usecontainer.State.
typeDefaultNetworkSettingsdeprecatedadded inv1.9.0
type DefaultNetworkSettings =container.DefaultNetworkSettings//nolint:staticcheck // ignore SA1019: DefaultNetworkSettings is deprecated in v28.4.
DefaultNetworkSettings holds network informationduring the 2 release deprecation period.It will be removed in Docker 1.11.
Deprecated: usecontainer.DefaultNetworkSettings.
typeDiskUsage¶added inv1.13.0
type DiskUsage struct {LayersSizeint64Images []*image.SummaryContainers []*container.SummaryVolumes []*volume.VolumeBuildCache []*build.CacheRecordBuilderSizeint64 `json:",omitempty"`// Deprecated: deprecated in API 1.38, and no longer used since API 1.40.}DiskUsage contains response of Engine API:GET "/system/df"
typeDiskUsageObject¶
type DiskUsageObjectstring
DiskUsageObject represents an object type used for disk usage query filtering.
const (// ContainerObject represents a container DiskUsageObject.ContainerObjectDiskUsageObject = "container"// ImageObject represents an image DiskUsageObject.ImageObjectDiskUsageObject = "image"// VolumeObject represents a volume DiskUsageObject.VolumeObjectDiskUsageObject = "volume"// BuildCacheObject represents a build-cache DiskUsageObject.BuildCacheObjectDiskUsageObject = "build-cache")
typeDiskUsageOptions¶
type DiskUsageOptions struct {// Types specifies what object types to include in the response. If empty,// all object types are returned.Types []DiskUsageObject}DiskUsageOptions holds parameters for system disk usage query.
typeErrorResponse¶added inv1.13.0
type ErrorResponse struct {// The error message.// Required: trueMessagestring `json:"message"`}ErrorResponse Represents an error.swagger:model ErrorResponse
typeGraphDriverDatadeprecatedadded inv1.8.0
type GraphDriverData =storage.DriverData
GraphDriverData Information about the storage driver used to store the container's andimage's filesystem.
Deprecated: usestorage.DriverData.
typeHealthdeprecatedadded inv1.13.0
Health stores information about the container's healthcheck results.
Deprecated: usecontainer.Health.
typeHealthcheckResultdeprecatedadded inv1.13.0
type HealthcheckResult =container.HealthcheckResult
HealthcheckResult stores information about a single run of a healthcheck probe.
Deprecated: usecontainer.HealthcheckResult.
typeHijackedResponse¶added inv1.13.0
type HijackedResponse struct {Connnet.ConnReader *bufio.Reader// contains filtered or unexported fields}HijackedResponse holds connection information for a hijacked request.
funcNewHijackedResponse¶
func NewHijackedResponse(connnet.Conn, mediaTypestring)HijackedResponse
NewHijackedResponse initializes aHijackedResponse type.
func (*HijackedResponse)Close¶added inv1.13.0
func (h *HijackedResponse) Close()
Close closes the hijacked connection and reader.
func (*HijackedResponse)CloseWrite¶added inv1.13.0
func (h *HijackedResponse) CloseWrite()error
CloseWrite closes a readWriter for writing.
func (*HijackedResponse)MediaType¶
func (h *HijackedResponse) MediaType() (string,bool)
MediaType let client know if HijackedResponse hold a raw or multiplexed stream.returns false if HTTP Content-Type is not relevant, and container must be inspected
typeIDResponsedeprecatedadded inv1.13.0
type IDResponse =common.IDResponse
IDResponse Response to an API call that returns just an Id.
Deprecated: use eithercontainer.CommitResponse orcontainer.ExecCreateResponse. It will be removed in the next release.
typeImageBuildOptionsdeprecatedadded inv1.13.0
type ImageBuildOptions =build.ImageBuildOptions
ImageBuildOptions holds the informationnecessary to build images.
Deprecated: usebuild.ImageBuildOptions.
typeImageBuildOutputdeprecated
type ImageBuildOutput =build.ImageBuildOutput
ImageBuildOutput defines configuration for exporting a build result
Deprecated: usebuild.ImageBuildOutput.
typeImageBuildResponsedeprecatedadded inv1.13.0
type ImageBuildResponse =build.ImageBuildResponse
ImageBuildResponse holds informationreturned by a server after buildingan image.
Deprecated: usebuild.ImageBuildResponse.
typeImageInspectdeprecatedadded inv1.7.0
type ImageInspect =image.InspectResponse
ImageInspect contains response of Engine API:GET "/images/{name:.*}/json"
Deprecated: useimage.InspectResponse.
typeMountPointdeprecatedadded inv1.8.0
type MountPoint =container.MountPoint
MountPoint represents a mount point configuration inside the container.This is used for reporting the mountpoints in use by a container.
Deprecated: usecontainer.MountPoint.
typeNetworkSettingsdeprecatedadded inv1.9.0
type NetworkSettings =container.NetworkSettings
NetworkSettings exposes the network settings in the api.
Deprecated: usecontainer.NetworkSettings.
typeNetworkSettingsBasedeprecatedadded inv1.9.0
type NetworkSettingsBase =container.NetworkSettingsBase//nolint:staticcheck // ignore SA1019: NetworkSettingsBase is deprecated in v28.4.
NetworkSettingsBase holds networking state for a container when inspecting it.
Deprecated:container.NetworkSettingsBase will be removed in v29. Preferaccessing the fields it contains throughcontainer.NetworkSettings.
typeNodeListOptionsdeprecatedadded inv1.13.0
type NodeListOptions =swarm.NodeListOptions
NodeListOptions holds parameters to list nodes with.
Deprecated: useswarm.NodeListOptions.
typeNodeRemoveOptionsdeprecatedadded inv1.13.0
type NodeRemoveOptions =swarm.NodeRemoveOptions
NodeRemoveOptions holds parameters to remove nodes with.
Deprecated: useswarm.NodeRemoveOptions.
typePing¶added inv1.13.0
type Ping struct {APIVersionstringOSTypestringExperimentalboolBuilderVersionbuild.BuilderVersion// SwarmStatus provides information about the current swarm status of the// engine, obtained from the "Swarm" header in the API response.//// It can be a nil struct if the API version does not provide this header// in the ping response, or if an error occurred, in which case the client// should use other ways to get the current swarm status, such as the /swarm// endpoint.SwarmStatus *swarm.Status}Ping contains response of Engine API:GET "/_ping"
typePlugin¶added inv1.13.0
type Plugin struct {// config// Required: trueConfigPluginConfig `json:"Config"`// True if the plugin is running. False if the plugin is not running, only installed.// Required: trueEnabledbool `json:"Enabled"`// IdIDstring `json:"Id,omitempty"`// name// Required: trueNamestring `json:"Name"`// plugin remote reference used to push/pull the pluginPluginReferencestring `json:"PluginReference,omitempty"`// settings// Required: trueSettingsPluginSettings `json:"Settings"`}Plugin A plugin for the Engine APIswagger:model Plugin
typePluginConfig¶added inv1.13.0
type PluginConfig struct {// args// Required: trueArgsPluginConfigArgs `json:"Args"`// description// Required: trueDescriptionstring `json:"Description"`// Docker Version used to create the plugin.//// Depending on how the plugin was created, this field may be empty or omitted.//// Deprecated: this field is no longer set, and will be removed in the next API version.DockerVersionstring `json:"DockerVersion,omitempty"`// documentation// Required: trueDocumentationstring `json:"Documentation"`// entrypoint// Required: trueEntrypoint []string `json:"Entrypoint"`// env// Required: trueEnv []PluginEnv `json:"Env"`// interface// Required: trueInterfacePluginConfigInterface `json:"Interface"`// ipc host// Required: trueIpcHostbool `json:"IpcHost"`// linux// Required: trueLinuxPluginConfigLinux `json:"Linux"`// mounts// Required: trueMounts []PluginMount `json:"Mounts"`// network// Required: trueNetworkPluginConfigNetwork `json:"Network"`// pid host// Required: truePidHostbool `json:"PidHost"`// propagated mount// Required: truePropagatedMountstring `json:"PropagatedMount"`// userUserPluginConfigUser `json:"User,omitempty"`// work dir// Required: trueWorkDirstring `json:"WorkDir"`// rootfsRootfs *PluginConfigRootfs `json:"rootfs,omitempty"`}PluginConfig The config of a plugin.swagger:model PluginConfig
typePluginConfigArgs¶added inv1.13.0
type PluginConfigArgs struct {// description// Required: trueDescriptionstring `json:"Description"`// name// Required: trueNamestring `json:"Name"`// settable// Required: trueSettable []string `json:"Settable"`// value// Required: trueValue []string `json:"Value"`}PluginConfigArgs plugin config argsswagger:model PluginConfigArgs
typePluginConfigInterface¶added inv1.13.0
type PluginConfigInterface struct {// Protocol to use for clients connecting to the plugin.ProtocolSchemestring `json:"ProtocolScheme,omitempty"`// socket// Required: trueSocketstring `json:"Socket"`// types// Required: trueTypes []PluginInterfaceType `json:"Types"`}PluginConfigInterface The interface between Docker and the pluginswagger:model PluginConfigInterface
typePluginConfigLinux¶added inv1.13.0
type PluginConfigLinux struct {// allow all devices// Required: trueAllowAllDevicesbool `json:"AllowAllDevices"`// capabilities// Required: trueCapabilities []string `json:"Capabilities"`// devices// Required: trueDevices []PluginDevice `json:"Devices"`}PluginConfigLinux plugin config linuxswagger:model PluginConfigLinux
typePluginConfigNetwork¶added inv1.13.0
type PluginConfigNetwork struct {// type// Required: trueTypestring `json:"Type"`}PluginConfigNetwork plugin config networkswagger:model PluginConfigNetwork
typePluginConfigRootfs¶added inv1.13.0
type PluginConfigRootfs struct {// diff idsDiffIds []string `json:"diff_ids"`// typeTypestring `json:"type,omitempty"`}PluginConfigRootfs plugin config rootfsswagger:model PluginConfigRootfs
typePluginConfigUser¶added inv1.13.0
type PluginConfigUser struct {// g IDGIDuint32 `json:"GID,omitempty"`// UIDUIDuint32 `json:"UID,omitempty"`}PluginConfigUser plugin config userswagger:model PluginConfigUser
typePluginCreateOptions¶added inv1.13.0
type PluginCreateOptions struct {RepoNamestring}PluginCreateOptions hold all options to plugin create.
typePluginDevice¶added inv1.13.0
type PluginDevice struct {// description// Required: trueDescriptionstring `json:"Description"`// name// Required: trueNamestring `json:"Name"`// path// Required: truePath *string `json:"Path"`// settable// Required: trueSettable []string `json:"Settable"`}PluginDevice plugin deviceswagger:model PluginDevice
typePluginDisableOptions¶added inv1.13.0
type PluginDisableOptions struct {Forcebool}PluginDisableOptions holds parameters to disable plugins.
typePluginEnableOptions¶added inv1.13.0
type PluginEnableOptions struct {Timeoutint}PluginEnableOptions holds parameters to enable plugins.
typePluginEnv¶added inv1.13.0
type PluginEnv struct {// description// Required: trueDescriptionstring `json:"Description"`// name// Required: trueNamestring `json:"Name"`// settable// Required: trueSettable []string `json:"Settable"`// value// Required: trueValue *string `json:"Value"`}PluginEnv plugin envswagger:model PluginEnv
typePluginInstallOptions¶added inv1.13.0
type PluginInstallOptions struct {DisabledboolAcceptAllPermissionsboolRegistryAuthstring// RegistryAuth is the base64 encoded credentials for the registryRemoteRefstring// RemoteRef is the plugin name on the registry// PrivilegeFunc is a function that clients can supply to retry operations// after getting an authorization error. This function returns the registry// authentication header value in base64 encoded format, or an error if the// privilege request fails.//// For details, refer to [github.com/docker/docker/api/types/registry.RequestAuthConfig].PrivilegeFunc func(context.Context) (string,error)AcceptPermissionsFunc func(context.Context,PluginPrivileges) (bool,error)Args []string}PluginInstallOptions holds parameters to install a plugin.
typePluginInterfaceType¶added inv1.13.0
type PluginInterfaceType struct {// capability// Required: trueCapabilitystring `json:"Capability"`// prefix// Required: truePrefixstring `json:"Prefix"`// version// Required: trueVersionstring `json:"Version"`}PluginInterfaceType plugin interface typeswagger:model PluginInterfaceType
func (*PluginInterfaceType)MarshalJSON¶added inv1.13.0
func (t *PluginInterfaceType) MarshalJSON() ([]byte,error)
MarshalJSON implements json.Marshaler for PluginInterfaceType
func (PluginInterfaceType)String¶added inv1.13.0
func (tPluginInterfaceType) String()string
String implements fmt.Stringer for PluginInterfaceType
func (*PluginInterfaceType)UnmarshalJSON¶added inv1.13.0
func (t *PluginInterfaceType) UnmarshalJSON(p []byte)error
UnmarshalJSON implements json.Unmarshaler for PluginInterfaceType
typePluginMount¶added inv1.13.0
type PluginMount struct {// description// Required: trueDescriptionstring `json:"Description"`// destination// Required: trueDestinationstring `json:"Destination"`// name// Required: trueNamestring `json:"Name"`// options// Required: trueOptions []string `json:"Options"`// settable// Required: trueSettable []string `json:"Settable"`// source// Required: trueSource *string `json:"Source"`// type// Required: trueTypestring `json:"Type"`}PluginMount plugin mountswagger:model PluginMount
typePluginPrivilege¶added inv1.13.0
PluginPrivilege describes a permission the user has to acceptupon installing a plugin.
typePluginPrivileges¶added inv1.13.0
type PluginPrivileges []PluginPrivilege
PluginPrivileges is a list of PluginPrivilege
func (PluginPrivileges)Len¶
func (sPluginPrivileges) Len()int
func (PluginPrivileges)Less¶
func (sPluginPrivileges) Less(i, jint)bool
func (PluginPrivileges)Swap¶
func (sPluginPrivileges) Swap(i, jint)
typePluginRemoveOptions¶added inv1.13.0
type PluginRemoveOptions struct {Forcebool}PluginRemoveOptions holds parameters to remove plugins.
typePluginSettings¶added inv1.13.0
type PluginSettings struct {// args// Required: trueArgs []string `json:"Args"`// devices// Required: trueDevices []PluginDevice `json:"Devices"`// env// Required: trueEnv []string `json:"Env"`// mounts// Required: trueMounts []PluginMount `json:"Mounts"`}PluginSettings Settings that can be modified by users.swagger:model PluginSettings
typePluginsListResponse¶added inv1.13.0
type PluginsListResponse []*Plugin
PluginsListResponse contains the response for the Engine API
typePortdeprecatedadded inv1.7.0
typePushResult¶
PushResult contains the tag, manifest digest, and manifest size from thepush. It's used to signal this information to the trust code in the clientso it can sign the manifest if necessary.
typeRequestPrivilegeFuncdeprecatedadded inv1.13.0
RequestPrivilegeFunc is a function interface that clients can supply toretry operations after getting an authorization error.This function returns the registry authentication header value in base64format, or an error if the privilege request fails.
Deprecated: moved togithub.com/docker/docker/api/types/registry.RequestAuthConfig.
typeRootFSdeprecatedadded inv1.13.0
RootFS returns Image's RootFS description including the layer IDs.
Deprecated: useimage.RootFS.
typeSecretCreateResponsedeprecatedadded inv1.13.0
type SecretCreateResponse =swarm.SecretCreateResponse
SecretCreateResponse contains the information returned to a clienton the creation of a new secret.
Deprecated: useswarm.SecretCreateResponse.
typeSecretListOptionsdeprecatedadded inv1.13.0
type SecretListOptions =swarm.SecretListOptions
SecretListOptions holds parameters to list secrets
Deprecated: useswarm.SecretListOptions.
typeServiceCreateOptionsdeprecatedadded inv1.13.0
type ServiceCreateOptions =swarm.ServiceCreateOptions
ServiceCreateOptions contains the options to use when creating a service.
Deprecated: useswarm.ServiceCreateOptions.
typeServiceInspectOptionsdeprecated
type ServiceInspectOptions =swarm.ServiceInspectOptions
ServiceInspectOptions holds parameters related to the "service inspect"operation.
Deprecated: useswarm.ServiceInspectOptions.
typeServiceListOptionsdeprecatedadded inv1.13.0
type ServiceListOptions =swarm.ServiceListOptions
ServiceListOptions holds parameters to list services with.
Deprecated: useswarm.ServiceListOptions.
typeServiceUpdateOptionsdeprecatedadded inv1.13.0
type ServiceUpdateOptions =swarm.ServiceUpdateOptions
ServiceUpdateOptions contains the options to be used for updating services.
Deprecated: useswarm.ServiceCreateOptions.
typeSummaryNetworkSettingsdeprecatedadded inv1.13.0
type SummaryNetworkSettings =container.NetworkSettingsSummary
SummaryNetworkSettings provides a summary of container's networksin /containers/json.
Deprecated: usecontainer.NetworkSettingsSummary.
typeSwarmUnlockKeyResponsedeprecatedadded inv1.13.0
type SwarmUnlockKeyResponse =swarm.UnlockKeyResponse
SwarmUnlockKeyResponse contains the response for Engine API:GET /swarm/unlockkey
Deprecated: useswarm.UnlockKeyResponse.
typeTaskListOptionsdeprecatedadded inv1.13.0
type TaskListOptions =swarm.TaskListOptions
TaskListOptions holds parameters to list tasks with.
Deprecated: useswarm.TaskListOptions.
typeVersion¶added inv1.7.0
type Version struct {Platform struct{ Namestring } `json:",omitempty"`Components []ComponentVersion `json:",omitempty"`VersionstringAPIVersionstring `json:"ApiVersion"`MinAPIVersionstring `json:"MinAPIVersion,omitempty"`GitCommitstringGoVersionstringOsstringArchstringKernelVersionstring `json:",omitempty"`Experimentalbool `json:",omitempty"`BuildTimestring `json:",omitempty"`}Version contains response of Engine API:GET "/version"
Source Files¶
Directories¶
| Path | Synopsis |
|---|---|
Package backend includes types to send information to server backends. | Package backend includes types to send information to server backends. |
Package filters provides tools for encoding a mapping of keys to a set of multiple values. | Package filters provides tools for encoding a mapping of keys to a set of multiple values. |
plugins | |