卷

卷资源的模型和管理器。

class Volume(attrs: Mapping[str, Any] | None = None, client: APIClient | None = None, collection: Manager | None = None)

基类：PodmanResource

由 Podman 服务管理的镜像的详细信息和配置。

初始化 PodmanResource 的基类。

参数：

• attrs – 来自 Podman 服务的资源属性映射。

• client – 配置的 Podman 服务连接。

• collection – 此类资源的管理器，名为 collection 以保持兼容性

reload() → None

从服务刷新此对象的数据。

remove(force: bool | None = None) → None

删除此卷。

参数：

force – 为真时，强制删除正在使用的卷

引发：

APIError – 当服务报告错误时

property id

返回对象的标识符。

类型：

str

property name

返回卷的名称。

类型：

str

property short_id

返回截断的标识符。'sha256' 在包含在 id 中时保留。

不会尝试确保返回值对所有资源在语义上都有意义。

类型：

str

class VolumesManager(client: APIClient = None)

基类：Manager

卷资源的专用管理器。

初始化 Manager() 对象。

参数：

client – 配置为连接到 Podman 服务的 APIClient()。

create(name: str | None = None, **kwargs) → Volume

创建一个卷。

参数：

name – 给新卷起的名字

关键字参数：

• driver (str) – 要使用的卷驱动程序

• driver_opts (Dict[str, str]) – 与驱动程序一起使用的选项

• labels (Dict[str, str]) – 应用于卷的标签

引发：

APIError – 当服务报告错误时

exists(key: str) → bool

如果资源存在，则返回 True。

仅限 Podman。

注释

此方法_不_提供任何互斥机制。

get(volume_id: str) → Volume

按名称或 ID 返回和卷。

参数：

volume_id – 要搜索的卷 ID 或名称

引发：

• NotFound – 当找不到卷时

• APIError – 当服务报告错误时

list(*_, **kwargs) → List[Volume]

报告卷。

关键字参数：

filters (Dict[str, str]) –

筛选卷列表的条件

• driver (str): 按其驱动程序筛选卷

• label (Dict[str, str]): 按标签和/或值筛选

• name (str): 按卷的名称筛选

prepare_model(attrs: PodmanResource | Mapping[str, Any]) → PodmanResourceType

从一组属性创建模型。

prune(filters: Dict[str, str] | None = None) → Dict[Literal['VolumesDeleted', 'SpaceReclaimed'], Any]

删除未使用的卷。

参数：

filters – 选择要删除的卷的条件。忽略。

引发：

APIError – 当服务报告错误时

remove(name: Volume | str, force: bool | None = None) → None

删除一个卷。

仅限 Podman。

参数：

• name – 要删除的卷的标识符。

• force – 为真时，强制删除正在使用的卷

引发：

APIError – 当服务报告错误时

property resource

prepare_model() 将创建 Volume 类。

类型：

Type[Volume]