podman library

Dart client library for interacting with the Podman libpod API.

Classes

ArtifactAddOptions
Options for adding artifact blobs.
ArtifactAddResult
Result from adding content to an artifact.
ArtifactDetails
Artifact details from GET /libpod/artifacts/{name}/json.
ArtifactPullOptions
Options for pulling an OCI artifact.
ArtifactPullResult
Result from pulling an artifact.
ArtifactPushOptions
Options for pushing an OCI artifact.
ArtifactPushResult
Result from pushing an artifact.
ArtifactRemoveOptions
Options for batch artifact removal.
ArtifactRemoveResult
Result from removing artifacts.
ArtifactSummary
Artifact summary from GET /libpod/artifacts/json.
ContainerArchiveGetResult
Result of copying a container path as a tar archive.
ContainerCheckpointOptions
Options for container checkpoint operations.
ContainerCheckpointReport
Report from POST /libpod/containers/{name}/checkpoint.
ContainerCreateResult
Result from POST /containers/create.
ContainerDetails
Detailed container data parsed from GET /libpod/containers/{id}/json.
ContainerExecCreateResult
Exec creation result from POST /libpod/containers/{id}/exec.
ContainerExecInspectResult
Exec inspect result from GET /libpod/exec/{id}/json.
ContainerExecStartResult
Captured output from POST /libpod/exec/{id}/start.
ContainerHealthStatus
Container health status from inspect payload.
ContainerRestoreOptions
Options for container restore operations.
ContainerRestoreReport
Report from POST /libpod/containers/{name}/restore.
ContainerStats
Snapshot stats from GET /libpod/containers/{id}/stats?stream=false.
ContainerSummary
Lightweight container data from GET /libpod/containers/json.
ContainerTopOptions
Options for GET /libpod/containers/{name}/top.
ContainerTopReport
Process listing from GET /libpod/containers/{name}/top.
ContainerUpdateOptions
Options for POST /libpod/containers/{name}/update.
ContainerWaitResult
Wait response parsed from POST /libpod/containers/{id}/wait.
ExecCreateOptions
Options for creating an exec process in a running container.
GenerateKubeOptions
Options for generating Kubernetes YAML.
GenerateSystemdOptions
Options for generating systemd units.
GenerateSystemdResult
Result from GET /libpod/generate/{name}/systemd.
ImageDetails
Detailed image data from GET /libpod/images/{name}/json.
ImageExportOptions
Options for exporting image archives.
ImageHistoryEntry
Image history entry from GET /libpod/images/{name}/history.
ImageImportOptions
Options for POST /libpod/images/import.
ImageImportReport
Result from POST /libpod/images/import.
ImageLoadReport
Result from POST /libpod/images/load.
ImagePushEvent
Push stream event from POST /libpod/images/{name}/push.
ImagePushOptions
Options for POST /libpod/images/{name}/push.
ImageRemoveOptions
Options for DELETE /libpod/images/remove.
ImageRemoveResult
Image removal result from libpod image remove endpoints.
ImageSummary
Image data from GET /libpod/images/json.
ImageTreeReport
Image tree report from GET /libpod/images/{name}/tree.
ManifestCreateOptions
Options for creating a Podman manifest list.
ManifestCreateResult
Manifest create result from POST /libpod/manifests/{name}.
ManifestDeleteResult
Result from deleting a manifest list.
ManifestDetails
Manifest details from GET /libpod/manifests/{name}/json.
ManifestPushResult
Result from pushing a manifest list.
MountBinding
Podman container mount configuration.
NetworkConnectOptions
Options for connecting a container to a Podman network.
NetworkCreateOptions
Options for creating a Podman network.
NetworkDetails
Detailed network data from GET /libpod/networks/{name}/json.
NetworkPruneOptions
Options for POST /libpod/networks/prune.
NetworkPruneReport
Network prune result item from POST /libpod/networks/prune.
NetworkSubnet
Network subnet/gateway pair from Podman network APIs.
NetworkSummary
Network summary from GET /libpod/networks/json.
NetworkUpdateOptions
Options for POST /libpod/networks/{name}/update.
PlayKubeOptions
Options for play kube operations.
PlayKubeReport
Report from play-kube up/down APIs.
PodCreateOptions
Options for creating a Podman pod.
PodDetails
Detailed pod data from GET /libpod/pods/{name}/json.
PodmanClient
High-level Podman libpod API client.
PodmanEvent
Event from GET /libpod/events.
PodmanEventActor
Event actor object included in Podman events.
PodmanEventFilter
Single key-value event filter for Podman events API.
PodmanInfo
Parsed output from GET /libpod/info.
PodmanTransport
Abstraction for sending Podman HTTP API requests.
PodmanTransportRequest
Transport-level request to the Podman API.
PodmanTransportResponse
Transport-level response from the Podman API.
PodmanVersion
Parsed output from GET /libpod/version.
PodPruneReport
Pod prune result item from POST /libpod/pods/prune.
PodStatsOptions
Options for GET /libpod/pods/stats.
PodStatsReport
Pod stats item from GET /libpod/pods/stats.
PodSummary
Pod summary from GET /libpod/pods/json.
PodTopOptions
Options for GET /libpod/pods/{name}/top.
PodTopReport
Process listing from GET /libpod/pods/{name}/top.
PortBinding
Podman container port mapping.
RunOptions
Options for creating/running a container through the Podman API.
SecretCreateOptions
Options for creating a Podman secret.
SecretCreateResult
Secret creation result from POST /libpod/secrets/create.
SecretDetails
Secret details from GET /libpod/secrets/{name}/json.
SecretSummary
Secret summary from GET /libpod/secrets/json.
SystemCheckOptions
Options for POST /libpod/system/check.
SystemCheckReport
Storage consistency report from POST /libpod/system/check.
SystemDfContainer
Container row from GET /libpod/system/df.
SystemDfImage
Image row from GET /libpod/system/df.
SystemDfReport
Disk usage report from GET /libpod/system/df.
SystemDfVolume
Volume row from GET /libpod/system/df.
SystemPruneOptions
Options for POST /libpod/system/prune.
SystemPruneReport
System prune report from POST /libpod/system/prune.
UnixSocketPodmanTransport
Unix-socket transport for the Podman API.
VolumeCreateOptions
Options for creating a Podman volume.
VolumeDetails
Detailed volume data from GET /libpod/volumes/{name}/json.
VolumeListOptions
Options for GET /libpod/volumes/json.
VolumePruneOptions
Options for POST /libpod/volumes/prune.
VolumePruneReport
Volume prune report item from POST /libpod/volumes/prune.
VolumeSummary
Volume summary from GET /libpod/volumes/json.

Enums

HttpMethod
Supported HTTP methods for Podman transport requests.
PodmanMountType
Supported Podman mount types.

Functions

defaultPodmanSocketPath() → String
Resolves the default Podman Unix socket path from environment.

Exceptions / Errors

PodmanApiException
Exception thrown when Podman API returns an unexpected response.
PodmanException
Base exception for Podman package failures.
PodmanParseException
Exception thrown when Podman output cannot be parsed.