All Classes and Interfaces
Class
Description
Abstract class for oneOf,anyOf schemas defined in OpenAPI spec
AccessMode
Address
Callback for asynchronous API call.
ApiClient class.
ApiException class.
API response returned by API call.
AttestationProperties
AuthConfig contains authorization information for connecting to a Registry
AuthenticateOKBody authenticate o k body
AuthReport describes the response for authentication check
AutoUserNsOptions
BindOptions
CapacityRange describes the minimum and maximum capacity a volume should be created with
ClusterVolume contains options and information specific to, and only present on, Swarm CSI cluster volumes.
ClusterVolumeSpec
ComponentVersion
It should hold only portable information about the container.
ConfigReference specifies the source which provides a network's configuration
ConmonInfo describes the conmon executable being used
ConnectOptions represents the data to be used to connect a container to the network.
Container
ContainerBasicConfig
ContainerCgroupConfig contains configuration information about a container's cgroups.
ContainerCreateResponse is the response struct for creating a container
ContainerExecRequest
ContainerHealthCheckConfig describes a container healthcheck with attributes like command, retries, interval, start period, and timeout.
ContainerJSON is newly used struct along with MountPoint
ContainerNetworkConfig contains information on a container's network configuration.
Statistics for an individual container network interface
Deprecated: ContainerNode was used for the classic Docker Swarm standalone API.
ContainerResourceConfig
ContainerSecurityConfig is a container's security features, including SELinux, Apparmor, and Seccomp.
ContainerSize holds the size of the container's root filesystem and top read-write layer.
ContainersPruneReport
ContainersPruneReportLibpod
ContainerState stores container's running state it's part of ContainerJSONBase and will return by \"inspect\" command
ContainerStats contains the statistics information for a running container
ContainerStorageConfig contains information on the storage configuration of a container.
ContainerStore describes the quantity of containers in the store by status
ContainerTopOKBody OK response to ContainerTop operation
ContainerUpdateLibpod201Response
ContainerUpdateOKBody OK response to ContainerUpdate operation
Container update
ContainerWait200Response
ContainerWait200ResponseError
CPUUsage
CreateContainerConfig used when compatible endpoint creates a container
CreateOptions
CreateRequest
OK response to ContainerCreate operation
DeleteResponse delete response
This structure provides `application/vnd.oci.descriptor.v1+json` mediatype when marshalled to JSON.
DeviceMapping
Used by GPU device drivers.
DisconnectOptions represents the data to be used to disconnect a container from the network.
DistributionInfo describes the host distribution for libpod
DNSNetworkInfo
Driver
DriverData handles the data for a storage driver
EndpointIPAMConfig represents IPAM configurations for the endpoint
EndpointResource contains network resources allocated and used for a container in a network.
EndpointSettings stores the network endpoint details
ErrorModel is used in remote connections with podman
ErrorResponse
ExecStartLibpodRequest
ExecStartRequest
FilesystemChange
GraphDriverData Information about the storage driver used to store the container's and image's filesystem.
Health stores information about the container's healthcheck results
HealthcheckConfig
HealthCheckLog describes the results of a single healthcheck
HealthcheckResult stores information about a single run of a healthcheck probe
HealthCheckResults describes the results/logs from a healthcheck
History
HistoryResponse provides details on image layers
HistoryResponseItem individual image layer information in response to ImageHistory operation
Here, \"non-portable\" means \"dependent of the host we are running on\".
HostInfo describes the libpod host
IDMap contains a single entry for user namespace range remapping.
IDMappingOptions are used for specifying how ID mapping should be set up for a layer or container.
IDMappings describe the GID and UID mappings
IDResponse Response to an API call that returns just an Id
ImageBuild200Response
ImageBuildLibpod200Response
ImageConfig
ImageData
ImageDelete200ResponseInner
ImageImportReport
ImageInspect
ImageLoadReport
ImageProperties
ImagePropertiesSize
ImageSearch200Response
ImageStore describes the image store.
ImageTreeReport
ImageVolume is a volume based on a container image.
Info contains information about the Volume as a whole as provided by the CSI storage plugin.
Inspect
InspectAdditionalNetwork holds information about non-default networks the container has been connected to.
InspectBlkioThrottleDevice holds information about a speed cap for a device node.
InspectBlkioWeightDevice holds information about the relative weight of an individual device node.
InspectContainerConfig holds further data about how a container was initially configured.
InspectContainerData provides a detailed record of a container's configuration and state as viewed by Libpod.
nolint:revive,stylecheck // Field names are fixed for compatibility and cannot be changed.
InspectContainerState provides a detailed record of a container's current state.
InspectDevice
InspectExecProcess contains information about the process in a given exec session.
InspectExecSession
InspectHostPort provides information on a port on the host that a container's port is bound to.
InspectIDMappings
InspectLogConfig holds information about a container's configured log driver
InspectMount provides a record of a single mount in a container.
InspectNetworkSettings holds information about the network settings of the container.
InspectPodContainerInfo
InspectPodData contains detailed information on a pod's configuration and state.
InspectPodInfraConfig contains the configuration of the pod's infra container.
InspectRestartPolicy
InspectSecret contains information on secrets mounted inside the container
InspectUlimit
IPAM represents IP Address Management
IPAMConfig represents IPAM configurations
IPNet
Gson TypeAdapter for Byte Array type
Gson TypeAdapter for java.util.Date type
If the dateFormat is null, ISO8601Utils will be used.
Gson TypeAdapter for JSR310 LocalDate type
Gson TypeAdapter for JSR310 OffsetDateTime type
Gson TypeAdapter for java.sql.Date type
If the dateFormat is null, a simple "yyyy-MM-dd" format will be used
(more efficient than SimpleDateFormat).
LeaseRange
LibpodContainersRmReport
LibpodImagesPullReport
LibpodImagesRemoveReport is the return type for image removal via the rest api.
LibpodImageSummary
Info is the overall struct that describes the host system running libpod/podman
LinuxBlockIO for Linux cgroup 'blkio' resource management
LinuxBlockIODevice holds major:minor format supported in blkio cgroup
LinuxCPU for Linux cgroup 'cpu' resource management
LinuxDevice represents the mknod information for a Linux special device file
LinuxDeviceCgroup represents a device rule for the devices specified to the device controller
Default to reservation limits if supported.
LinuxIDMapping specifies UID/GID mappings
LinuxIntelRdt has container runtime resource constraints for Intel RDT CAT and MBA features and flags enabling Intel RDT CMT and MBM features.
LinuxInterfacePriority for network interfaces
LinuxMemory for Linux cgroup 'memory' resource management
LinuxNetwork identification and priority configuration
LinuxPersonality represents the Linux personality syscall input
LinuxPids for Linux cgroup 'pids' resource management (Linux 4.3)
LinuxRdma for Linux cgroup 'rdma' resource management (Linux 4.11)
LinuxResources has container runtime resource constraints
LinuxThrottleDevice struct holds a `major:minor rate_per_second` pair
LinuxWeightDevice struct holds a `major:minor weight` pair for weightDevice
ListContainer describes a container suitable for listing
ListContainerNamespaces contains the identifiers of the container's Linux namespaces
ListPodContainer
ListPodsReport
Volume list response
LogConfig
LogConfig describes the logging characteristics for a container
ManifestAddArtifactOptions provides the model for creating artifact manifests for files and adding those manifests to a manifest list
ManifestAddOptions provides model for adding digests to manifest list
ManifestAnnotateOptions provides model for annotating manifest list
swagger 2.0 does not support oneOf for schema validation.
ManifestModifyReport
ManifestPushReport
ManifestRemoveReport
ManifestSummary
Size is the size information of the content related to this manifest.
Meta
Metadata
Mount
This is used for reporting the mountpoints in use by a container.
NamedVolume holds information about a named volume that will be mounted into the container.
Namespace describes the namespace
NetAddress
NetInterface
NetOptions reflect the shared network options between pods and containers
Network
NetworkConnectOptions describes options for connecting a container to a network
NetworkContainerInfo
NetworkCreate201Response
Network create
NetworkInfo
NetworkingConfig represents the container's networking configuration for each of its interfaces Carries the networking configs specified in the `docker run` and `docker network connect` commands
NetworkInspectReport
NetworkPrune200Response
NetworkPruneReport containers the name of network and an error associated in its pruning (removal)
NetworkRmReport describes the results of network removal
NetworkSettings exposes the network settings in the api
NetworkUpdateOptions describes options to update a network
OCIRuntimeInfo describes the runtime (crun or runc) being used with podman
OverlayVolume holds information about an overlay volume that will be mounted into the container.
PastaInfo describes the pasta executable that is being used
PeerInfo represents one peer of an overlay network
PerNetworkOptions
Platform
PlayKubePod
PlayKubeReport
PlayKubeVolume
PlaySecret
Plugin A plugin for the Engine API
PluginConfig
PluginConfigArgs plugin config args
PluginConfigInterface The interface between Docker and the plugin
PluginConfigLinux plugin config linux
PluginConfigNetwork plugin config network
PluginConfigRootfs plugin config rootfs
PluginConfigUser plugin config user
PluginDevice plugin device
PluginEnv plugin env
PluginInterfaceType plugin interface type
PluginMount plugin mount
Plugins
PluginSettings
PodBasicConfig
This will be expanded in future updates to pods.
The JSON tags below are made to match the respective field in ContainerCreateOptions for the purpose of mapping.
PodKillReport
PodNetworkConfig
PodPauseReport
PodPruneReport
PodResourceConfig
PodRestartReport
PodRmReport
PodSecurityConfig
PodSpecGenerator describes options to create a pod
PodStartReport
PodStatsReport
PodStopReport
PodStorageConfig
PodTopOKBody
PodUnpauseReport
Port An open port on a container
PortBinding represents a binding between a Host IP address and a Host Port
PortMapping
POSIXRlimit type and restrictions
POST \"/volumes/prune\"
PublishStatus represents the status of the volume as published to an individual node
RemoteSocket describes information about the API socket
Resources contains container's resources (cgroups config, ulimits...)
RestartPolicy
RootFS
Route
Schema2HealthConfig is a HealthConfig, which holds configuration settings for the HEALTHCHECK feature, from docker/docker/api/types/container.
This is publicly visible as c/image/manifest.Schema2List.
This is publicly visible as c/image/manifest.Schema2ManifestDescriptor.
Schema2PlatformSpec describes the platform which a particular manifest is specialized for.
ScpReport
Secret represents a Swarm Secret value that must be passed to the CSI storage plugin when operating on this Volume.
SecretCreate
SecretCreateReport
SecretDeleteLibpod404Response
SecretDriverSpec
SecretInfoReport
SecretInfoReportCompat
SecretRmReport
SecretSpec
SecretVersion
SecurityInfo describes the libpod host
Representing a Server configuration.
Representing a Server Variable for server URL template substitution.
ServiceCreateResponse contains the information returned to a client on the creation of a new service.
ServiceInfo represents service parameters with the list of service's tasks
ServiceUpdateResponse service update response
SlirpInfo describes the slirp executable that is being used
SpecGenerator creates an OCI spec and Libpod configuration options to create a container based on the given configuration.
StartupHealthCheck
StoreInfo describes the container storage and its attributes
Subnet
Summary
SummaryNetworkSettings provides a summary of container's networks in /containers/json
SystemCheckReport provides a report of what a storage consistency check found, and if we removed anything that was damaged, what we removed.
SystemComponentVersion is the type used by pkg/domain/entities
SystemComponentVersionPlatform
SystemDfContainerReport describes a container for use with df
SystemDfImageReport describes an image for use with df
SystemDfReport describes the response for df information
SystemDfVolumeReport describes a volume and its size
SystemPruneReport
Task carries the information about one backend task
ThrottleDevice is a structure that holds device:rate_per_second pair
TmpfsOptions
This description is taken verbatim from the CSI Spec: A topological domain is a sub-division of a cluster, like \"region\", \"zone\", \"rack\", etc.
TopologyRequirement expresses the user's requirements for a volume's accessible topology.
TypeMount contains options for using a volume as a Mount-type volume.
Ulimit
Those attributes can be updated at runtime.
UpdateContainerDevicesLimits
UpdateEntities used to wrap the oci resource spec in a swagger model
UpdateHealthCheckConfig
UsageData Usage details about the volume.
Version
Volume volume
VolumeConfigResponse
Details for creating a volume
VolumeCreateOptions
VolumeOptions
VolumeRmReport
WaitExitError container waiting error, if any
OK response to ContainerWait operation
WeightDevice is a structure that holds device:weight pair