第 2 章 使用软件开发套件
本章定义了 Ruby Software Development Kit 的模块和类,并描述了它们的用法。
2.1. class
OvirtSDK4 模块包含以下软件开发套件类:
- 连接
- Connection 类是连接到服务器并获取对服务树根的引用的机制。有关详细信息 ,请参阅连接到服务器。
- 类型
Type 类实施 API 支持的类型。例如,Vm 类是虚拟机的实施。类是数据容器,不包含任何逻辑。您将处理类型的实例。
这些类的实例用作服务方法的参数和返回值。软件开发套件对从底层表示的转换或从中处理。
- 服务
服务类实施 API 支持的服务。例如,VmsService 类是该服务的实现,用于管理系统中虚拟机集合。
当服务被引用时,SDK 会自动创建这些类的实例。例如,当调用
SystemService
类的vms_service
方法时,SDK 会自动创建VmsService
类的新实例:vms_service = connection.system_service.vms_service
警告
不要手动创建这些类的实例。构造器参数和方法可能会在以后有所变化。
- Error
Error 类是软件开发工具包在报告错误时引发的基本异常类。
某些特定错误类扩展基本错误类:
- AuthError - Authentication or authorization failure
- ConnectionError - 服务器名称无法解析,或者服务器无法访问
- NotFoundError - Requested 对象不存在
- TimeoutError - 操作超时
- 其他类
- 其他类(例如,HTTP 客户端类、读者和作者)用于 HTTP 通信和 XML 解析和渲染。不建议使用这些类,因为它们组成了将来可能会改变的内部实施详情。其向后兼容性无法依赖。