docker-engine-ruby 0.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (608) hide show
  1. checksums.yaml +7 -0
  2. data/.ignore +2 -0
  3. data/CHANGELOG.md +41 -0
  4. data/README.md +232 -0
  5. data/SECURITY.md +27 -0
  6. data/lib/docker_engine_ruby/client.rb +109 -0
  7. data/lib/docker_engine_ruby/errors.rb +228 -0
  8. data/lib/docker_engine_ruby/file_part.rb +58 -0
  9. data/lib/docker_engine_ruby/internal/transport/base_client.rb +573 -0
  10. data/lib/docker_engine_ruby/internal/transport/pooled_net_requester.rb +210 -0
  11. data/lib/docker_engine_ruby/internal/type/array_of.rb +168 -0
  12. data/lib/docker_engine_ruby/internal/type/base_model.rb +534 -0
  13. data/lib/docker_engine_ruby/internal/type/base_page.rb +55 -0
  14. data/lib/docker_engine_ruby/internal/type/boolean.rb +77 -0
  15. data/lib/docker_engine_ruby/internal/type/converter.rb +327 -0
  16. data/lib/docker_engine_ruby/internal/type/enum.rb +133 -0
  17. data/lib/docker_engine_ruby/internal/type/file_input.rb +111 -0
  18. data/lib/docker_engine_ruby/internal/type/hash_of.rb +188 -0
  19. data/lib/docker_engine_ruby/internal/type/request_parameters.rb +42 -0
  20. data/lib/docker_engine_ruby/internal/type/union.rb +245 -0
  21. data/lib/docker_engine_ruby/internal/type/unknown.rb +81 -0
  22. data/lib/docker_engine_ruby/internal/util.rb +920 -0
  23. data/lib/docker_engine_ruby/internal.rb +20 -0
  24. data/lib/docker_engine_ruby/models/auth_login_params.rb +32 -0
  25. data/lib/docker_engine_ruby/models/auth_response.rb +27 -0
  26. data/lib/docker_engine_ruby/models/config.rb +307 -0
  27. data/lib/docker_engine_ruby/models/config_create_params.rb +24 -0
  28. data/lib/docker_engine_ruby/models/config_create_response.rb +19 -0
  29. data/lib/docker_engine_ruby/models/config_delete_params.rb +14 -0
  30. data/lib/docker_engine_ruby/models/config_inspect_params.rb +14 -0
  31. data/lib/docker_engine_ruby/models/config_list_params.rb +33 -0
  32. data/lib/docker_engine_ruby/models/config_list_response.rb +8 -0
  33. data/lib/docker_engine_ruby/models/config_update_params.rb +26 -0
  34. data/lib/docker_engine_ruby/models/connect_request.rb +198 -0
  35. data/lib/docker_engine_ruby/models/container.rb +2516 -0
  36. data/lib/docker_engine_ruby/models/container_archive_params.rb +22 -0
  37. data/lib/docker_engine_ruby/models/container_attach_params.rb +73 -0
  38. data/lib/docker_engine_ruby/models/container_changes_params.rb +14 -0
  39. data/lib/docker_engine_ruby/models/container_changes_response.rb +9 -0
  40. data/lib/docker_engine_ruby/models/container_create_params.rb +1724 -0
  41. data/lib/docker_engine_ruby/models/container_delete_params.rb +38 -0
  42. data/lib/docker_engine_ruby/models/container_exec_params.rb +111 -0
  43. data/lib/docker_engine_ruby/models/container_exec_response.rb +19 -0
  44. data/lib/docker_engine_ruby/models/container_export_params.rb +14 -0
  45. data/lib/docker_engine_ruby/models/container_inspect_params.rb +22 -0
  46. data/lib/docker_engine_ruby/models/container_kill_params.rb +25 -0
  47. data/lib/docker_engine_ruby/models/container_list_params.rb +70 -0
  48. data/lib/docker_engine_ruby/models/container_list_response.rb +8 -0
  49. data/lib/docker_engine_ruby/models/container_logs_params.rb +74 -0
  50. data/lib/docker_engine_ruby/models/container_pause_params.rb +14 -0
  51. data/lib/docker_engine_ruby/models/container_prune_params.rb +35 -0
  52. data/lib/docker_engine_ruby/models/container_prune_response.rb +27 -0
  53. data/lib/docker_engine_ruby/models/container_rename_params.rb +22 -0
  54. data/lib/docker_engine_ruby/models/container_resize_params.rb +30 -0
  55. data/lib/docker_engine_ruby/models/container_restart_params.rb +33 -0
  56. data/lib/docker_engine_ruby/models/container_start_params.rb +27 -0
  57. data/lib/docker_engine_ruby/models/container_stats_params.rb +35 -0
  58. data/lib/docker_engine_ruby/models/container_stop_params.rb +33 -0
  59. data/lib/docker_engine_ruby/models/container_top_params.rb +22 -0
  60. data/lib/docker_engine_ruby/models/container_unpause_params.rb +14 -0
  61. data/lib/docker_engine_ruby/models/container_update_params.rb +606 -0
  62. data/lib/docker_engine_ruby/models/container_wait_params.rb +41 -0
  63. data/lib/docker_engine_ruby/models/create_request.rb +348 -0
  64. data/lib/docker_engine_ruby/models/create_response.rb +27 -0
  65. data/lib/docker_engine_ruby/models/delete_item.rb +24 -0
  66. data/lib/docker_engine_ruby/models/disconnect_request.rb +27 -0
  67. data/lib/docker_engine_ruby/models/distribution_inspect_params.rb +14 -0
  68. data/lib/docker_engine_ruby/models/error.rb +18 -0
  69. data/lib/docker_engine_ruby/models/exec_inspect_params.rb +14 -0
  70. data/lib/docker_engine_ruby/models/exec_inspect_response.rb +87 -0
  71. data/lib/docker_engine_ruby/models/exec_resize_params.rb +30 -0
  72. data/lib/docker_engine_ruby/models/exec_start_params.rb +41 -0
  73. data/lib/docker_engine_ruby/models/filesystem_change.rb +55 -0
  74. data/lib/docker_engine_ruby/models/history_item.rb +47 -0
  75. data/lib/docker_engine_ruby/models/image.rb +1393 -0
  76. data/lib/docker_engine_ruby/models/image_build_params.rb +283 -0
  77. data/lib/docker_engine_ruby/models/image_build_prune_params.rb +71 -0
  78. data/lib/docker_engine_ruby/models/image_build_prune_response.rb +24 -0
  79. data/lib/docker_engine_ruby/models/image_commit_params.rb +70 -0
  80. data/lib/docker_engine_ruby/models/image_commit_response.rb +19 -0
  81. data/lib/docker_engine_ruby/models/image_delete_params.rb +43 -0
  82. data/lib/docker_engine_ruby/models/image_delete_response.rb +8 -0
  83. data/lib/docker_engine_ruby/models/image_get_all_params.rb +37 -0
  84. data/lib/docker_engine_ruby/models/image_get_params.rb +29 -0
  85. data/lib/docker_engine_ruby/models/image_history_params.rb +34 -0
  86. data/lib/docker_engine_ruby/models/image_history_response.rb +8 -0
  87. data/lib/docker_engine_ruby/models/image_inspect_params.rb +22 -0
  88. data/lib/docker_engine_ruby/models/image_list_params.rb +68 -0
  89. data/lib/docker_engine_ruby/models/image_list_response.rb +8 -0
  90. data/lib/docker_engine_ruby/models/image_load_params.rb +44 -0
  91. data/lib/docker_engine_ruby/models/image_prune_params.rb +35 -0
  92. data/lib/docker_engine_ruby/models/image_prune_response.rb +27 -0
  93. data/lib/docker_engine_ruby/models/image_pull_params.rb +115 -0
  94. data/lib/docker_engine_ruby/models/image_push_params.rb +49 -0
  95. data/lib/docker_engine_ruby/models/image_search_params.rb +45 -0
  96. data/lib/docker_engine_ruby/models/image_search_response.rb +55 -0
  97. data/lib/docker_engine_ruby/models/image_tag_params.rb +30 -0
  98. data/lib/docker_engine_ruby/models/info.rb +1496 -0
  99. data/lib/docker_engine_ruby/models/inspect.rb +221 -0
  100. data/lib/docker_engine_ruby/models/inspect_response.rb +39 -0
  101. data/lib/docker_engine_ruby/models/list_response.rb +32 -0
  102. data/lib/docker_engine_ruby/models/network.rb +253 -0
  103. data/lib/docker_engine_ruby/models/network_connect_params.rb +14 -0
  104. data/lib/docker_engine_ruby/models/network_create_params.rb +210 -0
  105. data/lib/docker_engine_ruby/models/network_delete_params.rb +14 -0
  106. data/lib/docker_engine_ruby/models/network_disconnect_params.rb +14 -0
  107. data/lib/docker_engine_ruby/models/network_inspect_params.rb +30 -0
  108. data/lib/docker_engine_ruby/models/network_inspect_response.rb +131 -0
  109. data/lib/docker_engine_ruby/models/network_list_params.rb +40 -0
  110. data/lib/docker_engine_ruby/models/network_list_response.rb +8 -0
  111. data/lib/docker_engine_ruby/models/network_prune_params.rb +35 -0
  112. data/lib/docker_engine_ruby/models/network_prune_response.rb +19 -0
  113. data/lib/docker_engine_ruby/models/node.rb +461 -0
  114. data/lib/docker_engine_ruby/models/node_delete_params.rb +22 -0
  115. data/lib/docker_engine_ruby/models/node_inspect_params.rb +14 -0
  116. data/lib/docker_engine_ruby/models/node_list_params.rb +34 -0
  117. data/lib/docker_engine_ruby/models/node_list_response.rb +8 -0
  118. data/lib/docker_engine_ruby/models/node_update_params.rb +26 -0
  119. data/lib/docker_engine_ruby/models/plugin.rb +532 -0
  120. data/lib/docker_engine_ruby/models/plugin_create_params.rb +33 -0
  121. data/lib/docker_engine_ruby/models/plugin_delete_params.rb +26 -0
  122. data/lib/docker_engine_ruby/models/plugin_disable_params.rb +25 -0
  123. data/lib/docker_engine_ruby/models/plugin_enable_params.rb +22 -0
  124. data/lib/docker_engine_ruby/models/plugin_inspect_params.rb +14 -0
  125. data/lib/docker_engine_ruby/models/plugin_list_params.rb +31 -0
  126. data/lib/docker_engine_ruby/models/plugin_list_response.rb +8 -0
  127. data/lib/docker_engine_ruby/models/plugin_privileges_params.rb +26 -0
  128. data/lib/docker_engine_ruby/models/plugin_privileges_response.rb +8 -0
  129. data/lib/docker_engine_ruby/models/plugin_pull_params.rb +51 -0
  130. data/lib/docker_engine_ruby/models/plugin_push_params.rb +14 -0
  131. data/lib/docker_engine_ruby/models/plugin_set_params.rb +20 -0
  132. data/lib/docker_engine_ruby/models/plugin_upgrade_params.rb +41 -0
  133. data/lib/docker_engine_ruby/models/privilege.rb +29 -0
  134. data/lib/docker_engine_ruby/models/secret.rb +77 -0
  135. data/lib/docker_engine_ruby/models/secret_create_params.rb +24 -0
  136. data/lib/docker_engine_ruby/models/secret_create_response.rb +19 -0
  137. data/lib/docker_engine_ruby/models/secret_delete_params.rb +14 -0
  138. data/lib/docker_engine_ruby/models/secret_inspect_params.rb +14 -0
  139. data/lib/docker_engine_ruby/models/secret_list_params.rb +33 -0
  140. data/lib/docker_engine_ruby/models/secret_list_response.rb +8 -0
  141. data/lib/docker_engine_ruby/models/secret_update_params.rb +26 -0
  142. data/lib/docker_engine_ruby/models/service.rb +522 -0
  143. data/lib/docker_engine_ruby/models/service_create_params.rb +34 -0
  144. data/lib/docker_engine_ruby/models/service_delete_params.rb +14 -0
  145. data/lib/docker_engine_ruby/models/service_inspect_params.rb +22 -0
  146. data/lib/docker_engine_ruby/models/service_list_params.rb +41 -0
  147. data/lib/docker_engine_ruby/models/service_list_response.rb +8 -0
  148. data/lib/docker_engine_ruby/models/service_logs_params.rb +74 -0
  149. data/lib/docker_engine_ruby/models/service_update_params.rb +78 -0
  150. data/lib/docker_engine_ruby/models/spec.rb +510 -0
  151. data/lib/docker_engine_ruby/models/stats_response.rb +954 -0
  152. data/lib/docker_engine_ruby/models/summary.rb +771 -0
  153. data/lib/docker_engine_ruby/models/swarm.rb +198 -0
  154. data/lib/docker_engine_ruby/models/swarm_init_params.rb +101 -0
  155. data/lib/docker_engine_ruby/models/swarm_init_response.rb +7 -0
  156. data/lib/docker_engine_ruby/models/swarm_inspect_params.rb +14 -0
  157. data/lib/docker_engine_ruby/models/swarm_join_params.rb +70 -0
  158. data/lib/docker_engine_ruby/models/swarm_leave_params.rb +26 -0
  159. data/lib/docker_engine_ruby/models/swarm_unlock_key_params.rb +14 -0
  160. data/lib/docker_engine_ruby/models/swarm_unlock_key_response.rb +17 -0
  161. data/lib/docker_engine_ruby/models/swarm_unlock_params.rb +22 -0
  162. data/lib/docker_engine_ruby/models/swarm_update_params.rb +50 -0
  163. data/lib/docker_engine_ruby/models/system_data_usage_params.rb +46 -0
  164. data/lib/docker_engine_ruby/models/system_data_usage_response.rb +260 -0
  165. data/lib/docker_engine_ruby/models/system_events_params.rb +58 -0
  166. data/lib/docker_engine_ruby/models/system_events_response.rb +126 -0
  167. data/lib/docker_engine_ruby/models/system_info_params.rb +14 -0
  168. data/lib/docker_engine_ruby/models/system_ping_params.rb +14 -0
  169. data/lib/docker_engine_ruby/models/system_ping_response.rb +7 -0
  170. data/lib/docker_engine_ruby/models/system_version_params.rb +14 -0
  171. data/lib/docker_engine_ruby/models/task.rb +471 -0
  172. data/lib/docker_engine_ruby/models/task_inspect_params.rb +14 -0
  173. data/lib/docker_engine_ruby/models/task_list_params.rb +35 -0
  174. data/lib/docker_engine_ruby/models/task_list_response.rb +8 -0
  175. data/lib/docker_engine_ruby/models/task_logs_params.rb +74 -0
  176. data/lib/docker_engine_ruby/models/top_response.rb +33 -0
  177. data/lib/docker_engine_ruby/models/update_response.rb +19 -0
  178. data/lib/docker_engine_ruby/models/version.rb +164 -0
  179. data/lib/docker_engine_ruby/models/volume.rb +651 -0
  180. data/lib/docker_engine_ruby/models/volume_create_params.rb +14 -0
  181. data/lib/docker_engine_ruby/models/volume_delete_params.rb +22 -0
  182. data/lib/docker_engine_ruby/models/volume_inspect_params.rb +14 -0
  183. data/lib/docker_engine_ruby/models/volume_list_params.rb +34 -0
  184. data/lib/docker_engine_ruby/models/volume_prune_params.rb +33 -0
  185. data/lib/docker_engine_ruby/models/volume_prune_response.rb +25 -0
  186. data/lib/docker_engine_ruby/models/volume_update_params.rb +323 -0
  187. data/lib/docker_engine_ruby/models/wait_response.rb +41 -0
  188. data/lib/docker_engine_ruby/models.rb +312 -0
  189. data/lib/docker_engine_ruby/request_options.rb +78 -0
  190. data/lib/docker_engine_ruby/resources/auth.rb +38 -0
  191. data/lib/docker_engine_ruby/resources/configs.rb +130 -0
  192. data/lib/docker_engine_ruby/resources/containers.rb +854 -0
  193. data/lib/docker_engine_ruby/resources/distribution.rb +34 -0
  194. data/lib/docker_engine_ruby/resources/exec.rb +91 -0
  195. data/lib/docker_engine_ruby/resources/images.rb +676 -0
  196. data/lib/docker_engine_ruby/resources/networks.rb +218 -0
  197. data/lib/docker_engine_ruby/resources/nodes.rb +113 -0
  198. data/lib/docker_engine_ruby/resources/plugins.rb +317 -0
  199. data/lib/docker_engine_ruby/resources/secrets.rb +130 -0
  200. data/lib/docker_engine_ruby/resources/services.rb +195 -0
  201. data/lib/docker_engine_ruby/resources/swarm.rb +183 -0
  202. data/lib/docker_engine_ruby/resources/system.rb +155 -0
  203. data/lib/docker_engine_ruby/resources/tasks.rb +103 -0
  204. data/lib/docker_engine_ruby/resources/volumes.rb +161 -0
  205. data/lib/docker_engine_ruby/version.rb +5 -0
  206. data/lib/docker_engine_ruby.rb +234 -0
  207. data/manifest.yaml +17 -0
  208. data/rbi/docker_engine_ruby/client.rbi +80 -0
  209. data/rbi/docker_engine_ruby/errors.rbi +205 -0
  210. data/rbi/docker_engine_ruby/file_part.rbi +37 -0
  211. data/rbi/docker_engine_ruby/internal/transport/base_client.rbi +305 -0
  212. data/rbi/docker_engine_ruby/internal/transport/pooled_net_requester.rbi +84 -0
  213. data/rbi/docker_engine_ruby/internal/type/array_of.rbi +108 -0
  214. data/rbi/docker_engine_ruby/internal/type/base_model.rbi +316 -0
  215. data/rbi/docker_engine_ruby/internal/type/base_page.rbi +43 -0
  216. data/rbi/docker_engine_ruby/internal/type/boolean.rbi +58 -0
  217. data/rbi/docker_engine_ruby/internal/type/converter.rbi +225 -0
  218. data/rbi/docker_engine_ruby/internal/type/enum.rbi +82 -0
  219. data/rbi/docker_engine_ruby/internal/type/file_input.rbi +59 -0
  220. data/rbi/docker_engine_ruby/internal/type/hash_of.rbi +108 -0
  221. data/rbi/docker_engine_ruby/internal/type/request_parameters.rbi +31 -0
  222. data/rbi/docker_engine_ruby/internal/type/union.rbi +134 -0
  223. data/rbi/docker_engine_ruby/internal/type/unknown.rbi +58 -0
  224. data/rbi/docker_engine_ruby/internal/util.rbi +487 -0
  225. data/rbi/docker_engine_ruby/internal.rbi +18 -0
  226. data/rbi/docker_engine_ruby/models/auth_login_params.rbi +65 -0
  227. data/rbi/docker_engine_ruby/models/auth_response.rbi +42 -0
  228. data/rbi/docker_engine_ruby/models/config.rbi +442 -0
  229. data/rbi/docker_engine_ruby/models/config_create_params.rbi +64 -0
  230. data/rbi/docker_engine_ruby/models/config_create_response.rbi +31 -0
  231. data/rbi/docker_engine_ruby/models/config_delete_params.rbi +32 -0
  232. data/rbi/docker_engine_ruby/models/config_inspect_params.rbi +32 -0
  233. data/rbi/docker_engine_ruby/models/config_list_params.rbi +62 -0
  234. data/rbi/docker_engine_ruby/models/config_list_response.rbi +11 -0
  235. data/rbi/docker_engine_ruby/models/config_update_params.rbi +48 -0
  236. data/rbi/docker_engine_ruby/models/connect_request.rbi +343 -0
  237. data/rbi/docker_engine_ruby/models/container.rbi +4672 -0
  238. data/rbi/docker_engine_ruby/models/container_archive_params.rbi +43 -0
  239. data/rbi/docker_engine_ruby/models/container_attach_params.rbi +120 -0
  240. data/rbi/docker_engine_ruby/models/container_changes_params.rbi +32 -0
  241. data/rbi/docker_engine_ruby/models/container_changes_response.rbi +13 -0
  242. data/rbi/docker_engine_ruby/models/container_create_params.rbi +3301 -0
  243. data/rbi/docker_engine_ruby/models/container_delete_params.rbi +71 -0
  244. data/rbi/docker_engine_ruby/models/container_exec_params.rbi +162 -0
  245. data/rbi/docker_engine_ruby/models/container_exec_response.rbi +31 -0
  246. data/rbi/docker_engine_ruby/models/container_export_params.rbi +32 -0
  247. data/rbi/docker_engine_ruby/models/container_inspect_params.rbi +49 -0
  248. data/rbi/docker_engine_ruby/models/container_kill_params.rbi +46 -0
  249. data/rbi/docker_engine_ruby/models/container_list_params.rbi +124 -0
  250. data/rbi/docker_engine_ruby/models/container_list_response.rbi +11 -0
  251. data/rbi/docker_engine_ruby/models/container_logs_params.rbi +117 -0
  252. data/rbi/docker_engine_ruby/models/container_pause_params.rbi +32 -0
  253. data/rbi/docker_engine_ruby/models/container_prune_params.rbi +66 -0
  254. data/rbi/docker_engine_ruby/models/container_prune_response.rbi +51 -0
  255. data/rbi/docker_engine_ruby/models/container_rename_params.rbi +43 -0
  256. data/rbi/docker_engine_ruby/models/container_resize_params.rbi +54 -0
  257. data/rbi/docker_engine_ruby/models/container_restart_params.rbi +60 -0
  258. data/rbi/docker_engine_ruby/models/container_start_params.rbi +53 -0
  259. data/rbi/docker_engine_ruby/models/container_stats_params.rbi +64 -0
  260. data/rbi/docker_engine_ruby/models/container_stop_params.rbi +60 -0
  261. data/rbi/docker_engine_ruby/models/container_top_params.rbi +46 -0
  262. data/rbi/docker_engine_ruby/models/container_unpause_params.rbi +32 -0
  263. data/rbi/docker_engine_ruby/models/container_update_params.rbi +1125 -0
  264. data/rbi/docker_engine_ruby/models/container_wait_params.rbi +101 -0
  265. data/rbi/docker_engine_ruby/models/create_request.rbi +708 -0
  266. data/rbi/docker_engine_ruby/models/create_response.rbi +39 -0
  267. data/rbi/docker_engine_ruby/models/delete_item.rbi +44 -0
  268. data/rbi/docker_engine_ruby/models/disconnect_request.rbi +43 -0
  269. data/rbi/docker_engine_ruby/models/distribution_inspect_params.rbi +32 -0
  270. data/rbi/docker_engine_ruby/models/error.rbi +28 -0
  271. data/rbi/docker_engine_ruby/models/exec_inspect_params.rbi +32 -0
  272. data/rbi/docker_engine_ruby/models/exec_inspect_response.rbi +135 -0
  273. data/rbi/docker_engine_ruby/models/exec_resize_params.rbi +54 -0
  274. data/rbi/docker_engine_ruby/models/exec_start_params.rbi +68 -0
  275. data/rbi/docker_engine_ruby/models/filesystem_change.rbi +93 -0
  276. data/rbi/docker_engine_ruby/models/history_item.rbi +62 -0
  277. data/rbi/docker_engine_ruby/models/image.rbi +2359 -0
  278. data/rbi/docker_engine_ruby/models/image_build_params.rbi +436 -0
  279. data/rbi/docker_engine_ruby/models/image_build_prune_params.rbi +121 -0
  280. data/rbi/docker_engine_ruby/models/image_build_prune_response.rbi +49 -0
  281. data/rbi/docker_engine_ruby/models/image_commit_params.rbi +115 -0
  282. data/rbi/docker_engine_ruby/models/image_commit_response.rbi +31 -0
  283. data/rbi/docker_engine_ruby/models/image_delete_params.rbi +75 -0
  284. data/rbi/docker_engine_ruby/models/image_delete_response.rbi +11 -0
  285. data/rbi/docker_engine_ruby/models/image_get_all_params.rbi +68 -0
  286. data/rbi/docker_engine_ruby/models/image_get_params.rbi +57 -0
  287. data/rbi/docker_engine_ruby/models/image_history_params.rbi +67 -0
  288. data/rbi/docker_engine_ruby/models/image_history_response.rbi +13 -0
  289. data/rbi/docker_engine_ruby/models/image_inspect_params.rbi +49 -0
  290. data/rbi/docker_engine_ruby/models/image_list_params.rbi +115 -0
  291. data/rbi/docker_engine_ruby/models/image_list_response.rbi +11 -0
  292. data/rbi/docker_engine_ruby/models/image_load_params.rbi +74 -0
  293. data/rbi/docker_engine_ruby/models/image_prune_params.rbi +66 -0
  294. data/rbi/docker_engine_ruby/models/image_prune_response.rbi +58 -0
  295. data/rbi/docker_engine_ruby/models/image_pull_params.rbi +189 -0
  296. data/rbi/docker_engine_ruby/models/image_push_params.rbi +84 -0
  297. data/rbi/docker_engine_ruby/models/image_search_params.rbi +76 -0
  298. data/rbi/docker_engine_ruby/models/image_search_response.rbi +95 -0
  299. data/rbi/docker_engine_ruby/models/image_tag_params.rbi +60 -0
  300. data/rbi/docker_engine_ruby/models/info.rbi +2574 -0
  301. data/rbi/docker_engine_ruby/models/inspect.rbi +361 -0
  302. data/rbi/docker_engine_ruby/models/inspect_response.rbi +77 -0
  303. data/rbi/docker_engine_ruby/models/list_response.rbi +55 -0
  304. data/rbi/docker_engine_ruby/models/network.rbi +427 -0
  305. data/rbi/docker_engine_ruby/models/network_connect_params.rbi +32 -0
  306. data/rbi/docker_engine_ruby/models/network_create_params.rbi +374 -0
  307. data/rbi/docker_engine_ruby/models/network_delete_params.rbi +32 -0
  308. data/rbi/docker_engine_ruby/models/network_disconnect_params.rbi +32 -0
  309. data/rbi/docker_engine_ruby/models/network_inspect_params.rbi +60 -0
  310. data/rbi/docker_engine_ruby/models/network_inspect_response.rbi +336 -0
  311. data/rbi/docker_engine_ruby/models/network_list_params.rbi +76 -0
  312. data/rbi/docker_engine_ruby/models/network_list_response.rbi +11 -0
  313. data/rbi/docker_engine_ruby/models/network_prune_params.rbi +66 -0
  314. data/rbi/docker_engine_ruby/models/network_prune_response.rbi +35 -0
  315. data/rbi/docker_engine_ruby/models/node.rbi +915 -0
  316. data/rbi/docker_engine_ruby/models/node_delete_params.rbi +49 -0
  317. data/rbi/docker_engine_ruby/models/node_inspect_params.rbi +32 -0
  318. data/rbi/docker_engine_ruby/models/node_list_params.rbi +64 -0
  319. data/rbi/docker_engine_ruby/models/node_list_response.rbi +11 -0
  320. data/rbi/docker_engine_ruby/models/node_update_params.rbi +48 -0
  321. data/rbi/docker_engine_ruby/models/plugin.rbi +843 -0
  322. data/rbi/docker_engine_ruby/models/plugin_create_params.rbi +54 -0
  323. data/rbi/docker_engine_ruby/models/plugin_delete_params.rbi +51 -0
  324. data/rbi/docker_engine_ruby/models/plugin_disable_params.rbi +49 -0
  325. data/rbi/docker_engine_ruby/models/plugin_enable_params.rbi +49 -0
  326. data/rbi/docker_engine_ruby/models/plugin_inspect_params.rbi +32 -0
  327. data/rbi/docker_engine_ruby/models/plugin_list_params.rbi +58 -0
  328. data/rbi/docker_engine_ruby/models/plugin_list_response.rbi +11 -0
  329. data/rbi/docker_engine_ruby/models/plugin_privileges_params.rbi +45 -0
  330. data/rbi/docker_engine_ruby/models/plugin_privileges_response.rbi +11 -0
  331. data/rbi/docker_engine_ruby/models/plugin_pull_params.rbi +83 -0
  332. data/rbi/docker_engine_ruby/models/plugin_push_params.rbi +32 -0
  333. data/rbi/docker_engine_ruby/models/plugin_set_params.rbi +44 -0
  334. data/rbi/docker_engine_ruby/models/plugin_upgrade_params.rbi +68 -0
  335. data/rbi/docker_engine_ruby/models/privilege.rbi +52 -0
  336. data/rbi/docker_engine_ruby/models/secret.rbi +125 -0
  337. data/rbi/docker_engine_ruby/models/secret_create_params.rbi +64 -0
  338. data/rbi/docker_engine_ruby/models/secret_create_response.rbi +31 -0
  339. data/rbi/docker_engine_ruby/models/secret_delete_params.rbi +32 -0
  340. data/rbi/docker_engine_ruby/models/secret_inspect_params.rbi +32 -0
  341. data/rbi/docker_engine_ruby/models/secret_list_params.rbi +62 -0
  342. data/rbi/docker_engine_ruby/models/secret_list_response.rbi +11 -0
  343. data/rbi/docker_engine_ruby/models/secret_update_params.rbi +48 -0
  344. data/rbi/docker_engine_ruby/models/service.rbi +1100 -0
  345. data/rbi/docker_engine_ruby/models/service_create_params.rbi +79 -0
  346. data/rbi/docker_engine_ruby/models/service_delete_params.rbi +32 -0
  347. data/rbi/docker_engine_ruby/models/service_inspect_params.rbi +49 -0
  348. data/rbi/docker_engine_ruby/models/service_list_params.rbi +76 -0
  349. data/rbi/docker_engine_ruby/models/service_list_response.rbi +11 -0
  350. data/rbi/docker_engine_ruby/models/service_logs_params.rbi +117 -0
  351. data/rbi/docker_engine_ruby/models/service_update_params.rbi +168 -0
  352. data/rbi/docker_engine_ruby/models/spec.rbi +1037 -0
  353. data/rbi/docker_engine_ruby/models/stats_response.rbi +1775 -0
  354. data/rbi/docker_engine_ruby/models/summary.rbi +1342 -0
  355. data/rbi/docker_engine_ruby/models/swarm.rbi +315 -0
  356. data/rbi/docker_engine_ruby/models/swarm_init_params.rbi +162 -0
  357. data/rbi/docker_engine_ruby/models/swarm_init_response.rbi +7 -0
  358. data/rbi/docker_engine_ruby/models/swarm_inspect_params.rbi +32 -0
  359. data/rbi/docker_engine_ruby/models/swarm_join_params.rbi +119 -0
  360. data/rbi/docker_engine_ruby/models/swarm_leave_params.rbi +51 -0
  361. data/rbi/docker_engine_ruby/models/swarm_unlock_key_params.rbi +32 -0
  362. data/rbi/docker_engine_ruby/models/swarm_unlock_key_response.rbi +33 -0
  363. data/rbi/docker_engine_ruby/models/swarm_unlock_params.rbi +49 -0
  364. data/rbi/docker_engine_ruby/models/swarm_update_params.rbi +81 -0
  365. data/rbi/docker_engine_ruby/models/system_data_usage_params.rbi +114 -0
  366. data/rbi/docker_engine_ruby/models/system_data_usage_response.rbi +460 -0
  367. data/rbi/docker_engine_ruby/models/system_events_params.rbi +105 -0
  368. data/rbi/docker_engine_ruby/models/system_events_response.rbi +289 -0
  369. data/rbi/docker_engine_ruby/models/system_info_params.rbi +32 -0
  370. data/rbi/docker_engine_ruby/models/system_ping_params.rbi +32 -0
  371. data/rbi/docker_engine_ruby/models/system_ping_response.rbi +7 -0
  372. data/rbi/docker_engine_ruby/models/system_version_params.rbi +32 -0
  373. data/rbi/docker_engine_ruby/models/task.rbi +948 -0
  374. data/rbi/docker_engine_ruby/models/task_inspect_params.rbi +32 -0
  375. data/rbi/docker_engine_ruby/models/task_list_params.rbi +66 -0
  376. data/rbi/docker_engine_ruby/models/task_list_response.rbi +11 -0
  377. data/rbi/docker_engine_ruby/models/task_logs_params.rbi +117 -0
  378. data/rbi/docker_engine_ruby/models/top_response.rbi +54 -0
  379. data/rbi/docker_engine_ruby/models/update_response.rbi +34 -0
  380. data/rbi/docker_engine_ruby/models/version.rbi +256 -0
  381. data/rbi/docker_engine_ruby/models/volume.rbi +1236 -0
  382. data/rbi/docker_engine_ruby/models/volume_create_params.rbi +32 -0
  383. data/rbi/docker_engine_ruby/models/volume_delete_params.rbi +49 -0
  384. data/rbi/docker_engine_ruby/models/volume_inspect_params.rbi +32 -0
  385. data/rbi/docker_engine_ruby/models/volume_list_params.rbi +64 -0
  386. data/rbi/docker_engine_ruby/models/volume_prune_params.rbi +62 -0
  387. data/rbi/docker_engine_ruby/models/volume_prune_response.rbi +51 -0
  388. data/rbi/docker_engine_ruby/models/volume_update_params.rbi +668 -0
  389. data/rbi/docker_engine_ruby/models/wait_response.rbi +78 -0
  390. data/rbi/docker_engine_ruby/models.rbi +272 -0
  391. data/rbi/docker_engine_ruby/request_options.rbi +64 -0
  392. data/rbi/docker_engine_ruby/resources/auth.rbi +30 -0
  393. data/rbi/docker_engine_ruby/resources/configs.rbi +93 -0
  394. data/rbi/docker_engine_ruby/resources/containers.rbi +843 -0
  395. data/rbi/docker_engine_ruby/resources/distribution.rbi +26 -0
  396. data/rbi/docker_engine_ruby/resources/exec.rbi +72 -0
  397. data/rbi/docker_engine_ruby/resources/images.rbi +739 -0
  398. data/rbi/docker_engine_ruby/resources/networks.rbi +201 -0
  399. data/rbi/docker_engine_ruby/resources/nodes.rbi +87 -0
  400. data/rbi/docker_engine_ruby/resources/plugins.rbi +228 -0
  401. data/rbi/docker_engine_ruby/resources/secrets.rbi +93 -0
  402. data/rbi/docker_engine_ruby/resources/services.rbi +166 -0
  403. data/rbi/docker_engine_ruby/resources/swarm.rbi +178 -0
  404. data/rbi/docker_engine_ruby/resources/system.rbi +123 -0
  405. data/rbi/docker_engine_ruby/resources/tasks.rbi +90 -0
  406. data/rbi/docker_engine_ruby/resources/volumes.rbi +123 -0
  407. data/rbi/docker_engine_ruby/version.rbi +5 -0
  408. data/sig/docker_engine_ruby/client.rbs +49 -0
  409. data/sig/docker_engine_ruby/errors.rbs +117 -0
  410. data/sig/docker_engine_ruby/file_part.rbs +21 -0
  411. data/sig/docker_engine_ruby/internal/transport/base_client.rbs +131 -0
  412. data/sig/docker_engine_ruby/internal/transport/pooled_net_requester.rbs +48 -0
  413. data/sig/docker_engine_ruby/internal/type/array_of.rbs +48 -0
  414. data/sig/docker_engine_ruby/internal/type/base_model.rbs +106 -0
  415. data/sig/docker_engine_ruby/internal/type/base_page.rbs +24 -0
  416. data/sig/docker_engine_ruby/internal/type/boolean.rbs +26 -0
  417. data/sig/docker_engine_ruby/internal/type/converter.rbs +79 -0
  418. data/sig/docker_engine_ruby/internal/type/enum.rbs +32 -0
  419. data/sig/docker_engine_ruby/internal/type/file_input.rbs +25 -0
  420. data/sig/docker_engine_ruby/internal/type/hash_of.rbs +48 -0
  421. data/sig/docker_engine_ruby/internal/type/request_parameters.rbs +20 -0
  422. data/sig/docker_engine_ruby/internal/type/union.rbs +52 -0
  423. data/sig/docker_engine_ruby/internal/type/unknown.rbs +26 -0
  424. data/sig/docker_engine_ruby/internal/util.rbs +185 -0
  425. data/sig/docker_engine_ruby/internal.rbs +10 -0
  426. data/sig/docker_engine_ruby/models/auth_login_params.rbs +38 -0
  427. data/sig/docker_engine_ruby/models/auth_response.rbs +17 -0
  428. data/sig/docker_engine_ruby/models/config.rbs +225 -0
  429. data/sig/docker_engine_ruby/models/config_create_params.rbs +36 -0
  430. data/sig/docker_engine_ruby/models/config_create_response.rbs +13 -0
  431. data/sig/docker_engine_ruby/models/config_delete_params.rbs +15 -0
  432. data/sig/docker_engine_ruby/models/config_inspect_params.rbs +15 -0
  433. data/sig/docker_engine_ruby/models/config_list_params.rbs +25 -0
  434. data/sig/docker_engine_ruby/models/config_list_response.rbs +7 -0
  435. data/sig/docker_engine_ruby/models/config_update_params.rbs +24 -0
  436. data/sig/docker_engine_ruby/models/connect_request.rbs +175 -0
  437. data/sig/docker_engine_ruby/models/container.rbs +1975 -0
  438. data/sig/docker_engine_ruby/models/container_archive_params.rbs +23 -0
  439. data/sig/docker_engine_ruby/models/container_attach_params.rbs +63 -0
  440. data/sig/docker_engine_ruby/models/container_changes_params.rbs +15 -0
  441. data/sig/docker_engine_ruby/models/container_changes_response.rbs +8 -0
  442. data/sig/docker_engine_ruby/models/container_create_params.rbs +1352 -0
  443. data/sig/docker_engine_ruby/models/container_delete_params.rbs +38 -0
  444. data/sig/docker_engine_ruby/models/container_exec_params.rbs +96 -0
  445. data/sig/docker_engine_ruby/models/container_exec_response.rbs +13 -0
  446. data/sig/docker_engine_ruby/models/container_export_params.rbs +15 -0
  447. data/sig/docker_engine_ruby/models/container_inspect_params.rbs +25 -0
  448. data/sig/docker_engine_ruby/models/container_kill_params.rbs +25 -0
  449. data/sig/docker_engine_ruby/models/container_list_params.rbs +44 -0
  450. data/sig/docker_engine_ruby/models/container_list_response.rbs +7 -0
  451. data/sig/docker_engine_ruby/models/container_logs_params.rbs +70 -0
  452. data/sig/docker_engine_ruby/models/container_pause_params.rbs +15 -0
  453. data/sig/docker_engine_ruby/models/container_prune_params.rbs +25 -0
  454. data/sig/docker_engine_ruby/models/container_prune_response.rbs +26 -0
  455. data/sig/docker_engine_ruby/models/container_rename_params.rbs +23 -0
  456. data/sig/docker_engine_ruby/models/container_resize_params.rbs +28 -0
  457. data/sig/docker_engine_ruby/models/container_restart_params.rbs +32 -0
  458. data/sig/docker_engine_ruby/models/container_start_params.rbs +26 -0
  459. data/sig/docker_engine_ruby/models/container_stats_params.rbs +32 -0
  460. data/sig/docker_engine_ruby/models/container_stop_params.rbs +32 -0
  461. data/sig/docker_engine_ruby/models/container_top_params.rbs +25 -0
  462. data/sig/docker_engine_ruby/models/container_unpause_params.rbs +15 -0
  463. data/sig/docker_engine_ruby/models/container_update_params.rbs +476 -0
  464. data/sig/docker_engine_ruby/models/container_wait_params.rbs +40 -0
  465. data/sig/docker_engine_ruby/models/create_request.rbs +255 -0
  466. data/sig/docker_engine_ruby/models/create_response.rbs +15 -0
  467. data/sig/docker_engine_ruby/models/delete_item.rbs +19 -0
  468. data/sig/docker_engine_ruby/models/disconnect_request.rbs +17 -0
  469. data/sig/docker_engine_ruby/models/distribution_inspect_params.rbs +15 -0
  470. data/sig/docker_engine_ruby/models/error.rbs +13 -0
  471. data/sig/docker_engine_ruby/models/exec_inspect_params.rbs +15 -0
  472. data/sig/docker_engine_ruby/models/exec_inspect_response.rbs +94 -0
  473. data/sig/docker_engine_ruby/models/exec_resize_params.rbs +28 -0
  474. data/sig/docker_engine_ruby/models/exec_start_params.rbs +36 -0
  475. data/sig/docker_engine_ruby/models/filesystem_change.rbs +34 -0
  476. data/sig/docker_engine_ruby/models/history_item.rbs +45 -0
  477. data/sig/docker_engine_ruby/models/image.rbs +1042 -0
  478. data/sig/docker_engine_ruby/models/image_build_params.rbs +221 -0
  479. data/sig/docker_engine_ruby/models/image_build_prune_params.rbs +56 -0
  480. data/sig/docker_engine_ruby/models/image_build_prune_response.rbs +26 -0
  481. data/sig/docker_engine_ruby/models/image_commit_params.rbs +70 -0
  482. data/sig/docker_engine_ruby/models/image_commit_response.rbs +13 -0
  483. data/sig/docker_engine_ruby/models/image_delete_params.rbs +38 -0
  484. data/sig/docker_engine_ruby/models/image_delete_response.rbs +7 -0
  485. data/sig/docker_engine_ruby/models/image_get_all_params.rbs +32 -0
  486. data/sig/docker_engine_ruby/models/image_get_params.rbs +26 -0
  487. data/sig/docker_engine_ruby/models/image_history_params.rbs +26 -0
  488. data/sig/docker_engine_ruby/models/image_history_response.rbs +7 -0
  489. data/sig/docker_engine_ruby/models/image_inspect_params.rbs +25 -0
  490. data/sig/docker_engine_ruby/models/image_list_params.rbs +56 -0
  491. data/sig/docker_engine_ruby/models/image_list_response.rbs +7 -0
  492. data/sig/docker_engine_ruby/models/image_load_params.rbs +40 -0
  493. data/sig/docker_engine_ruby/models/image_prune_params.rbs +25 -0
  494. data/sig/docker_engine_ruby/models/image_prune_response.rbs +31 -0
  495. data/sig/docker_engine_ruby/models/image_pull_params.rbs +84 -0
  496. data/sig/docker_engine_ruby/models/image_push_params.rbs +36 -0
  497. data/sig/docker_engine_ruby/models/image_search_params.rbs +36 -0
  498. data/sig/docker_engine_ruby/models/image_search_response.rbs +55 -0
  499. data/sig/docker_engine_ruby/models/image_tag_params.rbs +32 -0
  500. data/sig/docker_engine_ruby/models/info.rbs +1082 -0
  501. data/sig/docker_engine_ruby/models/inspect.rbs +177 -0
  502. data/sig/docker_engine_ruby/models/inspect_response.rbs +50 -0
  503. data/sig/docker_engine_ruby/models/list_response.rbs +28 -0
  504. data/sig/docker_engine_ruby/models/network.rbs +238 -0
  505. data/sig/docker_engine_ruby/models/network_connect_params.rbs +15 -0
  506. data/sig/docker_engine_ruby/models/network_create_params.rbs +203 -0
  507. data/sig/docker_engine_ruby/models/network_delete_params.rbs +15 -0
  508. data/sig/docker_engine_ruby/models/network_disconnect_params.rbs +15 -0
  509. data/sig/docker_engine_ruby/models/network_inspect_params.rbs +32 -0
  510. data/sig/docker_engine_ruby/models/network_inspect_response.rbs +149 -0
  511. data/sig/docker_engine_ruby/models/network_list_params.rbs +25 -0
  512. data/sig/docker_engine_ruby/models/network_list_response.rbs +7 -0
  513. data/sig/docker_engine_ruby/models/network_prune_params.rbs +25 -0
  514. data/sig/docker_engine_ruby/models/network_prune_response.rbs +15 -0
  515. data/sig/docker_engine_ruby/models/node.rbs +434 -0
  516. data/sig/docker_engine_ruby/models/node_delete_params.rbs +25 -0
  517. data/sig/docker_engine_ruby/models/node_inspect_params.rbs +15 -0
  518. data/sig/docker_engine_ruby/models/node_list_params.rbs +25 -0
  519. data/sig/docker_engine_ruby/models/node_list_response.rbs +7 -0
  520. data/sig/docker_engine_ruby/models/node_update_params.rbs +24 -0
  521. data/sig/docker_engine_ruby/models/plugin.rbs +509 -0
  522. data/sig/docker_engine_ruby/models/plugin_create_params.rbs +28 -0
  523. data/sig/docker_engine_ruby/models/plugin_delete_params.rbs +25 -0
  524. data/sig/docker_engine_ruby/models/plugin_disable_params.rbs +25 -0
  525. data/sig/docker_engine_ruby/models/plugin_enable_params.rbs +26 -0
  526. data/sig/docker_engine_ruby/models/plugin_inspect_params.rbs +15 -0
  527. data/sig/docker_engine_ruby/models/plugin_list_params.rbs +25 -0
  528. data/sig/docker_engine_ruby/models/plugin_list_response.rbs +7 -0
  529. data/sig/docker_engine_ruby/models/plugin_privileges_params.rbs +23 -0
  530. data/sig/docker_engine_ruby/models/plugin_privileges_response.rbs +7 -0
  531. data/sig/docker_engine_ruby/models/plugin_pull_params.rbs +49 -0
  532. data/sig/docker_engine_ruby/models/plugin_push_params.rbs +15 -0
  533. data/sig/docker_engine_ruby/models/plugin_set_params.rbs +26 -0
  534. data/sig/docker_engine_ruby/models/plugin_upgrade_params.rbs +42 -0
  535. data/sig/docker_engine_ruby/models/privilege.rbs +32 -0
  536. data/sig/docker_engine_ruby/models/secret.rbs +64 -0
  537. data/sig/docker_engine_ruby/models/secret_create_params.rbs +36 -0
  538. data/sig/docker_engine_ruby/models/secret_create_response.rbs +13 -0
  539. data/sig/docker_engine_ruby/models/secret_delete_params.rbs +15 -0
  540. data/sig/docker_engine_ruby/models/secret_inspect_params.rbs +15 -0
  541. data/sig/docker_engine_ruby/models/secret_list_params.rbs +25 -0
  542. data/sig/docker_engine_ruby/models/secret_list_response.rbs +7 -0
  543. data/sig/docker_engine_ruby/models/secret_update_params.rbs +24 -0
  544. data/sig/docker_engine_ruby/models/service.rbs +471 -0
  545. data/sig/docker_engine_ruby/models/service_create_params.rbs +41 -0
  546. data/sig/docker_engine_ruby/models/service_delete_params.rbs +15 -0
  547. data/sig/docker_engine_ruby/models/service_inspect_params.rbs +26 -0
  548. data/sig/docker_engine_ruby/models/service_list_params.rbs +32 -0
  549. data/sig/docker_engine_ruby/models/service_list_response.rbs +7 -0
  550. data/sig/docker_engine_ruby/models/service_logs_params.rbs +70 -0
  551. data/sig/docker_engine_ruby/models/service_update_params.rbs +73 -0
  552. data/sig/docker_engine_ruby/models/spec.rbs +467 -0
  553. data/sig/docker_engine_ruby/models/stats_response.rbs +730 -0
  554. data/sig/docker_engine_ruby/models/summary.rbs +634 -0
  555. data/sig/docker_engine_ruby/models/swarm.rbs +159 -0
  556. data/sig/docker_engine_ruby/models/swarm_init_params.rbs +77 -0
  557. data/sig/docker_engine_ruby/models/swarm_init_response.rbs +5 -0
  558. data/sig/docker_engine_ruby/models/swarm_inspect_params.rbs +15 -0
  559. data/sig/docker_engine_ruby/models/swarm_join_params.rbs +56 -0
  560. data/sig/docker_engine_ruby/models/swarm_leave_params.rbs +25 -0
  561. data/sig/docker_engine_ruby/models/swarm_unlock_key_params.rbs +15 -0
  562. data/sig/docker_engine_ruby/models/swarm_unlock_key_response.rbs +15 -0
  563. data/sig/docker_engine_ruby/models/swarm_unlock_params.rbs +26 -0
  564. data/sig/docker_engine_ruby/models/swarm_update_params.rbs +47 -0
  565. data/sig/docker_engine_ruby/models/system_data_usage_params.rbs +50 -0
  566. data/sig/docker_engine_ruby/models/system_data_usage_response.rbs +239 -0
  567. data/sig/docker_engine_ruby/models/system_events_params.rbs +38 -0
  568. data/sig/docker_engine_ruby/models/system_events_response.rbs +124 -0
  569. data/sig/docker_engine_ruby/models/system_info_params.rbs +15 -0
  570. data/sig/docker_engine_ruby/models/system_ping_params.rbs +15 -0
  571. data/sig/docker_engine_ruby/models/system_ping_response.rbs +5 -0
  572. data/sig/docker_engine_ruby/models/system_version_params.rbs +15 -0
  573. data/sig/docker_engine_ruby/models/task.rbs +469 -0
  574. data/sig/docker_engine_ruby/models/task_inspect_params.rbs +15 -0
  575. data/sig/docker_engine_ruby/models/task_list_params.rbs +25 -0
  576. data/sig/docker_engine_ruby/models/task_list_response.rbs +7 -0
  577. data/sig/docker_engine_ruby/models/task_logs_params.rbs +70 -0
  578. data/sig/docker_engine_ruby/models/top_response.rbs +26 -0
  579. data/sig/docker_engine_ruby/models/update_response.rbs +15 -0
  580. data/sig/docker_engine_ruby/models/version.rbs +127 -0
  581. data/sig/docker_engine_ruby/models/volume.rbs +478 -0
  582. data/sig/docker_engine_ruby/models/volume_create_params.rbs +15 -0
  583. data/sig/docker_engine_ruby/models/volume_delete_params.rbs +25 -0
  584. data/sig/docker_engine_ruby/models/volume_inspect_params.rbs +15 -0
  585. data/sig/docker_engine_ruby/models/volume_list_params.rbs +25 -0
  586. data/sig/docker_engine_ruby/models/volume_prune_params.rbs +25 -0
  587. data/sig/docker_engine_ruby/models/volume_prune_response.rbs +26 -0
  588. data/sig/docker_engine_ruby/models/volume_update_params.rbs +235 -0
  589. data/sig/docker_engine_ruby/models/wait_response.rbs +38 -0
  590. data/sig/docker_engine_ruby/models.rbs +269 -0
  591. data/sig/docker_engine_ruby/request_options.rbs +36 -0
  592. data/sig/docker_engine_ruby/resources/auth.rbs +14 -0
  593. data/sig/docker_engine_ruby/resources/configs.rbs +34 -0
  594. data/sig/docker_engine_ruby/resources/containers.rbs +200 -0
  595. data/sig/docker_engine_ruby/resources/distribution.rbs +12 -0
  596. data/sig/docker_engine_ruby/resources/exec.rbs +27 -0
  597. data/sig/docker_engine_ruby/resources/images.rbs +170 -0
  598. data/sig/docker_engine_ruby/resources/networks.rbs +60 -0
  599. data/sig/docker_engine_ruby/resources/nodes.rbs +30 -0
  600. data/sig/docker_engine_ruby/resources/plugins.rbs +73 -0
  601. data/sig/docker_engine_ruby/resources/secrets.rbs +34 -0
  602. data/sig/docker_engine_ruby/resources/services.rbs +52 -0
  603. data/sig/docker_engine_ruby/resources/swarm.rbs +55 -0
  604. data/sig/docker_engine_ruby/resources/system.rbs +30 -0
  605. data/sig/docker_engine_ruby/resources/tasks.rbs +29 -0
  606. data/sig/docker_engine_ruby/resources/volumes.rbs +40 -0
  607. data/sig/docker_engine_ruby/version.rbs +3 -0
  608. metadata +679 -0
@@ -0,0 +1,2359 @@
1
+ # typed: strong
2
+
3
+ module DockerEngineRuby
4
+ module Models
5
+ class Image < DockerEngineRuby::Internal::Type::BaseModel
6
+ OrHash =
7
+ T.type_alias do
8
+ T.any(DockerEngineRuby::Image, DockerEngineRuby::Internal::AnyHash)
9
+ end
10
+
11
+ # Hardware CPU architecture that the image runs on.
12
+ sig { returns(T.nilable(String)) }
13
+ attr_reader :architecture
14
+
15
+ sig { params(architecture: String).void }
16
+ attr_writer :architecture
17
+
18
+ # Name of the author that was specified when committing the image, or as specified
19
+ # through MAINTAINER (deprecated) in the Dockerfile.
20
+ sig { returns(T.nilable(String)) }
21
+ attr_accessor :author
22
+
23
+ # Optional message that was set when committing or importing the image.
24
+ sig { returns(T.nilable(String)) }
25
+ attr_accessor :comment
26
+
27
+ # Configuration of the image. These fields are used as defaults when starting a
28
+ # container from the image.
29
+ sig { returns(T.nilable(DockerEngineRuby::Image::Config)) }
30
+ attr_reader :config
31
+
32
+ sig { params(config: DockerEngineRuby::Image::Config::OrHash).void }
33
+ attr_writer :config
34
+
35
+ # Date and time at which the image was created, formatted in
36
+ # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
37
+ #
38
+ # This information is only available if present in the image, and omitted
39
+ # otherwise.
40
+ sig { returns(T.nilable(String)) }
41
+ attr_accessor :created
42
+
43
+ # A descriptor struct containing digest, media type, and size, as defined in the
44
+ # [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md).
45
+ sig { returns(T.nilable(DockerEngineRuby::Image::Descriptor)) }
46
+ attr_reader :descriptor
47
+
48
+ sig do
49
+ params(descriptor: DockerEngineRuby::Image::Descriptor::OrHash).void
50
+ end
51
+ attr_writer :descriptor
52
+
53
+ # Information about the storage driver used to store the container's and image's
54
+ # filesystem.
55
+ sig { returns(T.nilable(DockerEngineRuby::Image::GraphDriver)) }
56
+ attr_reader :graph_driver
57
+
58
+ sig do
59
+ params(graph_driver: DockerEngineRuby::Image::GraphDriver::OrHash).void
60
+ end
61
+ attr_writer :graph_driver
62
+
63
+ # ID is the content-addressable ID of an image.
64
+ #
65
+ # This identifier is a content-addressable digest calculated from the image's
66
+ # configuration (which includes the digests of layers used by the image).
67
+ #
68
+ # Note that this digest differs from the `RepoDigests` below, which holds digests
69
+ # of image manifests that reference the image.
70
+ sig { returns(T.nilable(String)) }
71
+ attr_reader :id
72
+
73
+ sig { params(id: String).void }
74
+ attr_writer :id
75
+
76
+ # Identity holds information about the identity and origin of the image. This is
77
+ # trusted information verified by the daemon and cannot be modified by tagging an
78
+ # image to a different name.
79
+ sig { returns(T.nilable(DockerEngineRuby::Image::Identity)) }
80
+ attr_reader :identity
81
+
82
+ sig { params(identity: DockerEngineRuby::Image::Identity::OrHash).void }
83
+ attr_writer :identity
84
+
85
+ # Manifests is a list of image manifests available in this image. It provides a
86
+ # more detailed view of the platform-specific image manifests or other
87
+ # image-attached data like build attestations.
88
+ #
89
+ # Only available if the daemon provides a multi-platform image store and the
90
+ # `manifests` option is set in the inspect request.
91
+ #
92
+ # WARNING: This is experimental and may change at any time without any backward
93
+ # compatibility.
94
+ sig { returns(T.nilable(T::Array[DockerEngineRuby::Image::Manifest])) }
95
+ attr_accessor :manifests
96
+
97
+ # Additional metadata of the image in the local cache. This information is local
98
+ # to the daemon, and not part of the image itself.
99
+ sig { returns(T.nilable(DockerEngineRuby::Image::Metadata)) }
100
+ attr_reader :metadata
101
+
102
+ sig { params(metadata: DockerEngineRuby::Image::Metadata::OrHash).void }
103
+ attr_writer :metadata
104
+
105
+ # Operating System the image is built to run on.
106
+ sig { returns(T.nilable(String)) }
107
+ attr_reader :os
108
+
109
+ sig { params(os: String).void }
110
+ attr_writer :os
111
+
112
+ # Operating System version the image is built to run on (especially for Windows).
113
+ sig { returns(T.nilable(String)) }
114
+ attr_accessor :os_version
115
+
116
+ # List of content-addressable digests of locally available image manifests that
117
+ # the image is referenced from. Multiple manifests can refer to the same image.
118
+ #
119
+ # These digests are usually only available if the image was either pulled from a
120
+ # registry, or if the image was pushed to a registry, which is when the manifest
121
+ # is generated and its digest calculated.
122
+ sig { returns(T.nilable(T::Array[String])) }
123
+ attr_reader :repo_digests
124
+
125
+ sig { params(repo_digests: T::Array[String]).void }
126
+ attr_writer :repo_digests
127
+
128
+ # List of image names/tags in the local image cache that reference this image.
129
+ #
130
+ # Multiple image tags can refer to the same image, and this list may be empty if
131
+ # no tags reference the image, in which case the image is "untagged", in which
132
+ # case it can still be referenced by its ID.
133
+ sig { returns(T.nilable(T::Array[String])) }
134
+ attr_reader :repo_tags
135
+
136
+ sig { params(repo_tags: T::Array[String]).void }
137
+ attr_writer :repo_tags
138
+
139
+ # Information about the image's RootFS, including the layer IDs.
140
+ sig { returns(T.nilable(DockerEngineRuby::Image::RootFs)) }
141
+ attr_reader :root_fs
142
+
143
+ sig { params(root_fs: DockerEngineRuby::Image::RootFs::OrHash).void }
144
+ attr_writer :root_fs
145
+
146
+ # Total size of the image including all layers it is composed of.
147
+ sig { returns(T.nilable(Integer)) }
148
+ attr_reader :size
149
+
150
+ sig { params(size: Integer).void }
151
+ attr_writer :size
152
+
153
+ # CPU architecture variant (presently ARM-only).
154
+ sig { returns(T.nilable(String)) }
155
+ attr_accessor :variant
156
+
157
+ # Information about an image in the local image cache.
158
+ sig do
159
+ params(
160
+ architecture: String,
161
+ author: T.nilable(String),
162
+ comment: T.nilable(String),
163
+ config: DockerEngineRuby::Image::Config::OrHash,
164
+ created: T.nilable(String),
165
+ descriptor: DockerEngineRuby::Image::Descriptor::OrHash,
166
+ graph_driver: DockerEngineRuby::Image::GraphDriver::OrHash,
167
+ id: String,
168
+ identity: DockerEngineRuby::Image::Identity::OrHash,
169
+ manifests:
170
+ T.nilable(T::Array[DockerEngineRuby::Image::Manifest::OrHash]),
171
+ metadata: DockerEngineRuby::Image::Metadata::OrHash,
172
+ os: String,
173
+ os_version: T.nilable(String),
174
+ repo_digests: T::Array[String],
175
+ repo_tags: T::Array[String],
176
+ root_fs: DockerEngineRuby::Image::RootFs::OrHash,
177
+ size: Integer,
178
+ variant: T.nilable(String)
179
+ ).returns(T.attached_class)
180
+ end
181
+ def self.new(
182
+ # Hardware CPU architecture that the image runs on.
183
+ architecture: nil,
184
+ # Name of the author that was specified when committing the image, or as specified
185
+ # through MAINTAINER (deprecated) in the Dockerfile.
186
+ author: nil,
187
+ # Optional message that was set when committing or importing the image.
188
+ comment: nil,
189
+ # Configuration of the image. These fields are used as defaults when starting a
190
+ # container from the image.
191
+ config: nil,
192
+ # Date and time at which the image was created, formatted in
193
+ # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
194
+ #
195
+ # This information is only available if present in the image, and omitted
196
+ # otherwise.
197
+ created: nil,
198
+ # A descriptor struct containing digest, media type, and size, as defined in the
199
+ # [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md).
200
+ descriptor: nil,
201
+ # Information about the storage driver used to store the container's and image's
202
+ # filesystem.
203
+ graph_driver: nil,
204
+ # ID is the content-addressable ID of an image.
205
+ #
206
+ # This identifier is a content-addressable digest calculated from the image's
207
+ # configuration (which includes the digests of layers used by the image).
208
+ #
209
+ # Note that this digest differs from the `RepoDigests` below, which holds digests
210
+ # of image manifests that reference the image.
211
+ id: nil,
212
+ # Identity holds information about the identity and origin of the image. This is
213
+ # trusted information verified by the daemon and cannot be modified by tagging an
214
+ # image to a different name.
215
+ identity: nil,
216
+ # Manifests is a list of image manifests available in this image. It provides a
217
+ # more detailed view of the platform-specific image manifests or other
218
+ # image-attached data like build attestations.
219
+ #
220
+ # Only available if the daemon provides a multi-platform image store and the
221
+ # `manifests` option is set in the inspect request.
222
+ #
223
+ # WARNING: This is experimental and may change at any time without any backward
224
+ # compatibility.
225
+ manifests: nil,
226
+ # Additional metadata of the image in the local cache. This information is local
227
+ # to the daemon, and not part of the image itself.
228
+ metadata: nil,
229
+ # Operating System the image is built to run on.
230
+ os: nil,
231
+ # Operating System version the image is built to run on (especially for Windows).
232
+ os_version: nil,
233
+ # List of content-addressable digests of locally available image manifests that
234
+ # the image is referenced from. Multiple manifests can refer to the same image.
235
+ #
236
+ # These digests are usually only available if the image was either pulled from a
237
+ # registry, or if the image was pushed to a registry, which is when the manifest
238
+ # is generated and its digest calculated.
239
+ repo_digests: nil,
240
+ # List of image names/tags in the local image cache that reference this image.
241
+ #
242
+ # Multiple image tags can refer to the same image, and this list may be empty if
243
+ # no tags reference the image, in which case the image is "untagged", in which
244
+ # case it can still be referenced by its ID.
245
+ repo_tags: nil,
246
+ # Information about the image's RootFS, including the layer IDs.
247
+ root_fs: nil,
248
+ # Total size of the image including all layers it is composed of.
249
+ size: nil,
250
+ # CPU architecture variant (presently ARM-only).
251
+ variant: nil
252
+ )
253
+ end
254
+
255
+ sig do
256
+ override.returns(
257
+ {
258
+ architecture: String,
259
+ author: T.nilable(String),
260
+ comment: T.nilable(String),
261
+ config: DockerEngineRuby::Image::Config,
262
+ created: T.nilable(String),
263
+ descriptor: DockerEngineRuby::Image::Descriptor,
264
+ graph_driver: DockerEngineRuby::Image::GraphDriver,
265
+ id: String,
266
+ identity: DockerEngineRuby::Image::Identity,
267
+ manifests: T.nilable(T::Array[DockerEngineRuby::Image::Manifest]),
268
+ metadata: DockerEngineRuby::Image::Metadata,
269
+ os: String,
270
+ os_version: T.nilable(String),
271
+ repo_digests: T::Array[String],
272
+ repo_tags: T::Array[String],
273
+ root_fs: DockerEngineRuby::Image::RootFs,
274
+ size: Integer,
275
+ variant: T.nilable(String)
276
+ }
277
+ )
278
+ end
279
+ def to_hash
280
+ end
281
+
282
+ class Config < DockerEngineRuby::Internal::Type::BaseModel
283
+ OrHash =
284
+ T.type_alias do
285
+ T.any(
286
+ DockerEngineRuby::Image::Config,
287
+ DockerEngineRuby::Internal::AnyHash
288
+ )
289
+ end
290
+
291
+ # Command is already escaped (Windows only)
292
+ sig { returns(T.nilable(T::Boolean)) }
293
+ attr_accessor :args_escaped
294
+
295
+ # Command to run specified as a string or an array of strings.
296
+ sig { returns(T.nilable(T::Array[String])) }
297
+ attr_reader :cmd
298
+
299
+ sig { params(cmd: T::Array[String]).void }
300
+ attr_writer :cmd
301
+
302
+ # The entry point for the container as a string or an array of strings.
303
+ #
304
+ # If the array consists of exactly one empty string (`[""]`) then the entry point
305
+ # is reset to system default (i.e., the entry point used by docker when there is
306
+ # no `ENTRYPOINT` instruction in the `Dockerfile`).
307
+ sig { returns(T.nilable(T::Array[String])) }
308
+ attr_reader :entrypoint
309
+
310
+ sig { params(entrypoint: T::Array[String]).void }
311
+ attr_writer :entrypoint
312
+
313
+ # A list of environment variables to set inside the container in the form
314
+ # `["VAR=value", ...]`. A variable without `=` is removed from the environment,
315
+ # rather than to have an empty value.
316
+ sig { returns(T.nilable(T::Array[String])) }
317
+ attr_reader :env
318
+
319
+ sig { params(env: T::Array[String]).void }
320
+ attr_writer :env
321
+
322
+ # An object mapping ports to an empty object in the form:
323
+ #
324
+ # `{"<port>/<tcp|udp|sctp>": {}}`
325
+ sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
326
+ attr_accessor :exposed_ports
327
+
328
+ # A test to perform to check that the container is healthy. Healthcheck commands
329
+ # should be side-effect free.
330
+ sig { returns(T.nilable(DockerEngineRuby::Image::Config::Healthcheck)) }
331
+ attr_reader :healthcheck
332
+
333
+ sig do
334
+ params(
335
+ healthcheck: DockerEngineRuby::Image::Config::Healthcheck::OrHash
336
+ ).void
337
+ end
338
+ attr_writer :healthcheck
339
+
340
+ # User-defined key/value metadata.
341
+ sig { returns(T.nilable(T::Hash[Symbol, String])) }
342
+ attr_reader :labels
343
+
344
+ sig { params(labels: T::Hash[Symbol, String]).void }
345
+ attr_writer :labels
346
+
347
+ # `ONBUILD` metadata that were defined in the image's `Dockerfile`.
348
+ sig { returns(T.nilable(T::Array[String])) }
349
+ attr_accessor :on_build
350
+
351
+ # Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.
352
+ sig { returns(T.nilable(T::Array[String])) }
353
+ attr_accessor :shell
354
+
355
+ # Signal to stop a container as a string or unsigned integer.
356
+ sig { returns(T.nilable(String)) }
357
+ attr_accessor :stop_signal
358
+
359
+ # The user that commands are run as inside the container.
360
+ sig { returns(T.nilable(String)) }
361
+ attr_reader :user
362
+
363
+ sig { params(user: String).void }
364
+ attr_writer :user
365
+
366
+ # An object mapping mount point paths inside the container to empty objects.
367
+ sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
368
+ attr_reader :volumes
369
+
370
+ sig { params(volumes: T::Hash[Symbol, T.anything]).void }
371
+ attr_writer :volumes
372
+
373
+ # The working directory for commands to run in.
374
+ sig { returns(T.nilable(String)) }
375
+ attr_reader :working_dir
376
+
377
+ sig { params(working_dir: String).void }
378
+ attr_writer :working_dir
379
+
380
+ # Configuration of the image. These fields are used as defaults when starting a
381
+ # container from the image.
382
+ sig do
383
+ params(
384
+ args_escaped: T.nilable(T::Boolean),
385
+ cmd: T::Array[String],
386
+ entrypoint: T::Array[String],
387
+ env: T::Array[String],
388
+ exposed_ports: T.nilable(T::Hash[Symbol, T.anything]),
389
+ healthcheck: DockerEngineRuby::Image::Config::Healthcheck::OrHash,
390
+ labels: T::Hash[Symbol, String],
391
+ on_build: T.nilable(T::Array[String]),
392
+ shell: T.nilable(T::Array[String]),
393
+ stop_signal: T.nilable(String),
394
+ user: String,
395
+ volumes: T::Hash[Symbol, T.anything],
396
+ working_dir: String
397
+ ).returns(T.attached_class)
398
+ end
399
+ def self.new(
400
+ # Command is already escaped (Windows only)
401
+ args_escaped: nil,
402
+ # Command to run specified as a string or an array of strings.
403
+ cmd: nil,
404
+ # The entry point for the container as a string or an array of strings.
405
+ #
406
+ # If the array consists of exactly one empty string (`[""]`) then the entry point
407
+ # is reset to system default (i.e., the entry point used by docker when there is
408
+ # no `ENTRYPOINT` instruction in the `Dockerfile`).
409
+ entrypoint: nil,
410
+ # A list of environment variables to set inside the container in the form
411
+ # `["VAR=value", ...]`. A variable without `=` is removed from the environment,
412
+ # rather than to have an empty value.
413
+ env: nil,
414
+ # An object mapping ports to an empty object in the form:
415
+ #
416
+ # `{"<port>/<tcp|udp|sctp>": {}}`
417
+ exposed_ports: nil,
418
+ # A test to perform to check that the container is healthy. Healthcheck commands
419
+ # should be side-effect free.
420
+ healthcheck: nil,
421
+ # User-defined key/value metadata.
422
+ labels: nil,
423
+ # `ONBUILD` metadata that were defined in the image's `Dockerfile`.
424
+ on_build: nil,
425
+ # Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.
426
+ shell: nil,
427
+ # Signal to stop a container as a string or unsigned integer.
428
+ stop_signal: nil,
429
+ # The user that commands are run as inside the container.
430
+ user: nil,
431
+ # An object mapping mount point paths inside the container to empty objects.
432
+ volumes: nil,
433
+ # The working directory for commands to run in.
434
+ working_dir: nil
435
+ )
436
+ end
437
+
438
+ sig do
439
+ override.returns(
440
+ {
441
+ args_escaped: T.nilable(T::Boolean),
442
+ cmd: T::Array[String],
443
+ entrypoint: T::Array[String],
444
+ env: T::Array[String],
445
+ exposed_ports: T.nilable(T::Hash[Symbol, T.anything]),
446
+ healthcheck: DockerEngineRuby::Image::Config::Healthcheck,
447
+ labels: T::Hash[Symbol, String],
448
+ on_build: T.nilable(T::Array[String]),
449
+ shell: T.nilable(T::Array[String]),
450
+ stop_signal: T.nilable(String),
451
+ user: String,
452
+ volumes: T::Hash[Symbol, T.anything],
453
+ working_dir: String
454
+ }
455
+ )
456
+ end
457
+ def to_hash
458
+ end
459
+
460
+ class Healthcheck < DockerEngineRuby::Internal::Type::BaseModel
461
+ OrHash =
462
+ T.type_alias do
463
+ T.any(
464
+ DockerEngineRuby::Image::Config::Healthcheck,
465
+ DockerEngineRuby::Internal::AnyHash
466
+ )
467
+ end
468
+
469
+ # The time to wait between checks in nanoseconds. It should be 0 or at least
470
+ # 1000000 (1 ms). 0 means inherit.
471
+ sig { returns(T.nilable(Integer)) }
472
+ attr_reader :interval
473
+
474
+ sig { params(interval: Integer).void }
475
+ attr_writer :interval
476
+
477
+ # The number of consecutive failures needed to consider a container as unhealthy.
478
+ # 0 means inherit.
479
+ sig { returns(T.nilable(Integer)) }
480
+ attr_reader :retries
481
+
482
+ sig { params(retries: Integer).void }
483
+ attr_writer :retries
484
+
485
+ # The time to wait between checks in nanoseconds during the start period. It
486
+ # should be 0 or at least 1000000 (1 ms). 0 means inherit.
487
+ sig { returns(T.nilable(Integer)) }
488
+ attr_reader :start_interval
489
+
490
+ sig { params(start_interval: Integer).void }
491
+ attr_writer :start_interval
492
+
493
+ # Start period for the container to initialize before starting health-retries
494
+ # countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means
495
+ # inherit.
496
+ sig { returns(T.nilable(Integer)) }
497
+ attr_reader :start_period
498
+
499
+ sig { params(start_period: Integer).void }
500
+ attr_writer :start_period
501
+
502
+ # The test to perform. Possible values are:
503
+ #
504
+ # - `[]` inherit healthcheck from image or parent image
505
+ # - `["NONE"]` disable healthcheck
506
+ # - `["CMD", args...]` exec arguments directly
507
+ # - `["CMD-SHELL", command]` run command with system's default shell
508
+ #
509
+ # A non-zero exit code indicates a failed healthcheck:
510
+ #
511
+ # - `0` healthy
512
+ # - `1` unhealthy
513
+ # - `2` reserved (treated as unhealthy)
514
+ # - other values: error running probe
515
+ sig { returns(T.nilable(T::Array[String])) }
516
+ attr_reader :test_
517
+
518
+ sig { params(test_: T::Array[String]).void }
519
+ attr_writer :test_
520
+
521
+ # The time to wait before considering the check to have hung. It should be 0 or at
522
+ # least 1000000 (1 ms). 0 means inherit.
523
+ #
524
+ # If the health check command does not complete within this timeout, the check is
525
+ # considered failed and the health check process is forcibly terminated without a
526
+ # graceful shutdown.
527
+ sig { returns(T.nilable(Integer)) }
528
+ attr_reader :timeout
529
+
530
+ sig { params(timeout: Integer).void }
531
+ attr_writer :timeout
532
+
533
+ # A test to perform to check that the container is healthy. Healthcheck commands
534
+ # should be side-effect free.
535
+ sig do
536
+ params(
537
+ interval: Integer,
538
+ retries: Integer,
539
+ start_interval: Integer,
540
+ start_period: Integer,
541
+ test_: T::Array[String],
542
+ timeout: Integer
543
+ ).returns(T.attached_class)
544
+ end
545
+ def self.new(
546
+ # The time to wait between checks in nanoseconds. It should be 0 or at least
547
+ # 1000000 (1 ms). 0 means inherit.
548
+ interval: nil,
549
+ # The number of consecutive failures needed to consider a container as unhealthy.
550
+ # 0 means inherit.
551
+ retries: nil,
552
+ # The time to wait between checks in nanoseconds during the start period. It
553
+ # should be 0 or at least 1000000 (1 ms). 0 means inherit.
554
+ start_interval: nil,
555
+ # Start period for the container to initialize before starting health-retries
556
+ # countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means
557
+ # inherit.
558
+ start_period: nil,
559
+ # The test to perform. Possible values are:
560
+ #
561
+ # - `[]` inherit healthcheck from image or parent image
562
+ # - `["NONE"]` disable healthcheck
563
+ # - `["CMD", args...]` exec arguments directly
564
+ # - `["CMD-SHELL", command]` run command with system's default shell
565
+ #
566
+ # A non-zero exit code indicates a failed healthcheck:
567
+ #
568
+ # - `0` healthy
569
+ # - `1` unhealthy
570
+ # - `2` reserved (treated as unhealthy)
571
+ # - other values: error running probe
572
+ test_: nil,
573
+ # The time to wait before considering the check to have hung. It should be 0 or at
574
+ # least 1000000 (1 ms). 0 means inherit.
575
+ #
576
+ # If the health check command does not complete within this timeout, the check is
577
+ # considered failed and the health check process is forcibly terminated without a
578
+ # graceful shutdown.
579
+ timeout: nil
580
+ )
581
+ end
582
+
583
+ sig do
584
+ override.returns(
585
+ {
586
+ interval: Integer,
587
+ retries: Integer,
588
+ start_interval: Integer,
589
+ start_period: Integer,
590
+ test_: T::Array[String],
591
+ timeout: Integer
592
+ }
593
+ )
594
+ end
595
+ def to_hash
596
+ end
597
+ end
598
+ end
599
+
600
+ class Descriptor < DockerEngineRuby::Internal::Type::BaseModel
601
+ OrHash =
602
+ T.type_alias do
603
+ T.any(
604
+ DockerEngineRuby::Image::Descriptor,
605
+ DockerEngineRuby::Internal::AnyHash
606
+ )
607
+ end
608
+
609
+ # Arbitrary metadata relating to the targeted content.
610
+ sig { returns(T.nilable(T::Hash[Symbol, String])) }
611
+ attr_accessor :annotations
612
+
613
+ # ArtifactType is the IANA media type of this artifact.
614
+ sig { returns(T.nilable(String)) }
615
+ attr_accessor :artifact_type
616
+
617
+ # Data is an embedding of the targeted content. This is encoded as a base64 string
618
+ # when marshalled to JSON (automatically, by encoding/json). If present, Data can
619
+ # be used directly to avoid fetching the targeted content.
620
+ sig { returns(T.nilable(String)) }
621
+ attr_accessor :data
622
+
623
+ # The digest of the targeted content.
624
+ sig { returns(T.nilable(String)) }
625
+ attr_reader :digest
626
+
627
+ sig { params(digest: String).void }
628
+ attr_writer :digest
629
+
630
+ # The media type of the object this schema refers to.
631
+ sig { returns(T.nilable(String)) }
632
+ attr_reader :media_type
633
+
634
+ sig { params(media_type: String).void }
635
+ attr_writer :media_type
636
+
637
+ # Describes the platform which the image in the manifest runs on, as defined in
638
+ # the
639
+ # [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
640
+ sig do
641
+ returns(T.nilable(DockerEngineRuby::Image::Descriptor::Platform))
642
+ end
643
+ attr_reader :platform
644
+
645
+ sig do
646
+ params(
647
+ platform:
648
+ T.nilable(DockerEngineRuby::Image::Descriptor::Platform::OrHash)
649
+ ).void
650
+ end
651
+ attr_writer :platform
652
+
653
+ # The size in bytes of the blob.
654
+ sig { returns(T.nilable(Integer)) }
655
+ attr_reader :size
656
+
657
+ sig { params(size: Integer).void }
658
+ attr_writer :size
659
+
660
+ # List of URLs from which this object MAY be downloaded.
661
+ sig { returns(T.nilable(T::Array[String])) }
662
+ attr_accessor :urls
663
+
664
+ # A descriptor struct containing digest, media type, and size, as defined in the
665
+ # [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md).
666
+ sig do
667
+ params(
668
+ annotations: T.nilable(T::Hash[Symbol, String]),
669
+ artifact_type: T.nilable(String),
670
+ data: T.nilable(String),
671
+ digest: String,
672
+ media_type: String,
673
+ platform:
674
+ T.nilable(DockerEngineRuby::Image::Descriptor::Platform::OrHash),
675
+ size: Integer,
676
+ urls: T.nilable(T::Array[String])
677
+ ).returns(T.attached_class)
678
+ end
679
+ def self.new(
680
+ # Arbitrary metadata relating to the targeted content.
681
+ annotations: nil,
682
+ # ArtifactType is the IANA media type of this artifact.
683
+ artifact_type: nil,
684
+ # Data is an embedding of the targeted content. This is encoded as a base64 string
685
+ # when marshalled to JSON (automatically, by encoding/json). If present, Data can
686
+ # be used directly to avoid fetching the targeted content.
687
+ data: nil,
688
+ # The digest of the targeted content.
689
+ digest: nil,
690
+ # The media type of the object this schema refers to.
691
+ media_type: nil,
692
+ # Describes the platform which the image in the manifest runs on, as defined in
693
+ # the
694
+ # [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
695
+ platform: nil,
696
+ # The size in bytes of the blob.
697
+ size: nil,
698
+ # List of URLs from which this object MAY be downloaded.
699
+ urls: nil
700
+ )
701
+ end
702
+
703
+ sig do
704
+ override.returns(
705
+ {
706
+ annotations: T.nilable(T::Hash[Symbol, String]),
707
+ artifact_type: T.nilable(String),
708
+ data: T.nilable(String),
709
+ digest: String,
710
+ media_type: String,
711
+ platform:
712
+ T.nilable(DockerEngineRuby::Image::Descriptor::Platform),
713
+ size: Integer,
714
+ urls: T.nilable(T::Array[String])
715
+ }
716
+ )
717
+ end
718
+ def to_hash
719
+ end
720
+
721
+ class Platform < DockerEngineRuby::Internal::Type::BaseModel
722
+ OrHash =
723
+ T.type_alias do
724
+ T.any(
725
+ DockerEngineRuby::Image::Descriptor::Platform,
726
+ DockerEngineRuby::Internal::AnyHash
727
+ )
728
+ end
729
+
730
+ # The CPU architecture, for example `amd64` or `ppc64`.
731
+ sig { returns(T.nilable(String)) }
732
+ attr_reader :architecture
733
+
734
+ sig { params(architecture: String).void }
735
+ attr_writer :architecture
736
+
737
+ # The operating system, for example `linux` or `windows`.
738
+ sig { returns(T.nilable(String)) }
739
+ attr_reader :os
740
+
741
+ sig { params(os: String).void }
742
+ attr_writer :os
743
+
744
+ # Optional field specifying an array of strings, each listing a required OS
745
+ # feature (for example on Windows `win32k`).
746
+ sig { returns(T.nilable(T::Array[String])) }
747
+ attr_reader :os_features
748
+
749
+ sig { params(os_features: T::Array[String]).void }
750
+ attr_writer :os_features
751
+
752
+ # Optional field specifying the operating system version, for example on Windows
753
+ # `10.0.19041.1165`.
754
+ sig { returns(T.nilable(String)) }
755
+ attr_reader :os_version
756
+
757
+ sig { params(os_version: String).void }
758
+ attr_writer :os_version
759
+
760
+ # Optional field specifying a variant of the CPU, for example `v7` to specify
761
+ # ARMv7 when architecture is `arm`.
762
+ sig { returns(T.nilable(String)) }
763
+ attr_reader :variant
764
+
765
+ sig { params(variant: String).void }
766
+ attr_writer :variant
767
+
768
+ # Describes the platform which the image in the manifest runs on, as defined in
769
+ # the
770
+ # [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
771
+ sig do
772
+ params(
773
+ architecture: String,
774
+ os: String,
775
+ os_features: T::Array[String],
776
+ os_version: String,
777
+ variant: String
778
+ ).returns(T.attached_class)
779
+ end
780
+ def self.new(
781
+ # The CPU architecture, for example `amd64` or `ppc64`.
782
+ architecture: nil,
783
+ # The operating system, for example `linux` or `windows`.
784
+ os: nil,
785
+ # Optional field specifying an array of strings, each listing a required OS
786
+ # feature (for example on Windows `win32k`).
787
+ os_features: nil,
788
+ # Optional field specifying the operating system version, for example on Windows
789
+ # `10.0.19041.1165`.
790
+ os_version: nil,
791
+ # Optional field specifying a variant of the CPU, for example `v7` to specify
792
+ # ARMv7 when architecture is `arm`.
793
+ variant: nil
794
+ )
795
+ end
796
+
797
+ sig do
798
+ override.returns(
799
+ {
800
+ architecture: String,
801
+ os: String,
802
+ os_features: T::Array[String],
803
+ os_version: String,
804
+ variant: String
805
+ }
806
+ )
807
+ end
808
+ def to_hash
809
+ end
810
+ end
811
+ end
812
+
813
+ class GraphDriver < DockerEngineRuby::Internal::Type::BaseModel
814
+ OrHash =
815
+ T.type_alias do
816
+ T.any(
817
+ DockerEngineRuby::Image::GraphDriver,
818
+ DockerEngineRuby::Internal::AnyHash
819
+ )
820
+ end
821
+
822
+ # Low-level storage metadata, provided as key/value pairs.
823
+ #
824
+ # This information is driver-specific, and depends on the storage-driver in use,
825
+ # and should be used for informational purposes only.
826
+ sig { returns(T::Hash[Symbol, String]) }
827
+ attr_accessor :data
828
+
829
+ # Name of the storage driver.
830
+ sig { returns(String) }
831
+ attr_accessor :name
832
+
833
+ # Information about the storage driver used to store the container's and image's
834
+ # filesystem.
835
+ sig do
836
+ params(data: T::Hash[Symbol, String], name: String).returns(
837
+ T.attached_class
838
+ )
839
+ end
840
+ def self.new(
841
+ # Low-level storage metadata, provided as key/value pairs.
842
+ #
843
+ # This information is driver-specific, and depends on the storage-driver in use,
844
+ # and should be used for informational purposes only.
845
+ data:,
846
+ # Name of the storage driver.
847
+ name:
848
+ )
849
+ end
850
+
851
+ sig do
852
+ override.returns({ data: T::Hash[Symbol, String], name: String })
853
+ end
854
+ def to_hash
855
+ end
856
+ end
857
+
858
+ class Identity < DockerEngineRuby::Internal::Type::BaseModel
859
+ OrHash =
860
+ T.type_alias do
861
+ T.any(
862
+ DockerEngineRuby::Image::Identity,
863
+ DockerEngineRuby::Internal::AnyHash
864
+ )
865
+ end
866
+
867
+ # Build contains build reference information if image was created via build.
868
+ sig do
869
+ returns(T.nilable(T::Array[DockerEngineRuby::Image::Identity::Build]))
870
+ end
871
+ attr_reader :build
872
+
873
+ sig do
874
+ params(
875
+ build: T::Array[DockerEngineRuby::Image::Identity::Build::OrHash]
876
+ ).void
877
+ end
878
+ attr_writer :build
879
+
880
+ # Pull contains remote location information if image was created via pull. If
881
+ # image was pulled via mirror, this contains the original repository location.
882
+ # After successful push this images also contains the pushed repository location.
883
+ sig do
884
+ returns(T.nilable(T::Array[DockerEngineRuby::Image::Identity::Pull]))
885
+ end
886
+ attr_reader :pull
887
+
888
+ sig do
889
+ params(
890
+ pull: T::Array[DockerEngineRuby::Image::Identity::Pull::OrHash]
891
+ ).void
892
+ end
893
+ attr_writer :pull
894
+
895
+ # Signature contains the properties of verified signatures for the image.
896
+ sig do
897
+ returns(
898
+ T.nilable(T::Array[DockerEngineRuby::Image::Identity::Signature])
899
+ )
900
+ end
901
+ attr_reader :signature
902
+
903
+ sig do
904
+ params(
905
+ signature:
906
+ T::Array[DockerEngineRuby::Image::Identity::Signature::OrHash]
907
+ ).void
908
+ end
909
+ attr_writer :signature
910
+
911
+ # Identity holds information about the identity and origin of the image. This is
912
+ # trusted information verified by the daemon and cannot be modified by tagging an
913
+ # image to a different name.
914
+ sig do
915
+ params(
916
+ build: T::Array[DockerEngineRuby::Image::Identity::Build::OrHash],
917
+ pull: T::Array[DockerEngineRuby::Image::Identity::Pull::OrHash],
918
+ signature:
919
+ T::Array[DockerEngineRuby::Image::Identity::Signature::OrHash]
920
+ ).returns(T.attached_class)
921
+ end
922
+ def self.new(
923
+ # Build contains build reference information if image was created via build.
924
+ build: nil,
925
+ # Pull contains remote location information if image was created via pull. If
926
+ # image was pulled via mirror, this contains the original repository location.
927
+ # After successful push this images also contains the pushed repository location.
928
+ pull: nil,
929
+ # Signature contains the properties of verified signatures for the image.
930
+ signature: nil
931
+ )
932
+ end
933
+
934
+ sig do
935
+ override.returns(
936
+ {
937
+ build: T::Array[DockerEngineRuby::Image::Identity::Build],
938
+ pull: T::Array[DockerEngineRuby::Image::Identity::Pull],
939
+ signature: T::Array[DockerEngineRuby::Image::Identity::Signature]
940
+ }
941
+ )
942
+ end
943
+ def to_hash
944
+ end
945
+
946
+ class Build < DockerEngineRuby::Internal::Type::BaseModel
947
+ OrHash =
948
+ T.type_alias do
949
+ T.any(
950
+ DockerEngineRuby::Image::Identity::Build,
951
+ DockerEngineRuby::Internal::AnyHash
952
+ )
953
+ end
954
+
955
+ # CreatedAt is the time when the build ran.
956
+ sig { returns(T.nilable(Time)) }
957
+ attr_reader :created_at
958
+
959
+ sig { params(created_at: Time).void }
960
+ attr_writer :created_at
961
+
962
+ # Ref is the identifier for the build request. This reference can be used to look
963
+ # up the build details in BuildKit history API.
964
+ sig { returns(T.nilable(String)) }
965
+ attr_reader :ref
966
+
967
+ sig { params(ref: String).void }
968
+ attr_writer :ref
969
+
970
+ # BuildIdentity contains build reference information if image was created via
971
+ # build.
972
+ sig do
973
+ params(created_at: Time, ref: String).returns(T.attached_class)
974
+ end
975
+ def self.new(
976
+ # CreatedAt is the time when the build ran.
977
+ created_at: nil,
978
+ # Ref is the identifier for the build request. This reference can be used to look
979
+ # up the build details in BuildKit history API.
980
+ ref: nil
981
+ )
982
+ end
983
+
984
+ sig { override.returns({ created_at: Time, ref: String }) }
985
+ def to_hash
986
+ end
987
+ end
988
+
989
+ class Pull < DockerEngineRuby::Internal::Type::BaseModel
990
+ OrHash =
991
+ T.type_alias do
992
+ T.any(
993
+ DockerEngineRuby::Image::Identity::Pull,
994
+ DockerEngineRuby::Internal::AnyHash
995
+ )
996
+ end
997
+
998
+ # Repository is the remote repository location the image was pulled from.
999
+ sig { returns(T.nilable(String)) }
1000
+ attr_reader :repository
1001
+
1002
+ sig { params(repository: String).void }
1003
+ attr_writer :repository
1004
+
1005
+ # PullIdentity contains remote location information if image was created via pull.
1006
+ # If image was pulled via mirror, this contains the original repository location.
1007
+ sig { params(repository: String).returns(T.attached_class) }
1008
+ def self.new(
1009
+ # Repository is the remote repository location the image was pulled from.
1010
+ repository: nil
1011
+ )
1012
+ end
1013
+
1014
+ sig { override.returns({ repository: String }) }
1015
+ def to_hash
1016
+ end
1017
+ end
1018
+
1019
+ class Signature < DockerEngineRuby::Internal::Type::BaseModel
1020
+ OrHash =
1021
+ T.type_alias do
1022
+ T.any(
1023
+ DockerEngineRuby::Image::Identity::Signature,
1024
+ DockerEngineRuby::Internal::AnyHash
1025
+ )
1026
+ end
1027
+
1028
+ # DockerReference is the Docker image reference associated with the signature.
1029
+ # This is an optional field only present in older hashedrecord signatures.
1030
+ sig { returns(T.nilable(String)) }
1031
+ attr_reader :docker_reference
1032
+
1033
+ sig { params(docker_reference: String).void }
1034
+ attr_writer :docker_reference
1035
+
1036
+ # Error contains error information if signature verification failed. Other fields
1037
+ # will be empty in this case.
1038
+ sig { returns(T.nilable(String)) }
1039
+ attr_reader :error
1040
+
1041
+ sig { params(error: String).void }
1042
+ attr_writer :error
1043
+
1044
+ # KnownSignerIdentity is an identifier for a special signer identity that is known
1045
+ # to the implementation.
1046
+ sig do
1047
+ returns(
1048
+ T.nilable(
1049
+ DockerEngineRuby::Image::Identity::Signature::KnownSigner::TaggedSymbol
1050
+ )
1051
+ )
1052
+ end
1053
+ attr_reader :known_signer
1054
+
1055
+ sig do
1056
+ params(
1057
+ known_signer:
1058
+ DockerEngineRuby::Image::Identity::Signature::KnownSigner::OrSymbol
1059
+ ).void
1060
+ end
1061
+ attr_writer :known_signer
1062
+
1063
+ # Name is a textual description summarizing the type of signature.
1064
+ sig { returns(T.nilable(String)) }
1065
+ attr_reader :name
1066
+
1067
+ sig { params(name: String).void }
1068
+ attr_writer :name
1069
+
1070
+ # SignatureType is the type of signature format.
1071
+ sig do
1072
+ returns(
1073
+ T.nilable(
1074
+ DockerEngineRuby::Image::Identity::Signature::SignatureType::TaggedSymbol
1075
+ )
1076
+ )
1077
+ end
1078
+ attr_reader :signature_type
1079
+
1080
+ sig do
1081
+ params(
1082
+ signature_type:
1083
+ DockerEngineRuby::Image::Identity::Signature::SignatureType::OrSymbol
1084
+ ).void
1085
+ end
1086
+ attr_writer :signature_type
1087
+
1088
+ # SignerIdentity contains information about the signer certificate used to sign
1089
+ # the image.
1090
+ sig do
1091
+ returns(
1092
+ T.nilable(DockerEngineRuby::Image::Identity::Signature::Signer)
1093
+ )
1094
+ end
1095
+ attr_reader :signer
1096
+
1097
+ sig do
1098
+ params(
1099
+ signer:
1100
+ DockerEngineRuby::Image::Identity::Signature::Signer::OrHash
1101
+ ).void
1102
+ end
1103
+ attr_writer :signer
1104
+
1105
+ # Timestamps contains a list of verified signed timestamps for the signature.
1106
+ sig do
1107
+ returns(
1108
+ T.nilable(
1109
+ T::Array[
1110
+ DockerEngineRuby::Image::Identity::Signature::Timestamp
1111
+ ]
1112
+ )
1113
+ )
1114
+ end
1115
+ attr_reader :timestamps
1116
+
1117
+ sig do
1118
+ params(
1119
+ timestamps:
1120
+ T::Array[
1121
+ DockerEngineRuby::Image::Identity::Signature::Timestamp::OrHash
1122
+ ]
1123
+ ).void
1124
+ end
1125
+ attr_writer :timestamps
1126
+
1127
+ # Warnings contains any warnings that occurred during signature verification. For
1128
+ # example, if there was no internet connectivity and cached trust roots were used.
1129
+ # Warning does not indicate a failed verification but may point to configuration
1130
+ # issues.
1131
+ sig { returns(T.nilable(T::Array[String])) }
1132
+ attr_reader :warnings
1133
+
1134
+ sig { params(warnings: T::Array[String]).void }
1135
+ attr_writer :warnings
1136
+
1137
+ # SignatureIdentity contains the properties of verified signatures for the image.
1138
+ sig do
1139
+ params(
1140
+ docker_reference: String,
1141
+ error: String,
1142
+ known_signer:
1143
+ DockerEngineRuby::Image::Identity::Signature::KnownSigner::OrSymbol,
1144
+ name: String,
1145
+ signature_type:
1146
+ DockerEngineRuby::Image::Identity::Signature::SignatureType::OrSymbol,
1147
+ signer:
1148
+ DockerEngineRuby::Image::Identity::Signature::Signer::OrHash,
1149
+ timestamps:
1150
+ T::Array[
1151
+ DockerEngineRuby::Image::Identity::Signature::Timestamp::OrHash
1152
+ ],
1153
+ warnings: T::Array[String]
1154
+ ).returns(T.attached_class)
1155
+ end
1156
+ def self.new(
1157
+ # DockerReference is the Docker image reference associated with the signature.
1158
+ # This is an optional field only present in older hashedrecord signatures.
1159
+ docker_reference: nil,
1160
+ # Error contains error information if signature verification failed. Other fields
1161
+ # will be empty in this case.
1162
+ error: nil,
1163
+ # KnownSignerIdentity is an identifier for a special signer identity that is known
1164
+ # to the implementation.
1165
+ known_signer: nil,
1166
+ # Name is a textual description summarizing the type of signature.
1167
+ name: nil,
1168
+ # SignatureType is the type of signature format.
1169
+ signature_type: nil,
1170
+ # SignerIdentity contains information about the signer certificate used to sign
1171
+ # the image.
1172
+ signer: nil,
1173
+ # Timestamps contains a list of verified signed timestamps for the signature.
1174
+ timestamps: nil,
1175
+ # Warnings contains any warnings that occurred during signature verification. For
1176
+ # example, if there was no internet connectivity and cached trust roots were used.
1177
+ # Warning does not indicate a failed verification but may point to configuration
1178
+ # issues.
1179
+ warnings: nil
1180
+ )
1181
+ end
1182
+
1183
+ sig do
1184
+ override.returns(
1185
+ {
1186
+ docker_reference: String,
1187
+ error: String,
1188
+ known_signer:
1189
+ DockerEngineRuby::Image::Identity::Signature::KnownSigner::TaggedSymbol,
1190
+ name: String,
1191
+ signature_type:
1192
+ DockerEngineRuby::Image::Identity::Signature::SignatureType::TaggedSymbol,
1193
+ signer: DockerEngineRuby::Image::Identity::Signature::Signer,
1194
+ timestamps:
1195
+ T::Array[
1196
+ DockerEngineRuby::Image::Identity::Signature::Timestamp
1197
+ ],
1198
+ warnings: T::Array[String]
1199
+ }
1200
+ )
1201
+ end
1202
+ def to_hash
1203
+ end
1204
+
1205
+ # KnownSignerIdentity is an identifier for a special signer identity that is known
1206
+ # to the implementation.
1207
+ module KnownSigner
1208
+ extend DockerEngineRuby::Internal::Type::Enum
1209
+
1210
+ TaggedSymbol =
1211
+ T.type_alias do
1212
+ T.all(
1213
+ Symbol,
1214
+ DockerEngineRuby::Image::Identity::Signature::KnownSigner
1215
+ )
1216
+ end
1217
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1218
+
1219
+ DHI =
1220
+ T.let(
1221
+ :DHI,
1222
+ DockerEngineRuby::Image::Identity::Signature::KnownSigner::TaggedSymbol
1223
+ )
1224
+
1225
+ sig do
1226
+ override.returns(
1227
+ T::Array[
1228
+ DockerEngineRuby::Image::Identity::Signature::KnownSigner::TaggedSymbol
1229
+ ]
1230
+ )
1231
+ end
1232
+ def self.values
1233
+ end
1234
+ end
1235
+
1236
+ # SignatureType is the type of signature format.
1237
+ module SignatureType
1238
+ extend DockerEngineRuby::Internal::Type::Enum
1239
+
1240
+ TaggedSymbol =
1241
+ T.type_alias do
1242
+ T.all(
1243
+ Symbol,
1244
+ DockerEngineRuby::Image::Identity::Signature::SignatureType
1245
+ )
1246
+ end
1247
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1248
+
1249
+ BUNDLE_V0_3 =
1250
+ T.let(
1251
+ :"bundle-v0.3",
1252
+ DockerEngineRuby::Image::Identity::Signature::SignatureType::TaggedSymbol
1253
+ )
1254
+ SIMPLESIGNING_V1 =
1255
+ T.let(
1256
+ :"simplesigning-v1",
1257
+ DockerEngineRuby::Image::Identity::Signature::SignatureType::TaggedSymbol
1258
+ )
1259
+
1260
+ sig do
1261
+ override.returns(
1262
+ T::Array[
1263
+ DockerEngineRuby::Image::Identity::Signature::SignatureType::TaggedSymbol
1264
+ ]
1265
+ )
1266
+ end
1267
+ def self.values
1268
+ end
1269
+ end
1270
+
1271
+ class Signer < DockerEngineRuby::Internal::Type::BaseModel
1272
+ OrHash =
1273
+ T.type_alias do
1274
+ T.any(
1275
+ DockerEngineRuby::Image::Identity::Signature::Signer,
1276
+ DockerEngineRuby::Internal::AnyHash
1277
+ )
1278
+ end
1279
+
1280
+ # Immutable reference to the specific version of the top-level/initiating build
1281
+ # instructions.
1282
+ sig { returns(T.nilable(String)) }
1283
+ attr_reader :build_config_digest
1284
+
1285
+ sig { params(build_config_digest: String).void }
1286
+ attr_writer :build_config_digest
1287
+
1288
+ # Build Config URL to the top-level/initiating build instructions.
1289
+ sig { returns(T.nilable(String)) }
1290
+ attr_reader :build_config_uri
1291
+
1292
+ sig { params(build_config_uri: String).void }
1293
+ attr_writer :build_config_uri
1294
+
1295
+ # Immutable reference to the specific version of the build instructions that is
1296
+ # responsible for signing.
1297
+ sig { returns(T.nilable(String)) }
1298
+ attr_reader :build_signer_digest
1299
+
1300
+ sig { params(build_signer_digest: String).void }
1301
+ attr_writer :build_signer_digest
1302
+
1303
+ # Reference to specific build instructions that are responsible for signing.
1304
+ sig { returns(T.nilable(String)) }
1305
+ attr_reader :build_signer_uri
1306
+
1307
+ sig { params(build_signer_uri: String).void }
1308
+ attr_writer :build_signer_uri
1309
+
1310
+ # Event or action that initiated the build.
1311
+ sig { returns(T.nilable(String)) }
1312
+ attr_reader :build_trigger
1313
+
1314
+ sig { params(build_trigger: String).void }
1315
+ attr_writer :build_trigger
1316
+
1317
+ # CertificateIssuer is the certificate issuer.
1318
+ sig { returns(T.nilable(String)) }
1319
+ attr_reader :certificate_issuer
1320
+
1321
+ sig { params(certificate_issuer: String).void }
1322
+ attr_writer :certificate_issuer
1323
+
1324
+ # The OIDC issuer. Should match `iss` claim of ID token or, in the case of a
1325
+ # federated login like Dex it should match the issuer URL of the upstream issuer.
1326
+ # The issuer is not set the extensions are invalid and will fail to render.
1327
+ sig { returns(T.nilable(String)) }
1328
+ attr_reader :issuer
1329
+
1330
+ sig { params(issuer: String).void }
1331
+ attr_writer :issuer
1332
+
1333
+ # Run Invocation URL to uniquely identify the build execution.
1334
+ sig { returns(T.nilable(String)) }
1335
+ attr_reader :run_invocation_uri
1336
+
1337
+ sig { params(run_invocation_uri: String).void }
1338
+ attr_writer :run_invocation_uri
1339
+
1340
+ # Specifies whether the build took place in platform-hosted cloud infrastructure
1341
+ # or customer/self-hosted infrastructure.
1342
+ sig { returns(T.nilable(String)) }
1343
+ attr_reader :runner_environment
1344
+
1345
+ sig { params(runner_environment: String).void }
1346
+ attr_writer :runner_environment
1347
+
1348
+ # Immutable reference to a specific version of the source code that the build was
1349
+ # based upon.
1350
+ sig { returns(T.nilable(String)) }
1351
+ attr_reader :source_repository_digest
1352
+
1353
+ sig { params(source_repository_digest: String).void }
1354
+ attr_writer :source_repository_digest
1355
+
1356
+ # Immutable identifier for the source repository the workflow was based upon.
1357
+ sig { returns(T.nilable(String)) }
1358
+ attr_reader :source_repository_identifier
1359
+
1360
+ sig { params(source_repository_identifier: String).void }
1361
+ attr_writer :source_repository_identifier
1362
+
1363
+ # Immutable identifier for the owner of the source repository that the workflow
1364
+ # was based upon.
1365
+ sig { returns(T.nilable(String)) }
1366
+ attr_reader :source_repository_owner_identifier
1367
+
1368
+ sig { params(source_repository_owner_identifier: String).void }
1369
+ attr_writer :source_repository_owner_identifier
1370
+
1371
+ # Source repository owner URL of the owner of the source repository that the build
1372
+ # was based on.
1373
+ sig { returns(T.nilable(String)) }
1374
+ attr_reader :source_repository_owner_uri
1375
+
1376
+ sig { params(source_repository_owner_uri: String).void }
1377
+ attr_writer :source_repository_owner_uri
1378
+
1379
+ # Source Repository Ref that the build run was based upon.
1380
+ sig { returns(T.nilable(String)) }
1381
+ attr_reader :source_repository_ref
1382
+
1383
+ sig { params(source_repository_ref: String).void }
1384
+ attr_writer :source_repository_ref
1385
+
1386
+ # Source repository URL that the build was based on.
1387
+ sig { returns(T.nilable(String)) }
1388
+ attr_reader :source_repository_uri
1389
+
1390
+ sig { params(source_repository_uri: String).void }
1391
+ attr_writer :source_repository_uri
1392
+
1393
+ # Source repository visibility at the time of signing the certificate.
1394
+ sig { returns(T.nilable(String)) }
1395
+ attr_reader :source_repository_visibility_at_signing
1396
+
1397
+ sig { params(source_repository_visibility_at_signing: String).void }
1398
+ attr_writer :source_repository_visibility_at_signing
1399
+
1400
+ # SubjectAlternativeName is the certificate subject alternative name.
1401
+ sig { returns(T.nilable(String)) }
1402
+ attr_reader :subject_alternative_name
1403
+
1404
+ sig { params(subject_alternative_name: String).void }
1405
+ attr_writer :subject_alternative_name
1406
+
1407
+ # SignerIdentity contains information about the signer certificate used to sign
1408
+ # the image.
1409
+ sig do
1410
+ params(
1411
+ build_config_digest: String,
1412
+ build_config_uri: String,
1413
+ build_signer_digest: String,
1414
+ build_signer_uri: String,
1415
+ build_trigger: String,
1416
+ certificate_issuer: String,
1417
+ issuer: String,
1418
+ run_invocation_uri: String,
1419
+ runner_environment: String,
1420
+ source_repository_digest: String,
1421
+ source_repository_identifier: String,
1422
+ source_repository_owner_identifier: String,
1423
+ source_repository_owner_uri: String,
1424
+ source_repository_ref: String,
1425
+ source_repository_uri: String,
1426
+ source_repository_visibility_at_signing: String,
1427
+ subject_alternative_name: String
1428
+ ).returns(T.attached_class)
1429
+ end
1430
+ def self.new(
1431
+ # Immutable reference to the specific version of the top-level/initiating build
1432
+ # instructions.
1433
+ build_config_digest: nil,
1434
+ # Build Config URL to the top-level/initiating build instructions.
1435
+ build_config_uri: nil,
1436
+ # Immutable reference to the specific version of the build instructions that is
1437
+ # responsible for signing.
1438
+ build_signer_digest: nil,
1439
+ # Reference to specific build instructions that are responsible for signing.
1440
+ build_signer_uri: nil,
1441
+ # Event or action that initiated the build.
1442
+ build_trigger: nil,
1443
+ # CertificateIssuer is the certificate issuer.
1444
+ certificate_issuer: nil,
1445
+ # The OIDC issuer. Should match `iss` claim of ID token or, in the case of a
1446
+ # federated login like Dex it should match the issuer URL of the upstream issuer.
1447
+ # The issuer is not set the extensions are invalid and will fail to render.
1448
+ issuer: nil,
1449
+ # Run Invocation URL to uniquely identify the build execution.
1450
+ run_invocation_uri: nil,
1451
+ # Specifies whether the build took place in platform-hosted cloud infrastructure
1452
+ # or customer/self-hosted infrastructure.
1453
+ runner_environment: nil,
1454
+ # Immutable reference to a specific version of the source code that the build was
1455
+ # based upon.
1456
+ source_repository_digest: nil,
1457
+ # Immutable identifier for the source repository the workflow was based upon.
1458
+ source_repository_identifier: nil,
1459
+ # Immutable identifier for the owner of the source repository that the workflow
1460
+ # was based upon.
1461
+ source_repository_owner_identifier: nil,
1462
+ # Source repository owner URL of the owner of the source repository that the build
1463
+ # was based on.
1464
+ source_repository_owner_uri: nil,
1465
+ # Source Repository Ref that the build run was based upon.
1466
+ source_repository_ref: nil,
1467
+ # Source repository URL that the build was based on.
1468
+ source_repository_uri: nil,
1469
+ # Source repository visibility at the time of signing the certificate.
1470
+ source_repository_visibility_at_signing: nil,
1471
+ # SubjectAlternativeName is the certificate subject alternative name.
1472
+ subject_alternative_name: nil
1473
+ )
1474
+ end
1475
+
1476
+ sig do
1477
+ override.returns(
1478
+ {
1479
+ build_config_digest: String,
1480
+ build_config_uri: String,
1481
+ build_signer_digest: String,
1482
+ build_signer_uri: String,
1483
+ build_trigger: String,
1484
+ certificate_issuer: String,
1485
+ issuer: String,
1486
+ run_invocation_uri: String,
1487
+ runner_environment: String,
1488
+ source_repository_digest: String,
1489
+ source_repository_identifier: String,
1490
+ source_repository_owner_identifier: String,
1491
+ source_repository_owner_uri: String,
1492
+ source_repository_ref: String,
1493
+ source_repository_uri: String,
1494
+ source_repository_visibility_at_signing: String,
1495
+ subject_alternative_name: String
1496
+ }
1497
+ )
1498
+ end
1499
+ def to_hash
1500
+ end
1501
+ end
1502
+
1503
+ class Timestamp < DockerEngineRuby::Internal::Type::BaseModel
1504
+ OrHash =
1505
+ T.type_alias do
1506
+ T.any(
1507
+ DockerEngineRuby::Image::Identity::Signature::Timestamp,
1508
+ DockerEngineRuby::Internal::AnyHash
1509
+ )
1510
+ end
1511
+
1512
+ sig { returns(T.nilable(Time)) }
1513
+ attr_reader :timestamp
1514
+
1515
+ sig { params(timestamp: Time).void }
1516
+ attr_writer :timestamp
1517
+
1518
+ # SignatureTimestampType is the type of timestamp used in the signature.
1519
+ sig do
1520
+ returns(
1521
+ T.nilable(
1522
+ DockerEngineRuby::Image::Identity::Signature::Timestamp::Type::TaggedSymbol
1523
+ )
1524
+ )
1525
+ end
1526
+ attr_reader :type
1527
+
1528
+ sig do
1529
+ params(
1530
+ type:
1531
+ DockerEngineRuby::Image::Identity::Signature::Timestamp::Type::OrSymbol
1532
+ ).void
1533
+ end
1534
+ attr_writer :type
1535
+
1536
+ sig { returns(T.nilable(String)) }
1537
+ attr_reader :uri
1538
+
1539
+ sig { params(uri: String).void }
1540
+ attr_writer :uri
1541
+
1542
+ # SignatureTimestamp contains information about a verified signed timestamp for an
1543
+ # image signature.
1544
+ sig do
1545
+ params(
1546
+ timestamp: Time,
1547
+ type:
1548
+ DockerEngineRuby::Image::Identity::Signature::Timestamp::Type::OrSymbol,
1549
+ uri: String
1550
+ ).returns(T.attached_class)
1551
+ end
1552
+ def self.new(
1553
+ timestamp: nil,
1554
+ # SignatureTimestampType is the type of timestamp used in the signature.
1555
+ type: nil,
1556
+ uri: nil
1557
+ )
1558
+ end
1559
+
1560
+ sig do
1561
+ override.returns(
1562
+ {
1563
+ timestamp: Time,
1564
+ type:
1565
+ DockerEngineRuby::Image::Identity::Signature::Timestamp::Type::TaggedSymbol,
1566
+ uri: String
1567
+ }
1568
+ )
1569
+ end
1570
+ def to_hash
1571
+ end
1572
+
1573
+ # SignatureTimestampType is the type of timestamp used in the signature.
1574
+ module Type
1575
+ extend DockerEngineRuby::Internal::Type::Enum
1576
+
1577
+ TaggedSymbol =
1578
+ T.type_alias do
1579
+ T.all(
1580
+ Symbol,
1581
+ DockerEngineRuby::Image::Identity::Signature::Timestamp::Type
1582
+ )
1583
+ end
1584
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1585
+
1586
+ TLOG =
1587
+ T.let(
1588
+ :Tlog,
1589
+ DockerEngineRuby::Image::Identity::Signature::Timestamp::Type::TaggedSymbol
1590
+ )
1591
+ TIMESTAMP_AUTHORITY =
1592
+ T.let(
1593
+ :TimestampAuthority,
1594
+ DockerEngineRuby::Image::Identity::Signature::Timestamp::Type::TaggedSymbol
1595
+ )
1596
+
1597
+ sig do
1598
+ override.returns(
1599
+ T::Array[
1600
+ DockerEngineRuby::Image::Identity::Signature::Timestamp::Type::TaggedSymbol
1601
+ ]
1602
+ )
1603
+ end
1604
+ def self.values
1605
+ end
1606
+ end
1607
+ end
1608
+ end
1609
+ end
1610
+
1611
+ class Manifest < DockerEngineRuby::Internal::Type::BaseModel
1612
+ OrHash =
1613
+ T.type_alias do
1614
+ T.any(
1615
+ DockerEngineRuby::Image::Manifest,
1616
+ DockerEngineRuby::Internal::AnyHash
1617
+ )
1618
+ end
1619
+
1620
+ # Indicates whether all the child content (image config, layers) is fully
1621
+ # available locally.
1622
+ sig { returns(T::Boolean) }
1623
+ attr_accessor :available
1624
+
1625
+ # A descriptor struct containing digest, media type, and size, as defined in the
1626
+ # [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md).
1627
+ sig { returns(DockerEngineRuby::Image::Manifest::Descriptor) }
1628
+ attr_reader :descriptor
1629
+
1630
+ sig do
1631
+ params(
1632
+ descriptor: DockerEngineRuby::Image::Manifest::Descriptor::OrHash
1633
+ ).void
1634
+ end
1635
+ attr_writer :descriptor
1636
+
1637
+ # ID is the content-addressable ID of an image and is the same as the digest of
1638
+ # the image manifest.
1639
+ sig { returns(String) }
1640
+ attr_accessor :id
1641
+
1642
+ # The kind of the manifest.
1643
+ #
1644
+ # | kind | description |
1645
+ # | ----------- | ------------------------------------------------------------------------------------ |
1646
+ # | image | Image manifest that can be used to start a container. |
1647
+ # | attestation | Attestation manifest produced by the Buildkit builder for a specific image manifest. |
1648
+ sig { returns(DockerEngineRuby::Image::Manifest::Kind::TaggedSymbol) }
1649
+ attr_accessor :kind
1650
+
1651
+ sig { returns(DockerEngineRuby::Image::Manifest::Size) }
1652
+ attr_reader :size
1653
+
1654
+ sig do
1655
+ params(size: DockerEngineRuby::Image::Manifest::Size::OrHash).void
1656
+ end
1657
+ attr_writer :size
1658
+
1659
+ # The image data for the attestation manifest. This field is only populated when
1660
+ # Kind is "attestation".
1661
+ sig do
1662
+ returns(T.nilable(DockerEngineRuby::Image::Manifest::AttestationData))
1663
+ end
1664
+ attr_reader :attestation_data
1665
+
1666
+ sig do
1667
+ params(
1668
+ attestation_data:
1669
+ T.nilable(
1670
+ DockerEngineRuby::Image::Manifest::AttestationData::OrHash
1671
+ )
1672
+ ).void
1673
+ end
1674
+ attr_writer :attestation_data
1675
+
1676
+ # The image data for the image manifest. This field is only populated when Kind is
1677
+ # "image".
1678
+ sig { returns(T.nilable(DockerEngineRuby::Image::Manifest::ImageData)) }
1679
+ attr_reader :image_data
1680
+
1681
+ sig do
1682
+ params(
1683
+ image_data:
1684
+ T.nilable(DockerEngineRuby::Image::Manifest::ImageData::OrHash)
1685
+ ).void
1686
+ end
1687
+ attr_writer :image_data
1688
+
1689
+ # ImageManifestSummary represents a summary of an image manifest.
1690
+ sig do
1691
+ params(
1692
+ available: T::Boolean,
1693
+ descriptor: DockerEngineRuby::Image::Manifest::Descriptor::OrHash,
1694
+ id: String,
1695
+ kind: DockerEngineRuby::Image::Manifest::Kind::OrSymbol,
1696
+ size: DockerEngineRuby::Image::Manifest::Size::OrHash,
1697
+ attestation_data:
1698
+ T.nilable(
1699
+ DockerEngineRuby::Image::Manifest::AttestationData::OrHash
1700
+ ),
1701
+ image_data:
1702
+ T.nilable(DockerEngineRuby::Image::Manifest::ImageData::OrHash)
1703
+ ).returns(T.attached_class)
1704
+ end
1705
+ def self.new(
1706
+ # Indicates whether all the child content (image config, layers) is fully
1707
+ # available locally.
1708
+ available:,
1709
+ # A descriptor struct containing digest, media type, and size, as defined in the
1710
+ # [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md).
1711
+ descriptor:,
1712
+ # ID is the content-addressable ID of an image and is the same as the digest of
1713
+ # the image manifest.
1714
+ id:,
1715
+ # The kind of the manifest.
1716
+ #
1717
+ # | kind | description |
1718
+ # | ----------- | ------------------------------------------------------------------------------------ |
1719
+ # | image | Image manifest that can be used to start a container. |
1720
+ # | attestation | Attestation manifest produced by the Buildkit builder for a specific image manifest. |
1721
+ kind:,
1722
+ size:,
1723
+ # The image data for the attestation manifest. This field is only populated when
1724
+ # Kind is "attestation".
1725
+ attestation_data: nil,
1726
+ # The image data for the image manifest. This field is only populated when Kind is
1727
+ # "image".
1728
+ image_data: nil
1729
+ )
1730
+ end
1731
+
1732
+ sig do
1733
+ override.returns(
1734
+ {
1735
+ available: T::Boolean,
1736
+ descriptor: DockerEngineRuby::Image::Manifest::Descriptor,
1737
+ id: String,
1738
+ kind: DockerEngineRuby::Image::Manifest::Kind::TaggedSymbol,
1739
+ size: DockerEngineRuby::Image::Manifest::Size,
1740
+ attestation_data:
1741
+ T.nilable(DockerEngineRuby::Image::Manifest::AttestationData),
1742
+ image_data:
1743
+ T.nilable(DockerEngineRuby::Image::Manifest::ImageData)
1744
+ }
1745
+ )
1746
+ end
1747
+ def to_hash
1748
+ end
1749
+
1750
+ class Descriptor < DockerEngineRuby::Internal::Type::BaseModel
1751
+ OrHash =
1752
+ T.type_alias do
1753
+ T.any(
1754
+ DockerEngineRuby::Image::Manifest::Descriptor,
1755
+ DockerEngineRuby::Internal::AnyHash
1756
+ )
1757
+ end
1758
+
1759
+ # Arbitrary metadata relating to the targeted content.
1760
+ sig { returns(T.nilable(T::Hash[Symbol, String])) }
1761
+ attr_accessor :annotations
1762
+
1763
+ # ArtifactType is the IANA media type of this artifact.
1764
+ sig { returns(T.nilable(String)) }
1765
+ attr_accessor :artifact_type
1766
+
1767
+ # Data is an embedding of the targeted content. This is encoded as a base64 string
1768
+ # when marshalled to JSON (automatically, by encoding/json). If present, Data can
1769
+ # be used directly to avoid fetching the targeted content.
1770
+ sig { returns(T.nilable(String)) }
1771
+ attr_accessor :data
1772
+
1773
+ # The digest of the targeted content.
1774
+ sig { returns(T.nilable(String)) }
1775
+ attr_reader :digest
1776
+
1777
+ sig { params(digest: String).void }
1778
+ attr_writer :digest
1779
+
1780
+ # The media type of the object this schema refers to.
1781
+ sig { returns(T.nilable(String)) }
1782
+ attr_reader :media_type
1783
+
1784
+ sig { params(media_type: String).void }
1785
+ attr_writer :media_type
1786
+
1787
+ # Describes the platform which the image in the manifest runs on, as defined in
1788
+ # the
1789
+ # [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
1790
+ sig do
1791
+ returns(
1792
+ T.nilable(DockerEngineRuby::Image::Manifest::Descriptor::Platform)
1793
+ )
1794
+ end
1795
+ attr_reader :platform
1796
+
1797
+ sig do
1798
+ params(
1799
+ platform:
1800
+ T.nilable(
1801
+ DockerEngineRuby::Image::Manifest::Descriptor::Platform::OrHash
1802
+ )
1803
+ ).void
1804
+ end
1805
+ attr_writer :platform
1806
+
1807
+ # The size in bytes of the blob.
1808
+ sig { returns(T.nilable(Integer)) }
1809
+ attr_reader :size
1810
+
1811
+ sig { params(size: Integer).void }
1812
+ attr_writer :size
1813
+
1814
+ # List of URLs from which this object MAY be downloaded.
1815
+ sig { returns(T.nilable(T::Array[String])) }
1816
+ attr_accessor :urls
1817
+
1818
+ # A descriptor struct containing digest, media type, and size, as defined in the
1819
+ # [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md).
1820
+ sig do
1821
+ params(
1822
+ annotations: T.nilable(T::Hash[Symbol, String]),
1823
+ artifact_type: T.nilable(String),
1824
+ data: T.nilable(String),
1825
+ digest: String,
1826
+ media_type: String,
1827
+ platform:
1828
+ T.nilable(
1829
+ DockerEngineRuby::Image::Manifest::Descriptor::Platform::OrHash
1830
+ ),
1831
+ size: Integer,
1832
+ urls: T.nilable(T::Array[String])
1833
+ ).returns(T.attached_class)
1834
+ end
1835
+ def self.new(
1836
+ # Arbitrary metadata relating to the targeted content.
1837
+ annotations: nil,
1838
+ # ArtifactType is the IANA media type of this artifact.
1839
+ artifact_type: nil,
1840
+ # Data is an embedding of the targeted content. This is encoded as a base64 string
1841
+ # when marshalled to JSON (automatically, by encoding/json). If present, Data can
1842
+ # be used directly to avoid fetching the targeted content.
1843
+ data: nil,
1844
+ # The digest of the targeted content.
1845
+ digest: nil,
1846
+ # The media type of the object this schema refers to.
1847
+ media_type: nil,
1848
+ # Describes the platform which the image in the manifest runs on, as defined in
1849
+ # the
1850
+ # [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
1851
+ platform: nil,
1852
+ # The size in bytes of the blob.
1853
+ size: nil,
1854
+ # List of URLs from which this object MAY be downloaded.
1855
+ urls: nil
1856
+ )
1857
+ end
1858
+
1859
+ sig do
1860
+ override.returns(
1861
+ {
1862
+ annotations: T.nilable(T::Hash[Symbol, String]),
1863
+ artifact_type: T.nilable(String),
1864
+ data: T.nilable(String),
1865
+ digest: String,
1866
+ media_type: String,
1867
+ platform:
1868
+ T.nilable(
1869
+ DockerEngineRuby::Image::Manifest::Descriptor::Platform
1870
+ ),
1871
+ size: Integer,
1872
+ urls: T.nilable(T::Array[String])
1873
+ }
1874
+ )
1875
+ end
1876
+ def to_hash
1877
+ end
1878
+
1879
+ class Platform < DockerEngineRuby::Internal::Type::BaseModel
1880
+ OrHash =
1881
+ T.type_alias do
1882
+ T.any(
1883
+ DockerEngineRuby::Image::Manifest::Descriptor::Platform,
1884
+ DockerEngineRuby::Internal::AnyHash
1885
+ )
1886
+ end
1887
+
1888
+ # The CPU architecture, for example `amd64` or `ppc64`.
1889
+ sig { returns(T.nilable(String)) }
1890
+ attr_reader :architecture
1891
+
1892
+ sig { params(architecture: String).void }
1893
+ attr_writer :architecture
1894
+
1895
+ # The operating system, for example `linux` or `windows`.
1896
+ sig { returns(T.nilable(String)) }
1897
+ attr_reader :os
1898
+
1899
+ sig { params(os: String).void }
1900
+ attr_writer :os
1901
+
1902
+ # Optional field specifying an array of strings, each listing a required OS
1903
+ # feature (for example on Windows `win32k`).
1904
+ sig { returns(T.nilable(T::Array[String])) }
1905
+ attr_reader :os_features
1906
+
1907
+ sig { params(os_features: T::Array[String]).void }
1908
+ attr_writer :os_features
1909
+
1910
+ # Optional field specifying the operating system version, for example on Windows
1911
+ # `10.0.19041.1165`.
1912
+ sig { returns(T.nilable(String)) }
1913
+ attr_reader :os_version
1914
+
1915
+ sig { params(os_version: String).void }
1916
+ attr_writer :os_version
1917
+
1918
+ # Optional field specifying a variant of the CPU, for example `v7` to specify
1919
+ # ARMv7 when architecture is `arm`.
1920
+ sig { returns(T.nilable(String)) }
1921
+ attr_reader :variant
1922
+
1923
+ sig { params(variant: String).void }
1924
+ attr_writer :variant
1925
+
1926
+ # Describes the platform which the image in the manifest runs on, as defined in
1927
+ # the
1928
+ # [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
1929
+ sig do
1930
+ params(
1931
+ architecture: String,
1932
+ os: String,
1933
+ os_features: T::Array[String],
1934
+ os_version: String,
1935
+ variant: String
1936
+ ).returns(T.attached_class)
1937
+ end
1938
+ def self.new(
1939
+ # The CPU architecture, for example `amd64` or `ppc64`.
1940
+ architecture: nil,
1941
+ # The operating system, for example `linux` or `windows`.
1942
+ os: nil,
1943
+ # Optional field specifying an array of strings, each listing a required OS
1944
+ # feature (for example on Windows `win32k`).
1945
+ os_features: nil,
1946
+ # Optional field specifying the operating system version, for example on Windows
1947
+ # `10.0.19041.1165`.
1948
+ os_version: nil,
1949
+ # Optional field specifying a variant of the CPU, for example `v7` to specify
1950
+ # ARMv7 when architecture is `arm`.
1951
+ variant: nil
1952
+ )
1953
+ end
1954
+
1955
+ sig do
1956
+ override.returns(
1957
+ {
1958
+ architecture: String,
1959
+ os: String,
1960
+ os_features: T::Array[String],
1961
+ os_version: String,
1962
+ variant: String
1963
+ }
1964
+ )
1965
+ end
1966
+ def to_hash
1967
+ end
1968
+ end
1969
+ end
1970
+
1971
+ # The kind of the manifest.
1972
+ #
1973
+ # | kind | description |
1974
+ # | ----------- | ------------------------------------------------------------------------------------ |
1975
+ # | image | Image manifest that can be used to start a container. |
1976
+ # | attestation | Attestation manifest produced by the Buildkit builder for a specific image manifest. |
1977
+ module Kind
1978
+ extend DockerEngineRuby::Internal::Type::Enum
1979
+
1980
+ TaggedSymbol =
1981
+ T.type_alias do
1982
+ T.all(Symbol, DockerEngineRuby::Image::Manifest::Kind)
1983
+ end
1984
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1985
+
1986
+ IMAGE =
1987
+ T.let(:image, DockerEngineRuby::Image::Manifest::Kind::TaggedSymbol)
1988
+ ATTESTATION =
1989
+ T.let(
1990
+ :attestation,
1991
+ DockerEngineRuby::Image::Manifest::Kind::TaggedSymbol
1992
+ )
1993
+ UNKNOWN =
1994
+ T.let(
1995
+ :unknown,
1996
+ DockerEngineRuby::Image::Manifest::Kind::TaggedSymbol
1997
+ )
1998
+
1999
+ sig do
2000
+ override.returns(
2001
+ T::Array[DockerEngineRuby::Image::Manifest::Kind::TaggedSymbol]
2002
+ )
2003
+ end
2004
+ def self.values
2005
+ end
2006
+ end
2007
+
2008
+ class Size < DockerEngineRuby::Internal::Type::BaseModel
2009
+ OrHash =
2010
+ T.type_alias do
2011
+ T.any(
2012
+ DockerEngineRuby::Image::Manifest::Size,
2013
+ DockerEngineRuby::Internal::AnyHash
2014
+ )
2015
+ end
2016
+
2017
+ # Content is the size (in bytes) of all the locally present content in the content
2018
+ # store (e.g. image config, layers) referenced by this manifest and its children.
2019
+ # This only includes blobs in the content store.
2020
+ sig { returns(Integer) }
2021
+ attr_accessor :content
2022
+
2023
+ # Total is the total size (in bytes) of all the locally present data (both
2024
+ # distributable and non-distributable) that's related to this manifest and its
2025
+ # children. This equal to the sum of [Content] size AND all the sizes in the
2026
+ # [Size] struct present in the Kind-specific data struct. For example, for an
2027
+ # image kind (Kind == "image") this would include the size of the image content
2028
+ # and unpacked image snapshots ([Size.Content] + [ImageData.Size.Unpacked]).
2029
+ sig { returns(Integer) }
2030
+ attr_accessor :total
2031
+
2032
+ sig do
2033
+ params(content: Integer, total: Integer).returns(T.attached_class)
2034
+ end
2035
+ def self.new(
2036
+ # Content is the size (in bytes) of all the locally present content in the content
2037
+ # store (e.g. image config, layers) referenced by this manifest and its children.
2038
+ # This only includes blobs in the content store.
2039
+ content:,
2040
+ # Total is the total size (in bytes) of all the locally present data (both
2041
+ # distributable and non-distributable) that's related to this manifest and its
2042
+ # children. This equal to the sum of [Content] size AND all the sizes in the
2043
+ # [Size] struct present in the Kind-specific data struct. For example, for an
2044
+ # image kind (Kind == "image") this would include the size of the image content
2045
+ # and unpacked image snapshots ([Size.Content] + [ImageData.Size.Unpacked]).
2046
+ total:
2047
+ )
2048
+ end
2049
+
2050
+ sig { override.returns({ content: Integer, total: Integer }) }
2051
+ def to_hash
2052
+ end
2053
+ end
2054
+
2055
+ class AttestationData < DockerEngineRuby::Internal::Type::BaseModel
2056
+ OrHash =
2057
+ T.type_alias do
2058
+ T.any(
2059
+ DockerEngineRuby::Image::Manifest::AttestationData,
2060
+ DockerEngineRuby::Internal::AnyHash
2061
+ )
2062
+ end
2063
+
2064
+ # The digest of the image manifest that this attestation is for.
2065
+ sig { returns(String) }
2066
+ attr_accessor :for_
2067
+
2068
+ # The image data for the attestation manifest. This field is only populated when
2069
+ # Kind is "attestation".
2070
+ sig { params(for_: String).returns(T.attached_class) }
2071
+ def self.new(
2072
+ # The digest of the image manifest that this attestation is for.
2073
+ for_:
2074
+ )
2075
+ end
2076
+
2077
+ sig { override.returns({ for_: String }) }
2078
+ def to_hash
2079
+ end
2080
+ end
2081
+
2082
+ class ImageData < DockerEngineRuby::Internal::Type::BaseModel
2083
+ OrHash =
2084
+ T.type_alias do
2085
+ T.any(
2086
+ DockerEngineRuby::Image::Manifest::ImageData,
2087
+ DockerEngineRuby::Internal::AnyHash
2088
+ )
2089
+ end
2090
+
2091
+ # The IDs of the containers that are using this image.
2092
+ sig { returns(T::Array[String]) }
2093
+ attr_accessor :containers
2094
+
2095
+ # Describes the platform which the image in the manifest runs on, as defined in
2096
+ # the
2097
+ # [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
2098
+ sig do
2099
+ returns(
2100
+ T.nilable(DockerEngineRuby::Image::Manifest::ImageData::Platform)
2101
+ )
2102
+ end
2103
+ attr_reader :platform
2104
+
2105
+ sig do
2106
+ params(
2107
+ platform:
2108
+ T.nilable(
2109
+ DockerEngineRuby::Image::Manifest::ImageData::Platform::OrHash
2110
+ )
2111
+ ).void
2112
+ end
2113
+ attr_writer :platform
2114
+
2115
+ sig { returns(DockerEngineRuby::Image::Manifest::ImageData::Size) }
2116
+ attr_reader :size
2117
+
2118
+ sig do
2119
+ params(
2120
+ size: DockerEngineRuby::Image::Manifest::ImageData::Size::OrHash
2121
+ ).void
2122
+ end
2123
+ attr_writer :size
2124
+
2125
+ # The image data for the image manifest. This field is only populated when Kind is
2126
+ # "image".
2127
+ sig do
2128
+ params(
2129
+ containers: T::Array[String],
2130
+ platform:
2131
+ T.nilable(
2132
+ DockerEngineRuby::Image::Manifest::ImageData::Platform::OrHash
2133
+ ),
2134
+ size: DockerEngineRuby::Image::Manifest::ImageData::Size::OrHash
2135
+ ).returns(T.attached_class)
2136
+ end
2137
+ def self.new(
2138
+ # The IDs of the containers that are using this image.
2139
+ containers:,
2140
+ # Describes the platform which the image in the manifest runs on, as defined in
2141
+ # the
2142
+ # [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
2143
+ platform:,
2144
+ size:
2145
+ )
2146
+ end
2147
+
2148
+ sig do
2149
+ override.returns(
2150
+ {
2151
+ containers: T::Array[String],
2152
+ platform:
2153
+ T.nilable(
2154
+ DockerEngineRuby::Image::Manifest::ImageData::Platform
2155
+ ),
2156
+ size: DockerEngineRuby::Image::Manifest::ImageData::Size
2157
+ }
2158
+ )
2159
+ end
2160
+ def to_hash
2161
+ end
2162
+
2163
+ class Platform < DockerEngineRuby::Internal::Type::BaseModel
2164
+ OrHash =
2165
+ T.type_alias do
2166
+ T.any(
2167
+ DockerEngineRuby::Image::Manifest::ImageData::Platform,
2168
+ DockerEngineRuby::Internal::AnyHash
2169
+ )
2170
+ end
2171
+
2172
+ # The CPU architecture, for example `amd64` or `ppc64`.
2173
+ sig { returns(T.nilable(String)) }
2174
+ attr_reader :architecture
2175
+
2176
+ sig { params(architecture: String).void }
2177
+ attr_writer :architecture
2178
+
2179
+ # The operating system, for example `linux` or `windows`.
2180
+ sig { returns(T.nilable(String)) }
2181
+ attr_reader :os
2182
+
2183
+ sig { params(os: String).void }
2184
+ attr_writer :os
2185
+
2186
+ # Optional field specifying an array of strings, each listing a required OS
2187
+ # feature (for example on Windows `win32k`).
2188
+ sig { returns(T.nilable(T::Array[String])) }
2189
+ attr_reader :os_features
2190
+
2191
+ sig { params(os_features: T::Array[String]).void }
2192
+ attr_writer :os_features
2193
+
2194
+ # Optional field specifying the operating system version, for example on Windows
2195
+ # `10.0.19041.1165`.
2196
+ sig { returns(T.nilable(String)) }
2197
+ attr_reader :os_version
2198
+
2199
+ sig { params(os_version: String).void }
2200
+ attr_writer :os_version
2201
+
2202
+ # Optional field specifying a variant of the CPU, for example `v7` to specify
2203
+ # ARMv7 when architecture is `arm`.
2204
+ sig { returns(T.nilable(String)) }
2205
+ attr_reader :variant
2206
+
2207
+ sig { params(variant: String).void }
2208
+ attr_writer :variant
2209
+
2210
+ # Describes the platform which the image in the manifest runs on, as defined in
2211
+ # the
2212
+ # [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
2213
+ sig do
2214
+ params(
2215
+ architecture: String,
2216
+ os: String,
2217
+ os_features: T::Array[String],
2218
+ os_version: String,
2219
+ variant: String
2220
+ ).returns(T.attached_class)
2221
+ end
2222
+ def self.new(
2223
+ # The CPU architecture, for example `amd64` or `ppc64`.
2224
+ architecture: nil,
2225
+ # The operating system, for example `linux` or `windows`.
2226
+ os: nil,
2227
+ # Optional field specifying an array of strings, each listing a required OS
2228
+ # feature (for example on Windows `win32k`).
2229
+ os_features: nil,
2230
+ # Optional field specifying the operating system version, for example on Windows
2231
+ # `10.0.19041.1165`.
2232
+ os_version: nil,
2233
+ # Optional field specifying a variant of the CPU, for example `v7` to specify
2234
+ # ARMv7 when architecture is `arm`.
2235
+ variant: nil
2236
+ )
2237
+ end
2238
+
2239
+ sig do
2240
+ override.returns(
2241
+ {
2242
+ architecture: String,
2243
+ os: String,
2244
+ os_features: T::Array[String],
2245
+ os_version: String,
2246
+ variant: String
2247
+ }
2248
+ )
2249
+ end
2250
+ def to_hash
2251
+ end
2252
+ end
2253
+
2254
+ class Size < DockerEngineRuby::Internal::Type::BaseModel
2255
+ OrHash =
2256
+ T.type_alias do
2257
+ T.any(
2258
+ DockerEngineRuby::Image::Manifest::ImageData::Size,
2259
+ DockerEngineRuby::Internal::AnyHash
2260
+ )
2261
+ end
2262
+
2263
+ # Unpacked is the size (in bytes) of the locally unpacked (uncompressed) image
2264
+ # content that's directly usable by the containers running this image. It's
2265
+ # independent of the distributable content - e.g. the image might still have an
2266
+ # unpacked data that's still used by some container even when the
2267
+ # distributable/compressed content is already gone.
2268
+ sig { returns(Integer) }
2269
+ attr_accessor :unpacked
2270
+
2271
+ sig { params(unpacked: Integer).returns(T.attached_class) }
2272
+ def self.new(
2273
+ # Unpacked is the size (in bytes) of the locally unpacked (uncompressed) image
2274
+ # content that's directly usable by the containers running this image. It's
2275
+ # independent of the distributable content - e.g. the image might still have an
2276
+ # unpacked data that's still used by some container even when the
2277
+ # distributable/compressed content is already gone.
2278
+ unpacked:
2279
+ )
2280
+ end
2281
+
2282
+ sig { override.returns({ unpacked: Integer }) }
2283
+ def to_hash
2284
+ end
2285
+ end
2286
+ end
2287
+ end
2288
+
2289
+ class Metadata < DockerEngineRuby::Internal::Type::BaseModel
2290
+ OrHash =
2291
+ T.type_alias do
2292
+ T.any(
2293
+ DockerEngineRuby::Image::Metadata,
2294
+ DockerEngineRuby::Internal::AnyHash
2295
+ )
2296
+ end
2297
+
2298
+ # Date and time at which the image was last tagged in
2299
+ # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
2300
+ #
2301
+ # This information is only available if the image was tagged locally, and omitted
2302
+ # otherwise.
2303
+ sig { returns(T.nilable(String)) }
2304
+ attr_accessor :last_tag_time
2305
+
2306
+ # Additional metadata of the image in the local cache. This information is local
2307
+ # to the daemon, and not part of the image itself.
2308
+ sig do
2309
+ params(last_tag_time: T.nilable(String)).returns(T.attached_class)
2310
+ end
2311
+ def self.new(
2312
+ # Date and time at which the image was last tagged in
2313
+ # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
2314
+ #
2315
+ # This information is only available if the image was tagged locally, and omitted
2316
+ # otherwise.
2317
+ last_tag_time: nil
2318
+ )
2319
+ end
2320
+
2321
+ sig { override.returns({ last_tag_time: T.nilable(String) }) }
2322
+ def to_hash
2323
+ end
2324
+ end
2325
+
2326
+ class RootFs < DockerEngineRuby::Internal::Type::BaseModel
2327
+ OrHash =
2328
+ T.type_alias do
2329
+ T.any(
2330
+ DockerEngineRuby::Image::RootFs,
2331
+ DockerEngineRuby::Internal::AnyHash
2332
+ )
2333
+ end
2334
+
2335
+ sig { returns(String) }
2336
+ attr_accessor :type
2337
+
2338
+ sig { returns(T.nilable(T::Array[String])) }
2339
+ attr_reader :layers
2340
+
2341
+ sig { params(layers: T::Array[String]).void }
2342
+ attr_writer :layers
2343
+
2344
+ # Information about the image's RootFS, including the layer IDs.
2345
+ sig do
2346
+ params(type: String, layers: T::Array[String]).returns(
2347
+ T.attached_class
2348
+ )
2349
+ end
2350
+ def self.new(type:, layers: nil)
2351
+ end
2352
+
2353
+ sig { override.returns({ type: String, layers: T::Array[String] }) }
2354
+ def to_hash
2355
+ end
2356
+ end
2357
+ end
2358
+ end
2359
+ end