Documentation
¶
Overview ¶
Package types catalogs github.com/moby/moby/api/types/container for wrapping by containerkit.
Code generated by go run ./tools/gencatalog; DO NOT EDIT.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container
Each identifier keeps the exact upstream type name. Domain isolation lives in the import path (internal/engine/container/types), not in renamed aliases.
Index ¶
- type BlkioStatEntry
- type BlkioStats
- type CPUStats
- type CPUUsage
- type CgroupSpec
- type CgroupnsMode
- type ChangeType
- type CommitResponse
- type Config
- type ContainerState
- type CreateRequest
- type CreateResponse
- type DeviceMapping
- type DeviceRequest
- type DiskUsage
- type ExecCreateRequest
- type ExecCreateResponse
- type ExecInspectResponse
- type ExecProcessConfig
- type ExecStartRequest
- type FilesystemChange
- type Health
- type HealthConfig
- type HealthStatus
- type HealthSummary
- type HealthcheckResult
- type HostConfig
- type InspectResponse
- type IpcMode
- type Isolation
- type LogConfig
- type LogMode
- type MemoryStats
- type MountPoint
- type NetworkMode
- type NetworkSettings
- type NetworkSettingsSummary
- type NetworkStats
- type PathStat
- type PidMode
- type PidsStats
- type PortSummary
- type PruneReport
- type Resources
- type RestartPolicy
- type RestartPolicyMode
- type State
- type StatsResponse
- type StorageStats
- type Summary
- type ThrottlingData
- type TopResponse
- type UTSMode
- type Ulimit
- type UpdateConfig
- type UpdateResponse
- type UsernsMode
- type WaitCondition
- type WaitExitError
- type WaitResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BlkioStatEntry ¶
type BlkioStatEntry = container.BlkioStatEntry
BlkioStatEntry wraps container.BlkioStatEntry.
BlkioStatEntry is one small entity to store a piece of Blkio stats Not used on Windows.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#BlkioStatEntry GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/stats.go Kind: struct Usecase: wrap the Engine API type BlkioStatEntry from container.
type BlkioStats ¶
type BlkioStats = container.BlkioStats
BlkioStats wraps container.BlkioStats.
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.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#BlkioStats GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/stats.go Kind: struct Usecase: wrap the Engine API type BlkioStats from container.
type CPUStats ¶
CPUStats wraps container.CPUStats.
CPUStats aggregates and wraps all CPU related info of container ¶
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#CPUStats GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/stats.go Kind: struct Usecase: wrap the Engine API type CPUStats from container.
type CPUUsage ¶
CPUUsage wraps container.CPUUsage.
CPUUsage stores All CPU stats aggregated since container inception.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#CPUUsage GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/stats.go Kind: struct Usecase: wrap the Engine API type CPUUsage from container.
type CgroupSpec ¶
type CgroupSpec = container.CgroupSpec
CgroupSpec wraps container.CgroupSpec.
CgroupSpec represents the cgroup to use for the container.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#CgroupSpec GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/hostconfig.go Kind: named:string Underlying: string Usecase: wrap the Engine API type CgroupSpec from container.
type CgroupnsMode ¶
type CgroupnsMode = container.CgroupnsMode
CgroupnsMode wraps container.CgroupnsMode.
CgroupnsMode represents the cgroup namespace mode of the container ¶
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#CgroupnsMode GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/hostconfig.go Kind: named:string Underlying: string Usecase: wrap the Engine API type CgroupnsMode from container.
type ChangeType ¶
type ChangeType = container.ChangeType
ChangeType wraps container.ChangeType.
ChangeType Kind of change ¶
Can be one of:
- `0`: Modified ("C") - `1`: Added ("A") - `2`: Deleted ("D")
swagger:model ChangeType
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#ChangeType GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/change_type.go Kind: named:uint8 Underlying: uint8 Usecase: wrap the Engine API type ChangeType from container.
type CommitResponse ¶
type CommitResponse = container.CommitResponse
CommitResponse wraps container.CommitResponse.
CommitResponse response for the commit API call, containing the ID of the image that was produced.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#CommitResponse GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/commit.go Kind: named:common.IDResponse Underlying: common.IDResponse References: github.com/moby/moby/api/types/common.IDResponse Usecase: wrap the Engine API type CommitResponse from container.
type Config ¶
Config wraps container.Config.
Config contains the configuration data about a container. It should hold only portable information about the container. Here, "portable" means "independent from the host we are running on". Non-portable information *should* appear in HostConfig. All fields added to this struct must be marked `omitempty` to keep getting predictable hashes from the old `v1Compatibility` configuration.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#Config GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/config.go Kind: struct References: github.com/moby/moby/api/types/network.PortSet Usecase: wrap the Engine API type Config from container.
type ContainerState ¶
type ContainerState = container.ContainerState
ContainerState wraps container.ContainerState.
ContainerState is a string representation of the container's current state.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#ContainerState GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/state.go Kind: named:string Underlying: string Usecase: wrap the Engine API type ContainerState from container.
type CreateRequest ¶
type CreateRequest = container.CreateRequest
CreateRequest wraps container.CreateRequest.
CreateRequest is the request message sent to the server for container create calls. It is a config wrapper that holds the container Config (portable) and the corresponding HostConfig (non-portable) and [network.NetworkingConfig].
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#CreateRequest GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/create_request.go Kind: struct References: github.com/moby/moby/api/types/network.NetworkingConfig Usecase: wrap the Engine API type CreateRequest from container.
type CreateResponse ¶
type CreateResponse = container.CreateResponse
CreateResponse wraps container.CreateResponse.
CreateResponse ContainerCreateResponse ¶
OK response to ContainerCreate operation ¶
swagger:model CreateResponse
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#CreateResponse GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/create_response.go Kind: struct Usecase: wrap the Engine API type CreateResponse from container.
type DeviceMapping ¶
type DeviceMapping = container.DeviceMapping
DeviceMapping wraps container.DeviceMapping.
DeviceMapping represents the device mapping between the host and the container.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#DeviceMapping GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/hostconfig.go Kind: struct Usecase: wrap the Engine API type DeviceMapping from container.
type DeviceRequest ¶
type DeviceRequest = container.DeviceRequest
DeviceRequest wraps container.DeviceRequest.
DeviceRequest represents a request for devices from a device driver. Used by GPU device drivers.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#DeviceRequest GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/hostconfig.go Kind: struct Usecase: wrap the Engine API type DeviceRequest from container.
type DiskUsage ¶
DiskUsage wraps container.DiskUsage.
DiskUsage represents system data usage information for container resources.
swagger:model DiskUsage
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#DiskUsage GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/disk_usage.go Kind: struct Usecase: wrap the Engine API type DiskUsage from container.
type ExecCreateRequest ¶
type ExecCreateRequest = container.ExecCreateRequest
ExecCreateRequest wraps container.ExecCreateRequest.
ExecCreateRequest is a small subset of the Config struct that holds the configuration for the exec feature of docker.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#ExecCreateRequest GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/exec_create_request.go Kind: struct Usecase: wrap the Engine API type ExecCreateRequest from container.
type ExecCreateResponse ¶
type ExecCreateResponse = container.ExecCreateResponse
ExecCreateResponse wraps container.ExecCreateResponse.
ExecCreateResponse is the response for a successful exec-create request. It holds the ID of the exec that was created.
TODO(thaJeztah): make this a distinct type.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#ExecCreateResponse GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/exec.go Kind: named:common.IDResponse Underlying: common.IDResponse References: github.com/moby/moby/api/types/common.IDResponse Usecase: wrap the Engine API type ExecCreateResponse from container.
type ExecInspectResponse ¶
type ExecInspectResponse = container.ExecInspectResponse
ExecInspectResponse wraps container.ExecInspectResponse.
ExecInspectResponse is the API response for the "GET /exec/{id}/json" endpoint and holds information about and exec.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#ExecInspectResponse GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/exec.go Kind: struct Usecase: wrap the Engine API type ExecInspectResponse from container.
type ExecProcessConfig ¶
type ExecProcessConfig = container.ExecProcessConfig
ExecProcessConfig wraps container.ExecProcessConfig.
ExecProcessConfig holds information about the exec process running on the host.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#ExecProcessConfig GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/exec.go Kind: struct Usecase: wrap the Engine API type ExecProcessConfig from container.
type ExecStartRequest ¶
type ExecStartRequest = container.ExecStartRequest
ExecStartRequest wraps container.ExecStartRequest.
ExecStartRequest is a temp struct used by execStart Config fields is part of ExecConfig in runconfig package
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#ExecStartRequest GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/exec_start_request.go Kind: struct Usecase: wrap the Engine API type ExecStartRequest from container.
type FilesystemChange ¶
type FilesystemChange = container.FilesystemChange
FilesystemChange wraps container.FilesystemChange.
FilesystemChange Change in the container's filesystem.
swagger:model FilesystemChange
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#FilesystemChange GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/filesystem_change.go Kind: struct Usecase: wrap the Engine API type FilesystemChange from container.
type Health ¶
Health wraps container.Health.
Health stores information about the container's healthcheck results ¶
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#Health GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/health.go Kind: struct Usecase: wrap the Engine API type Health from container.
type HealthConfig ¶
type HealthConfig = container.HealthConfig
HealthConfig wraps container.HealthConfig.
HealthConfig holds configuration settings for the HEALTHCHECK feature.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#HealthConfig GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/config.go Kind: named:dockerspec.HealthcheckConfig Underlying: dockerspec.HealthcheckConfig References: github.com/moby/docker-image-spec/specs-go/v1.HealthcheckConfig Usecase: wrap the Engine API type HealthConfig from container.
type HealthStatus ¶
type HealthStatus = container.HealthStatus
HealthStatus wraps container.HealthStatus.
HealthStatus is a string representation of the container's health.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#HealthStatus GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/health.go Kind: named:string Underlying: string Usecase: wrap the Engine API type HealthStatus from container.
type HealthSummary ¶
type HealthSummary = container.HealthSummary
HealthSummary wraps container.HealthSummary.
HealthSummary stores a summary of the container's healthcheck results.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#HealthSummary GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/health.go Kind: struct Usecase: wrap the Engine API type HealthSummary from container.
type HealthcheckResult ¶
type HealthcheckResult = container.HealthcheckResult
HealthcheckResult wraps container.HealthcheckResult.
HealthcheckResult stores information about a single run of a healthcheck probe ¶
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#HealthcheckResult GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/health.go Kind: struct References: time.Time Usecase: wrap the Engine API type HealthcheckResult from container.
type HostConfig ¶
type HostConfig = container.HostConfig
HostConfig wraps container.HostConfig.
HostConfig the non-portable Config structure of a container. Here, "non-portable" means "dependent of the host we are running on". Portable information *should* appear in Config.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#HostConfig GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/hostconfig.go Kind: struct References: github.com/moby/moby/api/types/mount.Mount, github.com/moby/moby/api/types/network.PortMap, net/netip.Addr Usecase: wrap the Engine API type HostConfig from container.
type InspectResponse ¶
type InspectResponse = container.InspectResponse
InspectResponse wraps container.InspectResponse.
InspectResponse is the response for the GET "/containers/{name:.*}/json" endpoint.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#InspectResponse GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/container.go Kind: struct References: github.com/moby/moby/api/types/storage.DriverData, github.com/moby/moby/api/types/storage.Storage, github.com/opencontainers/image-spec/specs-go/v1.Descriptor Usecase: wrap the Engine API type InspectResponse from container.
type IpcMode ¶
IpcMode wraps container.IpcMode.
IpcMode represents the container ipc stack.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#IpcMode GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/hostconfig.go Kind: named:string Underlying: string Usecase: wrap the Engine API type IpcMode from container.
type Isolation ¶
Isolation wraps container.Isolation.
Isolation represents the isolation technology of a container. The supported values are platform specific
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#Isolation GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/hostconfig.go Kind: named:string Underlying: string Usecase: wrap the Engine API type Isolation from container.
type LogConfig ¶
LogConfig wraps container.LogConfig.
LogConfig represents the logging configuration of the container.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#LogConfig GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/hostconfig.go Kind: struct Usecase: wrap the Engine API type LogConfig from container.
type LogMode ¶
LogMode wraps container.LogMode.
LogMode is a type to define the available modes for logging These modes affect how logs are handled when log messages start piling up.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#LogMode GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/hostconfig.go Kind: named:string Underlying: string Usecase: wrap the Engine API type LogMode from container.
type MemoryStats ¶
type MemoryStats = container.MemoryStats
MemoryStats wraps container.MemoryStats.
MemoryStats aggregates all memory stats since container inception on Linux. Windows returns stats for commit and private working set only.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#MemoryStats GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/stats.go Kind: struct Usecase: wrap the Engine API type MemoryStats from container.
type MountPoint ¶
type MountPoint = container.MountPoint
MountPoint wraps container.MountPoint.
MountPoint represents a mount point configuration inside the container. This is used for reporting the mountpoints in use by a container.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#MountPoint GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/container.go Kind: struct References: github.com/moby/moby/api/types/mount.Propagation, github.com/moby/moby/api/types/mount.Type Usecase: wrap the Engine API type MountPoint from container.
type NetworkMode ¶
type NetworkMode = container.NetworkMode
NetworkMode wraps container.NetworkMode.
NetworkMode represents the container network stack.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#NetworkMode GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/hostconfig.go Kind: named:string Underlying: string Usecase: wrap the Engine API type NetworkMode from container.
type NetworkSettings ¶
type NetworkSettings = container.NetworkSettings
NetworkSettings wraps container.NetworkSettings.
NetworkSettings exposes the network settings in the api ¶
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#NetworkSettings GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/network_settings.go Kind: struct References: github.com/moby/moby/api/types/network.EndpointSettings, github.com/moby/moby/api/types/network.PortMap Usecase: wrap the Engine API type NetworkSettings from container.
type NetworkSettingsSummary ¶
type NetworkSettingsSummary = container.NetworkSettingsSummary
NetworkSettingsSummary wraps container.NetworkSettingsSummary.
NetworkSettingsSummary provides a summary of container's networks in /containers/json
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#NetworkSettingsSummary GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/network_settings.go Kind: struct References: github.com/moby/moby/api/types/network.EndpointSettings Usecase: wrap the Engine API type NetworkSettingsSummary from container.
type NetworkStats ¶
type NetworkStats = container.NetworkStats
NetworkStats wraps container.NetworkStats.
NetworkStats aggregates the network stats of one container ¶
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#NetworkStats GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/stats.go Kind: struct Usecase: wrap the Engine API type NetworkStats from container.
type PathStat ¶
PathStat wraps container.PathStat.
PathStat is used to encode the header from GET "/containers/{name:.*}/archive" "Name" is the file or directory name.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#PathStat GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/container.go Kind: struct References: os.FileMode, time.Time Usecase: wrap the Engine API type PathStat from container.
type PidMode ¶
PidMode wraps container.PidMode.
PidMode represents the pid namespace of the container.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#PidMode GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/hostconfig.go Kind: named:string Underlying: string Usecase: wrap the Engine API type PidMode from container.
type PidsStats ¶
PidsStats wraps container.PidsStats.
PidsStats contains the stats of a container's pids ¶
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#PidsStats GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/stats.go Kind: struct Usecase: wrap the Engine API type PidsStats from container.
type PortSummary ¶
type PortSummary = container.PortSummary
PortSummary wraps container.PortSummary.
PortSummary Describes a port-mapping between the container and the host.
Example: {"PrivatePort":8080,"PublicPort":80,"Type":"tcp"}
swagger:model PortSummary
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#PortSummary GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/port_summary.go Kind: struct References: net/netip.Addr Usecase: wrap the Engine API type PortSummary from container.
type PruneReport ¶
type PruneReport = container.PruneReport
PruneReport wraps container.PruneReport.
PruneReport contains the response for Engine API: POST "/containers/prune"
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#PruneReport GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/container.go Kind: struct Usecase: wrap the Engine API type PruneReport from container.
type Resources ¶
Resources wraps container.Resources.
Resources contains container's resources (cgroups config, ulimits...)
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#Resources GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/hostconfig.go Kind: struct References: github.com/moby/moby/api/types/blkiodev.ThrottleDevice, github.com/moby/moby/api/types/blkiodev.WeightDevice Usecase: wrap the Engine API type Resources from container.
type RestartPolicy ¶
type RestartPolicy = container.RestartPolicy
RestartPolicy wraps container.RestartPolicy.
RestartPolicy represents the restart policies of the container.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#RestartPolicy GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/hostconfig.go Kind: struct Usecase: wrap the Engine API type RestartPolicy from container.
type RestartPolicyMode ¶
type RestartPolicyMode = container.RestartPolicyMode
RestartPolicyMode wraps container.RestartPolicyMode.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#RestartPolicyMode GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/hostconfig.go Kind: named:string Underlying: string Usecase: wrap the Engine API type RestartPolicyMode from container.
type State ¶
State wraps container.State.
State stores container's running state it's part of ContainerJSONBase and returned by "inspect" command
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#State GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/container.go Kind: struct Usecase: wrap the Engine API type State from container.
type StatsResponse ¶
type StatsResponse = container.StatsResponse
StatsResponse wraps container.StatsResponse.
StatsResponse aggregates all types of stats of one container.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#StatsResponse GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/stats.go Kind: struct References: time.Time Usecase: wrap the Engine API type StatsResponse from container.
type StorageStats ¶
type StorageStats = container.StorageStats
StorageStats wraps container.StorageStats.
StorageStats is the disk I/O stats for read/write on Windows.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#StorageStats GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/stats.go Kind: struct Usecase: wrap the Engine API type StorageStats from container.
type Summary ¶
Summary wraps container.Summary.
Summary contains response of Engine API: GET "/containers/json"
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#Summary GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/container.go Kind: struct References: github.com/opencontainers/image-spec/specs-go/v1.Descriptor Usecase: wrap the Engine API type Summary from container.
type ThrottlingData ¶
type ThrottlingData = container.ThrottlingData
ThrottlingData wraps container.ThrottlingData.
ThrottlingData stores CPU throttling stats of one running container. Not used on Windows.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#ThrottlingData GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/stats.go Kind: struct Usecase: wrap the Engine API type ThrottlingData from container.
type TopResponse ¶
type TopResponse = container.TopResponse
TopResponse wraps container.TopResponse.
TopResponse ContainerTopResponse ¶
Container "top" response.
swagger:model TopResponse
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#TopResponse GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/top_response.go Kind: struct Usecase: wrap the Engine API type TopResponse from container.
type UTSMode ¶
UTSMode wraps container.UTSMode.
UTSMode represents the UTS namespace of the container.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#UTSMode GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/hostconfig.go Kind: named:string Underlying: string Usecase: wrap the Engine API type UTSMode from container.
type Ulimit ¶
Ulimit wraps container.Ulimit.
Ulimit is an alias for [units.Ulimit], which may be moving to a different location or become a local type. This alias is to help transitioning.
Users are recommended to use this alias instead of using [units.Ulimit] directly.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#Ulimit GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/hostconfig.go Kind: named:units.Ulimit Underlying: units.Ulimit Usecase: wrap the Engine API type Ulimit from container.
type UpdateConfig ¶
type UpdateConfig = container.UpdateConfig
UpdateConfig wraps container.UpdateConfig.
UpdateConfig holds the mutable attributes of a Container. Those attributes can be updated at runtime.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#UpdateConfig GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/hostconfig.go Kind: struct Usecase: wrap the Engine API type UpdateConfig from container.
type UpdateResponse ¶
type UpdateResponse = container.UpdateResponse
UpdateResponse wraps container.UpdateResponse.
UpdateResponse ContainerUpdateResponse ¶
Response for a successful container-update.
swagger:model UpdateResponse
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#UpdateResponse GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/update_response.go Kind: struct Usecase: wrap the Engine API type UpdateResponse from container.
type UsernsMode ¶
type UsernsMode = container.UsernsMode
UsernsMode wraps container.UsernsMode.
UsernsMode represents userns mode in the container.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#UsernsMode GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/hostconfig.go Kind: named:string Underlying: string Usecase: wrap the Engine API type UsernsMode from container.
type WaitCondition ¶
type WaitCondition = container.WaitCondition
WaitCondition wraps container.WaitCondition.
WaitCondition is a type used to specify a container state for which to wait.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#WaitCondition GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/waitcondition.go Kind: named:string Underlying: string Usecase: wrap the Engine API type WaitCondition from container.
type WaitExitError ¶
type WaitExitError = container.WaitExitError
WaitExitError wraps container.WaitExitError.
WaitExitError container waiting error, if any ¶
swagger:model WaitExitError
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#WaitExitError GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/wait_exit_error.go Kind: struct Usecase: wrap the Engine API type WaitExitError from container.
type WaitResponse ¶
type WaitResponse = container.WaitResponse
WaitResponse wraps container.WaitResponse.
WaitResponse ContainerWaitResponse ¶
OK response to ContainerWait operation ¶
swagger:model WaitResponse
Source: https://pkg.go.dev/github.com/moby/moby/api/types/container#WaitResponse GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/container/wait_response.go Kind: struct Usecase: wrap the Engine API type WaitResponse from container.