Movatterモバイル変換


[0]ホーム

URL:


backend

package
v2.0.0-beta.5Latest Latest
Warning

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

Go to latest
Published: Nov 27, 2025 License:Apache-2.0Imports:10Imported by:0

Details

Repository

github.com/moby/moby

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

typeCheckpointDeleteOptions

type CheckpointDeleteOptions struct {CheckpointIDstringCheckpointDirstring}

CheckpointDeleteOptions holds parameters to delete a checkpoint from a container.

typeCheckpointListOptions

type CheckpointListOptions struct {CheckpointDirstring}

CheckpointListOptions holds parameters to list checkpoints for a container.

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()

typeContainerDiskUsage

type ContainerDiskUsage =container.DiskUsage

ContainerDiskUsage contains disk usage for containers.

typeContainerInspectOptions

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

ContainerInspectOptions defines options for the backend.ContainerInspectcall.

typeContainerListOptions

type ContainerListOptions struct {SizeboolAllboolLatestboolSincestringBeforestringLimitintFiltersfilters.Args}

ContainerListOptions holds parameters to list containers with.

typeContainerLogsOptions

type ContainerLogsOptions struct {ShowStdoutboolShowStderrboolSincestringUntilstringTimestampsboolFollowboolTailstringDetailsbool}

ContainerLogsOptions holds parameters to filter logs with.

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.

typeContainerStopOptions

type ContainerStopOptions struct {// Signal (optional) is the signal to send to the container to (gracefully)// stop it before forcibly terminating the container with SIGKILL after the// timeout expires. If not value is set, the default (SIGTERM) is used.Signalstring `json:",omitempty"`// Timeout (optional) is the timeout (in seconds) to wait for the container// to stop gracefully before forcibly terminating it with SIGKILL.//// - Use nil to use the default timeout (10 seconds).// - Use '-1' to wait indefinitely.// - Use '0' to not wait for the container to exit gracefully, and//   immediately proceeds to forcibly terminating the container.// - Other positive values are used as timeout (in seconds).Timeout *int `json:",omitempty"`}

ContainerStopOptions holds the options to stop or restart a container.

typeCreateImageConfig

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

CreateImageConfig is the configuration for creating an image from acontainer.

typeDiskUsage

type DiskUsage struct {Images     *ImageDiskUsageContainers *ContainerDiskUsageVolumes    *VolumeDiskUsageBuildCache *build.DiskUsage}

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// Verbose indicates whether to include detailed information.Verbosebool}

DiskUsageOptions holds parameters for system disk usage query.

typeExecStartConfig

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

ExecStartConfig holds the options to start container's exec.

typeImageDiskUsage

type ImageDiskUsage =image.DiskUsage

ImageDiskUsage contains disk usage for images.

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 {WithServicesboolWithStatusbool}

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.

typePluginCreateConfig

type PluginCreateConfig struct {RepoNamestring}

PluginCreateConfig hold all options to plugin create.

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.

typeVolumeDiskUsage

type VolumeDiskUsage =volume.DiskUsage

VolumeDiskUsage contains disk usage for volumes.

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