Movatterモバイル変換


[0]ホーム

URL:


backend

package
v28.5.2+incompatibleLatest Latest
Warning

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

Go to latest
Published: Nov 5, 2025 License:Apache-2.0Imports:11Imported by:2,895

Details

Repository

github.com/docker/docker

Links

Documentation

Overview

Package backend includes types to send information to server backends.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

typeBuildConfig

type BuildConfig struct {Sourceio.ReadCloserProgressWriterProgressWriterOptions        *build.ImageBuildOptions}

BuildConfig is the configuration used by a BuildManager to start a build

typeCommitConfig

type CommitConfig struct {AuthorstringCommentstringConfig              *container.Config// TODO(thaJeztah); change this to [dockerspec.DockerOCIImageConfig]ContainerConfig     *container.ConfigContainerIDstringContainerMountLabelstringContainerOSstringParentImageIDstring}

CommitConfig is the configuration for creating an image as part of a build.

typeContainerAttachConfig

type ContainerAttachConfig struct {GetStreams func(multiplexedbool, cancel func()) (io.ReadCloser,io.Writer,io.Writer,error)UseStdinboolUseStdoutboolUseStderrboolLogsboolStreamboolDetachKeysstring// Used to signify that streams must be multiplexed by producer as endpoint can't manage multiple streams.// This is typically set by HTTP endpoint, while websocket can transport raw streamsMuxStreamsbool}

ContainerAttachConfig holds the streams to use when connecting to a container to view logs.

typeContainerCreateConfig

type ContainerCreateConfig struct {NamestringConfig                      *container.ConfigHostConfig                  *container.HostConfigNetworkingConfig            *network.NetworkingConfigPlatform                    *ocispec.PlatformDefaultReadOnlyNonRecursivebool}

ContainerCreateConfig is the parameter set to ContainerCreate()

typeContainerInspectOptions

type ContainerInspectOptions struct {// Size controls whether to propagate the container's size fields.Sizebool}

ContainerInspectOptions defines options for the backend.ContainerInspectcall.

typeContainerRmConfig

type ContainerRmConfig struct {ForceRemove, RemoveVolume, RemoveLinkbool}

ContainerRmConfig holds arguments for the container removeoperation. This struct is used to tell the backend what operationsto perform.

typeContainerStatsConfig

type ContainerStatsConfig struct {StreamboolOneShotboolOutStream func()io.Writer}

ContainerStatsConfig holds information for configuring the runtimebehavior of a backend.ContainerStats() call.

typeCreateImageConfig

type CreateImageConfig struct {Tagreference.NamedTaggedPauseboolAuthorstringCommentstringConfig  *container.ConfigChanges []string}

CreateImageConfig is the configuration for creating an image from acontainer.

typeDiskUsage

type DiskUsage struct {Images     *image.DiskUsageContainers *container.DiskUsageVolumes    *volume.DiskUsageBuildCache *build.CacheDiskUsage}

DiskUsage contains the information returned by the backend for theGET "/system/df" endpoint.

typeDiskUsageOptions

type DiskUsageOptions struct {// Containers controls whether container disk usage should be computed.Containersbool// Images controls whether image disk usage should be computed.Imagesbool// Volumes controls whether volume disk usage should be computed.Volumesbool}

DiskUsageOptions holds parameters for system disk usage query.

typeExecInspect

type ExecInspect struct {IDstringRunningboolExitCode      *intProcessConfig *ExecProcessConfigOpenStdinboolOpenStderrboolOpenStdoutboolCanRemoveboolContainerIDstringDetachKeys    []bytePidint}

ExecInspect holds information about a running process startedwith docker exec.

typeExecProcessConfig

type ExecProcessConfig struct {Ttybool     `json:"tty"`Entrypointstring   `json:"entrypoint"`Arguments  []string `json:"arguments"`Privileged *bool    `json:"privileged,omitempty"`Userstring   `json:"user,omitempty"`}

ExecProcessConfig holds information about the exec processrunning on the host.

typeExecStartConfig

type ExecStartConfig struct {Stdinio.ReaderStdoutio.WriterStderrio.WriterConsoleSize *[2]uint `json:",omitempty"`}

ExecStartConfig holds the options to start container's exec.

typeGetImageAndLayerOptions

type GetImageAndLayerOptions struct {PullOptionPullOptionAuthConfig map[string]registry.AuthConfigOutputio.WriterPlatform   *ocispec.Platform}

GetImageAndLayerOptions are the options supported by GetImageAndReleasableLayer

typeGetImageOpts

type GetImageOpts struct {Platform *ocispec.Platform}

GetImageOpts holds parameters to retrieve image informationfrom the backend.

typeImageInspectOpts

type ImageInspectOpts struct {ManifestsboolPlatform  *ocispec.Platform}

ImageInspectOpts holds parameters to inspect an image.

typeLogAttr

type LogAttr struct {KeystringValuestring}

LogAttr is used to hold the extra attributes available in the log message.

typeLogMessage

type LogMessage struct {Line         []byteSourcestringTimestamptime.TimeAttrs        []LogAttrPLogMetaData *PartialLogMetaData// Err is an error associated with a message. Completeness of a message// with Err is not expected, tho it may be partially complete (fields may// be missing, gibberish, or nil)Errerror}

LogMessage is datastructure that represents piece of output produced by somecontainer. The Line member is a slice of an array whose contents can bechanged after a log driver's Log() method returns.

typeLogSelector

type LogSelector struct {Services []stringTasks    []string}

LogSelector is a list of services and tasks that should be returned as partof a log stream. It is similar to swarmapi.LogSelector, with the differencethat the names don't have to be resolved to IDs; this is mostly to avoidaccidents later where a swarmapi LogSelector might have been incorrectlyused verbatim (and to avoid the handler having to import swarmapi types)

typeNetworkListConfig

type NetworkListConfig struct {// TODO(@cpuguy83): naming is hard, this is pulled from what was being used in the router before moving hereDetailedboolVerbosebool}

NetworkListConfig stores the options available for listing networks

typePartialLogMetaData

type PartialLogMetaData struct {Lastbool// true if this message is last of a partialIDstring// identifies group of messages comprising a single recordOrdinalint// ordering of message in partial group}

PartialLogMetaData provides meta data for a partial log message. Messagesexceeding a predefined size are split into chunks with this metadata. Theexpectation is for the logger endpoints to assemble the chunks using thismetadata.

typePluginDisableConfig

type PluginDisableConfig struct {ForceDisablebool}

PluginDisableConfig holds arguments for plugin disable.

typePluginEnableConfig

type PluginEnableConfig struct {Timeoutint}

PluginEnableConfig holds arguments for plugin enable

typePluginRmConfig

type PluginRmConfig struct {ForceRemovebool}

PluginRmConfig holds arguments for plugin remove.

typeProgressWriteradded inv1.12.0

type ProgressWriter struct {Outputio.WriterStdoutFormatterio.WriterStderrFormatterio.WriterAuxFormatter       *streamformatter.AuxFormatterProgressReaderFunc func(io.ReadCloser)io.ReadCloser}

ProgressWriter is a data object to transport progress streams to the client

typePullOption

type PullOptionint

PullOption defines different modes for accessing images

const (// PullOptionNoPull only returns local imagesPullOptionNoPullPullOption =iota// PullOptionForcePull always tries to pull a ref from the registry firstPullOptionForcePull// PullOptionPreferLocal uses local image if it exists, otherwise pullsPullOptionPreferLocal)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f orF : Jump to
y orY : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic.Learn more.

[8]ページ先頭

©2009-2025 Movatter.jp