engine-api: github.com/docker/engine-api/types Index | Files | Directories

package types

import "github.com/docker/engine-api/types"

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 errors.go seccomp.go stats.go types.go


const (
    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 Action Uses

type Action string

Action taken upon Seccomp rule match

const (
    ActKill  Action = "SCMP_ACT_KILL"
    ActTrap  Action = "SCMP_ACT_TRAP"
    ActErrno Action = "SCMP_ACT_ERRNO"
    ActTrace Action = "SCMP_ACT_TRACE"
    ActAllow Action = "SCMP_ACT_ALLOW"

Define actions for Seccomp rules

type Arch Uses

type Arch string

Arch used for architectures

const (
    ArchX86         Arch = "SCMP_ARCH_X86"
    ArchX86_64      Arch = "SCMP_ARCH_X86_64"
    ArchX32         Arch = "SCMP_ARCH_X32"
    ArchARM         Arch = "SCMP_ARCH_ARM"
    ArchAARCH64     Arch = "SCMP_ARCH_AARCH64"
    ArchMIPS        Arch = "SCMP_ARCH_MIPS"
    ArchMIPS64      Arch = "SCMP_ARCH_MIPS64"
    ArchMIPS64N32   Arch = "SCMP_ARCH_MIPS64N32"
    ArchMIPSEL      Arch = "SCMP_ARCH_MIPSEL"
    ArchMIPSEL64    Arch = "SCMP_ARCH_MIPSEL64"
    ArchMIPSEL64N32 Arch = "SCMP_ARCH_MIPSEL64N32"
    ArchPPC         Arch = "SCMP_ARCH_PPC"
    ArchPPC64       Arch = "SCMP_ARCH_PPC64"
    ArchPPC64LE     Arch = "SCMP_ARCH_PPC64LE"
    ArchS390        Arch = "SCMP_ARCH_S390"
    ArchS390X       Arch = "SCMP_ARCH_S390X"

Additional architectures permitted to be used for system calls By default only the native architecture of the kernel is permitted

type Architecture Uses

type Architecture struct {
    Arch      Arch   `json:"architecture"`
    SubArches []Arch `json:"subArchitectures"`

Architecture is used to represent an specific architecture and its sub-architectures

type Arg Uses

type Arg struct {
    Index    uint     `json:"index"`
    Value    uint64   `json:"value"`
    ValueTwo uint64   `json:"valueTwo"`
    Op       Operator `json:"op"`

Arg used for matching specific syscall arguments in Seccomp

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 AuthResponse Uses

type AuthResponse struct {
    // Status is the authentication status
    Status string `json:"Status"`

    // IdentityToken is an opaque token used for authenticating
    // a user after a successful login.
    IdentityToken string `json:"IdentityToken,omitempty"`

AuthResponse contains response of Remote API: POST "/auth"

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 TODO Windows: This can be factored out

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 TODO Windows: This can be factored out

type CPUStats Uses

type CPUStats struct {
    CPUUsage       CPUUsage       `json:"cpu_usage"`
    SystemUsage    uint64         `json:"system_cpu_usage"`
    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.
    TotalUsage uint64 `json:"total_usage"`
    // Total CPU time consumed per core.
    // Units: nanoseconds.
    PercpuUsage []uint64 `json:"percpu_usage"`
    // Time spent by tasks of the cgroup in kernel mode.
    // Units: nanoseconds.
    UsageInKernelmode uint64 `json:"usage_in_kernelmode"`
    // Time spent by tasks of the cgroup in user mode.
    // Units: nanoseconds.
    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
    Exit         bool

CheckpointCreateOptions holds parameters to create a checkpoint from 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 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 Remote API: GET "/containers/json"

type ContainerAttachOptions Uses

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

ContainerAttachOptions holds parameters to attach to a container.

type ContainerChange Uses

type ContainerChange struct {
    Kind int
    Path string

ContainerChange contains response of Remote API: GET "/containers/{name:.*}/changes"

type ContainerCommitConfig Uses

type ContainerCommitConfig struct {
    Pause   bool
    Repo    string
    Tag     string
    Author  string
    Comment string
    // merge container config into commit config before commit
    MergeConfigs bool
    Config       *container.Config

ContainerCommitConfig contains build configs for commit operation, and is used when making a commit with the current state of the 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 ContainerCommitResponse Uses

type ContainerCommitResponse struct {
    ID string `json:"Id"`

ContainerCommitResponse contains response of Remote API: POST "/commit?container="+containerID

type ContainerCreateConfig Uses

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

ContainerCreateConfig is the parameter set to ContainerCreate()

type ContainerCreateResponse Uses

type ContainerCreateResponse struct {
    // ID is the ID of the created container.
    ID  string `json:"Id"`

    // Warnings are any warnings encountered during the creation of the container.
    Warnings []string `json:"Warnings"`

ContainerCreateResponse contains the information returned to a client on the creation of a new container.

type ContainerExecCreateResponse Uses

type ContainerExecCreateResponse struct {
    // ID is the exec ID.
    ID string `json:"Id"`

ContainerExecCreateResponse contains response of Remote API: POST "/containers/{name:.*}/exec"

type ContainerExecInspect Uses

type ContainerExecInspect struct {
    ExecID      string
    ContainerID string
    Running     bool
    ExitCode    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"`
    Name            string
    RestartCount    int
    Driver          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 Remote 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
    Filter filters.Args

ContainerListOptions holds parameters to list containers with.

type ContainerLogsOptions Uses

type ContainerLogsOptions struct {
    ShowStdout bool
    ShowStderr bool
    Since      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 available in Docker Swarm

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 ContainerProcessList Uses

type ContainerProcessList struct {
    Processes [][]string
    Titles    []string

ContainerProcessList contains response of Remote API: GET "/containers/{name:.*}/top"

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

ContainerStartOptions holds parameters to start containers.

type ContainerState Uses

type ContainerState struct {
    Status     string
    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 ContainerUpdateResponse Uses

type ContainerUpdateResponse struct {
    // Warnings are any warnings encountered during the updating of the container.
    Warnings []string `json:"Warnings"`

ContainerUpdateResponse contains response of Remote API: POST "/containers/{name:.*}/update"

type ContainerWaitResponse Uses

type ContainerWaitResponse struct {
    // StatusCode is the status code of the wait job
    StatusCode int `json:"StatusCode"`

ContainerWaitResponse contains response of Remote API: POST "/containers/"+containerID+"/wait"

type CopyConfig Uses

type CopyConfig struct {
    Resource string

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

type CopyToContainerOptions Uses

type CopyToContainerOptions struct {
    AllowOverwriteDirWithFile 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 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 {
    Message string `json:"message"`

ErrorResponse is the response body of API errors.

type EventsOptions Uses

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

EventsOptions hold 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
    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 Filter Uses

type Filter struct {
    Caps   []string `json:"caps,omitempty"`
    Arches []string `json:"arches,omitempty"`

Filter is used to conditionally apply Seccomp rules

type GraphDriverData Uses

type GraphDriverData struct {
    Name string
    Data map[string]string

GraphDriverData returns Image's graph driver config info when calling inspect command

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 Image Uses

type Image struct {
    ID          string `json:"Id"`
    ParentID    string `json:"ParentId"`
    RepoTags    []string
    RepoDigests []string
    Created     int64
    Size        int64
    VirtualSize int64
    Labels      map[string]string

Image contains response of Remote API: GET "/images/json"

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
    ShmSize        int64
    Dockerfile     string
    Ulimits        []*units.Ulimit
    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

ImageBuildOptions holds the information necessary to build images.

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

ImageCreateOptions holds information to create images.

type ImageDelete Uses

type ImageDelete struct {
    Untagged string `json:",omitempty"`
    Deleted  string `json:",omitempty"`

ImageDelete contains response of Remote API: DELETE "/images/{name:.*}"

type ImageHistory Uses

type ImageHistory struct {
    ID        string `json:"Id"`
    Created   int64
    CreatedBy string
    Tags      []string
    Size      int64
    Comment   string

ImageHistory contains response of Remote API: GET "/images/{name:.*}/history"

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

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 (mutually exclusive with SourceName)
    SourceName string    // SourceName is the name of the image to pull (mutually exclusive with Source)

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
    Os              string
    Size            int64
    VirtualSize     int64
    GraphDriver     GraphDriverData
    RootFS          RootFS

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

type ImageListOptions Uses

type ImageListOptions struct {
    MatchName string
    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 ImagePullOptions Uses

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

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 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
    Plugins            PluginsInfo
    MemoryLimit        bool
    SwapLimit          bool
    KernelMemory       bool
    CPUCfsPeriod       bool `json:"CpuCfsPeriod"`
    CPUCfsQuota        bool `json:"CpuCfsQuota"`
    CPUShares          bool
    CPUSet             bool
    IPv4Forwarding     bool
    BridgeNfIptables   bool
    BridgeNfIP6tables  bool `json:"BridgeNfIp6tables"`
    Debug              bool
    NFd                int
    OomKillDisable     bool
    NGoroutines        int
    SystemTime         string
    LoggingDriver      string
    CgroupDriver       string
    NEventsListener    int
    KernelVersion      string
    OperatingSystem    string
    OSType             string
    Architecture       string
    IndexServerAddress string
    RegistryConfig     *registry.ServiceConfig
    NCPU               int
    MemTotal           int64
    DockerRootDir      string
    HTTPProxy          string `json:"HttpProxy"`
    HTTPSProxy         string `json:"HttpsProxy"`
    NoProxy            string
    Name               string
    Labels             []string
    ExperimentalBuild  bool
    ServerVersion      string
    ClusterStore       string
    ClusterAdvertise   string
    SecurityOptions    []string
    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

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

type MemoryStats Uses

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

MemoryStats aggregates All memory stats since container inception

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 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 {
    CheckDuplicate bool
    Driver         string
    EnableIPv6     bool
    IPAM           *network.IPAM
    Internal       bool
    Attachable     bool
    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 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
    Scope      string                      // Scope describes the level at which the network exists (e.g. `global` 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.
    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

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 {
    RxBytes   uint64 `json:"rx_bytes"`
    RxPackets uint64 `json:"rx_packets"`
    RxErrors  uint64 `json:"rx_errors"`
    RxDropped uint64 `json:"rx_dropped"`
    TxBytes   uint64 `json:"tx_bytes"`
    TxPackets uint64 `json:"tx_packets"`
    TxErrors  uint64 `json:"tx_errors"`
    TxDropped uint64 `json:"tx_dropped"`

NetworkStats aggregates All network stats of one container TODO Windows: This will require refactoring

type NodeListOptions Uses

type NodeListOptions struct {
    Filter 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 Operator Uses

type Operator string

Operator used to match syscall arguments in Seccomp

const (
    OpNotEqual     Operator = "SCMP_CMP_NE"
    OpLessThan     Operator = "SCMP_CMP_LT"
    OpLessEqual    Operator = "SCMP_CMP_LE"
    OpEqualTo      Operator = "SCMP_CMP_EQ"
    OpGreaterEqual Operator = "SCMP_CMP_GE"
    OpGreaterThan  Operator = "SCMP_CMP_GT"
    OpMaskedEqual  Operator = "SCMP_CMP_MASKED_EQ"

Define operators for syscall arguments in Seccomp

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 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 the plugin remove operation. This struct is used to tell the backend what operations to perform.

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

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

type Port Uses

type Port struct {
    IP          string `json:",omitempty"`
    PrivatePort int
    PublicPort  int `json:",omitempty"`
    Type        string

Port stores open ports info of container e.g. {"PrivatePort": 8080, "PublicPort": 80, "Type": "tcp"}

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 int
    Width  int

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"`

Runtime describes an OCI runtime

type Seccomp Uses

type Seccomp struct {
    DefaultAction Action `json:"defaultAction"`
    // Architectures is kept to maintain backward compatibility with the old
    // seccomp profile.
    Architectures []Arch         `json:"architectures,omitempty"`
    ArchMap       []Architecture `json:"archMap,omitempty"`
    Syscalls      []*Syscall     `json:"syscalls"`

Seccomp represents the config for a seccomp profile for syscall restriction.

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

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

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

type ServiceListOptions Uses

type ServiceListOptions struct {
    Filter filters.Args

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

ServiceUpdateOptions contains the options to be used for updating services.

type Stats Uses

type Stats struct {
    Read        time.Time   `json:"read"`
    PreCPUStats CPUStats    `json:"precpu_stats,omitempty"`
    CPUStats    CPUStats    `json:"cpu_stats,omitempty"`
    MemoryStats MemoryStats `json:"memory_stats,omitempty"`
    BlkioStats  BlkioStats  `json:"blkio_stats,omitempty"`
    PidsStats   PidsStats   `json:"pids_stats,omitempty"`

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

type StatsJSON Uses

type StatsJSON struct {

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

StatsJSON is newly used Networks

type SummaryNetworkSettings Uses

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

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

type Syscall Uses

type Syscall struct {
    Name     string   `json:"name,omitempty"`
    Names    []string `json:"names,omitempty"`
    Action   Action   `json:"action"`
    Args     []*Arg   `json:"args"`
    Comment  string   `json:"comment"`
    Includes Filter   `json:"includes"`
    Excludes Filter   `json:"excludes"`

Syscall is used to match a group of syscalls in Seccomp

type TaskListOptions Uses

type TaskListOptions struct {
    Filter 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

type Version Uses

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

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

type VersionResponse Uses

type VersionResponse struct {
    Client *Version
    Server *Version

VersionResponse holds version information for the client and the server

func (VersionResponse) ServerOK Uses

func (v VersionResponse) ServerOK() bool

ServerOK returns true when the client could connect to the docker server and parse the information received. It returns false otherwise.

type Volume Uses

type Volume struct {
    Name       string                 // Name is the name of the volume
    Driver     string                 // Driver is the Driver name used to create the volume
    Mountpoint string                 // Mountpoint is the location on disk of the volume
    Status     map[string]interface{} `json:",omitempty"` // Status provides low-level status information about the volume
    Labels     map[string]string      // Labels is metadata specific to the volume
    Scope      string                 // Scope describes the level at which the volume exists (e.g. `global` for cluster-wide or `local` for machine level)

Volume represents the configuration of a volume for the remote API

type VolumeCreateRequest Uses

type VolumeCreateRequest struct {
    Name       string            // Name is the requested name of the volume
    Driver     string            // Driver is the name of the driver that should be used to create the volume
    DriverOpts map[string]string // DriverOpts holds the driver specific options to use for when creating the volume.
    Labels     map[string]string // Labels holds metadata specific to the volume being created.

VolumeCreateRequest contains the response for the remote API: POST "/volumes/create"

type VolumesListResponse Uses

type VolumesListResponse struct {
    Volumes  []*Volume // Volumes is the list of volumes being returned
    Warnings []string  // Warnings is a list of warnings that occurred when getting the list from the volume drivers

VolumesListResponse contains the response for the remote API: GET "/volumes"


filtersPackage filters provides helper function to parse and handle command line filter, used for example in docker ps or docker images commands.
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 13 packages (graph) and is imported by 5418 packages. Updated 2017-07-19. Refresh now. Tools for package owners.