docker: Index | Files | Directories

package types

import ""

Package types is used for API stability in the types and response to the consumers of the API stats endpoint.


Package Files

auth.go client.go configs.go error_response.go error_response_ext.go graph_driver_data.go id_response.go image_delete_response_item.go image_summary.go plugin.go plugin_device.go plugin_env.go plugin_interface_type.go plugin_mount.go plugin_responses.go port.go service_update_response.go stats.go types.go volume.go


const (
    RegistryAuthFromSpec         = "spec"
    RegistryAuthFromPreviousSpec = "previous-spec"

Values for RegistryAuthFrom in ServiceUpdateOptions

const (
    NoHealthcheck = "none"      // Indicates there is no healthcheck
    Starting      = "starting"  // Starting indicates that the container is not yet ready
    Healthy       = "healthy"   // Healthy indicates that the container is running correctly
    Unhealthy     = "unhealthy" // Unhealthy indicates that the container has a problem

Health states

type AuthConfig Uses

type AuthConfig struct {
    Username string `json:"username,omitempty"`
    Password string `json:"password,omitempty"`
    Auth     string `json:"auth,omitempty"`

    // Email is an optional value associated with the username.
    // This field is deprecated and will be removed in a later
    // version of docker.
    Email string `json:"email,omitempty"`

    ServerAddress string `json:"serveraddress,omitempty"`

    // IdentityToken is used to authenticate the user and get
    // an access token for the registry.
    IdentityToken string `json:"identitytoken,omitempty"`

    // RegistryToken is a bearer token to be sent to a registry
    RegistryToken string `json:"registrytoken,omitempty"`

AuthConfig contains authorization information for connecting to a Registry

type BlkioStatEntry Uses

type BlkioStatEntry struct {
    Major uint64 `json:"major"`
    Minor uint64 `json:"minor"`
    Op    string `json:"op"`
    Value uint64 `json:"value"`

BlkioStatEntry is one small entity to store a piece of Blkio stats Not used on Windows.

type BlkioStats Uses

type BlkioStats struct {
    // number of bytes transferred to and from the block device
    IoServiceBytesRecursive []BlkioStatEntry `json:"io_service_bytes_recursive"`
    IoServicedRecursive     []BlkioStatEntry `json:"io_serviced_recursive"`
    IoQueuedRecursive       []BlkioStatEntry `json:"io_queue_recursive"`
    IoServiceTimeRecursive  []BlkioStatEntry `json:"io_service_time_recursive"`
    IoWaitTimeRecursive     []BlkioStatEntry `json:"io_wait_time_recursive"`
    IoMergedRecursive       []BlkioStatEntry `json:"io_merged_recursive"`
    IoTimeRecursive         []BlkioStatEntry `json:"io_time_recursive"`
    SectorsRecursive        []BlkioStatEntry `json:"sectors_recursive"`

BlkioStats stores All IO service stats for data read and write. This is a Linux specific structure as the differences between expressing block I/O on Windows and Linux are sufficiently significant to make little sense attempting to morph into a combined structure.

type BuildCache Uses

type BuildCache struct {
    ID          string
    Parent      string
    Type        string
    Description string
    InUse       bool
    Shared      bool
    Size        int64
    CreatedAt   time.Time
    LastUsedAt  *time.Time
    UsageCount  int

BuildCache contains information about a build cache record

type BuildCachePruneOptions Uses

type BuildCachePruneOptions struct {
    All         bool
    KeepStorage int64
    Filters     filters.Args

BuildCachePruneOptions hold parameters to prune the build cache

type BuildCachePruneReport Uses

type BuildCachePruneReport struct {
    CachesDeleted  []string
    SpaceReclaimed uint64

BuildCachePruneReport contains the response for Engine API: POST "/build/prune"

type BuildResult Uses

type BuildResult struct {
    ID string

BuildResult contains the image id of a successful build

type BuilderVersion Uses

type BuilderVersion string

BuilderVersion sets the version of underlying builder to use

const (
    // BuilderV1 is the first generation builder in docker daemon
    BuilderV1 BuilderVersion = "1"
    // BuilderBuildKit is builder based on moby/buildkit project
    BuilderBuildKit BuilderVersion = "2"

type CPUStats Uses

type CPUStats struct {
    // CPU Usage. Linux and Windows.
    CPUUsage CPUUsage `json:"cpu_usage"`

    // System Usage. Linux only.
    SystemUsage uint64 `json:"system_cpu_usage,omitempty"`

    // Online CPUs. Linux only.
    OnlineCPUs uint32 `json:"online_cpus,omitempty"`

    // Throttling Data. Linux only.
    ThrottlingData ThrottlingData `json:"throttling_data,omitempty"`

CPUStats aggregates and wraps all CPU related info of container

type CPUUsage Uses

type CPUUsage struct {
    // Total CPU time consumed.
    // Units: nanoseconds (Linux)
    // Units: 100's of nanoseconds (Windows)
    TotalUsage uint64 `json:"total_usage"`

    // Total CPU time consumed per core (Linux). Not used on Windows.
    // Units: nanoseconds.
    PercpuUsage []uint64 `json:"percpu_usage,omitempty"`

    // Time spent by tasks of the cgroup in kernel mode (Linux).
    // Time spent by all container processes in kernel mode (Windows).
    // Units: nanoseconds (Linux).
    // Units: 100's of nanoseconds (Windows). Not populated for Hyper-V Containers.
    UsageInKernelmode uint64 `json:"usage_in_kernelmode"`

    // Time spent by tasks of the cgroup in user mode (Linux).
    // Time spent by all container processes in user mode (Windows).
    // Units: nanoseconds (Linux).
    // Units: 100's of nanoseconds (Windows). Not populated for Hyper-V Containers
    UsageInUsermode uint64 `json:"usage_in_usermode"`

CPUUsage stores All CPU stats aggregated since container inception.

type Checkpoint Uses

type Checkpoint struct {
    Name string // Name is the name of the checkpoint

Checkpoint represents the details of a checkpoint

type CheckpointCreateOptions Uses

type CheckpointCreateOptions struct {
    CheckpointID  string
    CheckpointDir string
    Exit          bool

CheckpointCreateOptions holds parameters to create a checkpoint from a container

type CheckpointDeleteOptions Uses

type CheckpointDeleteOptions struct {
    CheckpointID  string
    CheckpointDir string

CheckpointDeleteOptions holds parameters to delete a checkpoint from a container

type CheckpointListOptions Uses

type CheckpointListOptions struct {
    CheckpointDir string

CheckpointListOptions holds parameters to list checkpoints for a container

type CloseWriter Uses

type CloseWriter interface {
    CloseWrite() error

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

type Commit Uses

type Commit struct {
    ID       string // ID is the actual commit ID of external tool.
    Expected string // Expected is the commit ID of external tool expected by dockerd as set at build time.

Commit holds the Git-commit (SHA1) that a binary was built from, as reported in the version-string of external tools, such as containerd, or runC.

type ComponentVersion Uses

type ComponentVersion struct {
    Name    string
    Version string
    Details map[string]string `json:",omitempty"`

ComponentVersion describes the version information for a specific component.

type ConfigCreateResponse Uses

type ConfigCreateResponse struct {
    // ID is the id of the created config.
    ID string

ConfigCreateResponse contains the information returned to a client on the creation of a new config.

type ConfigListOptions Uses

type ConfigListOptions struct {
    Filters filters.Args

ConfigListOptions holds parameters to list configs

type Container Uses

type Container struct {
    ID         string `json:"Id"`
    Names      []string
    Image      string
    ImageID    string
    Command    string
    Created    int64
    Ports      []Port
    SizeRw     int64 `json:",omitempty"`
    SizeRootFs int64 `json:",omitempty"`
    Labels     map[string]string
    State      string
    Status     string
    HostConfig struct {
        NetworkMode string `json:",omitempty"`
    NetworkSettings *SummaryNetworkSettings
    Mounts          []MountPoint

Container contains response of Engine API: GET "/containers/json"

type ContainerAttachOptions Uses

type ContainerAttachOptions struct {
    Stream     bool
    Stdin      bool
    Stdout     bool
    Stderr     bool
    DetachKeys string
    Logs       bool

ContainerAttachOptions holds parameters to attach to a container.

type ContainerCommitOptions Uses

type ContainerCommitOptions struct {
    Reference string
    Comment   string
    Author    string
    Changes   []string
    Pause     bool
    Config    *container.Config

ContainerCommitOptions holds parameters to commit changes into a container.

type ContainerCreateConfig Uses

type ContainerCreateConfig struct {
    Name             string
    Config           *container.Config
    HostConfig       *container.HostConfig
    NetworkingConfig *network.NetworkingConfig
    Platform         *specs.Platform
    AdjustCPUShares  bool

ContainerCreateConfig is the parameter set to ContainerCreate()

type ContainerExecInspect Uses

type ContainerExecInspect struct {
    ExecID      string `json:"ID"`
    ContainerID string
    Running     bool
    ExitCode    int
    Pid         int

ContainerExecInspect holds information returned by exec inspect.

type ContainerJSON Uses

type ContainerJSON struct {
    Mounts          []MountPoint
    Config          *container.Config
    NetworkSettings *NetworkSettings

ContainerJSON is newly used struct along with MountPoint

type ContainerJSONBase Uses

type ContainerJSONBase struct {
    ID              string `json:"Id"`
    Created         string
    Path            string
    Args            []string
    State           *ContainerState
    Image           string
    ResolvConfPath  string
    HostnamePath    string
    HostsPath       string
    LogPath         string
    Node            *ContainerNode `json:",omitempty"` // Node is only propagated by Docker Swarm standalone API
    Name            string
    RestartCount    int
    Driver          string
    Platform        string
    MountLabel      string
    ProcessLabel    string
    AppArmorProfile string
    ExecIDs         []string
    HostConfig      *container.HostConfig
    GraphDriver     GraphDriverData
    SizeRw          *int64 `json:",omitempty"`
    SizeRootFs      *int64 `json:",omitempty"`

ContainerJSONBase contains response of Engine API: GET "/containers/{name:.*}/json"

type ContainerListOptions Uses

type ContainerListOptions struct {
    Quiet   bool
    Size    bool
    All     bool
    Latest  bool
    Since   string
    Before  string
    Limit   int
    Filters filters.Args

ContainerListOptions holds parameters to list containers with.

type ContainerLogsOptions Uses

type ContainerLogsOptions struct {
    ShowStdout bool
    ShowStderr bool
    Since      string
    Until      string
    Timestamps bool
    Follow     bool
    Tail       string
    Details    bool

ContainerLogsOptions holds parameters to filter logs with.

type ContainerNode Uses

type ContainerNode struct {
    ID        string
    IPAddress string `json:"IP"`
    Addr      string
    Name      string
    Cpus      int
    Memory    int64
    Labels    map[string]string

ContainerNode stores information about the node that a container is running on. It's only used by the Docker Swarm standalone API

type ContainerPathStat Uses

type ContainerPathStat struct {
    Name       string      `json:"name"`
    Size       int64       `json:"size"`
    Mode       os.FileMode `json:"mode"`
    Mtime      time.Time   `json:"mtime"`
    LinkTarget string      `json:"linkTarget"`

ContainerPathStat is used to encode the header from GET "/containers/{name:.*}/archive" "Name" is the file or directory name.

type ContainerRemoveOptions Uses

type ContainerRemoveOptions struct {
    RemoveVolumes bool
    RemoveLinks   bool
    Force         bool

ContainerRemoveOptions holds parameters to remove containers.

type ContainerRmConfig Uses

type ContainerRmConfig struct {
    ForceRemove, RemoveVolume, RemoveLink bool

ContainerRmConfig holds arguments for the container remove operation. This struct is used to tell the backend what operations to perform.

type ContainerStartOptions Uses

type ContainerStartOptions struct {
    CheckpointID  string
    CheckpointDir string

ContainerStartOptions holds parameters to start containers.

type ContainerState Uses

type ContainerState struct {
    Status     string // String representation of the container state. Can be one of "created", "running", "paused", "restarting", "removing", "exited", or "dead"
    Running    bool
    Paused     bool
    Restarting bool
    OOMKilled  bool
    Dead       bool
    Pid        int
    ExitCode   int
    Error      string
    StartedAt  string
    FinishedAt string
    Health     *Health `json:",omitempty"`

ContainerState stores container's running state it's part of ContainerJSONBase and will return by "inspect" command

type ContainerStats Uses

type ContainerStats struct {
    Body   io.ReadCloser `json:"body"`
    OSType string        `json:"ostype"`

ContainerStats contains response of Engine API: GET "/stats"

type ContainersPruneReport Uses

type ContainersPruneReport struct {
    ContainersDeleted []string
    SpaceReclaimed    uint64

ContainersPruneReport contains the response for Engine API: POST "/containers/prune"

type CopyConfig Uses

type CopyConfig struct {
    Resource string

CopyConfig contains request body of Engine API: POST "/containers/"+containerID+"/copy"

type CopyToContainerOptions Uses

type CopyToContainerOptions struct {
    AllowOverwriteDirWithFile bool
    CopyUIDGID                bool

CopyToContainerOptions holds information about files to copy into a container

type DefaultNetworkSettings Uses

type DefaultNetworkSettings struct {
    EndpointID          string // EndpointID uniquely represents a service endpoint in a Sandbox
    Gateway             string // Gateway holds the gateway address for the network
    GlobalIPv6Address   string // GlobalIPv6Address holds network's global IPv6 address
    GlobalIPv6PrefixLen int    // GlobalIPv6PrefixLen represents mask length of network's global IPv6 address
    IPAddress           string // IPAddress holds the IPv4 address for the network
    IPPrefixLen         int    // IPPrefixLen represents mask length of network's IPv4 address
    IPv6Gateway         string // IPv6Gateway holds gateway address specific for IPv6
    MacAddress          string // MacAddress holds the MAC address for the network

DefaultNetworkSettings holds network information during the 2 release deprecation period. It will be removed in Docker 1.11.

type DiskUsage Uses

type DiskUsage struct {
    LayersSize  int64
    Images      []*ImageSummary
    Containers  []*Container
    Volumes     []*Volume
    BuildCache  []*BuildCache
    BuilderSize int64 // deprecated

DiskUsage contains response of Engine API: GET "/system/df"

type EndpointResource Uses

type EndpointResource struct {
    Name        string
    EndpointID  string
    MacAddress  string
    IPv4Address string
    IPv6Address string

EndpointResource contains network resources allocated and used for a container in a network

type ErrorResponse Uses

type ErrorResponse struct {

    // The error message.
    // Required: true
    Message string `json:"message"`

ErrorResponse Represents an error. swagger:model ErrorResponse

func (ErrorResponse) Error Uses

func (e ErrorResponse) Error() string

Error returns the error message

type EventsOptions Uses

type EventsOptions struct {
    Since   string
    Until   string
    Filters filters.Args

EventsOptions holds parameters to filter events with.

type ExecConfig Uses

type ExecConfig struct {
    User         string   // User that will run the command
    Privileged   bool     // Is the container in privileged mode
    Tty          bool     // Attach standard streams to a tty.
    AttachStdin  bool     // Attach the standard input, makes possible user interaction
    AttachStderr bool     // Attach the standard error
    AttachStdout bool     // Attach the standard output
    Detach       bool     // Execute in detach mode
    DetachKeys   string   // Escape keys for detach
    Env          []string // Environment variables
    WorkingDir   string   // Working directory
    Cmd          []string // Execution commands and args

ExecConfig is a small subset of the Config struct that holds the configuration for the exec feature of docker.

type ExecStartCheck Uses

type ExecStartCheck struct {
    // ExecStart will first check if it's detached
    Detach bool
    // Check if there's a tty
    Tty bool

ExecStartCheck is a temp struct used by execStart Config fields is part of ExecConfig in runconfig package

type GraphDriverData Uses

type GraphDriverData struct {

    // data
    // Required: true
    Data map[string]string `json:"Data"`

    // name
    // Required: true
    Name string `json:"Name"`

GraphDriverData Information about a container's graph driver. swagger:model GraphDriverData

type Health Uses

type Health struct {
    Status        string               // Status is one of Starting, Healthy or Unhealthy
    FailingStreak int                  // FailingStreak is the number of consecutive failures
    Log           []*HealthcheckResult // Log contains the last few results (oldest first)

Health stores information about the container's healthcheck results

type HealthcheckResult Uses

type HealthcheckResult struct {
    Start    time.Time // Start is the time this check started
    End      time.Time // End is the time this check ended
    ExitCode int       // ExitCode meanings: 0=healthy, 1=unhealthy, 2=reserved (considered unhealthy), else=error running probe
    Output   string    // Output from last check

HealthcheckResult stores information about a single run of a healthcheck probe

type HijackedResponse Uses

type HijackedResponse struct {
    Conn   net.Conn
    Reader *bufio.Reader

HijackedResponse holds connection information for a hijacked request.

func (*HijackedResponse) Close Uses

func (h *HijackedResponse) Close()

Close closes the hijacked connection and reader.

func (*HijackedResponse) CloseWrite Uses

func (h *HijackedResponse) CloseWrite() error

CloseWrite closes a readWriter for writing.

type IDResponse Uses

type IDResponse struct {

    // The id of the newly created object.
    // Required: true
    ID string `json:"Id"`

IDResponse Response to an API call that returns just an Id swagger:model IdResponse

type ImageBuildOptions Uses

type ImageBuildOptions struct {
    Tags           []string
    SuppressOutput bool
    RemoteContext  string
    NoCache        bool
    Remove         bool
    ForceRemove    bool
    PullParent     bool
    Isolation      container.Isolation
    CPUSetCPUs     string
    CPUSetMems     string
    CPUShares      int64
    CPUQuota       int64
    CPUPeriod      int64
    Memory         int64
    MemorySwap     int64
    CgroupParent   string
    NetworkMode    string
    ShmSize        int64
    Dockerfile     string
    Ulimits        []*units.Ulimit
    // BuildArgs needs to be a *string instead of just a string so that
    // we can tell the difference between "" (empty string) and no value
    // at all (nil). See the parsing of buildArgs in
    // api/server/router/build/build_routes.go for even more info.
    BuildArgs   map[string]*string
    AuthConfigs map[string]AuthConfig
    Context     io.Reader
    Labels      map[string]string
    // squash the resulting image's layers to the parent
    // preserves the original image and creates a new one from the parent with all
    // the changes applied to a single layer
    Squash bool
    // CacheFrom specifies images that are used for matching cache. Images
    // specified here do not need to have a valid parent chain to match cache.
    CacheFrom   []string
    SecurityOpt []string
    ExtraHosts  []string // List of extra hosts
    Target      string
    SessionID   string
    Platform    string
    // Version specifies the version of the unerlying builder to use
    Version BuilderVersion
    // BuildID is an optional identifier that can be passed together with the
    // build request. The same identifier can be used to gracefully cancel the
    // build with the cancel request.
    BuildID string
    // Outputs defines configurations for exporting build results. Only supported
    // in BuildKit mode
    Outputs []ImageBuildOutput

ImageBuildOptions holds the information necessary to build images.

type ImageBuildOutput Uses

type ImageBuildOutput struct {
    Type  string
    Attrs map[string]string

ImageBuildOutput defines configuration for exporting a build result

type ImageBuildResponse Uses

type ImageBuildResponse struct {
    Body   io.ReadCloser
    OSType string

ImageBuildResponse holds information returned by a server after building an image.

type ImageCreateOptions Uses

type ImageCreateOptions struct {
    RegistryAuth string // RegistryAuth is the base64 encoded credentials for the registry.
    Platform     string // Platform is the target platform of the image if it needs to be pulled from the registry.

ImageCreateOptions holds information to create images.

type ImageDeleteResponseItem Uses

type ImageDeleteResponseItem struct {

    // The image ID of an image that was deleted
    Deleted string `json:"Deleted,omitempty"`

    // The image ID of an image that was untagged
    Untagged string `json:"Untagged,omitempty"`

ImageDeleteResponseItem image delete response item swagger:model ImageDeleteResponseItem

type ImageImportOptions Uses

type ImageImportOptions struct {
    Tag      string   // Tag is the name to tag this image with. This attribute is deprecated.
    Message  string   // Message is the message to tag the image with
    Changes  []string // Changes are the raw changes to apply to this image
    Platform string   // Platform is the target platform of the image

ImageImportOptions holds information to import images from the client host.

type ImageImportSource Uses

type ImageImportSource struct {
    Source     io.Reader // Source is the data to send to the server to create this image from. You must set SourceName to "-" to leverage this.
    SourceName string    // SourceName is the name of the image to pull. Set to "-" to leverage the Source attribute.

ImageImportSource holds source information for ImageImport

type ImageInspect Uses

type ImageInspect struct {
    ID              string `json:"Id"`
    RepoTags        []string
    RepoDigests     []string
    Parent          string
    Comment         string
    Created         string
    Container       string
    ContainerConfig *container.Config
    DockerVersion   string
    Author          string
    Config          *container.Config
    Architecture    string
    Variant         string `json:",omitempty"`
    Os              string
    OsVersion       string `json:",omitempty"`
    Size            int64
    VirtualSize     int64
    GraphDriver     GraphDriverData
    RootFS          RootFS
    Metadata        ImageMetadata

ImageInspect contains response of Engine API: GET "/images/{name:.*}/json"

type ImageListOptions Uses

type ImageListOptions struct {
    All     bool
    Filters filters.Args

ImageListOptions holds parameters to filter the list of images with.

type ImageLoadResponse Uses

type ImageLoadResponse struct {
    // Body must be closed to avoid a resource leak
    Body io.ReadCloser
    JSON bool

ImageLoadResponse returns information to the client about a load process.

type ImageMetadata Uses

type ImageMetadata struct {
    LastTagTime time.Time `json:",omitempty"`

ImageMetadata contains engine-local data about the image

type ImagePullOptions Uses

type ImagePullOptions struct {
    All           bool
    RegistryAuth  string // RegistryAuth is the base64 encoded credentials for the registry
    PrivilegeFunc RequestPrivilegeFunc
    Platform      string

ImagePullOptions holds information to pull images.

type ImagePushOptions Uses

type ImagePushOptions ImagePullOptions

ImagePushOptions holds information to push images.

type ImageRemoveOptions Uses

type ImageRemoveOptions struct {
    Force         bool
    PruneChildren bool

ImageRemoveOptions holds parameters to remove images.

type ImageSearchOptions Uses

type ImageSearchOptions struct {
    RegistryAuth  string
    PrivilegeFunc RequestPrivilegeFunc
    Filters       filters.Args
    Limit         int

ImageSearchOptions holds parameters to search images with.

type ImageSummary Uses

type ImageSummary struct {

    // containers
    // Required: true
    Containers int64 `json:"Containers"`

    // created
    // Required: true
    Created int64 `json:"Created"`

    // Id
    // Required: true
    ID  string `json:"Id"`

    // labels
    // Required: true
    Labels map[string]string `json:"Labels"`

    // parent Id
    // Required: true
    ParentID string `json:"ParentId"`

    // repo digests
    // Required: true
    RepoDigests []string `json:"RepoDigests"`

    // repo tags
    // Required: true
    RepoTags []string `json:"RepoTags"`

    // shared size
    // Required: true
    SharedSize int64 `json:"SharedSize"`

    // size
    // Required: true
    Size int64 `json:"Size"`

    // virtual size
    // Required: true
    VirtualSize int64 `json:"VirtualSize"`

ImageSummary image summary swagger:model ImageSummary

type ImagesPruneReport Uses

type ImagesPruneReport struct {
    ImagesDeleted  []ImageDeleteResponseItem
    SpaceReclaimed uint64

ImagesPruneReport contains the response for Engine API: POST "/images/prune"

type Info Uses

type Info struct {
    ID                 string
    Containers         int
    ContainersRunning  int
    ContainersPaused   int
    ContainersStopped  int
    Images             int
    Driver             string
    DriverStatus       [][2]string
    SystemStatus       [][2]string `json:",omitempty"` // SystemStatus is only propagated by the Swarm standalone API
    Plugins            PluginsInfo
    MemoryLimit        bool
    SwapLimit          bool
    KernelMemory       bool // Deprecated: kernel 5.4 deprecated kmem.limit_in_bytes
    KernelMemoryTCP    bool
    CPUCfsPeriod       bool `json:"CpuCfsPeriod"`
    CPUCfsQuota        bool `json:"CpuCfsQuota"`
    CPUShares          bool
    CPUSet             bool
    PidsLimit          bool
    IPv4Forwarding     bool
    BridgeNfIptables   bool
    BridgeNfIP6tables  bool `json:"BridgeNfIp6tables"`
    Debug              bool
    NFd                int
    OomKillDisable     bool
    NGoroutines        int
    SystemTime         string
    LoggingDriver      string
    CgroupDriver       string
    CgroupVersion      string `json:",omitempty"`
    NEventsListener    int
    KernelVersion      string
    OperatingSystem    string
    OSVersion          string
    OSType             string
    Architecture       string
    IndexServerAddress string
    RegistryConfig     *registry.ServiceConfig
    NCPU               int
    MemTotal           int64
    GenericResources   []swarm.GenericResource
    DockerRootDir      string
    HTTPProxy          string `json:"HttpProxy"`
    HTTPSProxy         string `json:"HttpsProxy"`
    NoProxy            string
    Name               string
    Labels             []string
    ExperimentalBuild  bool
    ServerVersion      string
    ClusterStore       string `json:",omitempty"` // Deprecated: host-discovery and overlay networks with external k/v stores are deprecated
    ClusterAdvertise   string `json:",omitempty"` // Deprecated: host-discovery and overlay networks with external k/v stores are deprecated
    Runtimes           map[string]Runtime
    DefaultRuntime     string
    Swarm              swarm.Info
    // LiveRestoreEnabled determines whether containers should be kept
    // running when the daemon is shutdown or upon daemon start if
    // running containers are detected
    LiveRestoreEnabled  bool
    Isolation           container.Isolation
    InitBinary          string
    ContainerdCommit    Commit
    RuncCommit          Commit
    InitCommit          Commit
    SecurityOptions     []string
    ProductLicense      string               `json:",omitempty"`
    DefaultAddressPools []NetworkAddressPool `json:",omitempty"`
    Warnings            []string

Info contains response of Engine API: GET "/info"

type KeyValue Uses

type KeyValue struct {
    Key, Value string

KeyValue holds a key/value pair

type MemoryStats Uses

type MemoryStats struct {

    // current res_counter usage for memory
    Usage uint64 `json:"usage,omitempty"`
    // maximum usage ever recorded.
    MaxUsage uint64 `json:"max_usage,omitempty"`
    // TODO(vishh): Export these as stronger types.
    // all the stats exported via memory.stat.
    Stats map[string]uint64 `json:"stats,omitempty"`
    // number of times memory usage hits limits.
    Failcnt uint64 `json:"failcnt,omitempty"`
    Limit   uint64 `json:"limit,omitempty"`

    // committed bytes
    Commit uint64 `json:"commitbytes,omitempty"`
    // peak committed bytes
    CommitPeak uint64 `json:"commitpeakbytes,omitempty"`
    // private working set
    PrivateWorkingSet uint64 `json:"privateworkingset,omitempty"`

MemoryStats aggregates all memory stats since container inception on Linux. Windows returns stats for commit and private working set only.

type MountPoint Uses

type MountPoint struct {
    Type        mount.Type `json:",omitempty"`
    Name        string     `json:",omitempty"`
    Source      string
    Destination string
    Driver      string `json:",omitempty"`
    Mode        string
    RW          bool
    Propagation mount.Propagation

MountPoint represents a mount point configuration inside the container. This is used for reporting the mountpoints in use by a container.

type NetworkAddressPool Uses

type NetworkAddressPool struct {
    Base string
    Size int

NetworkAddressPool is a temp struct used by Info struct

type NetworkConnect Uses

type NetworkConnect struct {
    Container      string
    EndpointConfig *network.EndpointSettings `json:",omitempty"`

NetworkConnect represents the data to be used to connect a container to the network

type NetworkCreate Uses

type NetworkCreate struct {
    // Check for networks with duplicate names.
    // Network is primarily keyed based on a random ID and not on the name.
    // Network name is strictly a user-friendly alias to the network
    // which is uniquely identified using ID.
    // And there is no guaranteed way to check for duplicates.
    // Option CheckDuplicate is there to provide a best effort checking of any networks
    // which has the same name but it is not guaranteed to catch all name collisions.
    CheckDuplicate bool
    Driver         string
    Scope          string
    EnableIPv6     bool
    IPAM           *network.IPAM
    Internal       bool
    Attachable     bool
    Ingress        bool
    ConfigOnly     bool
    ConfigFrom     *network.ConfigReference
    Options        map[string]string
    Labels         map[string]string

NetworkCreate is the expected body of the "create network" http request message

type NetworkCreateRequest Uses

type NetworkCreateRequest struct {
    Name string

NetworkCreateRequest is the request message sent to the server for network create call.

type NetworkCreateResponse Uses

type NetworkCreateResponse struct {
    ID      string `json:"Id"`
    Warning string

NetworkCreateResponse is the response message sent by the server for network create call

type NetworkDisconnect Uses

type NetworkDisconnect struct {
    Container string
    Force     bool

NetworkDisconnect represents the data to be used to disconnect a container from the network

type NetworkInspectOptions Uses

type NetworkInspectOptions struct {
    Scope   string
    Verbose bool

NetworkInspectOptions holds parameters to inspect network

type NetworkListConfig Uses

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

NetworkListConfig stores the options available for listing networks

type NetworkListOptions Uses

type NetworkListOptions struct {
    Filters filters.Args

NetworkListOptions holds parameters to filter the list of networks with.

type NetworkResource Uses

type NetworkResource struct {
    Name       string                         // Name is the requested name of the network
    ID         string                         `json:"Id"` // ID uniquely identifies a network on a single machine
    Created    time.Time                      // Created is the time the network created
    Scope      string                         // Scope describes the level at which the network exists (e.g. `swarm` for cluster-wide or `local` for machine level)
    Driver     string                         // Driver is the Driver name used to create the network (e.g. `bridge`, `overlay`)
    EnableIPv6 bool                           // EnableIPv6 represents whether to enable IPv6
    IPAM       network.IPAM                   // IPAM is the network's IP Address Management
    Internal   bool                           // Internal represents if the network is used internal only
    Attachable bool                           // Attachable represents if the global scope is manually attachable by regular containers from workers in swarm mode.
    Ingress    bool                           // Ingress indicates the network is providing the routing-mesh for the swarm cluster.
    ConfigFrom network.ConfigReference        // ConfigFrom specifies the source which will provide the configuration for this network.
    ConfigOnly bool                           // ConfigOnly networks are place-holder networks for network configurations to be used by other networks. ConfigOnly networks cannot be used directly to run containers or services.
    Containers map[string]EndpointResource    // Containers contains endpoints belonging to the network
    Options    map[string]string              // Options holds the network specific options to use for when creating the network
    Labels     map[string]string              // Labels holds metadata specific to the network being created
    Peers      []network.PeerInfo             `json:",omitempty"` // List of peer nodes for an overlay network
    Services   map[string]network.ServiceInfo `json:",omitempty"`

NetworkResource is the body of the "get network" http response message

type NetworkSettings Uses

type NetworkSettings struct {
    Networks map[string]*network.EndpointSettings

NetworkSettings exposes the network settings in the api

type NetworkSettingsBase Uses

type NetworkSettingsBase struct {
    Bridge                 string      // Bridge is the Bridge name the network uses(e.g. `docker0`)
    SandboxID              string      // SandboxID uniquely represents a container's network stack
    HairpinMode            bool        // HairpinMode specifies if hairpin NAT should be enabled on the virtual interface
    LinkLocalIPv6Address   string      // LinkLocalIPv6Address is an IPv6 unicast address using the link-local prefix
    LinkLocalIPv6PrefixLen int         // LinkLocalIPv6PrefixLen is the prefix length of an IPv6 unicast address
    Ports                  nat.PortMap // Ports is a collection of PortBinding indexed by Port
    SandboxKey             string      // SandboxKey identifies the sandbox
    SecondaryIPAddresses   []network.Address
    SecondaryIPv6Addresses []network.Address

NetworkSettingsBase holds basic information about networks

type NetworkStats Uses

type NetworkStats struct {
    // Bytes received. Windows and Linux.
    RxBytes uint64 `json:"rx_bytes"`
    // Packets received. Windows and Linux.
    RxPackets uint64 `json:"rx_packets"`
    // Received errors. Not used on Windows. Note that we don't `omitempty` this
    // field as it is expected in the >=v1.21 API stats structure.
    RxErrors uint64 `json:"rx_errors"`
    // Incoming packets dropped. Windows and Linux.
    RxDropped uint64 `json:"rx_dropped"`
    // Bytes sent. Windows and Linux.
    TxBytes uint64 `json:"tx_bytes"`
    // Packets sent. Windows and Linux.
    TxPackets uint64 `json:"tx_packets"`
    // Sent errors. Not used on Windows. Note that we don't `omitempty` this
    // field as it is expected in the >=v1.21 API stats structure.
    TxErrors uint64 `json:"tx_errors"`
    // Outgoing packets dropped. Windows and Linux.
    TxDropped uint64 `json:"tx_dropped"`
    // Endpoint ID. Not used on Linux.
    EndpointID string `json:"endpoint_id,omitempty"`
    // Instance ID. Not used on Linux.
    InstanceID string `json:"instance_id,omitempty"`

NetworkStats aggregates the network stats of one container

type NetworksPruneReport Uses

type NetworksPruneReport struct {
    NetworksDeleted []string

NetworksPruneReport contains the response for Engine API: POST "/networks/prune"

type NodeListOptions Uses

type NodeListOptions struct {
    Filters filters.Args

NodeListOptions holds parameters to list nodes with.

type NodeRemoveOptions Uses

type NodeRemoveOptions struct {
    Force bool

NodeRemoveOptions holds parameters to remove nodes with.

type PidsStats Uses

type PidsStats struct {
    // Current is the number of pids in the cgroup
    Current uint64 `json:"current,omitempty"`
    // Limit is the hard limit on the number of pids in the cgroup.
    // A "Limit" of 0 means that there is no limit.
    Limit uint64 `json:"limit,omitempty"`

PidsStats contains the stats of a container's pids

type Ping Uses

type Ping struct {
    APIVersion     string
    OSType         string
    Experimental   bool
    BuilderVersion BuilderVersion

Ping contains response of Engine API: GET "/_ping"

type Plugin Uses

type Plugin struct {

    // config
    // Required: true
    Config PluginConfig `json:"Config"`

    // True if the plugin is running. False if the plugin is not running, only installed.
    // Required: true
    Enabled bool `json:"Enabled"`

    // Id
    ID  string `json:"Id,omitempty"`

    // name
    // Required: true
    Name string `json:"Name"`

    // plugin remote reference used to push/pull the plugin
    PluginReference string `json:"PluginReference,omitempty"`

    // settings
    // Required: true
    Settings PluginSettings `json:"Settings"`

Plugin A plugin for the Engine API swagger:model Plugin

type PluginConfig Uses

type PluginConfig struct {

    // args
    // Required: true
    Args PluginConfigArgs `json:"Args"`

    // description
    // Required: true
    Description string `json:"Description"`

    // Docker Version used to create the plugin
    DockerVersion string `json:"DockerVersion,omitempty"`

    // documentation
    // Required: true
    Documentation string `json:"Documentation"`

    // entrypoint
    // Required: true
    Entrypoint []string `json:"Entrypoint"`

    // env
    // Required: true
    Env []PluginEnv `json:"Env"`

    // interface
    // Required: true
    Interface PluginConfigInterface `json:"Interface"`

    // ipc host
    // Required: true
    IpcHost bool `json:"IpcHost"`

    // linux
    // Required: true
    Linux PluginConfigLinux `json:"Linux"`

    // mounts
    // Required: true
    Mounts []PluginMount `json:"Mounts"`

    // network
    // Required: true
    Network PluginConfigNetwork `json:"Network"`

    // pid host
    // Required: true
    PidHost bool `json:"PidHost"`

    // propagated mount
    // Required: true
    PropagatedMount string `json:"PropagatedMount"`

    // user
    User PluginConfigUser `json:"User,omitempty"`

    // work dir
    // Required: true
    WorkDir string `json:"WorkDir"`

    // rootfs
    Rootfs *PluginConfigRootfs `json:"rootfs,omitempty"`

PluginConfig The config of a plugin. swagger:model PluginConfig

type PluginConfigArgs Uses

type PluginConfigArgs struct {

    // description
    // Required: true
    Description string `json:"Description"`

    // name
    // Required: true
    Name string `json:"Name"`

    // settable
    // Required: true
    Settable []string `json:"Settable"`

    // value
    // Required: true
    Value []string `json:"Value"`

PluginConfigArgs plugin config args swagger:model PluginConfigArgs

type PluginConfigInterface Uses

type PluginConfigInterface struct {

    // Protocol to use for clients connecting to the plugin.
    ProtocolScheme string `json:"ProtocolScheme,omitempty"`

    // socket
    // Required: true
    Socket string `json:"Socket"`

    // types
    // Required: true
    Types []PluginInterfaceType `json:"Types"`

PluginConfigInterface The interface between Docker and the plugin swagger:model PluginConfigInterface

type PluginConfigLinux Uses

type PluginConfigLinux struct {

    // allow all devices
    // Required: true
    AllowAllDevices bool `json:"AllowAllDevices"`

    // capabilities
    // Required: true
    Capabilities []string `json:"Capabilities"`

    // devices
    // Required: true
    Devices []PluginDevice `json:"Devices"`

PluginConfigLinux plugin config linux swagger:model PluginConfigLinux

type PluginConfigNetwork Uses

type PluginConfigNetwork struct {

    // type
    // Required: true
    Type string `json:"Type"`

PluginConfigNetwork plugin config network swagger:model PluginConfigNetwork

type PluginConfigRootfs Uses

type PluginConfigRootfs struct {

    // diff ids
    DiffIds []string `json:"diff_ids"`

    // type
    Type string `json:"type,omitempty"`

PluginConfigRootfs plugin config rootfs swagger:model PluginConfigRootfs

type PluginConfigUser Uses

type PluginConfigUser struct {

    // g ID
    GID uint32 `json:"GID,omitempty"`

    // UID
    UID uint32 `json:"UID,omitempty"`

PluginConfigUser plugin config user swagger:model PluginConfigUser

type PluginCreateOptions Uses

type PluginCreateOptions struct {
    RepoName string

PluginCreateOptions hold all options to plugin create.

type PluginDevice Uses

type PluginDevice struct {

    // description
    // Required: true
    Description string `json:"Description"`

    // name
    // Required: true
    Name string `json:"Name"`

    // path
    // Required: true
    Path *string `json:"Path"`

    // settable
    // Required: true
    Settable []string `json:"Settable"`

PluginDevice plugin device swagger:model PluginDevice

type PluginDisableConfig Uses

type PluginDisableConfig struct {
    ForceDisable bool

PluginDisableConfig holds arguments for plugin disable.

type PluginDisableOptions Uses

type PluginDisableOptions struct {
    Force bool

PluginDisableOptions holds parameters to disable plugins.

type PluginEnableConfig Uses

type PluginEnableConfig struct {
    Timeout int

PluginEnableConfig holds arguments for plugin enable

type PluginEnableOptions Uses

type PluginEnableOptions struct {
    Timeout int

PluginEnableOptions holds parameters to enable plugins.

type PluginEnv Uses

type PluginEnv struct {

    // description
    // Required: true
    Description string `json:"Description"`

    // name
    // Required: true
    Name string `json:"Name"`

    // settable
    // Required: true
    Settable []string `json:"Settable"`

    // value
    // Required: true
    Value *string `json:"Value"`

PluginEnv plugin env swagger:model PluginEnv

type PluginInstallOptions Uses

type PluginInstallOptions struct {
    Disabled              bool
    AcceptAllPermissions  bool
    RegistryAuth          string // RegistryAuth is the base64 encoded credentials for the registry
    RemoteRef             string // RemoteRef is the plugin name on the registry
    PrivilegeFunc         RequestPrivilegeFunc
    AcceptPermissionsFunc func(PluginPrivileges) (bool, error)
    Args                  []string

PluginInstallOptions holds parameters to install a plugin.

type PluginInterfaceType Uses

type PluginInterfaceType struct {

    // capability
    // Required: true
    Capability string `json:"Capability"`

    // prefix
    // Required: true
    Prefix string `json:"Prefix"`

    // version
    // Required: true
    Version string `json:"Version"`

PluginInterfaceType plugin interface type swagger:model PluginInterfaceType

func (*PluginInterfaceType) MarshalJSON Uses

func (t *PluginInterfaceType) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler for PluginInterfaceType

func (PluginInterfaceType) String Uses

func (t PluginInterfaceType) String() string

String implements fmt.Stringer for PluginInterfaceType

func (*PluginInterfaceType) UnmarshalJSON Uses

func (t *PluginInterfaceType) UnmarshalJSON(p []byte) error

UnmarshalJSON implements json.Unmarshaler for PluginInterfaceType

type PluginMount Uses

type PluginMount struct {

    // description
    // Required: true
    Description string `json:"Description"`

    // destination
    // Required: true
    Destination string `json:"Destination"`

    // name
    // Required: true
    Name string `json:"Name"`

    // options
    // Required: true
    Options []string `json:"Options"`

    // settable
    // Required: true
    Settable []string `json:"Settable"`

    // source
    // Required: true
    Source *string `json:"Source"`

    // type
    // Required: true
    Type string `json:"Type"`

PluginMount plugin mount swagger:model PluginMount

type PluginPrivilege Uses

type PluginPrivilege struct {
    Name        string
    Description string
    Value       []string

PluginPrivilege describes a permission the user has to accept upon installing a plugin.

type PluginPrivileges Uses

type PluginPrivileges []PluginPrivilege

PluginPrivileges is a list of PluginPrivilege

func (PluginPrivileges) Len Uses

func (s PluginPrivileges) Len() int

func (PluginPrivileges) Less Uses

func (s PluginPrivileges) Less(i, j int) bool

func (PluginPrivileges) Swap Uses

func (s PluginPrivileges) Swap(i, j int)

type PluginRemoveOptions Uses

type PluginRemoveOptions struct {
    Force bool

PluginRemoveOptions holds parameters to remove plugins.

type PluginRmConfig Uses

type PluginRmConfig struct {
    ForceRemove bool

PluginRmConfig holds arguments for plugin remove.

type PluginSettings Uses

type PluginSettings struct {

    // args
    // Required: true
    Args []string `json:"Args"`

    // devices
    // Required: true
    Devices []PluginDevice `json:"Devices"`

    // env
    // Required: true
    Env []string `json:"Env"`

    // mounts
    // Required: true
    Mounts []PluginMount `json:"Mounts"`

PluginSettings Settings that can be modified by users. swagger:model PluginSettings

type PluginsInfo Uses

type PluginsInfo struct {
    // List of Volume plugins registered
    Volume []string
    // List of Network plugins registered
    Network []string
    // List of Authorization plugins registered
    Authorization []string
    // List of Log plugins registered
    Log []string

PluginsInfo is a temp struct holding Plugins name registered with docker daemon. It is used by Info struct

type PluginsListResponse Uses

type PluginsListResponse []*Plugin

PluginsListResponse contains the response for the Engine API

type Port Uses

type Port struct {

    // Host IP address that the container's port is mapped to
    IP  string `json:"IP,omitempty"`

    // Port on the container
    // Required: true
    PrivatePort uint16 `json:"PrivatePort"`

    // Port exposed on the host
    PublicPort uint16 `json:"PublicPort,omitempty"`

    // type
    // Required: true
    Type string `json:"Type"`

Port An open port on a container swagger:model Port

type PushResult Uses

type PushResult struct {
    Tag    string
    Digest string
    Size   int

PushResult contains the tag, manifest digest, and manifest size from the push. It's used to signal this information to the trust code in the client so it can sign the manifest if necessary.

type RequestPrivilegeFunc Uses

type RequestPrivilegeFunc func() (string, error)

RequestPrivilegeFunc is a function interface that clients can supply to retry operations after getting an authorization error. This function returns the registry authentication header value in base 64 format, or an error if the privilege request fails.

type ResizeOptions Uses

type ResizeOptions struct {
    Height uint
    Width  uint

ResizeOptions holds parameters to resize a tty. It can be used to resize container ttys and exec process ttys too.

type RootFS Uses

type RootFS struct {
    Type      string
    Layers    []string `json:",omitempty"`
    BaseLayer string   `json:",omitempty"`

RootFS returns Image's RootFS description including the layer IDs.

type Runtime Uses

type Runtime struct {
    Path string   `json:"path"`
    Args []string `json:"runtimeArgs,omitempty"`

    // This is exposed here only for internal use
    // It is not currently supported to specify custom shim configs
    Shim *ShimConfig `json:"-"`

Runtime describes an OCI runtime

type SecretCreateResponse Uses

type SecretCreateResponse struct {
    // ID is the id of the created secret.
    ID string

SecretCreateResponse contains the information returned to a client on the creation of a new secret.

type SecretListOptions Uses

type SecretListOptions struct {
    Filters filters.Args

SecretListOptions holds parameters to list secrets

type SecurityOpt Uses

type SecurityOpt struct {
    Name    string
    Options []KeyValue

SecurityOpt contains the name and options of a security option

func DecodeSecurityOptions Uses

func DecodeSecurityOptions(opts []string) ([]SecurityOpt, error)

DecodeSecurityOptions decodes a security options string slice to a type safe SecurityOpt

type ServiceCreateOptions Uses

type ServiceCreateOptions struct {
    // EncodedRegistryAuth is the encoded registry authorization credentials to
    // use when updating the service.
    // This field follows the format of the X-Registry-Auth header.
    EncodedRegistryAuth string

    // QueryRegistry indicates whether the service update requires
    // contacting a registry. A registry may be contacted to retrieve
    // the image digest and manifest, which in turn can be used to update
    // platform or other information about the service.
    QueryRegistry bool

ServiceCreateOptions contains the options to use when creating a service.

type ServiceCreateResponse Uses

type ServiceCreateResponse struct {
    // ID is the ID of the created service.
    ID  string
    // Warnings is a set of non-fatal warning messages to pass on to the user.
    Warnings []string `json:",omitempty"`

ServiceCreateResponse contains the information returned to a client on the creation of a new service.

type ServiceInspectOptions Uses

type ServiceInspectOptions struct {
    InsertDefaults bool

ServiceInspectOptions holds parameters related to the "service inspect" operation.

type ServiceListOptions Uses

type ServiceListOptions struct {
    Filters filters.Args

    // Status indicates whether the server should include the service task
    // count of running and desired tasks.
    Status bool

ServiceListOptions holds parameters to list services with.

type ServiceUpdateOptions Uses

type ServiceUpdateOptions struct {
    // EncodedRegistryAuth is the encoded registry authorization credentials to
    // use when updating the service.
    // This field follows the format of the X-Registry-Auth header.
    EncodedRegistryAuth string

    // RegistryAuthFrom specifies where to find the registry authorization
    // credentials if they are not given in EncodedRegistryAuth. Valid
    // values are "spec" and "previous-spec".
    RegistryAuthFrom string

    // Rollback indicates whether a server-side rollback should be
    // performed. When this is set, the provided spec will be ignored.
    // The valid values are "previous" and "none". An empty value is the
    // same as "none".
    Rollback string

    // QueryRegistry indicates whether the service update requires
    // contacting a registry. A registry may be contacted to retrieve
    // the image digest and manifest, which in turn can be used to update
    // platform or other information about the service.
    QueryRegistry bool

ServiceUpdateOptions contains the options to be used for updating services.

type ServiceUpdateResponse Uses

type ServiceUpdateResponse struct {

    // Optional warning messages
    Warnings []string `json:"Warnings"`

ServiceUpdateResponse service update response swagger:model ServiceUpdateResponse

type ShimConfig Uses

type ShimConfig struct {
    Binary string
    Opts   interface{}

ShimConfig is used by runtime to configure containerd shims

type Stats Uses

type Stats struct {
    // Common stats
    Read    time.Time `json:"read"`
    PreRead time.Time `json:"preread"`

    // Linux specific stats, not populated on Windows.
    PidsStats  PidsStats  `json:"pids_stats,omitempty"`
    BlkioStats BlkioStats `json:"blkio_stats,omitempty"`

    // Windows specific stats, not populated on Linux.
    NumProcs     uint32       `json:"num_procs"`
    StorageStats StorageStats `json:"storage_stats,omitempty"`

    // Shared stats
    CPUStats    CPUStats    `json:"cpu_stats,omitempty"`
    PreCPUStats CPUStats    `json:"precpu_stats,omitempty"` // "Pre"="Previous"
    MemoryStats MemoryStats `json:"memory_stats,omitempty"`

Stats is Ultimate struct aggregating all types of stats of one container

type StatsJSON Uses

type StatsJSON struct {

    Name string `json:"name,omitempty"`
    ID   string `json:"id,omitempty"`

    // Networks request version >=1.21
    Networks map[string]NetworkStats `json:"networks,omitempty"`

StatsJSON is newly used Networks

type StorageStats Uses

type StorageStats struct {
    ReadCountNormalized  uint64 `json:"read_count_normalized,omitempty"`
    ReadSizeBytes        uint64 `json:"read_size_bytes,omitempty"`
    WriteCountNormalized uint64 `json:"write_count_normalized,omitempty"`
    WriteSizeBytes       uint64 `json:"write_size_bytes,omitempty"`

StorageStats is the disk I/O stats for read/write on Windows.

type SummaryNetworkSettings Uses

type SummaryNetworkSettings struct {
    Networks map[string]*network.EndpointSettings

SummaryNetworkSettings provides a summary of container's networks in /containers/json

type SwarmUnlockKeyResponse Uses

type SwarmUnlockKeyResponse struct {
    // UnlockKey is the unlock key in ASCII-armored format.
    UnlockKey string

SwarmUnlockKeyResponse contains the response for Engine API: GET /swarm/unlockkey

type TaskListOptions Uses

type TaskListOptions struct {
    Filters filters.Args

TaskListOptions holds parameters to list tasks with.

type ThrottlingData Uses

type ThrottlingData struct {
    // Number of periods with throttling active
    Periods uint64 `json:"periods"`
    // Number of periods when the container hits its throttling limit.
    ThrottledPeriods uint64 `json:"throttled_periods"`
    // Aggregate time the container was throttled for in nanoseconds.
    ThrottledTime uint64 `json:"throttled_time"`

ThrottlingData stores CPU throttling stats of one running container. Not used on Windows.

type Version Uses

type Version struct {
    Platform   struct{ Name string } `json:",omitempty"`
    Components []ComponentVersion    `json:",omitempty"`

    Version       string
    APIVersion    string `json:"ApiVersion"`
    MinAPIVersion string `json:"MinAPIVersion,omitempty"`
    GitCommit     string
    GoVersion     string
    Os            string
    Arch          string
    KernelVersion string `json:",omitempty"`
    Experimental  bool   `json:",omitempty"`
    BuildTime     string `json:",omitempty"`

Version contains response of Engine API: GET "/version"

type Volume Uses

type Volume struct {

    // Date/Time the volume was created.
    CreatedAt string `json:"CreatedAt,omitempty"`

    // Name of the volume driver used by the volume.
    // Required: true
    Driver string `json:"Driver"`

    // User-defined key/value metadata.
    // Required: true
    Labels map[string]string `json:"Labels"`

    // Mount path of the volume on the host.
    // Required: true
    Mountpoint string `json:"Mountpoint"`

    // Name of the volume.
    // Required: true
    Name string `json:"Name"`

    // The driver specific options used when creating the volume.
    // Required: true
    Options map[string]string `json:"Options"`

    // The level at which the volume exists. Either `global` for cluster-wide,
    // or `local` for machine level.
    // Required: true
    Scope string `json:"Scope"`

    // Low-level details about the volume, provided by the volume driver.
    // Details are returned as a map with key/value pairs:
    // `{"key":"value","key2":"value2"}`.
    // The `Status` field is optional, and is omitted if the volume driver
    // does not support this feature.
    Status map[string]interface{} `json:"Status,omitempty"`

    // usage data
    UsageData *VolumeUsageData `json:"UsageData,omitempty"`

Volume volume swagger:model Volume

type VolumeUsageData Uses

type VolumeUsageData struct {

    // The number of containers referencing this volume. This field
    // is set to `-1` if the reference-count is not available.
    // Required: true
    RefCount int64 `json:"RefCount"`

    // Amount of disk space used by the volume (in bytes). This information
    // is only available for volumes created with the `"local"` volume
    // driver. For volumes created with other volume drivers, this field
    // is set to `-1` ("not available")
    // Required: true
    Size int64 `json:"Size"`

VolumeUsageData Usage details about the volume. This information is used by the `GET /system/df` endpoint, and omitted in other endpoints.

swagger:model VolumeUsageData

type VolumesPruneReport Uses

type VolumesPruneReport struct {
    VolumesDeleted []string
    SpaceReclaimed uint64

VolumesPruneReport contains the response for Engine API: POST "/volumes/prune"


backendPackage backend includes types to send information to server backends.
filtersPackage filters provides tools for encoding a mapping of keys to a set of multiple values.
plugins/logdriverPackage logdriver is a generated protocol buffer package.
swarm/runtimePackage runtime is a generated protocol buffer package.
versions/v1p19Package v1p19 provides specific API types for the API version 1, patch 19.
versions/v1p20Package v1p20 provides specific API types for the API version 1, patch 20.

Package types imports 19 packages (graph) and is imported by 12210 packages. Updated 2020-11-16. Refresh now. Tools for package owners.