docker-engine-api 0.2.1

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 +33 -0
  4. data/README.md +232 -0
  5. data/SECURITY.md +27 -0
  6. data/lib/docker_engine_api/client.rb +109 -0
  7. data/lib/docker_engine_api/errors.rb +228 -0
  8. data/lib/docker_engine_api/file_part.rb +58 -0
  9. data/lib/docker_engine_api/internal/transport/base_client.rb +571 -0
  10. data/lib/docker_engine_api/internal/transport/pooled_net_requester.rb +210 -0
  11. data/lib/docker_engine_api/internal/type/array_of.rb +168 -0
  12. data/lib/docker_engine_api/internal/type/base_model.rb +534 -0
  13. data/lib/docker_engine_api/internal/type/base_page.rb +55 -0
  14. data/lib/docker_engine_api/internal/type/boolean.rb +77 -0
  15. data/lib/docker_engine_api/internal/type/converter.rb +327 -0
  16. data/lib/docker_engine_api/internal/type/enum.rb +131 -0
  17. data/lib/docker_engine_api/internal/type/file_input.rb +111 -0
  18. data/lib/docker_engine_api/internal/type/hash_of.rb +188 -0
  19. data/lib/docker_engine_api/internal/type/request_parameters.rb +42 -0
  20. data/lib/docker_engine_api/internal/type/union.rb +245 -0
  21. data/lib/docker_engine_api/internal/type/unknown.rb +81 -0
  22. data/lib/docker_engine_api/internal/util.rb +920 -0
  23. data/lib/docker_engine_api/internal.rb +20 -0
  24. data/lib/docker_engine_api/models/auth_login_params.rb +32 -0
  25. data/lib/docker_engine_api/models/auth_response.rb +27 -0
  26. data/lib/docker_engine_api/models/config.rb +307 -0
  27. data/lib/docker_engine_api/models/config_create_params.rb +24 -0
  28. data/lib/docker_engine_api/models/config_create_response.rb +19 -0
  29. data/lib/docker_engine_api/models/config_delete_params.rb +14 -0
  30. data/lib/docker_engine_api/models/config_inspect_params.rb +14 -0
  31. data/lib/docker_engine_api/models/config_list_params.rb +33 -0
  32. data/lib/docker_engine_api/models/config_list_response.rb +8 -0
  33. data/lib/docker_engine_api/models/config_update_params.rb +26 -0
  34. data/lib/docker_engine_api/models/connect_request.rb +198 -0
  35. data/lib/docker_engine_api/models/container.rb +2515 -0
  36. data/lib/docker_engine_api/models/container_archive_params.rb +22 -0
  37. data/lib/docker_engine_api/models/container_attach_params.rb +73 -0
  38. data/lib/docker_engine_api/models/container_changes_params.rb +14 -0
  39. data/lib/docker_engine_api/models/container_changes_response.rb +9 -0
  40. data/lib/docker_engine_api/models/container_create_params.rb +1720 -0
  41. data/lib/docker_engine_api/models/container_delete_params.rb +38 -0
  42. data/lib/docker_engine_api/models/container_exec_params.rb +111 -0
  43. data/lib/docker_engine_api/models/container_exec_response.rb +19 -0
  44. data/lib/docker_engine_api/models/container_export_params.rb +14 -0
  45. data/lib/docker_engine_api/models/container_inspect_params.rb +22 -0
  46. data/lib/docker_engine_api/models/container_kill_params.rb +25 -0
  47. data/lib/docker_engine_api/models/container_list_params.rb +70 -0
  48. data/lib/docker_engine_api/models/container_list_response.rb +8 -0
  49. data/lib/docker_engine_api/models/container_logs_params.rb +74 -0
  50. data/lib/docker_engine_api/models/container_pause_params.rb +14 -0
  51. data/lib/docker_engine_api/models/container_prune_params.rb +35 -0
  52. data/lib/docker_engine_api/models/container_prune_response.rb +27 -0
  53. data/lib/docker_engine_api/models/container_rename_params.rb +22 -0
  54. data/lib/docker_engine_api/models/container_resize_params.rb +30 -0
  55. data/lib/docker_engine_api/models/container_restart_params.rb +33 -0
  56. data/lib/docker_engine_api/models/container_start_params.rb +27 -0
  57. data/lib/docker_engine_api/models/container_stats_params.rb +35 -0
  58. data/lib/docker_engine_api/models/container_stop_params.rb +33 -0
  59. data/lib/docker_engine_api/models/container_top_params.rb +22 -0
  60. data/lib/docker_engine_api/models/container_unpause_params.rb +14 -0
  61. data/lib/docker_engine_api/models/container_update_params.rb +606 -0
  62. data/lib/docker_engine_api/models/container_wait_params.rb +41 -0
  63. data/lib/docker_engine_api/models/create_request.rb +348 -0
  64. data/lib/docker_engine_api/models/create_response.rb +27 -0
  65. data/lib/docker_engine_api/models/delete_item.rb +24 -0
  66. data/lib/docker_engine_api/models/disconnect_request.rb +27 -0
  67. data/lib/docker_engine_api/models/distribution_inspect_params.rb +14 -0
  68. data/lib/docker_engine_api/models/error.rb +18 -0
  69. data/lib/docker_engine_api/models/exec_inspect_params.rb +14 -0
  70. data/lib/docker_engine_api/models/exec_inspect_response.rb +87 -0
  71. data/lib/docker_engine_api/models/exec_resize_params.rb +30 -0
  72. data/lib/docker_engine_api/models/exec_start_params.rb +41 -0
  73. data/lib/docker_engine_api/models/filesystem_change.rb +55 -0
  74. data/lib/docker_engine_api/models/history_item.rb +47 -0
  75. data/lib/docker_engine_api/models/image.rb +1395 -0
  76. data/lib/docker_engine_api/models/image_build_params.rb +283 -0
  77. data/lib/docker_engine_api/models/image_build_prune_params.rb +71 -0
  78. data/lib/docker_engine_api/models/image_build_prune_response.rb +24 -0
  79. data/lib/docker_engine_api/models/image_commit_params.rb +70 -0
  80. data/lib/docker_engine_api/models/image_commit_response.rb +19 -0
  81. data/lib/docker_engine_api/models/image_delete_params.rb +43 -0
  82. data/lib/docker_engine_api/models/image_delete_response.rb +8 -0
  83. data/lib/docker_engine_api/models/image_get_all_params.rb +37 -0
  84. data/lib/docker_engine_api/models/image_get_params.rb +29 -0
  85. data/lib/docker_engine_api/models/image_history_params.rb +34 -0
  86. data/lib/docker_engine_api/models/image_history_response.rb +8 -0
  87. data/lib/docker_engine_api/models/image_inspect_params.rb +22 -0
  88. data/lib/docker_engine_api/models/image_list_params.rb +68 -0
  89. data/lib/docker_engine_api/models/image_list_response.rb +8 -0
  90. data/lib/docker_engine_api/models/image_load_params.rb +44 -0
  91. data/lib/docker_engine_api/models/image_prune_params.rb +35 -0
  92. data/lib/docker_engine_api/models/image_prune_response.rb +27 -0
  93. data/lib/docker_engine_api/models/image_pull_params.rb +115 -0
  94. data/lib/docker_engine_api/models/image_push_params.rb +49 -0
  95. data/lib/docker_engine_api/models/image_search_params.rb +45 -0
  96. data/lib/docker_engine_api/models/image_search_response.rb +55 -0
  97. data/lib/docker_engine_api/models/image_tag_params.rb +30 -0
  98. data/lib/docker_engine_api/models/info.rb +1488 -0
  99. data/lib/docker_engine_api/models/inspect.rb +221 -0
  100. data/lib/docker_engine_api/models/inspect_response.rb +39 -0
  101. data/lib/docker_engine_api/models/list_response.rb +32 -0
  102. data/lib/docker_engine_api/models/network.rb +253 -0
  103. data/lib/docker_engine_api/models/network_connect_params.rb +14 -0
  104. data/lib/docker_engine_api/models/network_create_params.rb +210 -0
  105. data/lib/docker_engine_api/models/network_delete_params.rb +14 -0
  106. data/lib/docker_engine_api/models/network_disconnect_params.rb +14 -0
  107. data/lib/docker_engine_api/models/network_inspect_params.rb +30 -0
  108. data/lib/docker_engine_api/models/network_inspect_response.rb +131 -0
  109. data/lib/docker_engine_api/models/network_list_params.rb +40 -0
  110. data/lib/docker_engine_api/models/network_list_response.rb +8 -0
  111. data/lib/docker_engine_api/models/network_prune_params.rb +35 -0
  112. data/lib/docker_engine_api/models/network_prune_response.rb +17 -0
  113. data/lib/docker_engine_api/models/node.rb +459 -0
  114. data/lib/docker_engine_api/models/node_delete_params.rb +22 -0
  115. data/lib/docker_engine_api/models/node_inspect_params.rb +14 -0
  116. data/lib/docker_engine_api/models/node_list_params.rb +34 -0
  117. data/lib/docker_engine_api/models/node_list_response.rb +8 -0
  118. data/lib/docker_engine_api/models/node_update_params.rb +26 -0
  119. data/lib/docker_engine_api/models/plugin.rb +532 -0
  120. data/lib/docker_engine_api/models/plugin_create_params.rb +33 -0
  121. data/lib/docker_engine_api/models/plugin_delete_params.rb +26 -0
  122. data/lib/docker_engine_api/models/plugin_disable_params.rb +25 -0
  123. data/lib/docker_engine_api/models/plugin_enable_params.rb +22 -0
  124. data/lib/docker_engine_api/models/plugin_inspect_params.rb +14 -0
  125. data/lib/docker_engine_api/models/plugin_list_params.rb +31 -0
  126. data/lib/docker_engine_api/models/plugin_list_response.rb +8 -0
  127. data/lib/docker_engine_api/models/plugin_privileges_params.rb +26 -0
  128. data/lib/docker_engine_api/models/plugin_privileges_response.rb +8 -0
  129. data/lib/docker_engine_api/models/plugin_pull_params.rb +51 -0
  130. data/lib/docker_engine_api/models/plugin_push_params.rb +14 -0
  131. data/lib/docker_engine_api/models/plugin_set_params.rb +20 -0
  132. data/lib/docker_engine_api/models/plugin_upgrade_params.rb +41 -0
  133. data/lib/docker_engine_api/models/privilege.rb +29 -0
  134. data/lib/docker_engine_api/models/secret.rb +77 -0
  135. data/lib/docker_engine_api/models/secret_create_params.rb +24 -0
  136. data/lib/docker_engine_api/models/secret_create_response.rb +19 -0
  137. data/lib/docker_engine_api/models/secret_delete_params.rb +14 -0
  138. data/lib/docker_engine_api/models/secret_inspect_params.rb +14 -0
  139. data/lib/docker_engine_api/models/secret_list_params.rb +33 -0
  140. data/lib/docker_engine_api/models/secret_list_response.rb +8 -0
  141. data/lib/docker_engine_api/models/secret_update_params.rb +26 -0
  142. data/lib/docker_engine_api/models/service.rb +524 -0
  143. data/lib/docker_engine_api/models/service_create_params.rb +34 -0
  144. data/lib/docker_engine_api/models/service_delete_params.rb +14 -0
  145. data/lib/docker_engine_api/models/service_inspect_params.rb +22 -0
  146. data/lib/docker_engine_api/models/service_list_params.rb +41 -0
  147. data/lib/docker_engine_api/models/service_list_response.rb +8 -0
  148. data/lib/docker_engine_api/models/service_logs_params.rb +74 -0
  149. data/lib/docker_engine_api/models/service_update_params.rb +78 -0
  150. data/lib/docker_engine_api/models/spec.rb +510 -0
  151. data/lib/docker_engine_api/models/stats_response.rb +950 -0
  152. data/lib/docker_engine_api/models/summary.rb +767 -0
  153. data/lib/docker_engine_api/models/swarm.rb +198 -0
  154. data/lib/docker_engine_api/models/swarm_init_params.rb +101 -0
  155. data/lib/docker_engine_api/models/swarm_init_response.rb +7 -0
  156. data/lib/docker_engine_api/models/swarm_inspect_params.rb +14 -0
  157. data/lib/docker_engine_api/models/swarm_join_params.rb +70 -0
  158. data/lib/docker_engine_api/models/swarm_leave_params.rb +26 -0
  159. data/lib/docker_engine_api/models/swarm_unlock_key_params.rb +14 -0
  160. data/lib/docker_engine_api/models/swarm_unlock_key_response.rb +17 -0
  161. data/lib/docker_engine_api/models/swarm_unlock_params.rb +22 -0
  162. data/lib/docker_engine_api/models/swarm_update_params.rb +50 -0
  163. data/lib/docker_engine_api/models/system_data_usage_params.rb +46 -0
  164. data/lib/docker_engine_api/models/system_data_usage_response.rb +260 -0
  165. data/lib/docker_engine_api/models/system_events_params.rb +58 -0
  166. data/lib/docker_engine_api/models/system_events_response.rb +126 -0
  167. data/lib/docker_engine_api/models/system_info_params.rb +14 -0
  168. data/lib/docker_engine_api/models/system_ping_params.rb +14 -0
  169. data/lib/docker_engine_api/models/system_ping_response.rb +7 -0
  170. data/lib/docker_engine_api/models/system_version_params.rb +14 -0
  171. data/lib/docker_engine_api/models/task.rb +471 -0
  172. data/lib/docker_engine_api/models/task_inspect_params.rb +14 -0
  173. data/lib/docker_engine_api/models/task_list_params.rb +35 -0
  174. data/lib/docker_engine_api/models/task_list_response.rb +8 -0
  175. data/lib/docker_engine_api/models/task_logs_params.rb +74 -0
  176. data/lib/docker_engine_api/models/top_response.rb +33 -0
  177. data/lib/docker_engine_api/models/update_response.rb +19 -0
  178. data/lib/docker_engine_api/models/version.rb +164 -0
  179. data/lib/docker_engine_api/models/volume.rb +651 -0
  180. data/lib/docker_engine_api/models/volume_create_params.rb +14 -0
  181. data/lib/docker_engine_api/models/volume_delete_params.rb +22 -0
  182. data/lib/docker_engine_api/models/volume_inspect_params.rb +14 -0
  183. data/lib/docker_engine_api/models/volume_list_params.rb +34 -0
  184. data/lib/docker_engine_api/models/volume_prune_params.rb +33 -0
  185. data/lib/docker_engine_api/models/volume_prune_response.rb +25 -0
  186. data/lib/docker_engine_api/models/volume_update_params.rb +325 -0
  187. data/lib/docker_engine_api/models/wait_response.rb +41 -0
  188. data/lib/docker_engine_api/models.rb +312 -0
  189. data/lib/docker_engine_api/request_options.rb +78 -0
  190. data/lib/docker_engine_api/resources/auth.rb +38 -0
  191. data/lib/docker_engine_api/resources/configs.rb +130 -0
  192. data/lib/docker_engine_api/resources/containers.rb +854 -0
  193. data/lib/docker_engine_api/resources/distribution.rb +34 -0
  194. data/lib/docker_engine_api/resources/exec.rb +91 -0
  195. data/lib/docker_engine_api/resources/images.rb +676 -0
  196. data/lib/docker_engine_api/resources/networks.rb +218 -0
  197. data/lib/docker_engine_api/resources/nodes.rb +113 -0
  198. data/lib/docker_engine_api/resources/plugins.rb +317 -0
  199. data/lib/docker_engine_api/resources/secrets.rb +130 -0
  200. data/lib/docker_engine_api/resources/services.rb +195 -0
  201. data/lib/docker_engine_api/resources/swarm.rb +183 -0
  202. data/lib/docker_engine_api/resources/system.rb +155 -0
  203. data/lib/docker_engine_api/resources/tasks.rb +103 -0
  204. data/lib/docker_engine_api/resources/volumes.rb +161 -0
  205. data/lib/docker_engine_api/version.rb +5 -0
  206. data/lib/docker_engine_api.rb +234 -0
  207. data/manifest.yaml +17 -0
  208. data/rbi/docker_engine_api/client.rbi +80 -0
  209. data/rbi/docker_engine_api/errors.rbi +205 -0
  210. data/rbi/docker_engine_api/file_part.rbi +37 -0
  211. data/rbi/docker_engine_api/internal/transport/base_client.rbi +304 -0
  212. data/rbi/docker_engine_api/internal/transport/pooled_net_requester.rbi +84 -0
  213. data/rbi/docker_engine_api/internal/type/array_of.rbi +108 -0
  214. data/rbi/docker_engine_api/internal/type/base_model.rbi +314 -0
  215. data/rbi/docker_engine_api/internal/type/base_page.rbi +43 -0
  216. data/rbi/docker_engine_api/internal/type/boolean.rbi +58 -0
  217. data/rbi/docker_engine_api/internal/type/converter.rbi +225 -0
  218. data/rbi/docker_engine_api/internal/type/enum.rbi +82 -0
  219. data/rbi/docker_engine_api/internal/type/file_input.rbi +59 -0
  220. data/rbi/docker_engine_api/internal/type/hash_of.rbi +108 -0
  221. data/rbi/docker_engine_api/internal/type/request_parameters.rbi +31 -0
  222. data/rbi/docker_engine_api/internal/type/union.rbi +134 -0
  223. data/rbi/docker_engine_api/internal/type/unknown.rbi +58 -0
  224. data/rbi/docker_engine_api/internal/util.rbi +487 -0
  225. data/rbi/docker_engine_api/internal.rbi +18 -0
  226. data/rbi/docker_engine_api/models/auth_login_params.rbi +65 -0
  227. data/rbi/docker_engine_api/models/auth_response.rbi +42 -0
  228. data/rbi/docker_engine_api/models/config.rbi +442 -0
  229. data/rbi/docker_engine_api/models/config_create_params.rbi +64 -0
  230. data/rbi/docker_engine_api/models/config_create_response.rbi +31 -0
  231. data/rbi/docker_engine_api/models/config_delete_params.rbi +32 -0
  232. data/rbi/docker_engine_api/models/config_inspect_params.rbi +32 -0
  233. data/rbi/docker_engine_api/models/config_list_params.rbi +62 -0
  234. data/rbi/docker_engine_api/models/config_list_response.rbi +11 -0
  235. data/rbi/docker_engine_api/models/config_update_params.rbi +45 -0
  236. data/rbi/docker_engine_api/models/connect_request.rbi +343 -0
  237. data/rbi/docker_engine_api/models/container.rbi +4645 -0
  238. data/rbi/docker_engine_api/models/container_archive_params.rbi +43 -0
  239. data/rbi/docker_engine_api/models/container_attach_params.rbi +120 -0
  240. data/rbi/docker_engine_api/models/container_changes_params.rbi +32 -0
  241. data/rbi/docker_engine_api/models/container_changes_response.rbi +13 -0
  242. data/rbi/docker_engine_api/models/container_create_params.rbi +3301 -0
  243. data/rbi/docker_engine_api/models/container_delete_params.rbi +71 -0
  244. data/rbi/docker_engine_api/models/container_exec_params.rbi +162 -0
  245. data/rbi/docker_engine_api/models/container_exec_response.rbi +31 -0
  246. data/rbi/docker_engine_api/models/container_export_params.rbi +32 -0
  247. data/rbi/docker_engine_api/models/container_inspect_params.rbi +46 -0
  248. data/rbi/docker_engine_api/models/container_kill_params.rbi +46 -0
  249. data/rbi/docker_engine_api/models/container_list_params.rbi +124 -0
  250. data/rbi/docker_engine_api/models/container_list_response.rbi +11 -0
  251. data/rbi/docker_engine_api/models/container_logs_params.rbi +117 -0
  252. data/rbi/docker_engine_api/models/container_pause_params.rbi +32 -0
  253. data/rbi/docker_engine_api/models/container_prune_params.rbi +66 -0
  254. data/rbi/docker_engine_api/models/container_prune_response.rbi +51 -0
  255. data/rbi/docker_engine_api/models/container_rename_params.rbi +43 -0
  256. data/rbi/docker_engine_api/models/container_resize_params.rbi +54 -0
  257. data/rbi/docker_engine_api/models/container_restart_params.rbi +60 -0
  258. data/rbi/docker_engine_api/models/container_start_params.rbi +53 -0
  259. data/rbi/docker_engine_api/models/container_stats_params.rbi +64 -0
  260. data/rbi/docker_engine_api/models/container_stop_params.rbi +60 -0
  261. data/rbi/docker_engine_api/models/container_top_params.rbi +46 -0
  262. data/rbi/docker_engine_api/models/container_unpause_params.rbi +32 -0
  263. data/rbi/docker_engine_api/models/container_update_params.rbi +1121 -0
  264. data/rbi/docker_engine_api/models/container_wait_params.rbi +101 -0
  265. data/rbi/docker_engine_api/models/create_request.rbi +708 -0
  266. data/rbi/docker_engine_api/models/create_response.rbi +39 -0
  267. data/rbi/docker_engine_api/models/delete_item.rbi +41 -0
  268. data/rbi/docker_engine_api/models/disconnect_request.rbi +43 -0
  269. data/rbi/docker_engine_api/models/distribution_inspect_params.rbi +32 -0
  270. data/rbi/docker_engine_api/models/error.rbi +28 -0
  271. data/rbi/docker_engine_api/models/exec_inspect_params.rbi +32 -0
  272. data/rbi/docker_engine_api/models/exec_inspect_response.rbi +135 -0
  273. data/rbi/docker_engine_api/models/exec_resize_params.rbi +54 -0
  274. data/rbi/docker_engine_api/models/exec_start_params.rbi +68 -0
  275. data/rbi/docker_engine_api/models/filesystem_change.rbi +93 -0
  276. data/rbi/docker_engine_api/models/history_item.rbi +62 -0
  277. data/rbi/docker_engine_api/models/image.rbi +2353 -0
  278. data/rbi/docker_engine_api/models/image_build_params.rbi +434 -0
  279. data/rbi/docker_engine_api/models/image_build_prune_params.rbi +121 -0
  280. data/rbi/docker_engine_api/models/image_build_prune_response.rbi +49 -0
  281. data/rbi/docker_engine_api/models/image_commit_params.rbi +115 -0
  282. data/rbi/docker_engine_api/models/image_commit_response.rbi +31 -0
  283. data/rbi/docker_engine_api/models/image_delete_params.rbi +75 -0
  284. data/rbi/docker_engine_api/models/image_delete_response.rbi +11 -0
  285. data/rbi/docker_engine_api/models/image_get_all_params.rbi +68 -0
  286. data/rbi/docker_engine_api/models/image_get_params.rbi +57 -0
  287. data/rbi/docker_engine_api/models/image_history_params.rbi +64 -0
  288. data/rbi/docker_engine_api/models/image_history_response.rbi +11 -0
  289. data/rbi/docker_engine_api/models/image_inspect_params.rbi +49 -0
  290. data/rbi/docker_engine_api/models/image_list_params.rbi +115 -0
  291. data/rbi/docker_engine_api/models/image_list_response.rbi +11 -0
  292. data/rbi/docker_engine_api/models/image_load_params.rbi +74 -0
  293. data/rbi/docker_engine_api/models/image_prune_params.rbi +66 -0
  294. data/rbi/docker_engine_api/models/image_prune_response.rbi +58 -0
  295. data/rbi/docker_engine_api/models/image_pull_params.rbi +189 -0
  296. data/rbi/docker_engine_api/models/image_push_params.rbi +84 -0
  297. data/rbi/docker_engine_api/models/image_search_params.rbi +76 -0
  298. data/rbi/docker_engine_api/models/image_search_response.rbi +95 -0
  299. data/rbi/docker_engine_api/models/image_tag_params.rbi +60 -0
  300. data/rbi/docker_engine_api/models/info.rbi +2564 -0
  301. data/rbi/docker_engine_api/models/inspect.rbi +359 -0
  302. data/rbi/docker_engine_api/models/inspect_response.rbi +77 -0
  303. data/rbi/docker_engine_api/models/list_response.rbi +55 -0
  304. data/rbi/docker_engine_api/models/network.rbi +427 -0
  305. data/rbi/docker_engine_api/models/network_connect_params.rbi +32 -0
  306. data/rbi/docker_engine_api/models/network_create_params.rbi +373 -0
  307. data/rbi/docker_engine_api/models/network_delete_params.rbi +32 -0
  308. data/rbi/docker_engine_api/models/network_disconnect_params.rbi +32 -0
  309. data/rbi/docker_engine_api/models/network_inspect_params.rbi +60 -0
  310. data/rbi/docker_engine_api/models/network_inspect_response.rbi +336 -0
  311. data/rbi/docker_engine_api/models/network_list_params.rbi +76 -0
  312. data/rbi/docker_engine_api/models/network_list_response.rbi +11 -0
  313. data/rbi/docker_engine_api/models/network_prune_params.rbi +66 -0
  314. data/rbi/docker_engine_api/models/network_prune_response.rbi +35 -0
  315. data/rbi/docker_engine_api/models/node.rbi +909 -0
  316. data/rbi/docker_engine_api/models/node_delete_params.rbi +49 -0
  317. data/rbi/docker_engine_api/models/node_inspect_params.rbi +32 -0
  318. data/rbi/docker_engine_api/models/node_list_params.rbi +64 -0
  319. data/rbi/docker_engine_api/models/node_list_response.rbi +11 -0
  320. data/rbi/docker_engine_api/models/node_update_params.rbi +45 -0
  321. data/rbi/docker_engine_api/models/plugin.rbi +835 -0
  322. data/rbi/docker_engine_api/models/plugin_create_params.rbi +54 -0
  323. data/rbi/docker_engine_api/models/plugin_delete_params.rbi +51 -0
  324. data/rbi/docker_engine_api/models/plugin_disable_params.rbi +49 -0
  325. data/rbi/docker_engine_api/models/plugin_enable_params.rbi +46 -0
  326. data/rbi/docker_engine_api/models/plugin_inspect_params.rbi +32 -0
  327. data/rbi/docker_engine_api/models/plugin_list_params.rbi +58 -0
  328. data/rbi/docker_engine_api/models/plugin_list_response.rbi +11 -0
  329. data/rbi/docker_engine_api/models/plugin_privileges_params.rbi +45 -0
  330. data/rbi/docker_engine_api/models/plugin_privileges_response.rbi +11 -0
  331. data/rbi/docker_engine_api/models/plugin_pull_params.rbi +83 -0
  332. data/rbi/docker_engine_api/models/plugin_push_params.rbi +32 -0
  333. data/rbi/docker_engine_api/models/plugin_set_params.rbi +44 -0
  334. data/rbi/docker_engine_api/models/plugin_upgrade_params.rbi +68 -0
  335. data/rbi/docker_engine_api/models/privilege.rbi +49 -0
  336. data/rbi/docker_engine_api/models/secret.rbi +125 -0
  337. data/rbi/docker_engine_api/models/secret_create_params.rbi +64 -0
  338. data/rbi/docker_engine_api/models/secret_create_response.rbi +31 -0
  339. data/rbi/docker_engine_api/models/secret_delete_params.rbi +32 -0
  340. data/rbi/docker_engine_api/models/secret_inspect_params.rbi +32 -0
  341. data/rbi/docker_engine_api/models/secret_list_params.rbi +62 -0
  342. data/rbi/docker_engine_api/models/secret_list_response.rbi +11 -0
  343. data/rbi/docker_engine_api/models/secret_update_params.rbi +45 -0
  344. data/rbi/docker_engine_api/models/service.rbi +1093 -0
  345. data/rbi/docker_engine_api/models/service_create_params.rbi +79 -0
  346. data/rbi/docker_engine_api/models/service_delete_params.rbi +32 -0
  347. data/rbi/docker_engine_api/models/service_inspect_params.rbi +49 -0
  348. data/rbi/docker_engine_api/models/service_list_params.rbi +76 -0
  349. data/rbi/docker_engine_api/models/service_list_response.rbi +11 -0
  350. data/rbi/docker_engine_api/models/service_logs_params.rbi +117 -0
  351. data/rbi/docker_engine_api/models/service_update_params.rbi +168 -0
  352. data/rbi/docker_engine_api/models/spec.rbi +1030 -0
  353. data/rbi/docker_engine_api/models/stats_response.rbi +1772 -0
  354. data/rbi/docker_engine_api/models/summary.rbi +1332 -0
  355. data/rbi/docker_engine_api/models/swarm.rbi +315 -0
  356. data/rbi/docker_engine_api/models/swarm_init_params.rbi +162 -0
  357. data/rbi/docker_engine_api/models/swarm_init_response.rbi +7 -0
  358. data/rbi/docker_engine_api/models/swarm_inspect_params.rbi +32 -0
  359. data/rbi/docker_engine_api/models/swarm_join_params.rbi +119 -0
  360. data/rbi/docker_engine_api/models/swarm_leave_params.rbi +51 -0
  361. data/rbi/docker_engine_api/models/swarm_unlock_key_params.rbi +32 -0
  362. data/rbi/docker_engine_api/models/swarm_unlock_key_response.rbi +33 -0
  363. data/rbi/docker_engine_api/models/swarm_unlock_params.rbi +49 -0
  364. data/rbi/docker_engine_api/models/swarm_update_params.rbi +81 -0
  365. data/rbi/docker_engine_api/models/system_data_usage_params.rbi +111 -0
  366. data/rbi/docker_engine_api/models/system_data_usage_response.rbi +460 -0
  367. data/rbi/docker_engine_api/models/system_events_params.rbi +105 -0
  368. data/rbi/docker_engine_api/models/system_events_response.rbi +286 -0
  369. data/rbi/docker_engine_api/models/system_info_params.rbi +32 -0
  370. data/rbi/docker_engine_api/models/system_ping_params.rbi +32 -0
  371. data/rbi/docker_engine_api/models/system_ping_response.rbi +7 -0
  372. data/rbi/docker_engine_api/models/system_version_params.rbi +32 -0
  373. data/rbi/docker_engine_api/models/task.rbi +921 -0
  374. data/rbi/docker_engine_api/models/task_inspect_params.rbi +32 -0
  375. data/rbi/docker_engine_api/models/task_list_params.rbi +66 -0
  376. data/rbi/docker_engine_api/models/task_list_response.rbi +11 -0
  377. data/rbi/docker_engine_api/models/task_logs_params.rbi +117 -0
  378. data/rbi/docker_engine_api/models/top_response.rbi +54 -0
  379. data/rbi/docker_engine_api/models/update_response.rbi +34 -0
  380. data/rbi/docker_engine_api/models/version.rbi +256 -0
  381. data/rbi/docker_engine_api/models/volume.rbi +1230 -0
  382. data/rbi/docker_engine_api/models/volume_create_params.rbi +32 -0
  383. data/rbi/docker_engine_api/models/volume_delete_params.rbi +49 -0
  384. data/rbi/docker_engine_api/models/volume_inspect_params.rbi +32 -0
  385. data/rbi/docker_engine_api/models/volume_list_params.rbi +64 -0
  386. data/rbi/docker_engine_api/models/volume_prune_params.rbi +62 -0
  387. data/rbi/docker_engine_api/models/volume_prune_response.rbi +51 -0
  388. data/rbi/docker_engine_api/models/volume_update_params.rbi +668 -0
  389. data/rbi/docker_engine_api/models/wait_response.rbi +78 -0
  390. data/rbi/docker_engine_api/models.rbi +271 -0
  391. data/rbi/docker_engine_api/request_options.rbi +64 -0
  392. data/rbi/docker_engine_api/resources/auth.rbi +30 -0
  393. data/rbi/docker_engine_api/resources/configs.rbi +93 -0
  394. data/rbi/docker_engine_api/resources/containers.rbi +843 -0
  395. data/rbi/docker_engine_api/resources/distribution.rbi +26 -0
  396. data/rbi/docker_engine_api/resources/exec.rbi +72 -0
  397. data/rbi/docker_engine_api/resources/images.rbi +739 -0
  398. data/rbi/docker_engine_api/resources/networks.rbi +200 -0
  399. data/rbi/docker_engine_api/resources/nodes.rbi +87 -0
  400. data/rbi/docker_engine_api/resources/plugins.rbi +228 -0
  401. data/rbi/docker_engine_api/resources/secrets.rbi +93 -0
  402. data/rbi/docker_engine_api/resources/services.rbi +166 -0
  403. data/rbi/docker_engine_api/resources/swarm.rbi +178 -0
  404. data/rbi/docker_engine_api/resources/system.rbi +123 -0
  405. data/rbi/docker_engine_api/resources/tasks.rbi +90 -0
  406. data/rbi/docker_engine_api/resources/volumes.rbi +123 -0
  407. data/rbi/docker_engine_api/version.rbi +5 -0
  408. data/sig/docker_engine_api/client.rbs +49 -0
  409. data/sig/docker_engine_api/errors.rbs +117 -0
  410. data/sig/docker_engine_api/file_part.rbs +21 -0
  411. data/sig/docker_engine_api/internal/transport/base_client.rbs +131 -0
  412. data/sig/docker_engine_api/internal/transport/pooled_net_requester.rbs +48 -0
  413. data/sig/docker_engine_api/internal/type/array_of.rbs +48 -0
  414. data/sig/docker_engine_api/internal/type/base_model.rbs +104 -0
  415. data/sig/docker_engine_api/internal/type/base_page.rbs +24 -0
  416. data/sig/docker_engine_api/internal/type/boolean.rbs +26 -0
  417. data/sig/docker_engine_api/internal/type/converter.rbs +79 -0
  418. data/sig/docker_engine_api/internal/type/enum.rbs +32 -0
  419. data/sig/docker_engine_api/internal/type/file_input.rbs +25 -0
  420. data/sig/docker_engine_api/internal/type/hash_of.rbs +48 -0
  421. data/sig/docker_engine_api/internal/type/request_parameters.rbs +20 -0
  422. data/sig/docker_engine_api/internal/type/union.rbs +52 -0
  423. data/sig/docker_engine_api/internal/type/unknown.rbs +26 -0
  424. data/sig/docker_engine_api/internal/util.rbs +185 -0
  425. data/sig/docker_engine_api/internal.rbs +10 -0
  426. data/sig/docker_engine_api/models/auth_login_params.rbs +38 -0
  427. data/sig/docker_engine_api/models/auth_response.rbs +17 -0
  428. data/sig/docker_engine_api/models/config.rbs +225 -0
  429. data/sig/docker_engine_api/models/config_create_params.rbs +36 -0
  430. data/sig/docker_engine_api/models/config_create_response.rbs +13 -0
  431. data/sig/docker_engine_api/models/config_delete_params.rbs +15 -0
  432. data/sig/docker_engine_api/models/config_inspect_params.rbs +15 -0
  433. data/sig/docker_engine_api/models/config_list_params.rbs +25 -0
  434. data/sig/docker_engine_api/models/config_list_response.rbs +7 -0
  435. data/sig/docker_engine_api/models/config_update_params.rbs +23 -0
  436. data/sig/docker_engine_api/models/connect_request.rbs +175 -0
  437. data/sig/docker_engine_api/models/container.rbs +1973 -0
  438. data/sig/docker_engine_api/models/container_archive_params.rbs +23 -0
  439. data/sig/docker_engine_api/models/container_attach_params.rbs +63 -0
  440. data/sig/docker_engine_api/models/container_changes_params.rbs +15 -0
  441. data/sig/docker_engine_api/models/container_changes_response.rbs +7 -0
  442. data/sig/docker_engine_api/models/container_create_params.rbs +1352 -0
  443. data/sig/docker_engine_api/models/container_delete_params.rbs +38 -0
  444. data/sig/docker_engine_api/models/container_exec_params.rbs +96 -0
  445. data/sig/docker_engine_api/models/container_exec_response.rbs +13 -0
  446. data/sig/docker_engine_api/models/container_export_params.rbs +15 -0
  447. data/sig/docker_engine_api/models/container_inspect_params.rbs +25 -0
  448. data/sig/docker_engine_api/models/container_kill_params.rbs +25 -0
  449. data/sig/docker_engine_api/models/container_list_params.rbs +44 -0
  450. data/sig/docker_engine_api/models/container_list_response.rbs +7 -0
  451. data/sig/docker_engine_api/models/container_logs_params.rbs +70 -0
  452. data/sig/docker_engine_api/models/container_pause_params.rbs +15 -0
  453. data/sig/docker_engine_api/models/container_prune_params.rbs +25 -0
  454. data/sig/docker_engine_api/models/container_prune_response.rbs +26 -0
  455. data/sig/docker_engine_api/models/container_rename_params.rbs +23 -0
  456. data/sig/docker_engine_api/models/container_resize_params.rbs +28 -0
  457. data/sig/docker_engine_api/models/container_restart_params.rbs +32 -0
  458. data/sig/docker_engine_api/models/container_start_params.rbs +26 -0
  459. data/sig/docker_engine_api/models/container_stats_params.rbs +32 -0
  460. data/sig/docker_engine_api/models/container_stop_params.rbs +32 -0
  461. data/sig/docker_engine_api/models/container_top_params.rbs +25 -0
  462. data/sig/docker_engine_api/models/container_unpause_params.rbs +15 -0
  463. data/sig/docker_engine_api/models/container_update_params.rbs +476 -0
  464. data/sig/docker_engine_api/models/container_wait_params.rbs +40 -0
  465. data/sig/docker_engine_api/models/create_request.rbs +255 -0
  466. data/sig/docker_engine_api/models/create_response.rbs +15 -0
  467. data/sig/docker_engine_api/models/delete_item.rbs +19 -0
  468. data/sig/docker_engine_api/models/disconnect_request.rbs +17 -0
  469. data/sig/docker_engine_api/models/distribution_inspect_params.rbs +15 -0
  470. data/sig/docker_engine_api/models/error.rbs +13 -0
  471. data/sig/docker_engine_api/models/exec_inspect_params.rbs +15 -0
  472. data/sig/docker_engine_api/models/exec_inspect_response.rbs +94 -0
  473. data/sig/docker_engine_api/models/exec_resize_params.rbs +28 -0
  474. data/sig/docker_engine_api/models/exec_start_params.rbs +36 -0
  475. data/sig/docker_engine_api/models/filesystem_change.rbs +34 -0
  476. data/sig/docker_engine_api/models/history_item.rbs +45 -0
  477. data/sig/docker_engine_api/models/image.rbs +1042 -0
  478. data/sig/docker_engine_api/models/image_build_params.rbs +221 -0
  479. data/sig/docker_engine_api/models/image_build_prune_params.rbs +56 -0
  480. data/sig/docker_engine_api/models/image_build_prune_response.rbs +26 -0
  481. data/sig/docker_engine_api/models/image_commit_params.rbs +70 -0
  482. data/sig/docker_engine_api/models/image_commit_response.rbs +13 -0
  483. data/sig/docker_engine_api/models/image_delete_params.rbs +38 -0
  484. data/sig/docker_engine_api/models/image_delete_response.rbs +7 -0
  485. data/sig/docker_engine_api/models/image_get_all_params.rbs +32 -0
  486. data/sig/docker_engine_api/models/image_get_params.rbs +26 -0
  487. data/sig/docker_engine_api/models/image_history_params.rbs +25 -0
  488. data/sig/docker_engine_api/models/image_history_response.rbs +7 -0
  489. data/sig/docker_engine_api/models/image_inspect_params.rbs +25 -0
  490. data/sig/docker_engine_api/models/image_list_params.rbs +56 -0
  491. data/sig/docker_engine_api/models/image_list_response.rbs +7 -0
  492. data/sig/docker_engine_api/models/image_load_params.rbs +40 -0
  493. data/sig/docker_engine_api/models/image_prune_params.rbs +25 -0
  494. data/sig/docker_engine_api/models/image_prune_response.rbs +31 -0
  495. data/sig/docker_engine_api/models/image_pull_params.rbs +84 -0
  496. data/sig/docker_engine_api/models/image_push_params.rbs +36 -0
  497. data/sig/docker_engine_api/models/image_search_params.rbs +36 -0
  498. data/sig/docker_engine_api/models/image_search_response.rbs +55 -0
  499. data/sig/docker_engine_api/models/image_tag_params.rbs +32 -0
  500. data/sig/docker_engine_api/models/info.rbs +1080 -0
  501. data/sig/docker_engine_api/models/inspect.rbs +177 -0
  502. data/sig/docker_engine_api/models/inspect_response.rbs +50 -0
  503. data/sig/docker_engine_api/models/list_response.rbs +28 -0
  504. data/sig/docker_engine_api/models/network.rbs +238 -0
  505. data/sig/docker_engine_api/models/network_connect_params.rbs +15 -0
  506. data/sig/docker_engine_api/models/network_create_params.rbs +203 -0
  507. data/sig/docker_engine_api/models/network_delete_params.rbs +15 -0
  508. data/sig/docker_engine_api/models/network_disconnect_params.rbs +15 -0
  509. data/sig/docker_engine_api/models/network_inspect_params.rbs +32 -0
  510. data/sig/docker_engine_api/models/network_inspect_response.rbs +149 -0
  511. data/sig/docker_engine_api/models/network_list_params.rbs +25 -0
  512. data/sig/docker_engine_api/models/network_list_response.rbs +7 -0
  513. data/sig/docker_engine_api/models/network_prune_params.rbs +25 -0
  514. data/sig/docker_engine_api/models/network_prune_response.rbs +15 -0
  515. data/sig/docker_engine_api/models/node.rbs +434 -0
  516. data/sig/docker_engine_api/models/node_delete_params.rbs +25 -0
  517. data/sig/docker_engine_api/models/node_inspect_params.rbs +15 -0
  518. data/sig/docker_engine_api/models/node_list_params.rbs +25 -0
  519. data/sig/docker_engine_api/models/node_list_response.rbs +7 -0
  520. data/sig/docker_engine_api/models/node_update_params.rbs +23 -0
  521. data/sig/docker_engine_api/models/plugin.rbs +509 -0
  522. data/sig/docker_engine_api/models/plugin_create_params.rbs +28 -0
  523. data/sig/docker_engine_api/models/plugin_delete_params.rbs +25 -0
  524. data/sig/docker_engine_api/models/plugin_disable_params.rbs +25 -0
  525. data/sig/docker_engine_api/models/plugin_enable_params.rbs +25 -0
  526. data/sig/docker_engine_api/models/plugin_inspect_params.rbs +15 -0
  527. data/sig/docker_engine_api/models/plugin_list_params.rbs +25 -0
  528. data/sig/docker_engine_api/models/plugin_list_response.rbs +7 -0
  529. data/sig/docker_engine_api/models/plugin_privileges_params.rbs +23 -0
  530. data/sig/docker_engine_api/models/plugin_privileges_response.rbs +7 -0
  531. data/sig/docker_engine_api/models/plugin_pull_params.rbs +49 -0
  532. data/sig/docker_engine_api/models/plugin_push_params.rbs +15 -0
  533. data/sig/docker_engine_api/models/plugin_set_params.rbs +26 -0
  534. data/sig/docker_engine_api/models/plugin_upgrade_params.rbs +42 -0
  535. data/sig/docker_engine_api/models/privilege.rbs +32 -0
  536. data/sig/docker_engine_api/models/secret.rbs +64 -0
  537. data/sig/docker_engine_api/models/secret_create_params.rbs +36 -0
  538. data/sig/docker_engine_api/models/secret_create_response.rbs +13 -0
  539. data/sig/docker_engine_api/models/secret_delete_params.rbs +15 -0
  540. data/sig/docker_engine_api/models/secret_inspect_params.rbs +15 -0
  541. data/sig/docker_engine_api/models/secret_list_params.rbs +25 -0
  542. data/sig/docker_engine_api/models/secret_list_response.rbs +7 -0
  543. data/sig/docker_engine_api/models/secret_update_params.rbs +23 -0
  544. data/sig/docker_engine_api/models/service.rbs +471 -0
  545. data/sig/docker_engine_api/models/service_create_params.rbs +41 -0
  546. data/sig/docker_engine_api/models/service_delete_params.rbs +15 -0
  547. data/sig/docker_engine_api/models/service_inspect_params.rbs +26 -0
  548. data/sig/docker_engine_api/models/service_list_params.rbs +32 -0
  549. data/sig/docker_engine_api/models/service_list_response.rbs +7 -0
  550. data/sig/docker_engine_api/models/service_logs_params.rbs +70 -0
  551. data/sig/docker_engine_api/models/service_update_params.rbs +73 -0
  552. data/sig/docker_engine_api/models/spec.rbs +467 -0
  553. data/sig/docker_engine_api/models/stats_response.rbs +730 -0
  554. data/sig/docker_engine_api/models/summary.rbs +634 -0
  555. data/sig/docker_engine_api/models/swarm.rbs +159 -0
  556. data/sig/docker_engine_api/models/swarm_init_params.rbs +77 -0
  557. data/sig/docker_engine_api/models/swarm_init_response.rbs +5 -0
  558. data/sig/docker_engine_api/models/swarm_inspect_params.rbs +15 -0
  559. data/sig/docker_engine_api/models/swarm_join_params.rbs +56 -0
  560. data/sig/docker_engine_api/models/swarm_leave_params.rbs +25 -0
  561. data/sig/docker_engine_api/models/swarm_unlock_key_params.rbs +15 -0
  562. data/sig/docker_engine_api/models/swarm_unlock_key_response.rbs +15 -0
  563. data/sig/docker_engine_api/models/swarm_unlock_params.rbs +26 -0
  564. data/sig/docker_engine_api/models/swarm_update_params.rbs +47 -0
  565. data/sig/docker_engine_api/models/system_data_usage_params.rbs +50 -0
  566. data/sig/docker_engine_api/models/system_data_usage_response.rbs +239 -0
  567. data/sig/docker_engine_api/models/system_events_params.rbs +38 -0
  568. data/sig/docker_engine_api/models/system_events_response.rbs +124 -0
  569. data/sig/docker_engine_api/models/system_info_params.rbs +15 -0
  570. data/sig/docker_engine_api/models/system_ping_params.rbs +15 -0
  571. data/sig/docker_engine_api/models/system_ping_response.rbs +5 -0
  572. data/sig/docker_engine_api/models/system_version_params.rbs +15 -0
  573. data/sig/docker_engine_api/models/task.rbs +469 -0
  574. data/sig/docker_engine_api/models/task_inspect_params.rbs +15 -0
  575. data/sig/docker_engine_api/models/task_list_params.rbs +25 -0
  576. data/sig/docker_engine_api/models/task_list_response.rbs +7 -0
  577. data/sig/docker_engine_api/models/task_logs_params.rbs +70 -0
  578. data/sig/docker_engine_api/models/top_response.rbs +26 -0
  579. data/sig/docker_engine_api/models/update_response.rbs +15 -0
  580. data/sig/docker_engine_api/models/version.rbs +127 -0
  581. data/sig/docker_engine_api/models/volume.rbs +478 -0
  582. data/sig/docker_engine_api/models/volume_create_params.rbs +15 -0
  583. data/sig/docker_engine_api/models/volume_delete_params.rbs +25 -0
  584. data/sig/docker_engine_api/models/volume_inspect_params.rbs +15 -0
  585. data/sig/docker_engine_api/models/volume_list_params.rbs +25 -0
  586. data/sig/docker_engine_api/models/volume_prune_params.rbs +25 -0
  587. data/sig/docker_engine_api/models/volume_prune_response.rbs +26 -0
  588. data/sig/docker_engine_api/models/volume_update_params.rbs +235 -0
  589. data/sig/docker_engine_api/models/wait_response.rbs +38 -0
  590. data/sig/docker_engine_api/models.rbs +269 -0
  591. data/sig/docker_engine_api/request_options.rbs +36 -0
  592. data/sig/docker_engine_api/resources/auth.rbs +14 -0
  593. data/sig/docker_engine_api/resources/configs.rbs +34 -0
  594. data/sig/docker_engine_api/resources/containers.rbs +200 -0
  595. data/sig/docker_engine_api/resources/distribution.rbs +12 -0
  596. data/sig/docker_engine_api/resources/exec.rbs +27 -0
  597. data/sig/docker_engine_api/resources/images.rbs +170 -0
  598. data/sig/docker_engine_api/resources/networks.rbs +60 -0
  599. data/sig/docker_engine_api/resources/nodes.rbs +30 -0
  600. data/sig/docker_engine_api/resources/plugins.rbs +73 -0
  601. data/sig/docker_engine_api/resources/secrets.rbs +34 -0
  602. data/sig/docker_engine_api/resources/services.rbs +52 -0
  603. data/sig/docker_engine_api/resources/swarm.rbs +55 -0
  604. data/sig/docker_engine_api/resources/system.rbs +30 -0
  605. data/sig/docker_engine_api/resources/tasks.rbs +29 -0
  606. data/sig/docker_engine_api/resources/volumes.rbs +40 -0
  607. data/sig/docker_engine_api/version.rbs +3 -0
  608. metadata +679 -0
@@ -0,0 +1,1395 @@
1
+ # frozen_string_literal: true
2
+
3
+ module DockerEngineAPI
4
+ module Models
5
+ # @see DockerEngineAPI::Resources::Images#inspect_
6
+ class Image < DockerEngineAPI::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 [DockerEngineAPI::Models::Image::Config, nil]
31
+ optional :config, -> { DockerEngineAPI::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 [DockerEngineAPI::Models::Image::Descriptor, nil]
48
+ optional :descriptor, -> { DockerEngineAPI::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 [DockerEngineAPI::Models::Image::GraphDriver, nil]
55
+ optional :graph_driver, -> { DockerEngineAPI::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 [DockerEngineAPI::Models::Image::Identity, nil]
75
+ optional :identity, -> { DockerEngineAPI::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<DockerEngineAPI::Models::Image::Manifest>, nil]
89
+ optional :manifests,
90
+ -> { DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::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 [DockerEngineAPI::Models::Image::Metadata, nil]
99
+ optional :metadata, -> { DockerEngineAPI::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, DockerEngineAPI::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, DockerEngineAPI::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 [DockerEngineAPI::Models::Image::RootFs, nil]
138
+ optional :root_fs, -> { DockerEngineAPI::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
+ # {DockerEngineAPI::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 [DockerEngineAPI::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 [DockerEngineAPI::Models::Image::Descriptor] A descriptor struct containing digest, media type, and size, as defined in
169
+ #
170
+ # @param graph_driver [DockerEngineAPI::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 [DockerEngineAPI::Models::Image::Identity] Identity holds information about the identity and origin of the image.
175
+ #
176
+ # @param manifests [Array<DockerEngineAPI::Models::Image::Manifest>, nil] Manifests is a list of image manifests available in this image. It
177
+ #
178
+ # @param metadata [DockerEngineAPI::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 [DockerEngineAPI::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 DockerEngineAPI::Models::Image#config
195
+ class Config < DockerEngineAPI::Internal::Type::BaseModel
196
+ # @!attribute args_escaped
197
+ # Command is already escaped (Windows only)
198
+ #
199
+ # @return [Boolean, nil]
200
+ optional :args_escaped, DockerEngineAPI::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, DockerEngineAPI::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, DockerEngineAPI::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, DockerEngineAPI::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
+ DockerEngineAPI::Internal::Type::HashOf[DockerEngineAPI::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 [DockerEngineAPI::Models::Image::Config::Healthcheck, nil]
242
+ optional :healthcheck, -> { DockerEngineAPI::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, DockerEngineAPI::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, DockerEngineAPI::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, DockerEngineAPI::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
+ DockerEngineAPI::Internal::Type::HashOf[DockerEngineAPI::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
+ # {DockerEngineAPI::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 [DockerEngineAPI::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 DockerEngineAPI::Models::Image::Config#healthcheck
322
+ class Healthcheck < DockerEngineAPI::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_, DockerEngineAPI::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
+ # {DockerEngineAPI::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 DockerEngineAPI::Models::Image#descriptor
403
+ class Descriptor < DockerEngineAPI::Internal::Type::BaseModel
404
+ # @!attribute annotations
405
+ # Arbitrary metadata relating to the targeted content.
406
+ #
407
+ # @return [Hash{Symbol=>String}, nil]
408
+ optional :annotations, DockerEngineAPI::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 [DockerEngineAPI::Models::Image::Descriptor::Platform, nil]
442
+ optional :platform, -> { DockerEngineAPI::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, DockerEngineAPI::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
+ # {DockerEngineAPI::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 [DockerEngineAPI::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 DockerEngineAPI::Models::Image::Descriptor#platform
480
+ class Platform < DockerEngineAPI::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, DockerEngineAPI::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
+ # {DockerEngineAPI::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 DockerEngineAPI::Models::Image#graph_driver
535
+ class GraphDriver < DockerEngineAPI::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, DockerEngineAPI::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
+ # {DockerEngineAPI::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 DockerEngineAPI::Models::Image#identity
564
+ class Identity < DockerEngineAPI::Internal::Type::BaseModel
565
+ # @!attribute build
566
+ # Build contains build reference information if image was created via build.
567
+ #
568
+ # @return [Array<DockerEngineAPI::Models::Image::Identity::Build>, nil]
569
+ optional :build,
570
+ -> { DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::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<DockerEngineAPI::Models::Image::Identity::Pull>, nil]
579
+ optional :pull,
580
+ -> { DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::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<DockerEngineAPI::Models::Image::Identity::Signature>, nil]
587
+ optional :signature,
588
+ -> { DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Image::Identity::Signature] },
589
+ api_name: :Signature
590
+
591
+ # @!method initialize(build: nil, pull: nil, signature: nil)
592
+ # Some parameter documentations has been truncated, see
593
+ # {DockerEngineAPI::Models::Image::Identity} for more details.
594
+ #
595
+ # Identity holds information about the identity and origin of the image. This is
596
+ # trusted information verified by the daemon and cannot be modified by tagging an
597
+ # image to a different name.
598
+ #
599
+ # @param build [Array<DockerEngineAPI::Models::Image::Identity::Build>] Build contains build reference information if image was created via build.
600
+ #
601
+ # @param pull [Array<DockerEngineAPI::Models::Image::Identity::Pull>] Pull contains remote location information if image was created via pull.
602
+ #
603
+ # @param signature [Array<DockerEngineAPI::Models::Image::Identity::Signature>] Signature contains the properties of verified signatures for the image.
604
+
605
+ class Build < DockerEngineAPI::Internal::Type::BaseModel
606
+ # @!attribute created_at
607
+ # CreatedAt is the time when the build ran.
608
+ #
609
+ # @return [Time, nil]
610
+ optional :created_at, Time, api_name: :CreatedAt
611
+
612
+ # @!attribute ref
613
+ # Ref is the identifier for the build request. This reference can be used to look
614
+ # up the build details in BuildKit history API.
615
+ #
616
+ # @return [String, nil]
617
+ optional :ref, String, api_name: :Ref
618
+
619
+ # @!method initialize(created_at: nil, ref: nil)
620
+ # Some parameter documentations has been truncated, see
621
+ # {DockerEngineAPI::Models::Image::Identity::Build} for more details.
622
+ #
623
+ # BuildIdentity contains build reference information if image was created via
624
+ # build.
625
+ #
626
+ # @param created_at [Time] CreatedAt is the time when the build ran.
627
+ #
628
+ # @param ref [String] Ref is the identifier for the build request. This reference can be used to
629
+ end
630
+
631
+ class Pull < DockerEngineAPI::Internal::Type::BaseModel
632
+ # @!attribute repository
633
+ # Repository is the remote repository location the image was pulled from.
634
+ #
635
+ # @return [String, nil]
636
+ optional :repository, String, api_name: :Repository
637
+
638
+ # @!method initialize(repository: nil)
639
+ # PullIdentity contains remote location information if image was created via pull.
640
+ # If image was pulled via mirror, this contains the original repository location.
641
+ #
642
+ # @param repository [String] Repository is the remote repository location the image was pulled from.
643
+ end
644
+
645
+ class Signature < DockerEngineAPI::Internal::Type::BaseModel
646
+ # @!attribute docker_reference
647
+ # DockerReference is the Docker image reference associated with the signature.
648
+ # This is an optional field only present in older hashedrecord signatures.
649
+ #
650
+ # @return [String, nil]
651
+ optional :docker_reference, String, api_name: :DockerReference
652
+
653
+ # @!attribute error
654
+ # Error contains error information if signature verification failed. Other fields
655
+ # will be empty in this case.
656
+ #
657
+ # @return [String, nil]
658
+ optional :error, String, api_name: :Error
659
+
660
+ # @!attribute known_signer
661
+ # KnownSignerIdentity is an identifier for a special signer identity that is known
662
+ # to the implementation.
663
+ #
664
+ # @return [Symbol, DockerEngineAPI::Models::Image::Identity::Signature::KnownSigner, nil]
665
+ optional :known_signer,
666
+ enum: -> { DockerEngineAPI::Image::Identity::Signature::KnownSigner },
667
+ api_name: :KnownSigner
668
+
669
+ # @!attribute name
670
+ # Name is a textual description summarizing the type of signature.
671
+ #
672
+ # @return [String, nil]
673
+ optional :name, String, api_name: :Name
674
+
675
+ # @!attribute signature_type
676
+ # SignatureType is the type of signature format.
677
+ #
678
+ # @return [Symbol, DockerEngineAPI::Models::Image::Identity::Signature::SignatureType, nil]
679
+ optional :signature_type,
680
+ enum: -> { DockerEngineAPI::Image::Identity::Signature::SignatureType },
681
+ api_name: :SignatureType
682
+
683
+ # @!attribute signer
684
+ # SignerIdentity contains information about the signer certificate used to sign
685
+ # the image.
686
+ #
687
+ # @return [DockerEngineAPI::Models::Image::Identity::Signature::Signer, nil]
688
+ optional :signer, -> { DockerEngineAPI::Image::Identity::Signature::Signer }, api_name: :Signer
689
+
690
+ # @!attribute timestamps
691
+ # Timestamps contains a list of verified signed timestamps for the signature.
692
+ #
693
+ # @return [Array<DockerEngineAPI::Models::Image::Identity::Signature::Timestamp>, nil]
694
+ optional :timestamps,
695
+ -> {
696
+ DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Image::Identity::Signature::Timestamp]
697
+ },
698
+ api_name: :Timestamps
699
+
700
+ # @!attribute warnings
701
+ # Warnings contains any warnings that occurred during signature verification. For
702
+ # example, if there was no internet connectivity and cached trust roots were used.
703
+ # Warning does not indicate a failed verification but may point to configuration
704
+ # issues.
705
+ #
706
+ # @return [Array<String>, nil]
707
+ optional :warnings, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :Warnings
708
+
709
+ # @!method initialize(docker_reference: nil, error: nil, known_signer: nil, name: nil, signature_type: nil, signer: nil, timestamps: nil, warnings: nil)
710
+ # Some parameter documentations has been truncated, see
711
+ # {DockerEngineAPI::Models::Image::Identity::Signature} for more details.
712
+ #
713
+ # SignatureIdentity contains the properties of verified signatures for the image.
714
+ #
715
+ # @param docker_reference [String] DockerReference is the Docker image reference associated with the signature.
716
+ #
717
+ # @param error [String] Error contains error information if signature verification failed.
718
+ #
719
+ # @param known_signer [Symbol, DockerEngineAPI::Models::Image::Identity::Signature::KnownSigner] KnownSignerIdentity is an identifier for a special signer identity that is known
720
+ #
721
+ # @param name [String] Name is a textual description summarizing the type of signature.
722
+ #
723
+ # @param signature_type [Symbol, DockerEngineAPI::Models::Image::Identity::Signature::SignatureType] SignatureType is the type of signature format.
724
+ #
725
+ # @param signer [DockerEngineAPI::Models::Image::Identity::Signature::Signer] SignerIdentity contains information about the signer certificate used to sign th
726
+ #
727
+ # @param timestamps [Array<DockerEngineAPI::Models::Image::Identity::Signature::Timestamp>] Timestamps contains a list of verified signed timestamps for the signature.
728
+ #
729
+ # @param warnings [Array<String>] Warnings contains any warnings that occurred during signature verification.
730
+
731
+ # KnownSignerIdentity is an identifier for a special signer identity that is known
732
+ # to the implementation.
733
+ #
734
+ # @see DockerEngineAPI::Models::Image::Identity::Signature#known_signer
735
+ module KnownSigner
736
+ extend DockerEngineAPI::Internal::Type::Enum
737
+
738
+ DHI = :DHI
739
+
740
+ # @!method self.values
741
+ # @return [Array<Symbol>]
742
+ end
743
+
744
+ # SignatureType is the type of signature format.
745
+ #
746
+ # @see DockerEngineAPI::Models::Image::Identity::Signature#signature_type
747
+ module SignatureType
748
+ extend DockerEngineAPI::Internal::Type::Enum
749
+
750
+ BUNDLE_V0_3 = :"bundle-v0.3"
751
+ SIMPLESIGNING_V1 = :"simplesigning-v1"
752
+
753
+ # @!method self.values
754
+ # @return [Array<Symbol>]
755
+ end
756
+
757
+ # @see DockerEngineAPI::Models::Image::Identity::Signature#signer
758
+ class Signer < DockerEngineAPI::Internal::Type::BaseModel
759
+ # @!attribute build_config_digest
760
+ # Immutable reference to the specific version of the top-level/initiating build
761
+ # instructions.
762
+ #
763
+ # @return [String, nil]
764
+ optional :build_config_digest, String, api_name: :BuildConfigDigest
765
+
766
+ # @!attribute build_config_uri
767
+ # Build Config URL to the top-level/initiating build instructions.
768
+ #
769
+ # @return [String, nil]
770
+ optional :build_config_uri, String, api_name: :BuildConfigURI
771
+
772
+ # @!attribute build_signer_digest
773
+ # Immutable reference to the specific version of the build instructions that is
774
+ # responsible for signing.
775
+ #
776
+ # @return [String, nil]
777
+ optional :build_signer_digest, String, api_name: :BuildSignerDigest
778
+
779
+ # @!attribute build_signer_uri
780
+ # Reference to specific build instructions that are responsible for signing.
781
+ #
782
+ # @return [String, nil]
783
+ optional :build_signer_uri, String, api_name: :BuildSignerURI
784
+
785
+ # @!attribute build_trigger
786
+ # Event or action that initiated the build.
787
+ #
788
+ # @return [String, nil]
789
+ optional :build_trigger, String, api_name: :BuildTrigger
790
+
791
+ # @!attribute certificate_issuer
792
+ # CertificateIssuer is the certificate issuer.
793
+ #
794
+ # @return [String, nil]
795
+ optional :certificate_issuer, String, api_name: :CertificateIssuer
796
+
797
+ # @!attribute issuer
798
+ # The OIDC issuer. Should match `iss` claim of ID token or, in the case of a
799
+ # federated login like Dex it should match the issuer URL of the upstream issuer.
800
+ # The issuer is not set the extensions are invalid and will fail to render.
801
+ #
802
+ # @return [String, nil]
803
+ optional :issuer, String, api_name: :Issuer
804
+
805
+ # @!attribute run_invocation_uri
806
+ # Run Invocation URL to uniquely identify the build execution.
807
+ #
808
+ # @return [String, nil]
809
+ optional :run_invocation_uri, String, api_name: :RunInvocationURI
810
+
811
+ # @!attribute runner_environment
812
+ # Specifies whether the build took place in platform-hosted cloud infrastructure
813
+ # or customer/self-hosted infrastructure.
814
+ #
815
+ # @return [String, nil]
816
+ optional :runner_environment, String, api_name: :RunnerEnvironment
817
+
818
+ # @!attribute source_repository_digest
819
+ # Immutable reference to a specific version of the source code that the build was
820
+ # based upon.
821
+ #
822
+ # @return [String, nil]
823
+ optional :source_repository_digest, String, api_name: :SourceRepositoryDigest
824
+
825
+ # @!attribute source_repository_identifier
826
+ # Immutable identifier for the source repository the workflow was based upon.
827
+ #
828
+ # @return [String, nil]
829
+ optional :source_repository_identifier, String, api_name: :SourceRepositoryIdentifier
830
+
831
+ # @!attribute source_repository_owner_identifier
832
+ # Immutable identifier for the owner of the source repository that the workflow
833
+ # was based upon.
834
+ #
835
+ # @return [String, nil]
836
+ optional :source_repository_owner_identifier, String, api_name: :SourceRepositoryOwnerIdentifier
837
+
838
+ # @!attribute source_repository_owner_uri
839
+ # Source repository owner URL of the owner of the source repository that the build
840
+ # was based on.
841
+ #
842
+ # @return [String, nil]
843
+ optional :source_repository_owner_uri, String, api_name: :SourceRepositoryOwnerURI
844
+
845
+ # @!attribute source_repository_ref
846
+ # Source Repository Ref that the build run was based upon.
847
+ #
848
+ # @return [String, nil]
849
+ optional :source_repository_ref, String, api_name: :SourceRepositoryRef
850
+
851
+ # @!attribute source_repository_uri
852
+ # Source repository URL that the build was based on.
853
+ #
854
+ # @return [String, nil]
855
+ optional :source_repository_uri, String, api_name: :SourceRepositoryURI
856
+
857
+ # @!attribute source_repository_visibility_at_signing
858
+ # Source repository visibility at the time of signing the certificate.
859
+ #
860
+ # @return [String, nil]
861
+ optional :source_repository_visibility_at_signing,
862
+ String,
863
+ api_name: :SourceRepositoryVisibilityAtSigning
864
+
865
+ # @!attribute subject_alternative_name
866
+ # SubjectAlternativeName is the certificate subject alternative name.
867
+ #
868
+ # @return [String, nil]
869
+ optional :subject_alternative_name, String, api_name: :SubjectAlternativeName
870
+
871
+ # @!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)
872
+ # Some parameter documentations has been truncated, see
873
+ # {DockerEngineAPI::Models::Image::Identity::Signature::Signer} for more details.
874
+ #
875
+ # SignerIdentity contains information about the signer certificate used to sign
876
+ # the image.
877
+ #
878
+ # @param build_config_digest [String] Immutable reference to the specific version of the top-level/initiating build in
879
+ #
880
+ # @param build_config_uri [String] Build Config URL to the top-level/initiating build instructions.
881
+ #
882
+ # @param build_signer_digest [String] Immutable reference to the specific version of the build instructions that is re
883
+ #
884
+ # @param build_signer_uri [String] Reference to specific build instructions that are responsible for signing.
885
+ #
886
+ # @param build_trigger [String] Event or action that initiated the build.
887
+ #
888
+ # @param certificate_issuer [String] CertificateIssuer is the certificate issuer.
889
+ #
890
+ # @param issuer [String] The OIDC issuer. Should match `iss` claim of ID token or, in the case of
891
+ #
892
+ # @param run_invocation_uri [String] Run Invocation URL to uniquely identify the build execution.
893
+ #
894
+ # @param runner_environment [String] Specifies whether the build took place in platform-hosted cloud infrastructure o
895
+ #
896
+ # @param source_repository_digest [String] Immutable reference to a specific version of the source code that the build was
897
+ #
898
+ # @param source_repository_identifier [String] Immutable identifier for the source repository the workflow was based upon.
899
+ #
900
+ # @param source_repository_owner_identifier [String] Immutable identifier for the owner of the source repository that the workflow wa
901
+ #
902
+ # @param source_repository_owner_uri [String] Source repository owner URL of the owner of the source repository that the build
903
+ #
904
+ # @param source_repository_ref [String] Source Repository Ref that the build run was based upon.
905
+ #
906
+ # @param source_repository_uri [String] Source repository URL that the build was based on.
907
+ #
908
+ # @param source_repository_visibility_at_signing [String] Source repository visibility at the time of signing the certificate.
909
+ #
910
+ # @param subject_alternative_name [String] SubjectAlternativeName is the certificate subject alternative name.
911
+ end
912
+
913
+ class Timestamp < DockerEngineAPI::Internal::Type::BaseModel
914
+ # @!attribute timestamp
915
+ #
916
+ # @return [Time, nil]
917
+ optional :timestamp, Time, api_name: :Timestamp
918
+
919
+ # @!attribute type
920
+ # SignatureTimestampType is the type of timestamp used in the signature.
921
+ #
922
+ # @return [Symbol, DockerEngineAPI::Models::Image::Identity::Signature::Timestamp::Type, nil]
923
+ optional :type,
924
+ enum: -> {
925
+ DockerEngineAPI::Image::Identity::Signature::Timestamp::Type
926
+ },
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, DockerEngineAPI::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 DockerEngineAPI::Models::Image::Identity::Signature::Timestamp#type
947
+ module Type
948
+ extend DockerEngineAPI::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 < DockerEngineAPI::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, DockerEngineAPI::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 [DockerEngineAPI::Models::Image::Manifest::Descriptor]
973
+ required :descriptor, -> { DockerEngineAPI::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, DockerEngineAPI::Models::Image::Manifest::Kind]
991
+ required :kind, enum: -> { DockerEngineAPI::Image::Manifest::Kind }, api_name: :Kind
992
+
993
+ # @!attribute size
994
+ #
995
+ # @return [DockerEngineAPI::Models::Image::Manifest::Size]
996
+ required :size, -> { DockerEngineAPI::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 [DockerEngineAPI::Models::Image::Manifest::AttestationData, nil]
1003
+ optional :attestation_data,
1004
+ -> { DockerEngineAPI::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 [DockerEngineAPI::Models::Image::Manifest::ImageData, nil]
1013
+ optional :image_data,
1014
+ -> {
1015
+ DockerEngineAPI::Image::Manifest::ImageData
1016
+ },
1017
+ api_name: :ImageData,
1018
+ nil?: true
1019
+
1020
+ # @!method initialize(available:, descriptor:, id:, kind:, size:, attestation_data: nil, image_data: nil)
1021
+ # Some parameter documentations has been truncated, see
1022
+ # {DockerEngineAPI::Models::Image::Manifest} for more details.
1023
+ #
1024
+ # ImageManifestSummary represents a summary of an image manifest.
1025
+ #
1026
+ # @param available [Boolean] Indicates whether all the child content (image config, layers) is fully availabl
1027
+ #
1028
+ # @param descriptor [DockerEngineAPI::Models::Image::Manifest::Descriptor] A descriptor struct containing digest, media type, and size, as defined in
1029
+ #
1030
+ # @param id [String] ID is the content-addressable ID of an image and is the same as the
1031
+ #
1032
+ # @param kind [Symbol, DockerEngineAPI::Models::Image::Manifest::Kind] The kind of the manifest.
1033
+ #
1034
+ # @param size [DockerEngineAPI::Models::Image::Manifest::Size]
1035
+ #
1036
+ # @param attestation_data [DockerEngineAPI::Models::Image::Manifest::AttestationData, nil] The image data for the attestation manifest.
1037
+ #
1038
+ # @param image_data [DockerEngineAPI::Models::Image::Manifest::ImageData, nil] The image data for the image manifest.
1039
+
1040
+ # @see DockerEngineAPI::Models::Image::Manifest#descriptor
1041
+ class Descriptor < DockerEngineAPI::Internal::Type::BaseModel
1042
+ # @!attribute annotations
1043
+ # Arbitrary metadata relating to the targeted content.
1044
+ #
1045
+ # @return [Hash{Symbol=>String}, nil]
1046
+ optional :annotations, DockerEngineAPI::Internal::Type::HashOf[String], nil?: true
1047
+
1048
+ # @!attribute artifact_type
1049
+ # ArtifactType is the IANA media type of this artifact.
1050
+ #
1051
+ # @return [String, nil]
1052
+ optional :artifact_type, String, api_name: :artifactType, nil?: true
1053
+
1054
+ # @!attribute data
1055
+ # Data is an embedding of the targeted content. This is encoded as a base64 string
1056
+ # when marshalled to JSON (automatically, by encoding/json). If present, Data can
1057
+ # be used directly to avoid fetching the targeted content.
1058
+ #
1059
+ # @return [String, nil]
1060
+ optional :data, String, nil?: true
1061
+
1062
+ # @!attribute digest
1063
+ # The digest of the targeted content.
1064
+ #
1065
+ # @return [String, nil]
1066
+ optional :digest, String
1067
+
1068
+ # @!attribute media_type
1069
+ # The media type of the object this schema refers to.
1070
+ #
1071
+ # @return [String, nil]
1072
+ optional :media_type, String, api_name: :mediaType
1073
+
1074
+ # @!attribute platform
1075
+ # Describes the platform which the image in the manifest runs on, as defined in
1076
+ # the
1077
+ # [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
1078
+ #
1079
+ # @return [DockerEngineAPI::Models::Image::Manifest::Descriptor::Platform, nil]
1080
+ optional :platform, -> { DockerEngineAPI::Image::Manifest::Descriptor::Platform }, nil?: true
1081
+
1082
+ # @!attribute size
1083
+ # The size in bytes of the blob.
1084
+ #
1085
+ # @return [Integer, nil]
1086
+ optional :size, Integer
1087
+
1088
+ # @!attribute urls
1089
+ # List of URLs from which this object MAY be downloaded.
1090
+ #
1091
+ # @return [Array<String>, nil]
1092
+ optional :urls, DockerEngineAPI::Internal::Type::ArrayOf[String], nil?: true
1093
+
1094
+ # @!method initialize(annotations: nil, artifact_type: nil, data: nil, digest: nil, media_type: nil, platform: nil, size: nil, urls: nil)
1095
+ # Some parameter documentations has been truncated, see
1096
+ # {DockerEngineAPI::Models::Image::Manifest::Descriptor} for more details.
1097
+ #
1098
+ # A descriptor struct containing digest, media type, and size, as defined in the
1099
+ # [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md).
1100
+ #
1101
+ # @param annotations [Hash{Symbol=>String}, nil] Arbitrary metadata relating to the targeted content.
1102
+ #
1103
+ # @param artifact_type [String, nil] ArtifactType is the IANA media type of this artifact.
1104
+ #
1105
+ # @param data [String, nil] Data is an embedding of the targeted content. This is encoded as a base64
1106
+ #
1107
+ # @param digest [String] The digest of the targeted content.
1108
+ #
1109
+ # @param media_type [String] The media type of the object this schema refers to.
1110
+ #
1111
+ # @param platform [DockerEngineAPI::Models::Image::Manifest::Descriptor::Platform, nil] Describes the platform which the image in the manifest runs on, as defined
1112
+ #
1113
+ # @param size [Integer] The size in bytes of the blob.
1114
+ #
1115
+ # @param urls [Array<String>, nil] List of URLs from which this object MAY be downloaded.
1116
+
1117
+ # @see DockerEngineAPI::Models::Image::Manifest::Descriptor#platform
1118
+ class Platform < DockerEngineAPI::Internal::Type::BaseModel
1119
+ # @!attribute architecture
1120
+ # The CPU architecture, for example `amd64` or `ppc64`.
1121
+ #
1122
+ # @return [String, nil]
1123
+ optional :architecture, String
1124
+
1125
+ # @!attribute os
1126
+ # The operating system, for example `linux` or `windows`.
1127
+ #
1128
+ # @return [String, nil]
1129
+ optional :os, String
1130
+
1131
+ # @!attribute os_features
1132
+ # Optional field specifying an array of strings, each listing a required OS
1133
+ # feature (for example on Windows `win32k`).
1134
+ #
1135
+ # @return [Array<String>, nil]
1136
+ optional :os_features, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :"os.features"
1137
+
1138
+ # @!attribute os_version
1139
+ # Optional field specifying the operating system version, for example on Windows
1140
+ # `10.0.19041.1165`.
1141
+ #
1142
+ # @return [String, nil]
1143
+ optional :os_version, String, api_name: :"os.version"
1144
+
1145
+ # @!attribute variant
1146
+ # Optional field specifying a variant of the CPU, for example `v7` to specify
1147
+ # ARMv7 when architecture is `arm`.
1148
+ #
1149
+ # @return [String, nil]
1150
+ optional :variant, String
1151
+
1152
+ # @!method initialize(architecture: nil, os: nil, os_features: nil, os_version: nil, variant: nil)
1153
+ # Some parameter documentations has been truncated, see
1154
+ # {DockerEngineAPI::Models::Image::Manifest::Descriptor::Platform} for more
1155
+ # details.
1156
+ #
1157
+ # Describes the platform which the image in the manifest runs on, as defined in
1158
+ # the
1159
+ # [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
1160
+ #
1161
+ # @param architecture [String] The CPU architecture, for example `amd64` or `ppc64`.
1162
+ #
1163
+ # @param os [String] The operating system, for example `linux` or `windows`.
1164
+ #
1165
+ # @param os_features [Array<String>] Optional field specifying an array of strings, each listing a required
1166
+ #
1167
+ # @param os_version [String] Optional field specifying the operating system version, for example on
1168
+ #
1169
+ # @param variant [String] Optional field specifying a variant of the CPU, for example `v7` to
1170
+ end
1171
+ end
1172
+
1173
+ # The kind of the manifest.
1174
+ #
1175
+ # | kind | description |
1176
+ # | ----------- | ------------------------------------------------------------------------------------ |
1177
+ # | image | Image manifest that can be used to start a container. |
1178
+ # | attestation | Attestation manifest produced by the Buildkit builder for a specific image manifest. |
1179
+ #
1180
+ # @see DockerEngineAPI::Models::Image::Manifest#kind
1181
+ module Kind
1182
+ extend DockerEngineAPI::Internal::Type::Enum
1183
+
1184
+ IMAGE = :image
1185
+ ATTESTATION = :attestation
1186
+ UNKNOWN = :unknown
1187
+
1188
+ # @!method self.values
1189
+ # @return [Array<Symbol>]
1190
+ end
1191
+
1192
+ # @see DockerEngineAPI::Models::Image::Manifest#size
1193
+ class Size < DockerEngineAPI::Internal::Type::BaseModel
1194
+ # @!attribute content
1195
+ # Content is the size (in bytes) of all the locally present content in the content
1196
+ # store (e.g. image config, layers) referenced by this manifest and its children.
1197
+ # This only includes blobs in the content store.
1198
+ #
1199
+ # @return [Integer]
1200
+ required :content, Integer, api_name: :Content
1201
+
1202
+ # @!attribute total
1203
+ # Total is the total size (in bytes) of all the locally present data (both
1204
+ # distributable and non-distributable) that's related to this manifest and its
1205
+ # children. This equal to the sum of [Content] size AND all the sizes in the
1206
+ # [Size] struct present in the Kind-specific data struct. For example, for an
1207
+ # image kind (Kind == "image") this would include the size of the image content
1208
+ # and unpacked image snapshots ([Size.Content] + [ImageData.Size.Unpacked]).
1209
+ #
1210
+ # @return [Integer]
1211
+ required :total, Integer, api_name: :Total
1212
+
1213
+ # @!method initialize(content:, total:)
1214
+ # Some parameter documentations has been truncated, see
1215
+ # {DockerEngineAPI::Models::Image::Manifest::Size} for more details.
1216
+ #
1217
+ # @param content [Integer] Content is the size (in bytes) of all the locally present
1218
+ #
1219
+ # @param total [Integer] Total is the total size (in bytes) of all the locally present
1220
+ end
1221
+
1222
+ # @see DockerEngineAPI::Models::Image::Manifest#attestation_data
1223
+ class AttestationData < DockerEngineAPI::Internal::Type::BaseModel
1224
+ # @!attribute for_
1225
+ # The digest of the image manifest that this attestation is for.
1226
+ #
1227
+ # @return [String]
1228
+ required :for_, String, api_name: :For
1229
+
1230
+ # @!method initialize(for_:)
1231
+ # Some parameter documentations has been truncated, see
1232
+ # {DockerEngineAPI::Models::Image::Manifest::AttestationData} for more details.
1233
+ #
1234
+ # The image data for the attestation manifest. This field is only populated when
1235
+ # Kind is "attestation".
1236
+ #
1237
+ # @param for_ [String] The digest of the image manifest that this attestation is for.
1238
+ end
1239
+
1240
+ # @see DockerEngineAPI::Models::Image::Manifest#image_data
1241
+ class ImageData < DockerEngineAPI::Internal::Type::BaseModel
1242
+ # @!attribute containers
1243
+ # The IDs of the containers that are using this image.
1244
+ #
1245
+ # @return [Array<String>]
1246
+ required :containers, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :Containers
1247
+
1248
+ # @!attribute platform
1249
+ # Describes the platform which the image in the manifest runs on, as defined in
1250
+ # the
1251
+ # [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
1252
+ #
1253
+ # @return [DockerEngineAPI::Models::Image::Manifest::ImageData::Platform, nil]
1254
+ required :platform,
1255
+ -> { DockerEngineAPI::Image::Manifest::ImageData::Platform },
1256
+ api_name: :Platform,
1257
+ nil?: true
1258
+
1259
+ # @!attribute size
1260
+ #
1261
+ # @return [DockerEngineAPI::Models::Image::Manifest::ImageData::Size]
1262
+ required :size, -> { DockerEngineAPI::Image::Manifest::ImageData::Size }, api_name: :Size
1263
+
1264
+ # @!method initialize(containers:, platform:, size:)
1265
+ # Some parameter documentations has been truncated, see
1266
+ # {DockerEngineAPI::Models::Image::Manifest::ImageData} for more details.
1267
+ #
1268
+ # The image data for the image manifest. This field is only populated when Kind is
1269
+ # "image".
1270
+ #
1271
+ # @param containers [Array<String>] The IDs of the containers that are using this image.
1272
+ #
1273
+ # @param platform [DockerEngineAPI::Models::Image::Manifest::ImageData::Platform, nil] Describes the platform which the image in the manifest runs on, as defined
1274
+ #
1275
+ # @param size [DockerEngineAPI::Models::Image::Manifest::ImageData::Size]
1276
+
1277
+ # @see DockerEngineAPI::Models::Image::Manifest::ImageData#platform
1278
+ class Platform < DockerEngineAPI::Internal::Type::BaseModel
1279
+ # @!attribute architecture
1280
+ # The CPU architecture, for example `amd64` or `ppc64`.
1281
+ #
1282
+ # @return [String, nil]
1283
+ optional :architecture, String
1284
+
1285
+ # @!attribute os
1286
+ # The operating system, for example `linux` or `windows`.
1287
+ #
1288
+ # @return [String, nil]
1289
+ optional :os, String
1290
+
1291
+ # @!attribute os_features
1292
+ # Optional field specifying an array of strings, each listing a required OS
1293
+ # feature (for example on Windows `win32k`).
1294
+ #
1295
+ # @return [Array<String>, nil]
1296
+ optional :os_features, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :"os.features"
1297
+
1298
+ # @!attribute os_version
1299
+ # Optional field specifying the operating system version, for example on Windows
1300
+ # `10.0.19041.1165`.
1301
+ #
1302
+ # @return [String, nil]
1303
+ optional :os_version, String, api_name: :"os.version"
1304
+
1305
+ # @!attribute variant
1306
+ # Optional field specifying a variant of the CPU, for example `v7` to specify
1307
+ # ARMv7 when architecture is `arm`.
1308
+ #
1309
+ # @return [String, nil]
1310
+ optional :variant, String
1311
+
1312
+ # @!method initialize(architecture: nil, os: nil, os_features: nil, os_version: nil, variant: nil)
1313
+ # Some parameter documentations has been truncated, see
1314
+ # {DockerEngineAPI::Models::Image::Manifest::ImageData::Platform} for more
1315
+ # details.
1316
+ #
1317
+ # Describes the platform which the image in the manifest runs on, as defined in
1318
+ # the
1319
+ # [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
1320
+ #
1321
+ # @param architecture [String] The CPU architecture, for example `amd64` or `ppc64`.
1322
+ #
1323
+ # @param os [String] The operating system, for example `linux` or `windows`.
1324
+ #
1325
+ # @param os_features [Array<String>] Optional field specifying an array of strings, each listing a required
1326
+ #
1327
+ # @param os_version [String] Optional field specifying the operating system version, for example on
1328
+ #
1329
+ # @param variant [String] Optional field specifying a variant of the CPU, for example `v7` to
1330
+ end
1331
+
1332
+ # @see DockerEngineAPI::Models::Image::Manifest::ImageData#size
1333
+ class Size < DockerEngineAPI::Internal::Type::BaseModel
1334
+ # @!attribute unpacked
1335
+ # Unpacked is the size (in bytes) of the locally unpacked (uncompressed) image
1336
+ # content that's directly usable by the containers running this image. It's
1337
+ # independent of the distributable content - e.g. the image might still have an
1338
+ # unpacked data that's still used by some container even when the
1339
+ # distributable/compressed content is already gone.
1340
+ #
1341
+ # @return [Integer]
1342
+ required :unpacked, Integer, api_name: :Unpacked
1343
+
1344
+ # @!method initialize(unpacked:)
1345
+ # Some parameter documentations has been truncated, see
1346
+ # {DockerEngineAPI::Models::Image::Manifest::ImageData::Size} for more details.
1347
+ #
1348
+ # @param unpacked [Integer] Unpacked is the size (in bytes) of the locally unpacked
1349
+ end
1350
+ end
1351
+ end
1352
+
1353
+ # @see DockerEngineAPI::Models::Image#metadata
1354
+ class Metadata < DockerEngineAPI::Internal::Type::BaseModel
1355
+ # @!attribute last_tag_time
1356
+ # Date and time at which the image was last tagged in
1357
+ # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
1358
+ #
1359
+ # This information is only available if the image was tagged locally, and omitted
1360
+ # otherwise.
1361
+ #
1362
+ # @return [String, nil]
1363
+ optional :last_tag_time, String, api_name: :LastTagTime, nil?: true
1364
+
1365
+ # @!method initialize(last_tag_time: nil)
1366
+ # Some parameter documentations has been truncated, see
1367
+ # {DockerEngineAPI::Models::Image::Metadata} for more details.
1368
+ #
1369
+ # Additional metadata of the image in the local cache. This information is local
1370
+ # to the daemon, and not part of the image itself.
1371
+ #
1372
+ # @param last_tag_time [String, nil] Date and time at which the image was last tagged in
1373
+ end
1374
+
1375
+ # @see DockerEngineAPI::Models::Image#root_fs
1376
+ class RootFs < DockerEngineAPI::Internal::Type::BaseModel
1377
+ # @!attribute type
1378
+ #
1379
+ # @return [String]
1380
+ required :type, String, api_name: :Type
1381
+
1382
+ # @!attribute layers
1383
+ #
1384
+ # @return [Array<String>, nil]
1385
+ optional :layers, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :Layers
1386
+
1387
+ # @!method initialize(type:, layers: nil)
1388
+ # Information about the image's RootFS, including the layer IDs.
1389
+ #
1390
+ # @param type [String]
1391
+ # @param layers [Array<String>]
1392
+ end
1393
+ end
1394
+ end
1395
+ end