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,1393 @@
1
+ # frozen_string_literal: true
2
+
3
+ module DockerEngineRuby
4
+ module Models
5
+ # @see DockerEngineRuby::Resources::Images#inspect_
6
+ class Image < DockerEngineRuby::Internal::Type::BaseModel
7
+ # @!attribute architecture
8
+ # Hardware CPU architecture that the image runs on.
9
+ #
10
+ # @return [String, nil]
11
+ optional :architecture, String, api_name: :Architecture
12
+
13
+ # @!attribute author
14
+ # Name of the author that was specified when committing the image, or as specified
15
+ # through MAINTAINER (deprecated) in the Dockerfile.
16
+ #
17
+ # @return [String, nil]
18
+ optional :author, String, api_name: :Author, nil?: true
19
+
20
+ # @!attribute comment
21
+ # Optional message that was set when committing or importing the image.
22
+ #
23
+ # @return [String, nil]
24
+ optional :comment, String, api_name: :Comment, nil?: true
25
+
26
+ # @!attribute config
27
+ # Configuration of the image. These fields are used as defaults when starting a
28
+ # container from the image.
29
+ #
30
+ # @return [DockerEngineRuby::Models::Image::Config, nil]
31
+ optional :config, -> { DockerEngineRuby::Image::Config }, api_name: :Config
32
+
33
+ # @!attribute created
34
+ # Date and time at which the image was created, formatted in
35
+ # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
36
+ #
37
+ # This information is only available if present in the image, and omitted
38
+ # otherwise.
39
+ #
40
+ # @return [String, nil]
41
+ optional :created, String, api_name: :Created, nil?: true
42
+
43
+ # @!attribute descriptor
44
+ # A descriptor struct containing digest, media type, and size, as defined in the
45
+ # [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md).
46
+ #
47
+ # @return [DockerEngineRuby::Models::Image::Descriptor, nil]
48
+ optional :descriptor, -> { DockerEngineRuby::Image::Descriptor }, api_name: :Descriptor
49
+
50
+ # @!attribute graph_driver
51
+ # Information about the storage driver used to store the container's and image's
52
+ # filesystem.
53
+ #
54
+ # @return [DockerEngineRuby::Models::Image::GraphDriver, nil]
55
+ optional :graph_driver, -> { DockerEngineRuby::Image::GraphDriver }, api_name: :GraphDriver
56
+
57
+ # @!attribute id
58
+ # ID is the content-addressable ID of an image.
59
+ #
60
+ # This identifier is a content-addressable digest calculated from the image's
61
+ # configuration (which includes the digests of layers used by the image).
62
+ #
63
+ # Note that this digest differs from the `RepoDigests` below, which holds digests
64
+ # of image manifests that reference the image.
65
+ #
66
+ # @return [String, nil]
67
+ optional :id, String, api_name: :Id
68
+
69
+ # @!attribute identity
70
+ # Identity holds information about the identity and origin of the image. This is
71
+ # trusted information verified by the daemon and cannot be modified by tagging an
72
+ # image to a different name.
73
+ #
74
+ # @return [DockerEngineRuby::Models::Image::Identity, nil]
75
+ optional :identity, -> { DockerEngineRuby::Image::Identity }, api_name: :Identity
76
+
77
+ # @!attribute manifests
78
+ # Manifests is a list of image manifests available in this image. It provides a
79
+ # more detailed view of the platform-specific image manifests or other
80
+ # image-attached data like build attestations.
81
+ #
82
+ # Only available if the daemon provides a multi-platform image store and the
83
+ # `manifests` option is set in the inspect request.
84
+ #
85
+ # WARNING: This is experimental and may change at any time without any backward
86
+ # compatibility.
87
+ #
88
+ # @return [Array<DockerEngineRuby::Models::Image::Manifest>, nil]
89
+ optional :manifests,
90
+ -> { DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Image::Manifest] },
91
+ api_name: :Manifests,
92
+ nil?: true
93
+
94
+ # @!attribute metadata
95
+ # Additional metadata of the image in the local cache. This information is local
96
+ # to the daemon, and not part of the image itself.
97
+ #
98
+ # @return [DockerEngineRuby::Models::Image::Metadata, nil]
99
+ optional :metadata, -> { DockerEngineRuby::Image::Metadata }, api_name: :Metadata
100
+
101
+ # @!attribute os
102
+ # Operating System the image is built to run on.
103
+ #
104
+ # @return [String, nil]
105
+ optional :os, String, api_name: :Os
106
+
107
+ # @!attribute os_version
108
+ # Operating System version the image is built to run on (especially for Windows).
109
+ #
110
+ # @return [String, nil]
111
+ optional :os_version, String, api_name: :OsVersion, nil?: true
112
+
113
+ # @!attribute repo_digests
114
+ # List of content-addressable digests of locally available image manifests that
115
+ # the image is referenced from. Multiple manifests can refer to the same image.
116
+ #
117
+ # These digests are usually only available if the image was either pulled from a
118
+ # registry, or if the image was pushed to a registry, which is when the manifest
119
+ # is generated and its digest calculated.
120
+ #
121
+ # @return [Array<String>, nil]
122
+ optional :repo_digests, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :RepoDigests
123
+
124
+ # @!attribute repo_tags
125
+ # List of image names/tags in the local image cache that reference this image.
126
+ #
127
+ # Multiple image tags can refer to the same image, and this list may be empty if
128
+ # no tags reference the image, in which case the image is "untagged", in which
129
+ # case it can still be referenced by its ID.
130
+ #
131
+ # @return [Array<String>, nil]
132
+ optional :repo_tags, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :RepoTags
133
+
134
+ # @!attribute root_fs
135
+ # Information about the image's RootFS, including the layer IDs.
136
+ #
137
+ # @return [DockerEngineRuby::Models::Image::RootFs, nil]
138
+ optional :root_fs, -> { DockerEngineRuby::Image::RootFs }, api_name: :RootFS
139
+
140
+ # @!attribute size
141
+ # Total size of the image including all layers it is composed of.
142
+ #
143
+ # @return [Integer, nil]
144
+ optional :size, Integer, api_name: :Size
145
+
146
+ # @!attribute variant
147
+ # CPU architecture variant (presently ARM-only).
148
+ #
149
+ # @return [String, nil]
150
+ optional :variant, String, api_name: :Variant, nil?: true
151
+
152
+ # @!method initialize(architecture: nil, author: nil, comment: nil, config: nil, created: nil, descriptor: nil, graph_driver: nil, id: nil, identity: nil, manifests: nil, metadata: nil, os: nil, os_version: nil, repo_digests: nil, repo_tags: nil, root_fs: nil, size: nil, variant: nil)
153
+ # Some parameter documentations has been truncated, see
154
+ # {DockerEngineRuby::Models::Image} for more details.
155
+ #
156
+ # Information about an image in the local image cache.
157
+ #
158
+ # @param architecture [String] Hardware CPU architecture that the image runs on.
159
+ #
160
+ # @param author [String, nil] Name of the author that was specified when committing the image, or as
161
+ #
162
+ # @param comment [String, nil] Optional message that was set when committing or importing the image.
163
+ #
164
+ # @param config [DockerEngineRuby::Models::Image::Config] Configuration of the image. These fields are used as defaults
165
+ #
166
+ # @param created [String, nil] Date and time at which the image was created, formatted in
167
+ #
168
+ # @param descriptor [DockerEngineRuby::Models::Image::Descriptor] A descriptor struct containing digest, media type, and size, as defined in
169
+ #
170
+ # @param graph_driver [DockerEngineRuby::Models::Image::GraphDriver] Information about the storage driver used to store the container's and
171
+ #
172
+ # @param id [String] ID is the content-addressable ID of an image.
173
+ #
174
+ # @param identity [DockerEngineRuby::Models::Image::Identity] Identity holds information about the identity and origin of the image.
175
+ #
176
+ # @param manifests [Array<DockerEngineRuby::Models::Image::Manifest>, nil] Manifests is a list of image manifests available in this image. It
177
+ #
178
+ # @param metadata [DockerEngineRuby::Models::Image::Metadata] Additional metadata of the image in the local cache. This information
179
+ #
180
+ # @param os [String] Operating System the image is built to run on.
181
+ #
182
+ # @param os_version [String, nil] Operating System version the image is built to run on (especially
183
+ #
184
+ # @param repo_digests [Array<String>] List of content-addressable digests of locally available image manifests
185
+ #
186
+ # @param repo_tags [Array<String>] List of image names/tags in the local image cache that reference this
187
+ #
188
+ # @param root_fs [DockerEngineRuby::Models::Image::RootFs] Information about the image's RootFS, including the layer IDs.
189
+ #
190
+ # @param size [Integer] Total size of the image including all layers it is composed of.
191
+ #
192
+ # @param variant [String, nil] CPU architecture variant (presently ARM-only).
193
+
194
+ # @see DockerEngineRuby::Models::Image#config
195
+ class Config < DockerEngineRuby::Internal::Type::BaseModel
196
+ # @!attribute args_escaped
197
+ # Command is already escaped (Windows only)
198
+ #
199
+ # @return [Boolean, nil]
200
+ optional :args_escaped, DockerEngineRuby::Internal::Type::Boolean, api_name: :ArgsEscaped, nil?: true
201
+
202
+ # @!attribute cmd
203
+ # Command to run specified as a string or an array of strings.
204
+ #
205
+ # @return [Array<String>, nil]
206
+ optional :cmd, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Cmd
207
+
208
+ # @!attribute entrypoint
209
+ # The entry point for the container as a string or an array of strings.
210
+ #
211
+ # If the array consists of exactly one empty string (`[""]`) then the entry point
212
+ # is reset to system default (i.e., the entry point used by docker when there is
213
+ # no `ENTRYPOINT` instruction in the `Dockerfile`).
214
+ #
215
+ # @return [Array<String>, nil]
216
+ optional :entrypoint, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Entrypoint
217
+
218
+ # @!attribute env
219
+ # A list of environment variables to set inside the container in the form
220
+ # `["VAR=value", ...]`. A variable without `=` is removed from the environment,
221
+ # rather than to have an empty value.
222
+ #
223
+ # @return [Array<String>, nil]
224
+ optional :env, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Env
225
+
226
+ # @!attribute exposed_ports
227
+ # An object mapping ports to an empty object in the form:
228
+ #
229
+ # `{"<port>/<tcp|udp|sctp>": {}}`
230
+ #
231
+ # @return [Hash{Symbol=>Object}, nil]
232
+ optional :exposed_ports,
233
+ DockerEngineRuby::Internal::Type::HashOf[DockerEngineRuby::Internal::Type::Unknown],
234
+ api_name: :ExposedPorts,
235
+ nil?: true
236
+
237
+ # @!attribute healthcheck
238
+ # A test to perform to check that the container is healthy. Healthcheck commands
239
+ # should be side-effect free.
240
+ #
241
+ # @return [DockerEngineRuby::Models::Image::Config::Healthcheck, nil]
242
+ optional :healthcheck, -> { DockerEngineRuby::Image::Config::Healthcheck }, api_name: :Healthcheck
243
+
244
+ # @!attribute labels
245
+ # User-defined key/value metadata.
246
+ #
247
+ # @return [Hash{Symbol=>String}, nil]
248
+ optional :labels, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Labels
249
+
250
+ # @!attribute on_build
251
+ # `ONBUILD` metadata that were defined in the image's `Dockerfile`.
252
+ #
253
+ # @return [Array<String>, nil]
254
+ optional :on_build, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :OnBuild, nil?: true
255
+
256
+ # @!attribute shell
257
+ # Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.
258
+ #
259
+ # @return [Array<String>, nil]
260
+ optional :shell, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Shell, nil?: true
261
+
262
+ # @!attribute stop_signal
263
+ # Signal to stop a container as a string or unsigned integer.
264
+ #
265
+ # @return [String, nil]
266
+ optional :stop_signal, String, api_name: :StopSignal, nil?: true
267
+
268
+ # @!attribute user
269
+ # The user that commands are run as inside the container.
270
+ #
271
+ # @return [String, nil]
272
+ optional :user, String, api_name: :User
273
+
274
+ # @!attribute volumes
275
+ # An object mapping mount point paths inside the container to empty objects.
276
+ #
277
+ # @return [Hash{Symbol=>Object}, nil]
278
+ optional :volumes,
279
+ DockerEngineRuby::Internal::Type::HashOf[DockerEngineRuby::Internal::Type::Unknown],
280
+ api_name: :Volumes
281
+
282
+ # @!attribute working_dir
283
+ # The working directory for commands to run in.
284
+ #
285
+ # @return [String, nil]
286
+ optional :working_dir, String, api_name: :WorkingDir
287
+
288
+ # @!method initialize(args_escaped: nil, cmd: nil, entrypoint: nil, env: nil, exposed_ports: nil, healthcheck: nil, labels: nil, on_build: nil, shell: nil, stop_signal: nil, user: nil, volumes: nil, working_dir: nil)
289
+ # Some parameter documentations has been truncated, see
290
+ # {DockerEngineRuby::Models::Image::Config} for more details.
291
+ #
292
+ # Configuration of the image. These fields are used as defaults when starting a
293
+ # container from the image.
294
+ #
295
+ # @param args_escaped [Boolean, nil] Command is already escaped (Windows only)
296
+ #
297
+ # @param cmd [Array<String>] Command to run specified as a string or an array of strings.
298
+ #
299
+ # @param entrypoint [Array<String>] The entry point for the container as a string or an array of strings.
300
+ #
301
+ # @param env [Array<String>] A list of environment variables to set inside the container in the
302
+ #
303
+ # @param exposed_ports [Hash{Symbol=>Object}, nil] An object mapping ports to an empty object in the form:
304
+ #
305
+ # @param healthcheck [DockerEngineRuby::Models::Image::Config::Healthcheck] A test to perform to check that the container is healthy.
306
+ #
307
+ # @param labels [Hash{Symbol=>String}] User-defined key/value metadata.
308
+ #
309
+ # @param on_build [Array<String>, nil] `ONBUILD` metadata that were defined in the image's `Dockerfile`.
310
+ #
311
+ # @param shell [Array<String>, nil] Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.
312
+ #
313
+ # @param stop_signal [String, nil] Signal to stop a container as a string or unsigned integer.
314
+ #
315
+ # @param user [String] The user that commands are run as inside the container.
316
+ #
317
+ # @param volumes [Hash{Symbol=>Object}] An object mapping mount point paths inside the container to empty
318
+ #
319
+ # @param working_dir [String] The working directory for commands to run in.
320
+
321
+ # @see DockerEngineRuby::Models::Image::Config#healthcheck
322
+ class Healthcheck < DockerEngineRuby::Internal::Type::BaseModel
323
+ # @!attribute interval
324
+ # The time to wait between checks in nanoseconds. It should be 0 or at least
325
+ # 1000000 (1 ms). 0 means inherit.
326
+ #
327
+ # @return [Integer, nil]
328
+ optional :interval, Integer, api_name: :Interval
329
+
330
+ # @!attribute retries
331
+ # The number of consecutive failures needed to consider a container as unhealthy.
332
+ # 0 means inherit.
333
+ #
334
+ # @return [Integer, nil]
335
+ optional :retries, Integer, api_name: :Retries
336
+
337
+ # @!attribute start_interval
338
+ # The time to wait between checks in nanoseconds during the start period. It
339
+ # should be 0 or at least 1000000 (1 ms). 0 means inherit.
340
+ #
341
+ # @return [Integer, nil]
342
+ optional :start_interval, Integer, api_name: :StartInterval
343
+
344
+ # @!attribute start_period
345
+ # Start period for the container to initialize before starting health-retries
346
+ # countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means
347
+ # inherit.
348
+ #
349
+ # @return [Integer, nil]
350
+ optional :start_period, Integer, api_name: :StartPeriod
351
+
352
+ # @!attribute test_
353
+ # The test to perform. Possible values are:
354
+ #
355
+ # - `[]` inherit healthcheck from image or parent image
356
+ # - `["NONE"]` disable healthcheck
357
+ # - `["CMD", args...]` exec arguments directly
358
+ # - `["CMD-SHELL", command]` run command with system's default shell
359
+ #
360
+ # A non-zero exit code indicates a failed healthcheck:
361
+ #
362
+ # - `0` healthy
363
+ # - `1` unhealthy
364
+ # - `2` reserved (treated as unhealthy)
365
+ # - other values: error running probe
366
+ #
367
+ # @return [Array<String>, nil]
368
+ optional :test_, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Test
369
+
370
+ # @!attribute timeout
371
+ # The time to wait before considering the check to have hung. It should be 0 or at
372
+ # least 1000000 (1 ms). 0 means inherit.
373
+ #
374
+ # If the health check command does not complete within this timeout, the check is
375
+ # considered failed and the health check process is forcibly terminated without a
376
+ # graceful shutdown.
377
+ #
378
+ # @return [Integer, nil]
379
+ optional :timeout, Integer, api_name: :Timeout
380
+
381
+ # @!method initialize(interval: nil, retries: nil, start_interval: nil, start_period: nil, test_: nil, timeout: nil)
382
+ # Some parameter documentations has been truncated, see
383
+ # {DockerEngineRuby::Models::Image::Config::Healthcheck} for more details.
384
+ #
385
+ # A test to perform to check that the container is healthy. Healthcheck commands
386
+ # should be side-effect free.
387
+ #
388
+ # @param interval [Integer] The time to wait between checks in nanoseconds. It should be 0 or at
389
+ #
390
+ # @param retries [Integer] The number of consecutive failures needed to consider a container as
391
+ #
392
+ # @param start_interval [Integer] The time to wait between checks in nanoseconds during the start period.
393
+ #
394
+ # @param start_period [Integer] Start period for the container to initialize before starting
395
+ #
396
+ # @param test_ [Array<String>] The test to perform. Possible values are:
397
+ #
398
+ # @param timeout [Integer] The time to wait before considering the check to have hung. It should
399
+ end
400
+ end
401
+
402
+ # @see DockerEngineRuby::Models::Image#descriptor
403
+ class Descriptor < DockerEngineRuby::Internal::Type::BaseModel
404
+ # @!attribute annotations
405
+ # Arbitrary metadata relating to the targeted content.
406
+ #
407
+ # @return [Hash{Symbol=>String}, nil]
408
+ optional :annotations, DockerEngineRuby::Internal::Type::HashOf[String], nil?: true
409
+
410
+ # @!attribute artifact_type
411
+ # ArtifactType is the IANA media type of this artifact.
412
+ #
413
+ # @return [String, nil]
414
+ optional :artifact_type, String, api_name: :artifactType, nil?: true
415
+
416
+ # @!attribute data
417
+ # Data is an embedding of the targeted content. This is encoded as a base64 string
418
+ # when marshalled to JSON (automatically, by encoding/json). If present, Data can
419
+ # be used directly to avoid fetching the targeted content.
420
+ #
421
+ # @return [String, nil]
422
+ optional :data, String, nil?: true
423
+
424
+ # @!attribute digest
425
+ # The digest of the targeted content.
426
+ #
427
+ # @return [String, nil]
428
+ optional :digest, String
429
+
430
+ # @!attribute media_type
431
+ # The media type of the object this schema refers to.
432
+ #
433
+ # @return [String, nil]
434
+ optional :media_type, String, api_name: :mediaType
435
+
436
+ # @!attribute platform
437
+ # Describes the platform which the image in the manifest runs on, as defined in
438
+ # the
439
+ # [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
440
+ #
441
+ # @return [DockerEngineRuby::Models::Image::Descriptor::Platform, nil]
442
+ optional :platform, -> { DockerEngineRuby::Image::Descriptor::Platform }, nil?: true
443
+
444
+ # @!attribute size
445
+ # The size in bytes of the blob.
446
+ #
447
+ # @return [Integer, nil]
448
+ optional :size, Integer
449
+
450
+ # @!attribute urls
451
+ # List of URLs from which this object MAY be downloaded.
452
+ #
453
+ # @return [Array<String>, nil]
454
+ optional :urls, DockerEngineRuby::Internal::Type::ArrayOf[String], nil?: true
455
+
456
+ # @!method initialize(annotations: nil, artifact_type: nil, data: nil, digest: nil, media_type: nil, platform: nil, size: nil, urls: nil)
457
+ # Some parameter documentations has been truncated, see
458
+ # {DockerEngineRuby::Models::Image::Descriptor} for more details.
459
+ #
460
+ # A descriptor struct containing digest, media type, and size, as defined in the
461
+ # [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md).
462
+ #
463
+ # @param annotations [Hash{Symbol=>String}, nil] Arbitrary metadata relating to the targeted content.
464
+ #
465
+ # @param artifact_type [String, nil] ArtifactType is the IANA media type of this artifact.
466
+ #
467
+ # @param data [String, nil] Data is an embedding of the targeted content. This is encoded as a base64
468
+ #
469
+ # @param digest [String] The digest of the targeted content.
470
+ #
471
+ # @param media_type [String] The media type of the object this schema refers to.
472
+ #
473
+ # @param platform [DockerEngineRuby::Models::Image::Descriptor::Platform, nil] Describes the platform which the image in the manifest runs on, as defined
474
+ #
475
+ # @param size [Integer] The size in bytes of the blob.
476
+ #
477
+ # @param urls [Array<String>, nil] List of URLs from which this object MAY be downloaded.
478
+
479
+ # @see DockerEngineRuby::Models::Image::Descriptor#platform
480
+ class Platform < DockerEngineRuby::Internal::Type::BaseModel
481
+ # @!attribute architecture
482
+ # The CPU architecture, for example `amd64` or `ppc64`.
483
+ #
484
+ # @return [String, nil]
485
+ optional :architecture, String
486
+
487
+ # @!attribute os
488
+ # The operating system, for example `linux` or `windows`.
489
+ #
490
+ # @return [String, nil]
491
+ optional :os, String
492
+
493
+ # @!attribute os_features
494
+ # Optional field specifying an array of strings, each listing a required OS
495
+ # feature (for example on Windows `win32k`).
496
+ #
497
+ # @return [Array<String>, nil]
498
+ optional :os_features, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :"os.features"
499
+
500
+ # @!attribute os_version
501
+ # Optional field specifying the operating system version, for example on Windows
502
+ # `10.0.19041.1165`.
503
+ #
504
+ # @return [String, nil]
505
+ optional :os_version, String, api_name: :"os.version"
506
+
507
+ # @!attribute variant
508
+ # Optional field specifying a variant of the CPU, for example `v7` to specify
509
+ # ARMv7 when architecture is `arm`.
510
+ #
511
+ # @return [String, nil]
512
+ optional :variant, String
513
+
514
+ # @!method initialize(architecture: nil, os: nil, os_features: nil, os_version: nil, variant: nil)
515
+ # Some parameter documentations has been truncated, see
516
+ # {DockerEngineRuby::Models::Image::Descriptor::Platform} for more details.
517
+ #
518
+ # Describes the platform which the image in the manifest runs on, as defined in
519
+ # the
520
+ # [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
521
+ #
522
+ # @param architecture [String] The CPU architecture, for example `amd64` or `ppc64`.
523
+ #
524
+ # @param os [String] The operating system, for example `linux` or `windows`.
525
+ #
526
+ # @param os_features [Array<String>] Optional field specifying an array of strings, each listing a required
527
+ #
528
+ # @param os_version [String] Optional field specifying the operating system version, for example on
529
+ #
530
+ # @param variant [String] Optional field specifying a variant of the CPU, for example `v7` to
531
+ end
532
+ end
533
+
534
+ # @see DockerEngineRuby::Models::Image#graph_driver
535
+ class GraphDriver < DockerEngineRuby::Internal::Type::BaseModel
536
+ # @!attribute data
537
+ # Low-level storage metadata, provided as key/value pairs.
538
+ #
539
+ # This information is driver-specific, and depends on the storage-driver in use,
540
+ # and should be used for informational purposes only.
541
+ #
542
+ # @return [Hash{Symbol=>String}]
543
+ required :data, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Data
544
+
545
+ # @!attribute name
546
+ # Name of the storage driver.
547
+ #
548
+ # @return [String]
549
+ required :name, String, api_name: :Name
550
+
551
+ # @!method initialize(data:, name:)
552
+ # Some parameter documentations has been truncated, see
553
+ # {DockerEngineRuby::Models::Image::GraphDriver} for more details.
554
+ #
555
+ # Information about the storage driver used to store the container's and image's
556
+ # filesystem.
557
+ #
558
+ # @param data [Hash{Symbol=>String}] Low-level storage metadata, provided as key/value pairs.
559
+ #
560
+ # @param name [String] Name of the storage driver.
561
+ end
562
+
563
+ # @see DockerEngineRuby::Models::Image#identity
564
+ class Identity < DockerEngineRuby::Internal::Type::BaseModel
565
+ # @!attribute build
566
+ # Build contains build reference information if image was created via build.
567
+ #
568
+ # @return [Array<DockerEngineRuby::Models::Image::Identity::Build>, nil]
569
+ optional :build,
570
+ -> { DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Image::Identity::Build] },
571
+ api_name: :Build
572
+
573
+ # @!attribute pull
574
+ # Pull contains remote location information if image was created via pull. If
575
+ # image was pulled via mirror, this contains the original repository location.
576
+ # After successful push this images also contains the pushed repository location.
577
+ #
578
+ # @return [Array<DockerEngineRuby::Models::Image::Identity::Pull>, nil]
579
+ optional :pull,
580
+ -> { DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Image::Identity::Pull] },
581
+ api_name: :Pull
582
+
583
+ # @!attribute signature
584
+ # Signature contains the properties of verified signatures for the image.
585
+ #
586
+ # @return [Array<DockerEngineRuby::Models::Image::Identity::Signature>, nil]
587
+ optional :signature,
588
+ -> {
589
+ DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Image::Identity::Signature]
590
+ },
591
+ api_name: :Signature
592
+
593
+ # @!method initialize(build: nil, pull: nil, signature: nil)
594
+ # Some parameter documentations has been truncated, see
595
+ # {DockerEngineRuby::Models::Image::Identity} for more details.
596
+ #
597
+ # Identity holds information about the identity and origin of the image. This is
598
+ # trusted information verified by the daemon and cannot be modified by tagging an
599
+ # image to a different name.
600
+ #
601
+ # @param build [Array<DockerEngineRuby::Models::Image::Identity::Build>] Build contains build reference information if image was created via build.
602
+ #
603
+ # @param pull [Array<DockerEngineRuby::Models::Image::Identity::Pull>] Pull contains remote location information if image was created via pull.
604
+ #
605
+ # @param signature [Array<DockerEngineRuby::Models::Image::Identity::Signature>] Signature contains the properties of verified signatures for the image.
606
+
607
+ class Build < DockerEngineRuby::Internal::Type::BaseModel
608
+ # @!attribute created_at
609
+ # CreatedAt is the time when the build ran.
610
+ #
611
+ # @return [Time, nil]
612
+ optional :created_at, Time, api_name: :CreatedAt
613
+
614
+ # @!attribute ref
615
+ # Ref is the identifier for the build request. This reference can be used to look
616
+ # up the build details in BuildKit history API.
617
+ #
618
+ # @return [String, nil]
619
+ optional :ref, String, api_name: :Ref
620
+
621
+ # @!method initialize(created_at: nil, ref: nil)
622
+ # Some parameter documentations has been truncated, see
623
+ # {DockerEngineRuby::Models::Image::Identity::Build} for more details.
624
+ #
625
+ # BuildIdentity contains build reference information if image was created via
626
+ # build.
627
+ #
628
+ # @param created_at [Time] CreatedAt is the time when the build ran.
629
+ #
630
+ # @param ref [String] Ref is the identifier for the build request. This reference can be used to
631
+ end
632
+
633
+ class Pull < DockerEngineRuby::Internal::Type::BaseModel
634
+ # @!attribute repository
635
+ # Repository is the remote repository location the image was pulled from.
636
+ #
637
+ # @return [String, nil]
638
+ optional :repository, String, api_name: :Repository
639
+
640
+ # @!method initialize(repository: nil)
641
+ # PullIdentity contains remote location information if image was created via pull.
642
+ # If image was pulled via mirror, this contains the original repository location.
643
+ #
644
+ # @param repository [String] Repository is the remote repository location the image was pulled from.
645
+ end
646
+
647
+ class Signature < DockerEngineRuby::Internal::Type::BaseModel
648
+ # @!attribute docker_reference
649
+ # DockerReference is the Docker image reference associated with the signature.
650
+ # This is an optional field only present in older hashedrecord signatures.
651
+ #
652
+ # @return [String, nil]
653
+ optional :docker_reference, String, api_name: :DockerReference
654
+
655
+ # @!attribute error
656
+ # Error contains error information if signature verification failed. Other fields
657
+ # will be empty in this case.
658
+ #
659
+ # @return [String, nil]
660
+ optional :error, String, api_name: :Error
661
+
662
+ # @!attribute known_signer
663
+ # KnownSignerIdentity is an identifier for a special signer identity that is known
664
+ # to the implementation.
665
+ #
666
+ # @return [Symbol, DockerEngineRuby::Models::Image::Identity::Signature::KnownSigner, nil]
667
+ optional :known_signer,
668
+ enum: -> { DockerEngineRuby::Image::Identity::Signature::KnownSigner },
669
+ api_name: :KnownSigner
670
+
671
+ # @!attribute name
672
+ # Name is a textual description summarizing the type of signature.
673
+ #
674
+ # @return [String, nil]
675
+ optional :name, String, api_name: :Name
676
+
677
+ # @!attribute signature_type
678
+ # SignatureType is the type of signature format.
679
+ #
680
+ # @return [Symbol, DockerEngineRuby::Models::Image::Identity::Signature::SignatureType, nil]
681
+ optional :signature_type,
682
+ enum: -> { DockerEngineRuby::Image::Identity::Signature::SignatureType },
683
+ api_name: :SignatureType
684
+
685
+ # @!attribute signer
686
+ # SignerIdentity contains information about the signer certificate used to sign
687
+ # the image.
688
+ #
689
+ # @return [DockerEngineRuby::Models::Image::Identity::Signature::Signer, nil]
690
+ optional :signer, -> { DockerEngineRuby::Image::Identity::Signature::Signer }, api_name: :Signer
691
+
692
+ # @!attribute timestamps
693
+ # Timestamps contains a list of verified signed timestamps for the signature.
694
+ #
695
+ # @return [Array<DockerEngineRuby::Models::Image::Identity::Signature::Timestamp>, nil]
696
+ optional :timestamps,
697
+ -> {
698
+ DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Image::Identity::Signature::Timestamp]
699
+ },
700
+ api_name: :Timestamps
701
+
702
+ # @!attribute warnings
703
+ # Warnings contains any warnings that occurred during signature verification. For
704
+ # example, if there was no internet connectivity and cached trust roots were used.
705
+ # Warning does not indicate a failed verification but may point to configuration
706
+ # issues.
707
+ #
708
+ # @return [Array<String>, nil]
709
+ optional :warnings, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Warnings
710
+
711
+ # @!method initialize(docker_reference: nil, error: nil, known_signer: nil, name: nil, signature_type: nil, signer: nil, timestamps: nil, warnings: nil)
712
+ # Some parameter documentations has been truncated, see
713
+ # {DockerEngineRuby::Models::Image::Identity::Signature} for more details.
714
+ #
715
+ # SignatureIdentity contains the properties of verified signatures for the image.
716
+ #
717
+ # @param docker_reference [String] DockerReference is the Docker image reference associated with the signature.
718
+ #
719
+ # @param error [String] Error contains error information if signature verification failed.
720
+ #
721
+ # @param known_signer [Symbol, DockerEngineRuby::Models::Image::Identity::Signature::KnownSigner] KnownSignerIdentity is an identifier for a special signer identity that is known
722
+ #
723
+ # @param name [String] Name is a textual description summarizing the type of signature.
724
+ #
725
+ # @param signature_type [Symbol, DockerEngineRuby::Models::Image::Identity::Signature::SignatureType] SignatureType is the type of signature format.
726
+ #
727
+ # @param signer [DockerEngineRuby::Models::Image::Identity::Signature::Signer] SignerIdentity contains information about the signer certificate used to sign th
728
+ #
729
+ # @param timestamps [Array<DockerEngineRuby::Models::Image::Identity::Signature::Timestamp>] Timestamps contains a list of verified signed timestamps for the signature.
730
+ #
731
+ # @param warnings [Array<String>] Warnings contains any warnings that occurred during signature verification.
732
+
733
+ # KnownSignerIdentity is an identifier for a special signer identity that is known
734
+ # to the implementation.
735
+ #
736
+ # @see DockerEngineRuby::Models::Image::Identity::Signature#known_signer
737
+ module KnownSigner
738
+ extend DockerEngineRuby::Internal::Type::Enum
739
+
740
+ DHI = :DHI
741
+
742
+ # @!method self.values
743
+ # @return [Array<Symbol>]
744
+ end
745
+
746
+ # SignatureType is the type of signature format.
747
+ #
748
+ # @see DockerEngineRuby::Models::Image::Identity::Signature#signature_type
749
+ module SignatureType
750
+ extend DockerEngineRuby::Internal::Type::Enum
751
+
752
+ BUNDLE_V0_3 = :"bundle-v0.3"
753
+ SIMPLESIGNING_V1 = :"simplesigning-v1"
754
+
755
+ # @!method self.values
756
+ # @return [Array<Symbol>]
757
+ end
758
+
759
+ # @see DockerEngineRuby::Models::Image::Identity::Signature#signer
760
+ class Signer < DockerEngineRuby::Internal::Type::BaseModel
761
+ # @!attribute build_config_digest
762
+ # Immutable reference to the specific version of the top-level/initiating build
763
+ # instructions.
764
+ #
765
+ # @return [String, nil]
766
+ optional :build_config_digest, String, api_name: :BuildConfigDigest
767
+
768
+ # @!attribute build_config_uri
769
+ # Build Config URL to the top-level/initiating build instructions.
770
+ #
771
+ # @return [String, nil]
772
+ optional :build_config_uri, String, api_name: :BuildConfigURI
773
+
774
+ # @!attribute build_signer_digest
775
+ # Immutable reference to the specific version of the build instructions that is
776
+ # responsible for signing.
777
+ #
778
+ # @return [String, nil]
779
+ optional :build_signer_digest, String, api_name: :BuildSignerDigest
780
+
781
+ # @!attribute build_signer_uri
782
+ # Reference to specific build instructions that are responsible for signing.
783
+ #
784
+ # @return [String, nil]
785
+ optional :build_signer_uri, String, api_name: :BuildSignerURI
786
+
787
+ # @!attribute build_trigger
788
+ # Event or action that initiated the build.
789
+ #
790
+ # @return [String, nil]
791
+ optional :build_trigger, String, api_name: :BuildTrigger
792
+
793
+ # @!attribute certificate_issuer
794
+ # CertificateIssuer is the certificate issuer.
795
+ #
796
+ # @return [String, nil]
797
+ optional :certificate_issuer, String, api_name: :CertificateIssuer
798
+
799
+ # @!attribute issuer
800
+ # The OIDC issuer. Should match `iss` claim of ID token or, in the case of a
801
+ # federated login like Dex it should match the issuer URL of the upstream issuer.
802
+ # The issuer is not set the extensions are invalid and will fail to render.
803
+ #
804
+ # @return [String, nil]
805
+ optional :issuer, String, api_name: :Issuer
806
+
807
+ # @!attribute run_invocation_uri
808
+ # Run Invocation URL to uniquely identify the build execution.
809
+ #
810
+ # @return [String, nil]
811
+ optional :run_invocation_uri, String, api_name: :RunInvocationURI
812
+
813
+ # @!attribute runner_environment
814
+ # Specifies whether the build took place in platform-hosted cloud infrastructure
815
+ # or customer/self-hosted infrastructure.
816
+ #
817
+ # @return [String, nil]
818
+ optional :runner_environment, String, api_name: :RunnerEnvironment
819
+
820
+ # @!attribute source_repository_digest
821
+ # Immutable reference to a specific version of the source code that the build was
822
+ # based upon.
823
+ #
824
+ # @return [String, nil]
825
+ optional :source_repository_digest, String, api_name: :SourceRepositoryDigest
826
+
827
+ # @!attribute source_repository_identifier
828
+ # Immutable identifier for the source repository the workflow was based upon.
829
+ #
830
+ # @return [String, nil]
831
+ optional :source_repository_identifier, String, api_name: :SourceRepositoryIdentifier
832
+
833
+ # @!attribute source_repository_owner_identifier
834
+ # Immutable identifier for the owner of the source repository that the workflow
835
+ # was based upon.
836
+ #
837
+ # @return [String, nil]
838
+ optional :source_repository_owner_identifier, String, api_name: :SourceRepositoryOwnerIdentifier
839
+
840
+ # @!attribute source_repository_owner_uri
841
+ # Source repository owner URL of the owner of the source repository that the build
842
+ # was based on.
843
+ #
844
+ # @return [String, nil]
845
+ optional :source_repository_owner_uri, String, api_name: :SourceRepositoryOwnerURI
846
+
847
+ # @!attribute source_repository_ref
848
+ # Source Repository Ref that the build run was based upon.
849
+ #
850
+ # @return [String, nil]
851
+ optional :source_repository_ref, String, api_name: :SourceRepositoryRef
852
+
853
+ # @!attribute source_repository_uri
854
+ # Source repository URL that the build was based on.
855
+ #
856
+ # @return [String, nil]
857
+ optional :source_repository_uri, String, api_name: :SourceRepositoryURI
858
+
859
+ # @!attribute source_repository_visibility_at_signing
860
+ # Source repository visibility at the time of signing the certificate.
861
+ #
862
+ # @return [String, nil]
863
+ optional :source_repository_visibility_at_signing,
864
+ String,
865
+ api_name: :SourceRepositoryVisibilityAtSigning
866
+
867
+ # @!attribute subject_alternative_name
868
+ # SubjectAlternativeName is the certificate subject alternative name.
869
+ #
870
+ # @return [String, nil]
871
+ optional :subject_alternative_name, String, api_name: :SubjectAlternativeName
872
+
873
+ # @!method initialize(build_config_digest: nil, build_config_uri: nil, build_signer_digest: nil, build_signer_uri: nil, build_trigger: nil, certificate_issuer: nil, issuer: nil, run_invocation_uri: nil, runner_environment: nil, source_repository_digest: nil, source_repository_identifier: nil, source_repository_owner_identifier: nil, source_repository_owner_uri: nil, source_repository_ref: nil, source_repository_uri: nil, source_repository_visibility_at_signing: nil, subject_alternative_name: nil)
874
+ # Some parameter documentations has been truncated, see
875
+ # {DockerEngineRuby::Models::Image::Identity::Signature::Signer} for more details.
876
+ #
877
+ # SignerIdentity contains information about the signer certificate used to sign
878
+ # the image.
879
+ #
880
+ # @param build_config_digest [String] Immutable reference to the specific version of the top-level/initiating build in
881
+ #
882
+ # @param build_config_uri [String] Build Config URL to the top-level/initiating build instructions.
883
+ #
884
+ # @param build_signer_digest [String] Immutable reference to the specific version of the build instructions that is re
885
+ #
886
+ # @param build_signer_uri [String] Reference to specific build instructions that are responsible for signing.
887
+ #
888
+ # @param build_trigger [String] Event or action that initiated the build.
889
+ #
890
+ # @param certificate_issuer [String] CertificateIssuer is the certificate issuer.
891
+ #
892
+ # @param issuer [String] The OIDC issuer. Should match `iss` claim of ID token or, in the case of
893
+ #
894
+ # @param run_invocation_uri [String] Run Invocation URL to uniquely identify the build execution.
895
+ #
896
+ # @param runner_environment [String] Specifies whether the build took place in platform-hosted cloud infrastructure o
897
+ #
898
+ # @param source_repository_digest [String] Immutable reference to a specific version of the source code that the build was
899
+ #
900
+ # @param source_repository_identifier [String] Immutable identifier for the source repository the workflow was based upon.
901
+ #
902
+ # @param source_repository_owner_identifier [String] Immutable identifier for the owner of the source repository that the workflow wa
903
+ #
904
+ # @param source_repository_owner_uri [String] Source repository owner URL of the owner of the source repository that the build
905
+ #
906
+ # @param source_repository_ref [String] Source Repository Ref that the build run was based upon.
907
+ #
908
+ # @param source_repository_uri [String] Source repository URL that the build was based on.
909
+ #
910
+ # @param source_repository_visibility_at_signing [String] Source repository visibility at the time of signing the certificate.
911
+ #
912
+ # @param subject_alternative_name [String] SubjectAlternativeName is the certificate subject alternative name.
913
+ end
914
+
915
+ class Timestamp < DockerEngineRuby::Internal::Type::BaseModel
916
+ # @!attribute timestamp
917
+ #
918
+ # @return [Time, nil]
919
+ optional :timestamp, Time, api_name: :Timestamp
920
+
921
+ # @!attribute type
922
+ # SignatureTimestampType is the type of timestamp used in the signature.
923
+ #
924
+ # @return [Symbol, DockerEngineRuby::Models::Image::Identity::Signature::Timestamp::Type, nil]
925
+ optional :type,
926
+ enum: -> { DockerEngineRuby::Image::Identity::Signature::Timestamp::Type },
927
+ api_name: :Type
928
+
929
+ # @!attribute uri
930
+ #
931
+ # @return [String, nil]
932
+ optional :uri, String, api_name: :URI
933
+
934
+ # @!method initialize(timestamp: nil, type: nil, uri: nil)
935
+ # SignatureTimestamp contains information about a verified signed timestamp for an
936
+ # image signature.
937
+ #
938
+ # @param timestamp [Time]
939
+ #
940
+ # @param type [Symbol, DockerEngineRuby::Models::Image::Identity::Signature::Timestamp::Type] SignatureTimestampType is the type of timestamp used in the signature.
941
+ #
942
+ # @param uri [String]
943
+
944
+ # SignatureTimestampType is the type of timestamp used in the signature.
945
+ #
946
+ # @see DockerEngineRuby::Models::Image::Identity::Signature::Timestamp#type
947
+ module Type
948
+ extend DockerEngineRuby::Internal::Type::Enum
949
+
950
+ TLOG = :Tlog
951
+ TIMESTAMP_AUTHORITY = :TimestampAuthority
952
+
953
+ # @!method self.values
954
+ # @return [Array<Symbol>]
955
+ end
956
+ end
957
+ end
958
+ end
959
+
960
+ class Manifest < DockerEngineRuby::Internal::Type::BaseModel
961
+ # @!attribute available
962
+ # Indicates whether all the child content (image config, layers) is fully
963
+ # available locally.
964
+ #
965
+ # @return [Boolean]
966
+ required :available, DockerEngineRuby::Internal::Type::Boolean, api_name: :Available
967
+
968
+ # @!attribute descriptor
969
+ # A descriptor struct containing digest, media type, and size, as defined in the
970
+ # [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md).
971
+ #
972
+ # @return [DockerEngineRuby::Models::Image::Manifest::Descriptor]
973
+ required :descriptor, -> { DockerEngineRuby::Image::Manifest::Descriptor }, api_name: :Descriptor
974
+
975
+ # @!attribute id
976
+ # ID is the content-addressable ID of an image and is the same as the digest of
977
+ # the image manifest.
978
+ #
979
+ # @return [String]
980
+ required :id, String, api_name: :ID
981
+
982
+ # @!attribute kind
983
+ # The kind of the manifest.
984
+ #
985
+ # | kind | description |
986
+ # | ----------- | ------------------------------------------------------------------------------------ |
987
+ # | image | Image manifest that can be used to start a container. |
988
+ # | attestation | Attestation manifest produced by the Buildkit builder for a specific image manifest. |
989
+ #
990
+ # @return [Symbol, DockerEngineRuby::Models::Image::Manifest::Kind]
991
+ required :kind, enum: -> { DockerEngineRuby::Image::Manifest::Kind }, api_name: :Kind
992
+
993
+ # @!attribute size
994
+ #
995
+ # @return [DockerEngineRuby::Models::Image::Manifest::Size]
996
+ required :size, -> { DockerEngineRuby::Image::Manifest::Size }, api_name: :Size
997
+
998
+ # @!attribute attestation_data
999
+ # The image data for the attestation manifest. This field is only populated when
1000
+ # Kind is "attestation".
1001
+ #
1002
+ # @return [DockerEngineRuby::Models::Image::Manifest::AttestationData, nil]
1003
+ optional :attestation_data,
1004
+ -> { DockerEngineRuby::Image::Manifest::AttestationData },
1005
+ api_name: :AttestationData,
1006
+ nil?: true
1007
+
1008
+ # @!attribute image_data
1009
+ # The image data for the image manifest. This field is only populated when Kind is
1010
+ # "image".
1011
+ #
1012
+ # @return [DockerEngineRuby::Models::Image::Manifest::ImageData, nil]
1013
+ optional :image_data,
1014
+ -> { DockerEngineRuby::Image::Manifest::ImageData },
1015
+ api_name: :ImageData,
1016
+ nil?: true
1017
+
1018
+ # @!method initialize(available:, descriptor:, id:, kind:, size:, attestation_data: nil, image_data: nil)
1019
+ # Some parameter documentations has been truncated, see
1020
+ # {DockerEngineRuby::Models::Image::Manifest} for more details.
1021
+ #
1022
+ # ImageManifestSummary represents a summary of an image manifest.
1023
+ #
1024
+ # @param available [Boolean] Indicates whether all the child content (image config, layers) is fully availabl
1025
+ #
1026
+ # @param descriptor [DockerEngineRuby::Models::Image::Manifest::Descriptor] A descriptor struct containing digest, media type, and size, as defined in
1027
+ #
1028
+ # @param id [String] ID is the content-addressable ID of an image and is the same as the
1029
+ #
1030
+ # @param kind [Symbol, DockerEngineRuby::Models::Image::Manifest::Kind] The kind of the manifest.
1031
+ #
1032
+ # @param size [DockerEngineRuby::Models::Image::Manifest::Size]
1033
+ #
1034
+ # @param attestation_data [DockerEngineRuby::Models::Image::Manifest::AttestationData, nil] The image data for the attestation manifest.
1035
+ #
1036
+ # @param image_data [DockerEngineRuby::Models::Image::Manifest::ImageData, nil] The image data for the image manifest.
1037
+
1038
+ # @see DockerEngineRuby::Models::Image::Manifest#descriptor
1039
+ class Descriptor < DockerEngineRuby::Internal::Type::BaseModel
1040
+ # @!attribute annotations
1041
+ # Arbitrary metadata relating to the targeted content.
1042
+ #
1043
+ # @return [Hash{Symbol=>String}, nil]
1044
+ optional :annotations, DockerEngineRuby::Internal::Type::HashOf[String], nil?: true
1045
+
1046
+ # @!attribute artifact_type
1047
+ # ArtifactType is the IANA media type of this artifact.
1048
+ #
1049
+ # @return [String, nil]
1050
+ optional :artifact_type, String, api_name: :artifactType, nil?: true
1051
+
1052
+ # @!attribute data
1053
+ # Data is an embedding of the targeted content. This is encoded as a base64 string
1054
+ # when marshalled to JSON (automatically, by encoding/json). If present, Data can
1055
+ # be used directly to avoid fetching the targeted content.
1056
+ #
1057
+ # @return [String, nil]
1058
+ optional :data, String, nil?: true
1059
+
1060
+ # @!attribute digest
1061
+ # The digest of the targeted content.
1062
+ #
1063
+ # @return [String, nil]
1064
+ optional :digest, String
1065
+
1066
+ # @!attribute media_type
1067
+ # The media type of the object this schema refers to.
1068
+ #
1069
+ # @return [String, nil]
1070
+ optional :media_type, String, api_name: :mediaType
1071
+
1072
+ # @!attribute platform
1073
+ # Describes the platform which the image in the manifest runs on, as defined in
1074
+ # the
1075
+ # [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
1076
+ #
1077
+ # @return [DockerEngineRuby::Models::Image::Manifest::Descriptor::Platform, nil]
1078
+ optional :platform, -> { DockerEngineRuby::Image::Manifest::Descriptor::Platform }, nil?: true
1079
+
1080
+ # @!attribute size
1081
+ # The size in bytes of the blob.
1082
+ #
1083
+ # @return [Integer, nil]
1084
+ optional :size, Integer
1085
+
1086
+ # @!attribute urls
1087
+ # List of URLs from which this object MAY be downloaded.
1088
+ #
1089
+ # @return [Array<String>, nil]
1090
+ optional :urls, DockerEngineRuby::Internal::Type::ArrayOf[String], nil?: true
1091
+
1092
+ # @!method initialize(annotations: nil, artifact_type: nil, data: nil, digest: nil, media_type: nil, platform: nil, size: nil, urls: nil)
1093
+ # Some parameter documentations has been truncated, see
1094
+ # {DockerEngineRuby::Models::Image::Manifest::Descriptor} for more details.
1095
+ #
1096
+ # A descriptor struct containing digest, media type, and size, as defined in the
1097
+ # [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md).
1098
+ #
1099
+ # @param annotations [Hash{Symbol=>String}, nil] Arbitrary metadata relating to the targeted content.
1100
+ #
1101
+ # @param artifact_type [String, nil] ArtifactType is the IANA media type of this artifact.
1102
+ #
1103
+ # @param data [String, nil] Data is an embedding of the targeted content. This is encoded as a base64
1104
+ #
1105
+ # @param digest [String] The digest of the targeted content.
1106
+ #
1107
+ # @param media_type [String] The media type of the object this schema refers to.
1108
+ #
1109
+ # @param platform [DockerEngineRuby::Models::Image::Manifest::Descriptor::Platform, nil] Describes the platform which the image in the manifest runs on, as defined
1110
+ #
1111
+ # @param size [Integer] The size in bytes of the blob.
1112
+ #
1113
+ # @param urls [Array<String>, nil] List of URLs from which this object MAY be downloaded.
1114
+
1115
+ # @see DockerEngineRuby::Models::Image::Manifest::Descriptor#platform
1116
+ class Platform < DockerEngineRuby::Internal::Type::BaseModel
1117
+ # @!attribute architecture
1118
+ # The CPU architecture, for example `amd64` or `ppc64`.
1119
+ #
1120
+ # @return [String, nil]
1121
+ optional :architecture, String
1122
+
1123
+ # @!attribute os
1124
+ # The operating system, for example `linux` or `windows`.
1125
+ #
1126
+ # @return [String, nil]
1127
+ optional :os, String
1128
+
1129
+ # @!attribute os_features
1130
+ # Optional field specifying an array of strings, each listing a required OS
1131
+ # feature (for example on Windows `win32k`).
1132
+ #
1133
+ # @return [Array<String>, nil]
1134
+ optional :os_features, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :"os.features"
1135
+
1136
+ # @!attribute os_version
1137
+ # Optional field specifying the operating system version, for example on Windows
1138
+ # `10.0.19041.1165`.
1139
+ #
1140
+ # @return [String, nil]
1141
+ optional :os_version, String, api_name: :"os.version"
1142
+
1143
+ # @!attribute variant
1144
+ # Optional field specifying a variant of the CPU, for example `v7` to specify
1145
+ # ARMv7 when architecture is `arm`.
1146
+ #
1147
+ # @return [String, nil]
1148
+ optional :variant, String
1149
+
1150
+ # @!method initialize(architecture: nil, os: nil, os_features: nil, os_version: nil, variant: nil)
1151
+ # Some parameter documentations has been truncated, see
1152
+ # {DockerEngineRuby::Models::Image::Manifest::Descriptor::Platform} for more
1153
+ # details.
1154
+ #
1155
+ # Describes the platform which the image in the manifest runs on, as defined in
1156
+ # the
1157
+ # [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
1158
+ #
1159
+ # @param architecture [String] The CPU architecture, for example `amd64` or `ppc64`.
1160
+ #
1161
+ # @param os [String] The operating system, for example `linux` or `windows`.
1162
+ #
1163
+ # @param os_features [Array<String>] Optional field specifying an array of strings, each listing a required
1164
+ #
1165
+ # @param os_version [String] Optional field specifying the operating system version, for example on
1166
+ #
1167
+ # @param variant [String] Optional field specifying a variant of the CPU, for example `v7` to
1168
+ end
1169
+ end
1170
+
1171
+ # The kind of the manifest.
1172
+ #
1173
+ # | kind | description |
1174
+ # | ----------- | ------------------------------------------------------------------------------------ |
1175
+ # | image | Image manifest that can be used to start a container. |
1176
+ # | attestation | Attestation manifest produced by the Buildkit builder for a specific image manifest. |
1177
+ #
1178
+ # @see DockerEngineRuby::Models::Image::Manifest#kind
1179
+ module Kind
1180
+ extend DockerEngineRuby::Internal::Type::Enum
1181
+
1182
+ IMAGE = :image
1183
+ ATTESTATION = :attestation
1184
+ UNKNOWN = :unknown
1185
+
1186
+ # @!method self.values
1187
+ # @return [Array<Symbol>]
1188
+ end
1189
+
1190
+ # @see DockerEngineRuby::Models::Image::Manifest#size
1191
+ class Size < DockerEngineRuby::Internal::Type::BaseModel
1192
+ # @!attribute content
1193
+ # Content is the size (in bytes) of all the locally present content in the content
1194
+ # store (e.g. image config, layers) referenced by this manifest and its children.
1195
+ # This only includes blobs in the content store.
1196
+ #
1197
+ # @return [Integer]
1198
+ required :content, Integer, api_name: :Content
1199
+
1200
+ # @!attribute total
1201
+ # Total is the total size (in bytes) of all the locally present data (both
1202
+ # distributable and non-distributable) that's related to this manifest and its
1203
+ # children. This equal to the sum of [Content] size AND all the sizes in the
1204
+ # [Size] struct present in the Kind-specific data struct. For example, for an
1205
+ # image kind (Kind == "image") this would include the size of the image content
1206
+ # and unpacked image snapshots ([Size.Content] + [ImageData.Size.Unpacked]).
1207
+ #
1208
+ # @return [Integer]
1209
+ required :total, Integer, api_name: :Total
1210
+
1211
+ # @!method initialize(content:, total:)
1212
+ # Some parameter documentations has been truncated, see
1213
+ # {DockerEngineRuby::Models::Image::Manifest::Size} for more details.
1214
+ #
1215
+ # @param content [Integer] Content is the size (in bytes) of all the locally present
1216
+ #
1217
+ # @param total [Integer] Total is the total size (in bytes) of all the locally present
1218
+ end
1219
+
1220
+ # @see DockerEngineRuby::Models::Image::Manifest#attestation_data
1221
+ class AttestationData < DockerEngineRuby::Internal::Type::BaseModel
1222
+ # @!attribute for_
1223
+ # The digest of the image manifest that this attestation is for.
1224
+ #
1225
+ # @return [String]
1226
+ required :for_, String, api_name: :For
1227
+
1228
+ # @!method initialize(for_:)
1229
+ # Some parameter documentations has been truncated, see
1230
+ # {DockerEngineRuby::Models::Image::Manifest::AttestationData} for more details.
1231
+ #
1232
+ # The image data for the attestation manifest. This field is only populated when
1233
+ # Kind is "attestation".
1234
+ #
1235
+ # @param for_ [String] The digest of the image manifest that this attestation is for.
1236
+ end
1237
+
1238
+ # @see DockerEngineRuby::Models::Image::Manifest#image_data
1239
+ class ImageData < DockerEngineRuby::Internal::Type::BaseModel
1240
+ # @!attribute containers
1241
+ # The IDs of the containers that are using this image.
1242
+ #
1243
+ # @return [Array<String>]
1244
+ required :containers, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Containers
1245
+
1246
+ # @!attribute platform
1247
+ # Describes the platform which the image in the manifest runs on, as defined in
1248
+ # the
1249
+ # [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
1250
+ #
1251
+ # @return [DockerEngineRuby::Models::Image::Manifest::ImageData::Platform, nil]
1252
+ required :platform,
1253
+ -> { DockerEngineRuby::Image::Manifest::ImageData::Platform },
1254
+ api_name: :Platform,
1255
+ nil?: true
1256
+
1257
+ # @!attribute size
1258
+ #
1259
+ # @return [DockerEngineRuby::Models::Image::Manifest::ImageData::Size]
1260
+ required :size, -> { DockerEngineRuby::Image::Manifest::ImageData::Size }, api_name: :Size
1261
+
1262
+ # @!method initialize(containers:, platform:, size:)
1263
+ # Some parameter documentations has been truncated, see
1264
+ # {DockerEngineRuby::Models::Image::Manifest::ImageData} for more details.
1265
+ #
1266
+ # The image data for the image manifest. This field is only populated when Kind is
1267
+ # "image".
1268
+ #
1269
+ # @param containers [Array<String>] The IDs of the containers that are using this image.
1270
+ #
1271
+ # @param platform [DockerEngineRuby::Models::Image::Manifest::ImageData::Platform, nil] Describes the platform which the image in the manifest runs on, as defined
1272
+ #
1273
+ # @param size [DockerEngineRuby::Models::Image::Manifest::ImageData::Size]
1274
+
1275
+ # @see DockerEngineRuby::Models::Image::Manifest::ImageData#platform
1276
+ class Platform < DockerEngineRuby::Internal::Type::BaseModel
1277
+ # @!attribute architecture
1278
+ # The CPU architecture, for example `amd64` or `ppc64`.
1279
+ #
1280
+ # @return [String, nil]
1281
+ optional :architecture, String
1282
+
1283
+ # @!attribute os
1284
+ # The operating system, for example `linux` or `windows`.
1285
+ #
1286
+ # @return [String, nil]
1287
+ optional :os, String
1288
+
1289
+ # @!attribute os_features
1290
+ # Optional field specifying an array of strings, each listing a required OS
1291
+ # feature (for example on Windows `win32k`).
1292
+ #
1293
+ # @return [Array<String>, nil]
1294
+ optional :os_features, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :"os.features"
1295
+
1296
+ # @!attribute os_version
1297
+ # Optional field specifying the operating system version, for example on Windows
1298
+ # `10.0.19041.1165`.
1299
+ #
1300
+ # @return [String, nil]
1301
+ optional :os_version, String, api_name: :"os.version"
1302
+
1303
+ # @!attribute variant
1304
+ # Optional field specifying a variant of the CPU, for example `v7` to specify
1305
+ # ARMv7 when architecture is `arm`.
1306
+ #
1307
+ # @return [String, nil]
1308
+ optional :variant, String
1309
+
1310
+ # @!method initialize(architecture: nil, os: nil, os_features: nil, os_version: nil, variant: nil)
1311
+ # Some parameter documentations has been truncated, see
1312
+ # {DockerEngineRuby::Models::Image::Manifest::ImageData::Platform} for more
1313
+ # details.
1314
+ #
1315
+ # Describes the platform which the image in the manifest runs on, as defined in
1316
+ # the
1317
+ # [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
1318
+ #
1319
+ # @param architecture [String] The CPU architecture, for example `amd64` or `ppc64`.
1320
+ #
1321
+ # @param os [String] The operating system, for example `linux` or `windows`.
1322
+ #
1323
+ # @param os_features [Array<String>] Optional field specifying an array of strings, each listing a required
1324
+ #
1325
+ # @param os_version [String] Optional field specifying the operating system version, for example on
1326
+ #
1327
+ # @param variant [String] Optional field specifying a variant of the CPU, for example `v7` to
1328
+ end
1329
+
1330
+ # @see DockerEngineRuby::Models::Image::Manifest::ImageData#size
1331
+ class Size < DockerEngineRuby::Internal::Type::BaseModel
1332
+ # @!attribute unpacked
1333
+ # Unpacked is the size (in bytes) of the locally unpacked (uncompressed) image
1334
+ # content that's directly usable by the containers running this image. It's
1335
+ # independent of the distributable content - e.g. the image might still have an
1336
+ # unpacked data that's still used by some container even when the
1337
+ # distributable/compressed content is already gone.
1338
+ #
1339
+ # @return [Integer]
1340
+ required :unpacked, Integer, api_name: :Unpacked
1341
+
1342
+ # @!method initialize(unpacked:)
1343
+ # Some parameter documentations has been truncated, see
1344
+ # {DockerEngineRuby::Models::Image::Manifest::ImageData::Size} for more details.
1345
+ #
1346
+ # @param unpacked [Integer] Unpacked is the size (in bytes) of the locally unpacked
1347
+ end
1348
+ end
1349
+ end
1350
+
1351
+ # @see DockerEngineRuby::Models::Image#metadata
1352
+ class Metadata < DockerEngineRuby::Internal::Type::BaseModel
1353
+ # @!attribute last_tag_time
1354
+ # Date and time at which the image was last tagged in
1355
+ # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
1356
+ #
1357
+ # This information is only available if the image was tagged locally, and omitted
1358
+ # otherwise.
1359
+ #
1360
+ # @return [String, nil]
1361
+ optional :last_tag_time, String, api_name: :LastTagTime, nil?: true
1362
+
1363
+ # @!method initialize(last_tag_time: nil)
1364
+ # Some parameter documentations has been truncated, see
1365
+ # {DockerEngineRuby::Models::Image::Metadata} for more details.
1366
+ #
1367
+ # Additional metadata of the image in the local cache. This information is local
1368
+ # to the daemon, and not part of the image itself.
1369
+ #
1370
+ # @param last_tag_time [String, nil] Date and time at which the image was last tagged in
1371
+ end
1372
+
1373
+ # @see DockerEngineRuby::Models::Image#root_fs
1374
+ class RootFs < DockerEngineRuby::Internal::Type::BaseModel
1375
+ # @!attribute type
1376
+ #
1377
+ # @return [String]
1378
+ required :type, String, api_name: :Type
1379
+
1380
+ # @!attribute layers
1381
+ #
1382
+ # @return [Array<String>, nil]
1383
+ optional :layers, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Layers
1384
+
1385
+ # @!method initialize(type:, layers: nil)
1386
+ # Information about the image's RootFS, including the layer IDs.
1387
+ #
1388
+ # @param type [String]
1389
+ # @param layers [Array<String>]
1390
+ end
1391
+ end
1392
+ end
1393
+ end