package
0.0.0-20200907055328-bc5839e3c493
Repository: https://github.com/manlge/pouch.git
Documentation: pkg.go.dev

# Constants

ContainerConfigRichModeDumbInit captures enum value "dumb-init".
ContainerConfigRichModeSbinInit captures enum value "sbin-init".
ContainerConfigRichModeSystemd captures enum value "systemd".
EventTypeContainer captures enum value "container".
EventTypeDaemon captures enum value "daemon".
EventTypeImage captures enum value "image".
EventTypeNetwork captures enum value "network".
EventTypePlugin captures enum value "plugin".
EventTypeVolume captures enum value "volume".
LogConfigLogDriverAwslogs captures enum value "awslogs".
LogConfigLogDriverEtwlogs captures enum value "etwlogs".
LogConfigLogDriverFluentd captures enum value "fluentd".
LogConfigLogDriverGelf captures enum value "gelf".
LogConfigLogDriverJournald captures enum value "journald".
LogConfigLogDriverJSONFile captures enum value "json-file".
LogConfigLogDriverNone captures enum value "none".
LogConfigLogDriverSplunk captures enum value "splunk".
LogConfigLogDriverSyslog captures enum value "syslog".
StatusCreated captures enum value "created".
StatusDead captures enum value "dead".
StatusExited captures enum value "exited".
StatusPaused captures enum value "paused".
StatusRemoving captures enum value "removing".
StatusRestarting captures enum value "restarting".
StatusRunning captures enum value "running".
StatusStopped captures enum value "stopped".
SystemInfoCgroupDriverCgroupfs captures enum value "cgroupfs".
SystemInfoCgroupDriverSystemd captures enum value "systemd".

# Structs

AuthConfig auth config swagger:model AuthConfig.
AuthResponse The response returned by login to a registry swagger:model AuthResponse.
BlkioStatEntry BlkioStatEntry is one small entity to store a piece of Blkio stats swagger:model BlkioStatEntry.
BlkioStats BlkioStats stores All IO service stats for data read and write.
Checkpoint describe a created checkpoint, include container name and checkpoint name swagger:model Checkpoint.
CheckpointCreateOptions options of creating a checkpoint from a running container, checkpoint is used to restore a container with current state later swagger:model CheckpointCreateOptions.
CheckpointDeleteOptions options of deleting a checkpoint from a container swagger:model CheckpointDeleteOptions.
CheckpointListOptions options of listing all checkpoints of a container swagger:model CheckpointListOptions.
Commit 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`.
Container an array of Container contains response of Engine API: GET "/containers/json" swagger:model Container.
ContainerCommitOptions options of committing a container into an image swagger:model ContainerCommitOptions.
ContainerCommitResp response of commit container for the remote API: POST /commit swagger:model ContainerCommitResp.
ContainerConfig Configuration for a container that is portable between hosts swagger:model ContainerConfig.
ContainerCreateConfig ContainerCreateConfig is used for API "POST /containers/create".
ContainerCreateResp response returned by daemon when container create successfully swagger:model ContainerCreateResp.
ContainerExecInspect holds information about a running process started.
ContainerJSON ContainerJSON contains response of Engine API: GET "/containers/{id}/json" swagger:model ContainerJSON.
ContainerListOptions options of list container, filters (a `map[string][]string`) to process on the container list.
ContainerLogsOptions The parameters to filter the log.
ContainerNetworkSettings container network settings swagger:model ContainerNetworkSettings.
ContainerPathStat ContainerPathStat is used to describe the stat of file swagger:model ContainerPathStat.
ContainerProcessList OK Response to ContainerTop operation swagger:model ContainerProcessList.
ContainerRemoveOptions options of remove container swagger:model ContainerRemoveOptions.
ContainerStartOptions options of starting container swagger:model ContainerStartOptions.
ContainerState container state swagger:model ContainerState.
ContainerStats container stats almost from cgroup resource usage.
ContainerUpgradeConfig ContainerUpgradeConfig is used for API "POST /containers/{name:.*}/upgrade".
ContainerWaitOKBody container wait o k body swagger:model containerWaitOKBody.
CPUStats CPUStats aggregates and wraps all CPU related info of container swagger:model CPUStats.
CPUUsage CPUUsage stores All CPU stats aggregated since container inception.
DaemonUpdateConfig daemon update config swagger:model DaemonUpdateConfig.
DeviceMapping A device mapping between the host and container swagger:model DeviceMapping.
EndpointIPAMConfig IPAM configurations for the endpoint swagger:model EndpointIPAMConfig.
EndpointResource NetworkResource is the body of the "get network" http response message swagger:model EndpointResource.
EndpointSettings Configuration for a network endpoint.
Error error swagger:model Error.
EventsActor EventsActor describes something that generates events, like a container, or a network, or a volume.
EventsMessage EventsMessage represents the information an event contains, the message at least contains type, action and id.
ExecCreateConfig is a small subset of the Config struct that holds the configuration.
ExecCreateResp contains response of Remote API POST "/containers/{name:.*}/exec".
ExecStartConfig ExecStartConfig is a temp struct used by execStart.
GraphDriverData Information about a container's graph driver.
HistoryResultItem An object containing image history at API side.
HostConfig Container configuration that depends on the host we are running on swagger:model HostConfig.
ImageInfo An object containing all details of an image at API side swagger:model ImageInfo.
ImageInfoRootFS the rootfs key references the layer content addresses used by the image.
IndexInfo IndexInfo contains information about a registry.
IPAddress Address represents an IPv4 or IPv6 IP address.
IPAM represents IP Address Management swagger:model IPAM.
IPAMConfig represents IPAM configurations swagger:model IPAMConfig.
LogConfig The logging configuration for this container swagger:model LogConfig.
MemoryStats MemoryStats aggregates all memory stats since container inception on Linux.
MountPoint A mount point inside a container swagger:model MountPoint.
NetworkConnect contains the request for the remote API: POST /networks/{id:.*}/connect swagger:model NetworkConnect.
NetworkCreate is the expected body of the "create network" http request message swagger:model NetworkCreate.
NetworkCreateConfig contains the request for the remote API: POST /networks/create swagger:model NetworkCreateConfig.
NetworkCreateResp contains the response for the remote API: POST /networks/create swagger:model NetworkCreateResp.
NetworkDisconnect Parameters of network disconnect swagger:model NetworkDisconnect.
NetworkingConfig Configuration for a network used to create a container.
NetworkInspectResp is the expected body of the 'GET networks/{id}'' http request message swagger:model NetworkInspectResp.
NetworkResource NetworkResource is the body of the "get network" http response message swagger:model NetworkResource.
NetworkSettings NetworkSettings exposes the network settings in the API.
NetworkStats container stats almost from cgroup resource usage.
NvidiaConfig nvidia config swagger:model NvidiaConfig.
PidsStats PidsStats contains the stats of a container's pids swagger:model PidsStats.
PortBinding PortBinding represents a binding between a host IP address and a host port swagger:model PortBinding.
ProcessConfig ExecProcessConfig holds information about the exec process.
RegistryServiceConfig RegistryServiceConfig stores daemon registry services configuration.
ResizeOptions options of resizing container tty size swagger:model ResizeOptions.
Resources A container's resources (cgroups config, ulimits, etc) swagger:model Resources.
RestartPolicy Define container's restart policy swagger:model RestartPolicy.
Runtime Runtime describes an [OCI compliant](https://github.com/opencontainers/runtime-spec) runtime.
SearchResultItem search result item in search results.
SnapshotterData Information about a container's snapshotter.
SystemInfo system info swagger:model SystemInfo.
SystemVersion system version swagger:model SystemVersion.
ThrottleDevice throttle device swagger:model ThrottleDevice.
ThrottlingData ThrottlingData stores CPU throttling stats of one running container.
Ulimit A list of resource limits swagger:model Ulimit.
UpdateConfig UpdateConfig holds the mutable attributes of a Container.
VolumeCreateConfig config used to create a volume swagger:model VolumeCreateConfig.
VolumeInfo Volume represents the configuration of a volume for the container.
VolumeListResp volume list resp swagger:model VolumeListResp.
WeightDevice Weight for BlockIO Device swagger:model WeightDevice.

# Type aliases

EventType The type of event.
PortMap PortMap describes the mapping of container ports to host ports, using the container's port-number and protocol as key in the format `<port>/<protocol>`, for example, `80/udp`.
Status The status of the container.