docker-engine-ruby 0.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (608) hide show
  1. checksums.yaml +7 -0
  2. data/.ignore +2 -0
  3. data/CHANGELOG.md +41 -0
  4. data/README.md +232 -0
  5. data/SECURITY.md +27 -0
  6. data/lib/docker_engine_ruby/client.rb +109 -0
  7. data/lib/docker_engine_ruby/errors.rb +228 -0
  8. data/lib/docker_engine_ruby/file_part.rb +58 -0
  9. data/lib/docker_engine_ruby/internal/transport/base_client.rb +573 -0
  10. data/lib/docker_engine_ruby/internal/transport/pooled_net_requester.rb +210 -0
  11. data/lib/docker_engine_ruby/internal/type/array_of.rb +168 -0
  12. data/lib/docker_engine_ruby/internal/type/base_model.rb +534 -0
  13. data/lib/docker_engine_ruby/internal/type/base_page.rb +55 -0
  14. data/lib/docker_engine_ruby/internal/type/boolean.rb +77 -0
  15. data/lib/docker_engine_ruby/internal/type/converter.rb +327 -0
  16. data/lib/docker_engine_ruby/internal/type/enum.rb +133 -0
  17. data/lib/docker_engine_ruby/internal/type/file_input.rb +111 -0
  18. data/lib/docker_engine_ruby/internal/type/hash_of.rb +188 -0
  19. data/lib/docker_engine_ruby/internal/type/request_parameters.rb +42 -0
  20. data/lib/docker_engine_ruby/internal/type/union.rb +245 -0
  21. data/lib/docker_engine_ruby/internal/type/unknown.rb +81 -0
  22. data/lib/docker_engine_ruby/internal/util.rb +920 -0
  23. data/lib/docker_engine_ruby/internal.rb +20 -0
  24. data/lib/docker_engine_ruby/models/auth_login_params.rb +32 -0
  25. data/lib/docker_engine_ruby/models/auth_response.rb +27 -0
  26. data/lib/docker_engine_ruby/models/config.rb +307 -0
  27. data/lib/docker_engine_ruby/models/config_create_params.rb +24 -0
  28. data/lib/docker_engine_ruby/models/config_create_response.rb +19 -0
  29. data/lib/docker_engine_ruby/models/config_delete_params.rb +14 -0
  30. data/lib/docker_engine_ruby/models/config_inspect_params.rb +14 -0
  31. data/lib/docker_engine_ruby/models/config_list_params.rb +33 -0
  32. data/lib/docker_engine_ruby/models/config_list_response.rb +8 -0
  33. data/lib/docker_engine_ruby/models/config_update_params.rb +26 -0
  34. data/lib/docker_engine_ruby/models/connect_request.rb +198 -0
  35. data/lib/docker_engine_ruby/models/container.rb +2516 -0
  36. data/lib/docker_engine_ruby/models/container_archive_params.rb +22 -0
  37. data/lib/docker_engine_ruby/models/container_attach_params.rb +73 -0
  38. data/lib/docker_engine_ruby/models/container_changes_params.rb +14 -0
  39. data/lib/docker_engine_ruby/models/container_changes_response.rb +9 -0
  40. data/lib/docker_engine_ruby/models/container_create_params.rb +1724 -0
  41. data/lib/docker_engine_ruby/models/container_delete_params.rb +38 -0
  42. data/lib/docker_engine_ruby/models/container_exec_params.rb +111 -0
  43. data/lib/docker_engine_ruby/models/container_exec_response.rb +19 -0
  44. data/lib/docker_engine_ruby/models/container_export_params.rb +14 -0
  45. data/lib/docker_engine_ruby/models/container_inspect_params.rb +22 -0
  46. data/lib/docker_engine_ruby/models/container_kill_params.rb +25 -0
  47. data/lib/docker_engine_ruby/models/container_list_params.rb +70 -0
  48. data/lib/docker_engine_ruby/models/container_list_response.rb +8 -0
  49. data/lib/docker_engine_ruby/models/container_logs_params.rb +74 -0
  50. data/lib/docker_engine_ruby/models/container_pause_params.rb +14 -0
  51. data/lib/docker_engine_ruby/models/container_prune_params.rb +35 -0
  52. data/lib/docker_engine_ruby/models/container_prune_response.rb +27 -0
  53. data/lib/docker_engine_ruby/models/container_rename_params.rb +22 -0
  54. data/lib/docker_engine_ruby/models/container_resize_params.rb +30 -0
  55. data/lib/docker_engine_ruby/models/container_restart_params.rb +33 -0
  56. data/lib/docker_engine_ruby/models/container_start_params.rb +27 -0
  57. data/lib/docker_engine_ruby/models/container_stats_params.rb +35 -0
  58. data/lib/docker_engine_ruby/models/container_stop_params.rb +33 -0
  59. data/lib/docker_engine_ruby/models/container_top_params.rb +22 -0
  60. data/lib/docker_engine_ruby/models/container_unpause_params.rb +14 -0
  61. data/lib/docker_engine_ruby/models/container_update_params.rb +606 -0
  62. data/lib/docker_engine_ruby/models/container_wait_params.rb +41 -0
  63. data/lib/docker_engine_ruby/models/create_request.rb +348 -0
  64. data/lib/docker_engine_ruby/models/create_response.rb +27 -0
  65. data/lib/docker_engine_ruby/models/delete_item.rb +24 -0
  66. data/lib/docker_engine_ruby/models/disconnect_request.rb +27 -0
  67. data/lib/docker_engine_ruby/models/distribution_inspect_params.rb +14 -0
  68. data/lib/docker_engine_ruby/models/error.rb +18 -0
  69. data/lib/docker_engine_ruby/models/exec_inspect_params.rb +14 -0
  70. data/lib/docker_engine_ruby/models/exec_inspect_response.rb +87 -0
  71. data/lib/docker_engine_ruby/models/exec_resize_params.rb +30 -0
  72. data/lib/docker_engine_ruby/models/exec_start_params.rb +41 -0
  73. data/lib/docker_engine_ruby/models/filesystem_change.rb +55 -0
  74. data/lib/docker_engine_ruby/models/history_item.rb +47 -0
  75. data/lib/docker_engine_ruby/models/image.rb +1393 -0
  76. data/lib/docker_engine_ruby/models/image_build_params.rb +283 -0
  77. data/lib/docker_engine_ruby/models/image_build_prune_params.rb +71 -0
  78. data/lib/docker_engine_ruby/models/image_build_prune_response.rb +24 -0
  79. data/lib/docker_engine_ruby/models/image_commit_params.rb +70 -0
  80. data/lib/docker_engine_ruby/models/image_commit_response.rb +19 -0
  81. data/lib/docker_engine_ruby/models/image_delete_params.rb +43 -0
  82. data/lib/docker_engine_ruby/models/image_delete_response.rb +8 -0
  83. data/lib/docker_engine_ruby/models/image_get_all_params.rb +37 -0
  84. data/lib/docker_engine_ruby/models/image_get_params.rb +29 -0
  85. data/lib/docker_engine_ruby/models/image_history_params.rb +34 -0
  86. data/lib/docker_engine_ruby/models/image_history_response.rb +8 -0
  87. data/lib/docker_engine_ruby/models/image_inspect_params.rb +22 -0
  88. data/lib/docker_engine_ruby/models/image_list_params.rb +68 -0
  89. data/lib/docker_engine_ruby/models/image_list_response.rb +8 -0
  90. data/lib/docker_engine_ruby/models/image_load_params.rb +44 -0
  91. data/lib/docker_engine_ruby/models/image_prune_params.rb +35 -0
  92. data/lib/docker_engine_ruby/models/image_prune_response.rb +27 -0
  93. data/lib/docker_engine_ruby/models/image_pull_params.rb +115 -0
  94. data/lib/docker_engine_ruby/models/image_push_params.rb +49 -0
  95. data/lib/docker_engine_ruby/models/image_search_params.rb +45 -0
  96. data/lib/docker_engine_ruby/models/image_search_response.rb +55 -0
  97. data/lib/docker_engine_ruby/models/image_tag_params.rb +30 -0
  98. data/lib/docker_engine_ruby/models/info.rb +1496 -0
  99. data/lib/docker_engine_ruby/models/inspect.rb +221 -0
  100. data/lib/docker_engine_ruby/models/inspect_response.rb +39 -0
  101. data/lib/docker_engine_ruby/models/list_response.rb +32 -0
  102. data/lib/docker_engine_ruby/models/network.rb +253 -0
  103. data/lib/docker_engine_ruby/models/network_connect_params.rb +14 -0
  104. data/lib/docker_engine_ruby/models/network_create_params.rb +210 -0
  105. data/lib/docker_engine_ruby/models/network_delete_params.rb +14 -0
  106. data/lib/docker_engine_ruby/models/network_disconnect_params.rb +14 -0
  107. data/lib/docker_engine_ruby/models/network_inspect_params.rb +30 -0
  108. data/lib/docker_engine_ruby/models/network_inspect_response.rb +131 -0
  109. data/lib/docker_engine_ruby/models/network_list_params.rb +40 -0
  110. data/lib/docker_engine_ruby/models/network_list_response.rb +8 -0
  111. data/lib/docker_engine_ruby/models/network_prune_params.rb +35 -0
  112. data/lib/docker_engine_ruby/models/network_prune_response.rb +19 -0
  113. data/lib/docker_engine_ruby/models/node.rb +461 -0
  114. data/lib/docker_engine_ruby/models/node_delete_params.rb +22 -0
  115. data/lib/docker_engine_ruby/models/node_inspect_params.rb +14 -0
  116. data/lib/docker_engine_ruby/models/node_list_params.rb +34 -0
  117. data/lib/docker_engine_ruby/models/node_list_response.rb +8 -0
  118. data/lib/docker_engine_ruby/models/node_update_params.rb +26 -0
  119. data/lib/docker_engine_ruby/models/plugin.rb +532 -0
  120. data/lib/docker_engine_ruby/models/plugin_create_params.rb +33 -0
  121. data/lib/docker_engine_ruby/models/plugin_delete_params.rb +26 -0
  122. data/lib/docker_engine_ruby/models/plugin_disable_params.rb +25 -0
  123. data/lib/docker_engine_ruby/models/plugin_enable_params.rb +22 -0
  124. data/lib/docker_engine_ruby/models/plugin_inspect_params.rb +14 -0
  125. data/lib/docker_engine_ruby/models/plugin_list_params.rb +31 -0
  126. data/lib/docker_engine_ruby/models/plugin_list_response.rb +8 -0
  127. data/lib/docker_engine_ruby/models/plugin_privileges_params.rb +26 -0
  128. data/lib/docker_engine_ruby/models/plugin_privileges_response.rb +8 -0
  129. data/lib/docker_engine_ruby/models/plugin_pull_params.rb +51 -0
  130. data/lib/docker_engine_ruby/models/plugin_push_params.rb +14 -0
  131. data/lib/docker_engine_ruby/models/plugin_set_params.rb +20 -0
  132. data/lib/docker_engine_ruby/models/plugin_upgrade_params.rb +41 -0
  133. data/lib/docker_engine_ruby/models/privilege.rb +29 -0
  134. data/lib/docker_engine_ruby/models/secret.rb +77 -0
  135. data/lib/docker_engine_ruby/models/secret_create_params.rb +24 -0
  136. data/lib/docker_engine_ruby/models/secret_create_response.rb +19 -0
  137. data/lib/docker_engine_ruby/models/secret_delete_params.rb +14 -0
  138. data/lib/docker_engine_ruby/models/secret_inspect_params.rb +14 -0
  139. data/lib/docker_engine_ruby/models/secret_list_params.rb +33 -0
  140. data/lib/docker_engine_ruby/models/secret_list_response.rb +8 -0
  141. data/lib/docker_engine_ruby/models/secret_update_params.rb +26 -0
  142. data/lib/docker_engine_ruby/models/service.rb +522 -0
  143. data/lib/docker_engine_ruby/models/service_create_params.rb +34 -0
  144. data/lib/docker_engine_ruby/models/service_delete_params.rb +14 -0
  145. data/lib/docker_engine_ruby/models/service_inspect_params.rb +22 -0
  146. data/lib/docker_engine_ruby/models/service_list_params.rb +41 -0
  147. data/lib/docker_engine_ruby/models/service_list_response.rb +8 -0
  148. data/lib/docker_engine_ruby/models/service_logs_params.rb +74 -0
  149. data/lib/docker_engine_ruby/models/service_update_params.rb +78 -0
  150. data/lib/docker_engine_ruby/models/spec.rb +510 -0
  151. data/lib/docker_engine_ruby/models/stats_response.rb +954 -0
  152. data/lib/docker_engine_ruby/models/summary.rb +771 -0
  153. data/lib/docker_engine_ruby/models/swarm.rb +198 -0
  154. data/lib/docker_engine_ruby/models/swarm_init_params.rb +101 -0
  155. data/lib/docker_engine_ruby/models/swarm_init_response.rb +7 -0
  156. data/lib/docker_engine_ruby/models/swarm_inspect_params.rb +14 -0
  157. data/lib/docker_engine_ruby/models/swarm_join_params.rb +70 -0
  158. data/lib/docker_engine_ruby/models/swarm_leave_params.rb +26 -0
  159. data/lib/docker_engine_ruby/models/swarm_unlock_key_params.rb +14 -0
  160. data/lib/docker_engine_ruby/models/swarm_unlock_key_response.rb +17 -0
  161. data/lib/docker_engine_ruby/models/swarm_unlock_params.rb +22 -0
  162. data/lib/docker_engine_ruby/models/swarm_update_params.rb +50 -0
  163. data/lib/docker_engine_ruby/models/system_data_usage_params.rb +46 -0
  164. data/lib/docker_engine_ruby/models/system_data_usage_response.rb +260 -0
  165. data/lib/docker_engine_ruby/models/system_events_params.rb +58 -0
  166. data/lib/docker_engine_ruby/models/system_events_response.rb +126 -0
  167. data/lib/docker_engine_ruby/models/system_info_params.rb +14 -0
  168. data/lib/docker_engine_ruby/models/system_ping_params.rb +14 -0
  169. data/lib/docker_engine_ruby/models/system_ping_response.rb +7 -0
  170. data/lib/docker_engine_ruby/models/system_version_params.rb +14 -0
  171. data/lib/docker_engine_ruby/models/task.rb +471 -0
  172. data/lib/docker_engine_ruby/models/task_inspect_params.rb +14 -0
  173. data/lib/docker_engine_ruby/models/task_list_params.rb +35 -0
  174. data/lib/docker_engine_ruby/models/task_list_response.rb +8 -0
  175. data/lib/docker_engine_ruby/models/task_logs_params.rb +74 -0
  176. data/lib/docker_engine_ruby/models/top_response.rb +33 -0
  177. data/lib/docker_engine_ruby/models/update_response.rb +19 -0
  178. data/lib/docker_engine_ruby/models/version.rb +164 -0
  179. data/lib/docker_engine_ruby/models/volume.rb +651 -0
  180. data/lib/docker_engine_ruby/models/volume_create_params.rb +14 -0
  181. data/lib/docker_engine_ruby/models/volume_delete_params.rb +22 -0
  182. data/lib/docker_engine_ruby/models/volume_inspect_params.rb +14 -0
  183. data/lib/docker_engine_ruby/models/volume_list_params.rb +34 -0
  184. data/lib/docker_engine_ruby/models/volume_prune_params.rb +33 -0
  185. data/lib/docker_engine_ruby/models/volume_prune_response.rb +25 -0
  186. data/lib/docker_engine_ruby/models/volume_update_params.rb +323 -0
  187. data/lib/docker_engine_ruby/models/wait_response.rb +41 -0
  188. data/lib/docker_engine_ruby/models.rb +312 -0
  189. data/lib/docker_engine_ruby/request_options.rb +78 -0
  190. data/lib/docker_engine_ruby/resources/auth.rb +38 -0
  191. data/lib/docker_engine_ruby/resources/configs.rb +130 -0
  192. data/lib/docker_engine_ruby/resources/containers.rb +854 -0
  193. data/lib/docker_engine_ruby/resources/distribution.rb +34 -0
  194. data/lib/docker_engine_ruby/resources/exec.rb +91 -0
  195. data/lib/docker_engine_ruby/resources/images.rb +676 -0
  196. data/lib/docker_engine_ruby/resources/networks.rb +218 -0
  197. data/lib/docker_engine_ruby/resources/nodes.rb +113 -0
  198. data/lib/docker_engine_ruby/resources/plugins.rb +317 -0
  199. data/lib/docker_engine_ruby/resources/secrets.rb +130 -0
  200. data/lib/docker_engine_ruby/resources/services.rb +195 -0
  201. data/lib/docker_engine_ruby/resources/swarm.rb +183 -0
  202. data/lib/docker_engine_ruby/resources/system.rb +155 -0
  203. data/lib/docker_engine_ruby/resources/tasks.rb +103 -0
  204. data/lib/docker_engine_ruby/resources/volumes.rb +161 -0
  205. data/lib/docker_engine_ruby/version.rb +5 -0
  206. data/lib/docker_engine_ruby.rb +234 -0
  207. data/manifest.yaml +17 -0
  208. data/rbi/docker_engine_ruby/client.rbi +80 -0
  209. data/rbi/docker_engine_ruby/errors.rbi +205 -0
  210. data/rbi/docker_engine_ruby/file_part.rbi +37 -0
  211. data/rbi/docker_engine_ruby/internal/transport/base_client.rbi +305 -0
  212. data/rbi/docker_engine_ruby/internal/transport/pooled_net_requester.rbi +84 -0
  213. data/rbi/docker_engine_ruby/internal/type/array_of.rbi +108 -0
  214. data/rbi/docker_engine_ruby/internal/type/base_model.rbi +316 -0
  215. data/rbi/docker_engine_ruby/internal/type/base_page.rbi +43 -0
  216. data/rbi/docker_engine_ruby/internal/type/boolean.rbi +58 -0
  217. data/rbi/docker_engine_ruby/internal/type/converter.rbi +225 -0
  218. data/rbi/docker_engine_ruby/internal/type/enum.rbi +82 -0
  219. data/rbi/docker_engine_ruby/internal/type/file_input.rbi +59 -0
  220. data/rbi/docker_engine_ruby/internal/type/hash_of.rbi +108 -0
  221. data/rbi/docker_engine_ruby/internal/type/request_parameters.rbi +31 -0
  222. data/rbi/docker_engine_ruby/internal/type/union.rbi +134 -0
  223. data/rbi/docker_engine_ruby/internal/type/unknown.rbi +58 -0
  224. data/rbi/docker_engine_ruby/internal/util.rbi +487 -0
  225. data/rbi/docker_engine_ruby/internal.rbi +18 -0
  226. data/rbi/docker_engine_ruby/models/auth_login_params.rbi +65 -0
  227. data/rbi/docker_engine_ruby/models/auth_response.rbi +42 -0
  228. data/rbi/docker_engine_ruby/models/config.rbi +442 -0
  229. data/rbi/docker_engine_ruby/models/config_create_params.rbi +64 -0
  230. data/rbi/docker_engine_ruby/models/config_create_response.rbi +31 -0
  231. data/rbi/docker_engine_ruby/models/config_delete_params.rbi +32 -0
  232. data/rbi/docker_engine_ruby/models/config_inspect_params.rbi +32 -0
  233. data/rbi/docker_engine_ruby/models/config_list_params.rbi +62 -0
  234. data/rbi/docker_engine_ruby/models/config_list_response.rbi +11 -0
  235. data/rbi/docker_engine_ruby/models/config_update_params.rbi +48 -0
  236. data/rbi/docker_engine_ruby/models/connect_request.rbi +343 -0
  237. data/rbi/docker_engine_ruby/models/container.rbi +4672 -0
  238. data/rbi/docker_engine_ruby/models/container_archive_params.rbi +43 -0
  239. data/rbi/docker_engine_ruby/models/container_attach_params.rbi +120 -0
  240. data/rbi/docker_engine_ruby/models/container_changes_params.rbi +32 -0
  241. data/rbi/docker_engine_ruby/models/container_changes_response.rbi +13 -0
  242. data/rbi/docker_engine_ruby/models/container_create_params.rbi +3301 -0
  243. data/rbi/docker_engine_ruby/models/container_delete_params.rbi +71 -0
  244. data/rbi/docker_engine_ruby/models/container_exec_params.rbi +162 -0
  245. data/rbi/docker_engine_ruby/models/container_exec_response.rbi +31 -0
  246. data/rbi/docker_engine_ruby/models/container_export_params.rbi +32 -0
  247. data/rbi/docker_engine_ruby/models/container_inspect_params.rbi +49 -0
  248. data/rbi/docker_engine_ruby/models/container_kill_params.rbi +46 -0
  249. data/rbi/docker_engine_ruby/models/container_list_params.rbi +124 -0
  250. data/rbi/docker_engine_ruby/models/container_list_response.rbi +11 -0
  251. data/rbi/docker_engine_ruby/models/container_logs_params.rbi +117 -0
  252. data/rbi/docker_engine_ruby/models/container_pause_params.rbi +32 -0
  253. data/rbi/docker_engine_ruby/models/container_prune_params.rbi +66 -0
  254. data/rbi/docker_engine_ruby/models/container_prune_response.rbi +51 -0
  255. data/rbi/docker_engine_ruby/models/container_rename_params.rbi +43 -0
  256. data/rbi/docker_engine_ruby/models/container_resize_params.rbi +54 -0
  257. data/rbi/docker_engine_ruby/models/container_restart_params.rbi +60 -0
  258. data/rbi/docker_engine_ruby/models/container_start_params.rbi +53 -0
  259. data/rbi/docker_engine_ruby/models/container_stats_params.rbi +64 -0
  260. data/rbi/docker_engine_ruby/models/container_stop_params.rbi +60 -0
  261. data/rbi/docker_engine_ruby/models/container_top_params.rbi +46 -0
  262. data/rbi/docker_engine_ruby/models/container_unpause_params.rbi +32 -0
  263. data/rbi/docker_engine_ruby/models/container_update_params.rbi +1125 -0
  264. data/rbi/docker_engine_ruby/models/container_wait_params.rbi +101 -0
  265. data/rbi/docker_engine_ruby/models/create_request.rbi +708 -0
  266. data/rbi/docker_engine_ruby/models/create_response.rbi +39 -0
  267. data/rbi/docker_engine_ruby/models/delete_item.rbi +44 -0
  268. data/rbi/docker_engine_ruby/models/disconnect_request.rbi +43 -0
  269. data/rbi/docker_engine_ruby/models/distribution_inspect_params.rbi +32 -0
  270. data/rbi/docker_engine_ruby/models/error.rbi +28 -0
  271. data/rbi/docker_engine_ruby/models/exec_inspect_params.rbi +32 -0
  272. data/rbi/docker_engine_ruby/models/exec_inspect_response.rbi +135 -0
  273. data/rbi/docker_engine_ruby/models/exec_resize_params.rbi +54 -0
  274. data/rbi/docker_engine_ruby/models/exec_start_params.rbi +68 -0
  275. data/rbi/docker_engine_ruby/models/filesystem_change.rbi +93 -0
  276. data/rbi/docker_engine_ruby/models/history_item.rbi +62 -0
  277. data/rbi/docker_engine_ruby/models/image.rbi +2359 -0
  278. data/rbi/docker_engine_ruby/models/image_build_params.rbi +436 -0
  279. data/rbi/docker_engine_ruby/models/image_build_prune_params.rbi +121 -0
  280. data/rbi/docker_engine_ruby/models/image_build_prune_response.rbi +49 -0
  281. data/rbi/docker_engine_ruby/models/image_commit_params.rbi +115 -0
  282. data/rbi/docker_engine_ruby/models/image_commit_response.rbi +31 -0
  283. data/rbi/docker_engine_ruby/models/image_delete_params.rbi +75 -0
  284. data/rbi/docker_engine_ruby/models/image_delete_response.rbi +11 -0
  285. data/rbi/docker_engine_ruby/models/image_get_all_params.rbi +68 -0
  286. data/rbi/docker_engine_ruby/models/image_get_params.rbi +57 -0
  287. data/rbi/docker_engine_ruby/models/image_history_params.rbi +67 -0
  288. data/rbi/docker_engine_ruby/models/image_history_response.rbi +13 -0
  289. data/rbi/docker_engine_ruby/models/image_inspect_params.rbi +49 -0
  290. data/rbi/docker_engine_ruby/models/image_list_params.rbi +115 -0
  291. data/rbi/docker_engine_ruby/models/image_list_response.rbi +11 -0
  292. data/rbi/docker_engine_ruby/models/image_load_params.rbi +74 -0
  293. data/rbi/docker_engine_ruby/models/image_prune_params.rbi +66 -0
  294. data/rbi/docker_engine_ruby/models/image_prune_response.rbi +58 -0
  295. data/rbi/docker_engine_ruby/models/image_pull_params.rbi +189 -0
  296. data/rbi/docker_engine_ruby/models/image_push_params.rbi +84 -0
  297. data/rbi/docker_engine_ruby/models/image_search_params.rbi +76 -0
  298. data/rbi/docker_engine_ruby/models/image_search_response.rbi +95 -0
  299. data/rbi/docker_engine_ruby/models/image_tag_params.rbi +60 -0
  300. data/rbi/docker_engine_ruby/models/info.rbi +2574 -0
  301. data/rbi/docker_engine_ruby/models/inspect.rbi +361 -0
  302. data/rbi/docker_engine_ruby/models/inspect_response.rbi +77 -0
  303. data/rbi/docker_engine_ruby/models/list_response.rbi +55 -0
  304. data/rbi/docker_engine_ruby/models/network.rbi +427 -0
  305. data/rbi/docker_engine_ruby/models/network_connect_params.rbi +32 -0
  306. data/rbi/docker_engine_ruby/models/network_create_params.rbi +374 -0
  307. data/rbi/docker_engine_ruby/models/network_delete_params.rbi +32 -0
  308. data/rbi/docker_engine_ruby/models/network_disconnect_params.rbi +32 -0
  309. data/rbi/docker_engine_ruby/models/network_inspect_params.rbi +60 -0
  310. data/rbi/docker_engine_ruby/models/network_inspect_response.rbi +336 -0
  311. data/rbi/docker_engine_ruby/models/network_list_params.rbi +76 -0
  312. data/rbi/docker_engine_ruby/models/network_list_response.rbi +11 -0
  313. data/rbi/docker_engine_ruby/models/network_prune_params.rbi +66 -0
  314. data/rbi/docker_engine_ruby/models/network_prune_response.rbi +35 -0
  315. data/rbi/docker_engine_ruby/models/node.rbi +915 -0
  316. data/rbi/docker_engine_ruby/models/node_delete_params.rbi +49 -0
  317. data/rbi/docker_engine_ruby/models/node_inspect_params.rbi +32 -0
  318. data/rbi/docker_engine_ruby/models/node_list_params.rbi +64 -0
  319. data/rbi/docker_engine_ruby/models/node_list_response.rbi +11 -0
  320. data/rbi/docker_engine_ruby/models/node_update_params.rbi +48 -0
  321. data/rbi/docker_engine_ruby/models/plugin.rbi +843 -0
  322. data/rbi/docker_engine_ruby/models/plugin_create_params.rbi +54 -0
  323. data/rbi/docker_engine_ruby/models/plugin_delete_params.rbi +51 -0
  324. data/rbi/docker_engine_ruby/models/plugin_disable_params.rbi +49 -0
  325. data/rbi/docker_engine_ruby/models/plugin_enable_params.rbi +49 -0
  326. data/rbi/docker_engine_ruby/models/plugin_inspect_params.rbi +32 -0
  327. data/rbi/docker_engine_ruby/models/plugin_list_params.rbi +58 -0
  328. data/rbi/docker_engine_ruby/models/plugin_list_response.rbi +11 -0
  329. data/rbi/docker_engine_ruby/models/plugin_privileges_params.rbi +45 -0
  330. data/rbi/docker_engine_ruby/models/plugin_privileges_response.rbi +11 -0
  331. data/rbi/docker_engine_ruby/models/plugin_pull_params.rbi +83 -0
  332. data/rbi/docker_engine_ruby/models/plugin_push_params.rbi +32 -0
  333. data/rbi/docker_engine_ruby/models/plugin_set_params.rbi +44 -0
  334. data/rbi/docker_engine_ruby/models/plugin_upgrade_params.rbi +68 -0
  335. data/rbi/docker_engine_ruby/models/privilege.rbi +52 -0
  336. data/rbi/docker_engine_ruby/models/secret.rbi +125 -0
  337. data/rbi/docker_engine_ruby/models/secret_create_params.rbi +64 -0
  338. data/rbi/docker_engine_ruby/models/secret_create_response.rbi +31 -0
  339. data/rbi/docker_engine_ruby/models/secret_delete_params.rbi +32 -0
  340. data/rbi/docker_engine_ruby/models/secret_inspect_params.rbi +32 -0
  341. data/rbi/docker_engine_ruby/models/secret_list_params.rbi +62 -0
  342. data/rbi/docker_engine_ruby/models/secret_list_response.rbi +11 -0
  343. data/rbi/docker_engine_ruby/models/secret_update_params.rbi +48 -0
  344. data/rbi/docker_engine_ruby/models/service.rbi +1100 -0
  345. data/rbi/docker_engine_ruby/models/service_create_params.rbi +79 -0
  346. data/rbi/docker_engine_ruby/models/service_delete_params.rbi +32 -0
  347. data/rbi/docker_engine_ruby/models/service_inspect_params.rbi +49 -0
  348. data/rbi/docker_engine_ruby/models/service_list_params.rbi +76 -0
  349. data/rbi/docker_engine_ruby/models/service_list_response.rbi +11 -0
  350. data/rbi/docker_engine_ruby/models/service_logs_params.rbi +117 -0
  351. data/rbi/docker_engine_ruby/models/service_update_params.rbi +168 -0
  352. data/rbi/docker_engine_ruby/models/spec.rbi +1037 -0
  353. data/rbi/docker_engine_ruby/models/stats_response.rbi +1775 -0
  354. data/rbi/docker_engine_ruby/models/summary.rbi +1342 -0
  355. data/rbi/docker_engine_ruby/models/swarm.rbi +315 -0
  356. data/rbi/docker_engine_ruby/models/swarm_init_params.rbi +162 -0
  357. data/rbi/docker_engine_ruby/models/swarm_init_response.rbi +7 -0
  358. data/rbi/docker_engine_ruby/models/swarm_inspect_params.rbi +32 -0
  359. data/rbi/docker_engine_ruby/models/swarm_join_params.rbi +119 -0
  360. data/rbi/docker_engine_ruby/models/swarm_leave_params.rbi +51 -0
  361. data/rbi/docker_engine_ruby/models/swarm_unlock_key_params.rbi +32 -0
  362. data/rbi/docker_engine_ruby/models/swarm_unlock_key_response.rbi +33 -0
  363. data/rbi/docker_engine_ruby/models/swarm_unlock_params.rbi +49 -0
  364. data/rbi/docker_engine_ruby/models/swarm_update_params.rbi +81 -0
  365. data/rbi/docker_engine_ruby/models/system_data_usage_params.rbi +114 -0
  366. data/rbi/docker_engine_ruby/models/system_data_usage_response.rbi +460 -0
  367. data/rbi/docker_engine_ruby/models/system_events_params.rbi +105 -0
  368. data/rbi/docker_engine_ruby/models/system_events_response.rbi +289 -0
  369. data/rbi/docker_engine_ruby/models/system_info_params.rbi +32 -0
  370. data/rbi/docker_engine_ruby/models/system_ping_params.rbi +32 -0
  371. data/rbi/docker_engine_ruby/models/system_ping_response.rbi +7 -0
  372. data/rbi/docker_engine_ruby/models/system_version_params.rbi +32 -0
  373. data/rbi/docker_engine_ruby/models/task.rbi +948 -0
  374. data/rbi/docker_engine_ruby/models/task_inspect_params.rbi +32 -0
  375. data/rbi/docker_engine_ruby/models/task_list_params.rbi +66 -0
  376. data/rbi/docker_engine_ruby/models/task_list_response.rbi +11 -0
  377. data/rbi/docker_engine_ruby/models/task_logs_params.rbi +117 -0
  378. data/rbi/docker_engine_ruby/models/top_response.rbi +54 -0
  379. data/rbi/docker_engine_ruby/models/update_response.rbi +34 -0
  380. data/rbi/docker_engine_ruby/models/version.rbi +256 -0
  381. data/rbi/docker_engine_ruby/models/volume.rbi +1236 -0
  382. data/rbi/docker_engine_ruby/models/volume_create_params.rbi +32 -0
  383. data/rbi/docker_engine_ruby/models/volume_delete_params.rbi +49 -0
  384. data/rbi/docker_engine_ruby/models/volume_inspect_params.rbi +32 -0
  385. data/rbi/docker_engine_ruby/models/volume_list_params.rbi +64 -0
  386. data/rbi/docker_engine_ruby/models/volume_prune_params.rbi +62 -0
  387. data/rbi/docker_engine_ruby/models/volume_prune_response.rbi +51 -0
  388. data/rbi/docker_engine_ruby/models/volume_update_params.rbi +668 -0
  389. data/rbi/docker_engine_ruby/models/wait_response.rbi +78 -0
  390. data/rbi/docker_engine_ruby/models.rbi +272 -0
  391. data/rbi/docker_engine_ruby/request_options.rbi +64 -0
  392. data/rbi/docker_engine_ruby/resources/auth.rbi +30 -0
  393. data/rbi/docker_engine_ruby/resources/configs.rbi +93 -0
  394. data/rbi/docker_engine_ruby/resources/containers.rbi +843 -0
  395. data/rbi/docker_engine_ruby/resources/distribution.rbi +26 -0
  396. data/rbi/docker_engine_ruby/resources/exec.rbi +72 -0
  397. data/rbi/docker_engine_ruby/resources/images.rbi +739 -0
  398. data/rbi/docker_engine_ruby/resources/networks.rbi +201 -0
  399. data/rbi/docker_engine_ruby/resources/nodes.rbi +87 -0
  400. data/rbi/docker_engine_ruby/resources/plugins.rbi +228 -0
  401. data/rbi/docker_engine_ruby/resources/secrets.rbi +93 -0
  402. data/rbi/docker_engine_ruby/resources/services.rbi +166 -0
  403. data/rbi/docker_engine_ruby/resources/swarm.rbi +178 -0
  404. data/rbi/docker_engine_ruby/resources/system.rbi +123 -0
  405. data/rbi/docker_engine_ruby/resources/tasks.rbi +90 -0
  406. data/rbi/docker_engine_ruby/resources/volumes.rbi +123 -0
  407. data/rbi/docker_engine_ruby/version.rbi +5 -0
  408. data/sig/docker_engine_ruby/client.rbs +49 -0
  409. data/sig/docker_engine_ruby/errors.rbs +117 -0
  410. data/sig/docker_engine_ruby/file_part.rbs +21 -0
  411. data/sig/docker_engine_ruby/internal/transport/base_client.rbs +131 -0
  412. data/sig/docker_engine_ruby/internal/transport/pooled_net_requester.rbs +48 -0
  413. data/sig/docker_engine_ruby/internal/type/array_of.rbs +48 -0
  414. data/sig/docker_engine_ruby/internal/type/base_model.rbs +106 -0
  415. data/sig/docker_engine_ruby/internal/type/base_page.rbs +24 -0
  416. data/sig/docker_engine_ruby/internal/type/boolean.rbs +26 -0
  417. data/sig/docker_engine_ruby/internal/type/converter.rbs +79 -0
  418. data/sig/docker_engine_ruby/internal/type/enum.rbs +32 -0
  419. data/sig/docker_engine_ruby/internal/type/file_input.rbs +25 -0
  420. data/sig/docker_engine_ruby/internal/type/hash_of.rbs +48 -0
  421. data/sig/docker_engine_ruby/internal/type/request_parameters.rbs +20 -0
  422. data/sig/docker_engine_ruby/internal/type/union.rbs +52 -0
  423. data/sig/docker_engine_ruby/internal/type/unknown.rbs +26 -0
  424. data/sig/docker_engine_ruby/internal/util.rbs +185 -0
  425. data/sig/docker_engine_ruby/internal.rbs +10 -0
  426. data/sig/docker_engine_ruby/models/auth_login_params.rbs +38 -0
  427. data/sig/docker_engine_ruby/models/auth_response.rbs +17 -0
  428. data/sig/docker_engine_ruby/models/config.rbs +225 -0
  429. data/sig/docker_engine_ruby/models/config_create_params.rbs +36 -0
  430. data/sig/docker_engine_ruby/models/config_create_response.rbs +13 -0
  431. data/sig/docker_engine_ruby/models/config_delete_params.rbs +15 -0
  432. data/sig/docker_engine_ruby/models/config_inspect_params.rbs +15 -0
  433. data/sig/docker_engine_ruby/models/config_list_params.rbs +25 -0
  434. data/sig/docker_engine_ruby/models/config_list_response.rbs +7 -0
  435. data/sig/docker_engine_ruby/models/config_update_params.rbs +24 -0
  436. data/sig/docker_engine_ruby/models/connect_request.rbs +175 -0
  437. data/sig/docker_engine_ruby/models/container.rbs +1975 -0
  438. data/sig/docker_engine_ruby/models/container_archive_params.rbs +23 -0
  439. data/sig/docker_engine_ruby/models/container_attach_params.rbs +63 -0
  440. data/sig/docker_engine_ruby/models/container_changes_params.rbs +15 -0
  441. data/sig/docker_engine_ruby/models/container_changes_response.rbs +8 -0
  442. data/sig/docker_engine_ruby/models/container_create_params.rbs +1352 -0
  443. data/sig/docker_engine_ruby/models/container_delete_params.rbs +38 -0
  444. data/sig/docker_engine_ruby/models/container_exec_params.rbs +96 -0
  445. data/sig/docker_engine_ruby/models/container_exec_response.rbs +13 -0
  446. data/sig/docker_engine_ruby/models/container_export_params.rbs +15 -0
  447. data/sig/docker_engine_ruby/models/container_inspect_params.rbs +25 -0
  448. data/sig/docker_engine_ruby/models/container_kill_params.rbs +25 -0
  449. data/sig/docker_engine_ruby/models/container_list_params.rbs +44 -0
  450. data/sig/docker_engine_ruby/models/container_list_response.rbs +7 -0
  451. data/sig/docker_engine_ruby/models/container_logs_params.rbs +70 -0
  452. data/sig/docker_engine_ruby/models/container_pause_params.rbs +15 -0
  453. data/sig/docker_engine_ruby/models/container_prune_params.rbs +25 -0
  454. data/sig/docker_engine_ruby/models/container_prune_response.rbs +26 -0
  455. data/sig/docker_engine_ruby/models/container_rename_params.rbs +23 -0
  456. data/sig/docker_engine_ruby/models/container_resize_params.rbs +28 -0
  457. data/sig/docker_engine_ruby/models/container_restart_params.rbs +32 -0
  458. data/sig/docker_engine_ruby/models/container_start_params.rbs +26 -0
  459. data/sig/docker_engine_ruby/models/container_stats_params.rbs +32 -0
  460. data/sig/docker_engine_ruby/models/container_stop_params.rbs +32 -0
  461. data/sig/docker_engine_ruby/models/container_top_params.rbs +25 -0
  462. data/sig/docker_engine_ruby/models/container_unpause_params.rbs +15 -0
  463. data/sig/docker_engine_ruby/models/container_update_params.rbs +476 -0
  464. data/sig/docker_engine_ruby/models/container_wait_params.rbs +40 -0
  465. data/sig/docker_engine_ruby/models/create_request.rbs +255 -0
  466. data/sig/docker_engine_ruby/models/create_response.rbs +15 -0
  467. data/sig/docker_engine_ruby/models/delete_item.rbs +19 -0
  468. data/sig/docker_engine_ruby/models/disconnect_request.rbs +17 -0
  469. data/sig/docker_engine_ruby/models/distribution_inspect_params.rbs +15 -0
  470. data/sig/docker_engine_ruby/models/error.rbs +13 -0
  471. data/sig/docker_engine_ruby/models/exec_inspect_params.rbs +15 -0
  472. data/sig/docker_engine_ruby/models/exec_inspect_response.rbs +94 -0
  473. data/sig/docker_engine_ruby/models/exec_resize_params.rbs +28 -0
  474. data/sig/docker_engine_ruby/models/exec_start_params.rbs +36 -0
  475. data/sig/docker_engine_ruby/models/filesystem_change.rbs +34 -0
  476. data/sig/docker_engine_ruby/models/history_item.rbs +45 -0
  477. data/sig/docker_engine_ruby/models/image.rbs +1042 -0
  478. data/sig/docker_engine_ruby/models/image_build_params.rbs +221 -0
  479. data/sig/docker_engine_ruby/models/image_build_prune_params.rbs +56 -0
  480. data/sig/docker_engine_ruby/models/image_build_prune_response.rbs +26 -0
  481. data/sig/docker_engine_ruby/models/image_commit_params.rbs +70 -0
  482. data/sig/docker_engine_ruby/models/image_commit_response.rbs +13 -0
  483. data/sig/docker_engine_ruby/models/image_delete_params.rbs +38 -0
  484. data/sig/docker_engine_ruby/models/image_delete_response.rbs +7 -0
  485. data/sig/docker_engine_ruby/models/image_get_all_params.rbs +32 -0
  486. data/sig/docker_engine_ruby/models/image_get_params.rbs +26 -0
  487. data/sig/docker_engine_ruby/models/image_history_params.rbs +26 -0
  488. data/sig/docker_engine_ruby/models/image_history_response.rbs +7 -0
  489. data/sig/docker_engine_ruby/models/image_inspect_params.rbs +25 -0
  490. data/sig/docker_engine_ruby/models/image_list_params.rbs +56 -0
  491. data/sig/docker_engine_ruby/models/image_list_response.rbs +7 -0
  492. data/sig/docker_engine_ruby/models/image_load_params.rbs +40 -0
  493. data/sig/docker_engine_ruby/models/image_prune_params.rbs +25 -0
  494. data/sig/docker_engine_ruby/models/image_prune_response.rbs +31 -0
  495. data/sig/docker_engine_ruby/models/image_pull_params.rbs +84 -0
  496. data/sig/docker_engine_ruby/models/image_push_params.rbs +36 -0
  497. data/sig/docker_engine_ruby/models/image_search_params.rbs +36 -0
  498. data/sig/docker_engine_ruby/models/image_search_response.rbs +55 -0
  499. data/sig/docker_engine_ruby/models/image_tag_params.rbs +32 -0
  500. data/sig/docker_engine_ruby/models/info.rbs +1082 -0
  501. data/sig/docker_engine_ruby/models/inspect.rbs +177 -0
  502. data/sig/docker_engine_ruby/models/inspect_response.rbs +50 -0
  503. data/sig/docker_engine_ruby/models/list_response.rbs +28 -0
  504. data/sig/docker_engine_ruby/models/network.rbs +238 -0
  505. data/sig/docker_engine_ruby/models/network_connect_params.rbs +15 -0
  506. data/sig/docker_engine_ruby/models/network_create_params.rbs +203 -0
  507. data/sig/docker_engine_ruby/models/network_delete_params.rbs +15 -0
  508. data/sig/docker_engine_ruby/models/network_disconnect_params.rbs +15 -0
  509. data/sig/docker_engine_ruby/models/network_inspect_params.rbs +32 -0
  510. data/sig/docker_engine_ruby/models/network_inspect_response.rbs +149 -0
  511. data/sig/docker_engine_ruby/models/network_list_params.rbs +25 -0
  512. data/sig/docker_engine_ruby/models/network_list_response.rbs +7 -0
  513. data/sig/docker_engine_ruby/models/network_prune_params.rbs +25 -0
  514. data/sig/docker_engine_ruby/models/network_prune_response.rbs +15 -0
  515. data/sig/docker_engine_ruby/models/node.rbs +434 -0
  516. data/sig/docker_engine_ruby/models/node_delete_params.rbs +25 -0
  517. data/sig/docker_engine_ruby/models/node_inspect_params.rbs +15 -0
  518. data/sig/docker_engine_ruby/models/node_list_params.rbs +25 -0
  519. data/sig/docker_engine_ruby/models/node_list_response.rbs +7 -0
  520. data/sig/docker_engine_ruby/models/node_update_params.rbs +24 -0
  521. data/sig/docker_engine_ruby/models/plugin.rbs +509 -0
  522. data/sig/docker_engine_ruby/models/plugin_create_params.rbs +28 -0
  523. data/sig/docker_engine_ruby/models/plugin_delete_params.rbs +25 -0
  524. data/sig/docker_engine_ruby/models/plugin_disable_params.rbs +25 -0
  525. data/sig/docker_engine_ruby/models/plugin_enable_params.rbs +26 -0
  526. data/sig/docker_engine_ruby/models/plugin_inspect_params.rbs +15 -0
  527. data/sig/docker_engine_ruby/models/plugin_list_params.rbs +25 -0
  528. data/sig/docker_engine_ruby/models/plugin_list_response.rbs +7 -0
  529. data/sig/docker_engine_ruby/models/plugin_privileges_params.rbs +23 -0
  530. data/sig/docker_engine_ruby/models/plugin_privileges_response.rbs +7 -0
  531. data/sig/docker_engine_ruby/models/plugin_pull_params.rbs +49 -0
  532. data/sig/docker_engine_ruby/models/plugin_push_params.rbs +15 -0
  533. data/sig/docker_engine_ruby/models/plugin_set_params.rbs +26 -0
  534. data/sig/docker_engine_ruby/models/plugin_upgrade_params.rbs +42 -0
  535. data/sig/docker_engine_ruby/models/privilege.rbs +32 -0
  536. data/sig/docker_engine_ruby/models/secret.rbs +64 -0
  537. data/sig/docker_engine_ruby/models/secret_create_params.rbs +36 -0
  538. data/sig/docker_engine_ruby/models/secret_create_response.rbs +13 -0
  539. data/sig/docker_engine_ruby/models/secret_delete_params.rbs +15 -0
  540. data/sig/docker_engine_ruby/models/secret_inspect_params.rbs +15 -0
  541. data/sig/docker_engine_ruby/models/secret_list_params.rbs +25 -0
  542. data/sig/docker_engine_ruby/models/secret_list_response.rbs +7 -0
  543. data/sig/docker_engine_ruby/models/secret_update_params.rbs +24 -0
  544. data/sig/docker_engine_ruby/models/service.rbs +471 -0
  545. data/sig/docker_engine_ruby/models/service_create_params.rbs +41 -0
  546. data/sig/docker_engine_ruby/models/service_delete_params.rbs +15 -0
  547. data/sig/docker_engine_ruby/models/service_inspect_params.rbs +26 -0
  548. data/sig/docker_engine_ruby/models/service_list_params.rbs +32 -0
  549. data/sig/docker_engine_ruby/models/service_list_response.rbs +7 -0
  550. data/sig/docker_engine_ruby/models/service_logs_params.rbs +70 -0
  551. data/sig/docker_engine_ruby/models/service_update_params.rbs +73 -0
  552. data/sig/docker_engine_ruby/models/spec.rbs +467 -0
  553. data/sig/docker_engine_ruby/models/stats_response.rbs +730 -0
  554. data/sig/docker_engine_ruby/models/summary.rbs +634 -0
  555. data/sig/docker_engine_ruby/models/swarm.rbs +159 -0
  556. data/sig/docker_engine_ruby/models/swarm_init_params.rbs +77 -0
  557. data/sig/docker_engine_ruby/models/swarm_init_response.rbs +5 -0
  558. data/sig/docker_engine_ruby/models/swarm_inspect_params.rbs +15 -0
  559. data/sig/docker_engine_ruby/models/swarm_join_params.rbs +56 -0
  560. data/sig/docker_engine_ruby/models/swarm_leave_params.rbs +25 -0
  561. data/sig/docker_engine_ruby/models/swarm_unlock_key_params.rbs +15 -0
  562. data/sig/docker_engine_ruby/models/swarm_unlock_key_response.rbs +15 -0
  563. data/sig/docker_engine_ruby/models/swarm_unlock_params.rbs +26 -0
  564. data/sig/docker_engine_ruby/models/swarm_update_params.rbs +47 -0
  565. data/sig/docker_engine_ruby/models/system_data_usage_params.rbs +50 -0
  566. data/sig/docker_engine_ruby/models/system_data_usage_response.rbs +239 -0
  567. data/sig/docker_engine_ruby/models/system_events_params.rbs +38 -0
  568. data/sig/docker_engine_ruby/models/system_events_response.rbs +124 -0
  569. data/sig/docker_engine_ruby/models/system_info_params.rbs +15 -0
  570. data/sig/docker_engine_ruby/models/system_ping_params.rbs +15 -0
  571. data/sig/docker_engine_ruby/models/system_ping_response.rbs +5 -0
  572. data/sig/docker_engine_ruby/models/system_version_params.rbs +15 -0
  573. data/sig/docker_engine_ruby/models/task.rbs +469 -0
  574. data/sig/docker_engine_ruby/models/task_inspect_params.rbs +15 -0
  575. data/sig/docker_engine_ruby/models/task_list_params.rbs +25 -0
  576. data/sig/docker_engine_ruby/models/task_list_response.rbs +7 -0
  577. data/sig/docker_engine_ruby/models/task_logs_params.rbs +70 -0
  578. data/sig/docker_engine_ruby/models/top_response.rbs +26 -0
  579. data/sig/docker_engine_ruby/models/update_response.rbs +15 -0
  580. data/sig/docker_engine_ruby/models/version.rbs +127 -0
  581. data/sig/docker_engine_ruby/models/volume.rbs +478 -0
  582. data/sig/docker_engine_ruby/models/volume_create_params.rbs +15 -0
  583. data/sig/docker_engine_ruby/models/volume_delete_params.rbs +25 -0
  584. data/sig/docker_engine_ruby/models/volume_inspect_params.rbs +15 -0
  585. data/sig/docker_engine_ruby/models/volume_list_params.rbs +25 -0
  586. data/sig/docker_engine_ruby/models/volume_prune_params.rbs +25 -0
  587. data/sig/docker_engine_ruby/models/volume_prune_response.rbs +26 -0
  588. data/sig/docker_engine_ruby/models/volume_update_params.rbs +235 -0
  589. data/sig/docker_engine_ruby/models/wait_response.rbs +38 -0
  590. data/sig/docker_engine_ruby/models.rbs +269 -0
  591. data/sig/docker_engine_ruby/request_options.rbs +36 -0
  592. data/sig/docker_engine_ruby/resources/auth.rbs +14 -0
  593. data/sig/docker_engine_ruby/resources/configs.rbs +34 -0
  594. data/sig/docker_engine_ruby/resources/containers.rbs +200 -0
  595. data/sig/docker_engine_ruby/resources/distribution.rbs +12 -0
  596. data/sig/docker_engine_ruby/resources/exec.rbs +27 -0
  597. data/sig/docker_engine_ruby/resources/images.rbs +170 -0
  598. data/sig/docker_engine_ruby/resources/networks.rbs +60 -0
  599. data/sig/docker_engine_ruby/resources/nodes.rbs +30 -0
  600. data/sig/docker_engine_ruby/resources/plugins.rbs +73 -0
  601. data/sig/docker_engine_ruby/resources/secrets.rbs +34 -0
  602. data/sig/docker_engine_ruby/resources/services.rbs +52 -0
  603. data/sig/docker_engine_ruby/resources/swarm.rbs +55 -0
  604. data/sig/docker_engine_ruby/resources/system.rbs +30 -0
  605. data/sig/docker_engine_ruby/resources/tasks.rbs +29 -0
  606. data/sig/docker_engine_ruby/resources/volumes.rbs +40 -0
  607. data/sig/docker_engine_ruby/version.rbs +3 -0
  608. metadata +679 -0
@@ -0,0 +1,2516 @@
1
+ # frozen_string_literal: true
2
+
3
+ module DockerEngineRuby
4
+ module Models
5
+ # @see DockerEngineRuby::Resources::Containers#inspect_
6
+ class Container < DockerEngineRuby::Internal::Type::BaseModel
7
+ # @!attribute app_armor_profile
8
+ # The AppArmor profile set for the container.
9
+ #
10
+ # @return [String, nil]
11
+ optional :app_armor_profile, String, api_name: :AppArmorProfile
12
+
13
+ # @!attribute args
14
+ # The arguments to the command being run
15
+ #
16
+ # @return [Array<String>, nil]
17
+ optional :args, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Args
18
+
19
+ # @!attribute config
20
+ # Configuration for a container that is portable between hosts.
21
+ #
22
+ # @return [DockerEngineRuby::Models::Config, nil]
23
+ optional :config, -> { DockerEngineRuby::Config }, api_name: :Config
24
+
25
+ # @!attribute created
26
+ # Date and time at which the container was created, formatted in
27
+ # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
28
+ #
29
+ # @return [String, nil]
30
+ optional :created, String, api_name: :Created, nil?: true
31
+
32
+ # @!attribute driver
33
+ # The storage-driver used for the container's filesystem (graph-driver or
34
+ # snapshotter).
35
+ #
36
+ # @return [String, nil]
37
+ optional :driver, String, api_name: :Driver
38
+
39
+ # @!attribute exec_ids
40
+ # IDs of exec instances that are running in the container.
41
+ #
42
+ # @return [Array<String>, nil]
43
+ optional :exec_ids, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :ExecIDs, nil?: true
44
+
45
+ # @!attribute graph_driver
46
+ # Information about the storage driver used to store the container's and image's
47
+ # filesystem.
48
+ #
49
+ # @return [DockerEngineRuby::Models::Container::GraphDriver, nil]
50
+ optional :graph_driver, -> { DockerEngineRuby::Container::GraphDriver }, api_name: :GraphDriver
51
+
52
+ # @!attribute host_config
53
+ # Container configuration that depends on the host we are running on
54
+ #
55
+ # @return [DockerEngineRuby::Models::Container::HostConfig, nil]
56
+ optional :host_config, -> { DockerEngineRuby::Container::HostConfig }, api_name: :HostConfig
57
+
58
+ # @!attribute hostname_path
59
+ # Location of the `/etc/hostname` generated for the container on the host.
60
+ #
61
+ # This file is managed through the docker daemon, and should not be accessed or
62
+ # modified by other tools.
63
+ #
64
+ # @return [String, nil]
65
+ optional :hostname_path, String, api_name: :HostnamePath
66
+
67
+ # @!attribute hosts_path
68
+ # Location of the `/etc/hosts` generated for the container on the host.
69
+ #
70
+ # This file is managed through the docker daemon, and should not be accessed or
71
+ # modified by other tools.
72
+ #
73
+ # @return [String, nil]
74
+ optional :hosts_path, String, api_name: :HostsPath
75
+
76
+ # @!attribute id
77
+ # The ID of this container as a 128-bit (64-character) hexadecimal string (32
78
+ # bytes).
79
+ #
80
+ # @return [String, nil]
81
+ optional :id, String, api_name: :Id
82
+
83
+ # @!attribute image
84
+ # The ID (digest) of the image that this container was created from.
85
+ #
86
+ # @return [String, nil]
87
+ optional :image, String, api_name: :Image
88
+
89
+ # @!attribute image_manifest_descriptor
90
+ # A descriptor struct containing digest, media type, and size, as defined in the
91
+ # [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md).
92
+ #
93
+ # @return [DockerEngineRuby::Models::Container::ImageManifestDescriptor, nil]
94
+ optional :image_manifest_descriptor,
95
+ -> { DockerEngineRuby::Container::ImageManifestDescriptor },
96
+ api_name: :ImageManifestDescriptor
97
+
98
+ # @!attribute log_path
99
+ # Location of the file used to buffer the container's logs. Depending on the
100
+ # logging-driver used for the container, this field may be omitted.
101
+ #
102
+ # This file is managed through the docker daemon, and should not be accessed or
103
+ # modified by other tools.
104
+ #
105
+ # @return [String, nil]
106
+ optional :log_path, String, api_name: :LogPath, nil?: true
107
+
108
+ # @!attribute mount_label
109
+ # SELinux mount label set for the container.
110
+ #
111
+ # @return [String, nil]
112
+ optional :mount_label, String, api_name: :MountLabel
113
+
114
+ # @!attribute mounts
115
+ # List of mounts used by the container.
116
+ #
117
+ # @return [Array<DockerEngineRuby::Models::Container::Mount>, nil]
118
+ optional :mounts,
119
+ -> { DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Container::Mount] },
120
+ api_name: :Mounts
121
+
122
+ # @!attribute name
123
+ # The name associated with this container.
124
+ #
125
+ # For historic reasons, the name may be prefixed with a forward-slash (`/`).
126
+ #
127
+ # @return [String, nil]
128
+ optional :name, String, api_name: :Name
129
+
130
+ # @!attribute network_settings
131
+ # NetworkSettings exposes the network settings in the API
132
+ #
133
+ # @return [DockerEngineRuby::Models::Container::NetworkSettings, nil]
134
+ optional :network_settings,
135
+ -> { DockerEngineRuby::Container::NetworkSettings },
136
+ api_name: :NetworkSettings
137
+
138
+ # @!attribute path
139
+ # The path to the command being run
140
+ #
141
+ # @return [String, nil]
142
+ optional :path, String, api_name: :Path
143
+
144
+ # @!attribute platform
145
+ # The platform (operating system) for which the container was created.
146
+ #
147
+ # This field was introduced for the experimental "LCOW" (Linux Containers On
148
+ # Windows) features, which has been removed. In most cases, this field is equal to
149
+ # the host's operating system (`linux` or `windows`).
150
+ #
151
+ # @return [String, nil]
152
+ optional :platform, String, api_name: :Platform
153
+
154
+ # @!attribute process_label
155
+ # SELinux process label set for the container.
156
+ #
157
+ # @return [String, nil]
158
+ optional :process_label, String, api_name: :ProcessLabel
159
+
160
+ # @!attribute resolv_conf_path
161
+ # Location of the `/etc/resolv.conf` generated for the container on the host.
162
+ #
163
+ # This file is managed through the docker daemon, and should not be accessed or
164
+ # modified by other tools.
165
+ #
166
+ # @return [String, nil]
167
+ optional :resolv_conf_path, String, api_name: :ResolvConfPath
168
+
169
+ # @!attribute restart_count
170
+ # Number of times the container was restarted since it was created, or since
171
+ # daemon was started.
172
+ #
173
+ # @return [Integer, nil]
174
+ optional :restart_count, Integer, api_name: :RestartCount
175
+
176
+ # @!attribute size_root_fs
177
+ # The total size of all files in the read-only layers from the image that the
178
+ # container uses. These layers can be shared between containers.
179
+ #
180
+ # This field is omitted by default, and only set when size is requested in the API
181
+ # request.
182
+ #
183
+ # @return [Integer, nil]
184
+ optional :size_root_fs, Integer, api_name: :SizeRootFs, nil?: true
185
+
186
+ # @!attribute size_rw
187
+ # The size of files that have been created or changed by this container.
188
+ #
189
+ # This field is omitted by default, and only set when size is requested in the API
190
+ # request.
191
+ #
192
+ # @return [Integer, nil]
193
+ optional :size_rw, Integer, api_name: :SizeRw, nil?: true
194
+
195
+ # @!attribute state
196
+ # ContainerState stores container's running state. It's part of ContainerJSONBase
197
+ # and will be returned by the "inspect" command.
198
+ #
199
+ # @return [DockerEngineRuby::Models::Container::State, nil]
200
+ optional :state, -> { DockerEngineRuby::Container::State }, api_name: :State, nil?: true
201
+
202
+ # @!attribute storage
203
+ # Information about the storage used by the container.
204
+ #
205
+ # @return [DockerEngineRuby::Models::Container::Storage, nil]
206
+ optional :storage, -> { DockerEngineRuby::Container::Storage }, api_name: :Storage
207
+
208
+ # @!method initialize(app_armor_profile: nil, args: nil, config: nil, created: nil, driver: nil, exec_ids: nil, graph_driver: nil, host_config: nil, hostname_path: nil, hosts_path: nil, id: nil, image: nil, image_manifest_descriptor: nil, log_path: nil, mount_label: nil, mounts: nil, name: nil, network_settings: nil, path: nil, platform: nil, process_label: nil, resolv_conf_path: nil, restart_count: nil, size_root_fs: nil, size_rw: nil, state: nil, storage: nil)
209
+ # Some parameter documentations has been truncated, see
210
+ # {DockerEngineRuby::Models::Container} for more details.
211
+ #
212
+ # @param app_armor_profile [String] The AppArmor profile set for the container.
213
+ #
214
+ # @param args [Array<String>] The arguments to the command being run
215
+ #
216
+ # @param config [DockerEngineRuby::Models::Config] Configuration for a container that is portable between hosts.
217
+ #
218
+ # @param created [String, nil] Date and time at which the container was created, formatted in
219
+ #
220
+ # @param driver [String] The storage-driver used for the container's filesystem (graph-driver
221
+ #
222
+ # @param exec_ids [Array<String>, nil] IDs of exec instances that are running in the container.
223
+ #
224
+ # @param graph_driver [DockerEngineRuby::Models::Container::GraphDriver] Information about the storage driver used to store the container's and
225
+ #
226
+ # @param host_config [DockerEngineRuby::Models::Container::HostConfig] Container configuration that depends on the host we are running on
227
+ #
228
+ # @param hostname_path [String] Location of the `/etc/hostname` generated for the container on the
229
+ #
230
+ # @param hosts_path [String] Location of the `/etc/hosts` generated for the container on the
231
+ #
232
+ # @param id [String] The ID of this container as a 128-bit (64-character) hexadecimal string (32 byte
233
+ #
234
+ # @param image [String] The ID (digest) of the image that this container was created from.
235
+ #
236
+ # @param image_manifest_descriptor [DockerEngineRuby::Models::Container::ImageManifestDescriptor] A descriptor struct containing digest, media type, and size, as defined in
237
+ #
238
+ # @param log_path [String, nil] Location of the file used to buffer the container's logs. Depending on
239
+ #
240
+ # @param mount_label [String] SELinux mount label set for the container.
241
+ #
242
+ # @param mounts [Array<DockerEngineRuby::Models::Container::Mount>] List of mounts used by the container.
243
+ #
244
+ # @param name [String] The name associated with this container.
245
+ #
246
+ # @param network_settings [DockerEngineRuby::Models::Container::NetworkSettings] NetworkSettings exposes the network settings in the API
247
+ #
248
+ # @param path [String] The path to the command being run
249
+ #
250
+ # @param platform [String] The platform (operating system) for which the container was created.
251
+ #
252
+ # @param process_label [String] SELinux process label set for the container.
253
+ #
254
+ # @param resolv_conf_path [String] Location of the `/etc/resolv.conf` generated for the container on the
255
+ #
256
+ # @param restart_count [Integer] Number of times the container was restarted since it was created,
257
+ #
258
+ # @param size_root_fs [Integer, nil] The total size of all files in the read-only layers from the image
259
+ #
260
+ # @param size_rw [Integer, nil] The size of files that have been created or changed by this container.
261
+ #
262
+ # @param state [DockerEngineRuby::Models::Container::State, nil] ContainerState stores container's running state. It's part of ContainerJSONBase
263
+ #
264
+ # @param storage [DockerEngineRuby::Models::Container::Storage] Information about the storage used by the container.
265
+
266
+ # @see DockerEngineRuby::Models::Container#graph_driver
267
+ class GraphDriver < DockerEngineRuby::Internal::Type::BaseModel
268
+ # @!attribute data
269
+ # Low-level storage metadata, provided as key/value pairs.
270
+ #
271
+ # This information is driver-specific, and depends on the storage-driver in use,
272
+ # and should be used for informational purposes only.
273
+ #
274
+ # @return [Hash{Symbol=>String}]
275
+ required :data, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Data
276
+
277
+ # @!attribute name
278
+ # Name of the storage driver.
279
+ #
280
+ # @return [String]
281
+ required :name, String, api_name: :Name
282
+
283
+ # @!method initialize(data:, name:)
284
+ # Some parameter documentations has been truncated, see
285
+ # {DockerEngineRuby::Models::Container::GraphDriver} for more details.
286
+ #
287
+ # Information about the storage driver used to store the container's and image's
288
+ # filesystem.
289
+ #
290
+ # @param data [Hash{Symbol=>String}] Low-level storage metadata, provided as key/value pairs.
291
+ #
292
+ # @param name [String] Name of the storage driver.
293
+ end
294
+
295
+ # @see DockerEngineRuby::Models::Container#host_config
296
+ class HostConfig < DockerEngineRuby::Internal::Type::BaseModel
297
+ # @!attribute annotations
298
+ # Arbitrary non-identifying metadata attached to container and provided to the
299
+ # runtime when the container is started.
300
+ #
301
+ # @return [Hash{Symbol=>String}, nil]
302
+ optional :annotations, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Annotations
303
+
304
+ # @!attribute auto_remove
305
+ # Automatically remove the container when the container's process exits. This has
306
+ # no effect if `RestartPolicy` is set.
307
+ #
308
+ # @return [Boolean, nil]
309
+ optional :auto_remove, DockerEngineRuby::Internal::Type::Boolean, api_name: :AutoRemove
310
+
311
+ # @!attribute binds
312
+ # A list of volume bindings for this container. Each volume binding is a string in
313
+ # one of these forms:
314
+ #
315
+ # - `host-src:container-dest[:options]` to bind-mount a host path into the
316
+ # container. Both `host-src`, and `container-dest` must be an _absolute_ path.
317
+ # - `volume-name:container-dest[:options]` to bind-mount a volume managed by a
318
+ # volume driver into the container. `container-dest` must be an _absolute_ path.
319
+ #
320
+ # `options` is an optional, comma-delimited list of:
321
+ #
322
+ # - `nocopy` disables automatic copying of data from the container path to the
323
+ # volume. The `nocopy` flag only applies to named volumes.
324
+ # - `[ro|rw]` mounts a volume read-only or read-write, respectively. If omitted or
325
+ # set to `rw`, volumes are mounted read-write.
326
+ # - `[z|Z]` applies SELinux labels to allow or deny multiple containers to read
327
+ # and write to the same volume.
328
+ # - `z`: a _shared_ content label is applied to the content. This label
329
+ # indicates that multiple containers can share the volume content, for both
330
+ # reading and writing.
331
+ # - `Z`: a _private unshared_ label is applied to the content. This label
332
+ # indicates that only the current container can use a private volume. Labeling
333
+ # systems such as SELinux require proper labels to be placed on volume content
334
+ # that is mounted into a container. Without a label, the security system can
335
+ # prevent a container's processes from using the content. By default, the
336
+ # labels set by the host operating system are not modified.
337
+ # - `[[r]shared|[r]slave|[r]private]` specifies mount
338
+ # [propagation behavior](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt).
339
+ # This only applies to bind-mounted volumes, not internal volumes or named
340
+ # volumes. Mount propagation requires the source mount point (the location where
341
+ # the source directory is mounted in the host operating system) to have the
342
+ # correct propagation properties. For shared volumes, the source mount point
343
+ # must be set to `shared`. For slave volumes, the mount must be set to either
344
+ # `shared` or `slave`.
345
+ #
346
+ # @return [Array<String>, nil]
347
+ optional :binds, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Binds
348
+
349
+ # @!attribute blkio_device_read_bps
350
+ # Limit read rate (bytes per second) from a device, in the form:
351
+ #
352
+ # ```
353
+ # [{"Path": "device_path", "Rate": rate}]
354
+ # ```
355
+ #
356
+ # @return [Array<DockerEngineRuby::Models::Container::HostConfig::BlkioDeviceReadBp>, nil]
357
+ optional :blkio_device_read_bps,
358
+ -> {
359
+ DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Container::HostConfig::BlkioDeviceReadBp]
360
+ },
361
+ api_name: :BlkioDeviceReadBps
362
+
363
+ # @!attribute blkio_device_read_i_ops
364
+ # Limit read rate (IO per second) from a device, in the form:
365
+ #
366
+ # ```
367
+ # [{"Path": "device_path", "Rate": rate}]
368
+ # ```
369
+ #
370
+ # @return [Array<DockerEngineRuby::Models::Container::HostConfig::BlkioDeviceReadIOp>, nil]
371
+ optional :blkio_device_read_i_ops,
372
+ -> {
373
+ DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Container::HostConfig::BlkioDeviceReadIOp]
374
+ },
375
+ api_name: :BlkioDeviceReadIOps
376
+
377
+ # @!attribute blkio_device_write_bps
378
+ # Limit write rate (bytes per second) to a device, in the form:
379
+ #
380
+ # ```
381
+ # [{"Path": "device_path", "Rate": rate}]
382
+ # ```
383
+ #
384
+ # @return [Array<DockerEngineRuby::Models::Container::HostConfig::BlkioDeviceWriteBp>, nil]
385
+ optional :blkio_device_write_bps,
386
+ -> {
387
+ DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Container::HostConfig::BlkioDeviceWriteBp]
388
+ },
389
+ api_name: :BlkioDeviceWriteBps
390
+
391
+ # @!attribute blkio_device_write_i_ops
392
+ # Limit write rate (IO per second) to a device, in the form:
393
+ #
394
+ # ```
395
+ # [{"Path": "device_path", "Rate": rate}]
396
+ # ```
397
+ #
398
+ # @return [Array<DockerEngineRuby::Models::Container::HostConfig::BlkioDeviceWriteIOp>, nil]
399
+ optional :blkio_device_write_i_ops,
400
+ -> {
401
+ DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Container::HostConfig::BlkioDeviceWriteIOp]
402
+ },
403
+ api_name: :BlkioDeviceWriteIOps
404
+
405
+ # @!attribute blkio_weight
406
+ # Block IO weight (relative weight).
407
+ #
408
+ # @return [Integer, nil]
409
+ optional :blkio_weight, Integer, api_name: :BlkioWeight
410
+
411
+ # @!attribute blkio_weight_device
412
+ # Block IO weight (relative device weight) in the form:
413
+ #
414
+ # ```
415
+ # [{"Path": "device_path", "Weight": weight}]
416
+ # ```
417
+ #
418
+ # @return [Array<DockerEngineRuby::Models::Container::HostConfig::BlkioWeightDevice>, nil]
419
+ optional :blkio_weight_device,
420
+ -> {
421
+ DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Container::HostConfig::BlkioWeightDevice]
422
+ },
423
+ api_name: :BlkioWeightDevice
424
+
425
+ # @!attribute cap_add
426
+ # A list of kernel capabilities to add to the container. Conflicts with option
427
+ # 'Capabilities'.
428
+ #
429
+ # @return [Array<String>, nil]
430
+ optional :cap_add, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :CapAdd
431
+
432
+ # @!attribute cap_drop
433
+ # A list of kernel capabilities to drop from the container. Conflicts with option
434
+ # 'Capabilities'.
435
+ #
436
+ # @return [Array<String>, nil]
437
+ optional :cap_drop, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :CapDrop
438
+
439
+ # @!attribute cgroup
440
+ # Cgroup to use for the container.
441
+ #
442
+ # @return [String, nil]
443
+ optional :cgroup, String, api_name: :Cgroup
444
+
445
+ # @!attribute cgroupns_mode
446
+ # cgroup namespace mode for the container. Possible values are:
447
+ #
448
+ # - `"private"`: the container runs in its own private cgroup namespace
449
+ # - `"host"`: use the host system's cgroup namespace
450
+ #
451
+ # If not specified, the daemon default is used, which can either be `"private"` or
452
+ # `"host"`, depending on daemon version, kernel support and configuration.
453
+ #
454
+ # @return [Symbol, DockerEngineRuby::Models::Container::HostConfig::CgroupnsMode, nil]
455
+ optional :cgroupns_mode,
456
+ enum: -> { DockerEngineRuby::Container::HostConfig::CgroupnsMode },
457
+ api_name: :CgroupnsMode
458
+
459
+ # @!attribute cgroup_parent
460
+ # Path to `cgroups` under which the container's `cgroup` is created. If the path
461
+ # is not absolute, the path is considered to be relative to the `cgroups` path of
462
+ # the init process. Cgroups are created if they do not already exist.
463
+ #
464
+ # @return [String, nil]
465
+ optional :cgroup_parent, String, api_name: :CgroupParent
466
+
467
+ # @!attribute console_size
468
+ # Initial console size, as an `[height, width]` array.
469
+ #
470
+ # @return [Array<Integer>, nil]
471
+ optional :console_size,
472
+ DockerEngineRuby::Internal::Type::ArrayOf[Integer],
473
+ api_name: :ConsoleSize,
474
+ nil?: true
475
+
476
+ # @!attribute container_id_file
477
+ # Path to a file where the container ID is written
478
+ #
479
+ # @return [String, nil]
480
+ optional :container_id_file, String, api_name: :ContainerIDFile
481
+
482
+ # @!attribute cpu_count
483
+ # The number of usable CPUs (Windows only).
484
+ #
485
+ # On Windows Server containers, the processor resource controls are mutually
486
+ # exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and
487
+ # `CPUPercent` last.
488
+ #
489
+ # @return [Integer, nil]
490
+ optional :cpu_count, Integer, api_name: :CpuCount
491
+
492
+ # @!attribute cpu_percent
493
+ # The usable percentage of the available CPUs (Windows only).
494
+ #
495
+ # On Windows Server containers, the processor resource controls are mutually
496
+ # exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and
497
+ # `CPUPercent` last.
498
+ #
499
+ # @return [Integer, nil]
500
+ optional :cpu_percent, Integer, api_name: :CpuPercent
501
+
502
+ # @!attribute cpu_period
503
+ # The length of a CPU period in microseconds.
504
+ #
505
+ # @return [Integer, nil]
506
+ optional :cpu_period, Integer, api_name: :CpuPeriod
507
+
508
+ # @!attribute cpu_quota
509
+ # Microseconds of CPU time that the container can get in a CPU period.
510
+ #
511
+ # @return [Integer, nil]
512
+ optional :cpu_quota, Integer, api_name: :CpuQuota
513
+
514
+ # @!attribute cpu_realtime_period
515
+ # The length of a CPU real-time period in microseconds. Set to 0 to allocate no
516
+ # time allocated to real-time tasks.
517
+ #
518
+ # @return [Integer, nil]
519
+ optional :cpu_realtime_period, Integer, api_name: :CpuRealtimePeriod
520
+
521
+ # @!attribute cpu_realtime_runtime
522
+ # The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no
523
+ # time allocated to real-time tasks.
524
+ #
525
+ # @return [Integer, nil]
526
+ optional :cpu_realtime_runtime, Integer, api_name: :CpuRealtimeRuntime
527
+
528
+ # @!attribute cpuset_cpus
529
+ # CPUs in which to allow execution (e.g., `0-3`, `0,1`).
530
+ #
531
+ # @return [String, nil]
532
+ optional :cpuset_cpus, String, api_name: :CpusetCpus
533
+
534
+ # @!attribute cpuset_mems
535
+ # Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on
536
+ # NUMA systems.
537
+ #
538
+ # @return [String, nil]
539
+ optional :cpuset_mems, String, api_name: :CpusetMems
540
+
541
+ # @!attribute cpu_shares
542
+ # An integer value representing this container's relative CPU weight versus other
543
+ # containers.
544
+ #
545
+ # @return [Integer, nil]
546
+ optional :cpu_shares, Integer, api_name: :CpuShares
547
+
548
+ # @!attribute device_cgroup_rules
549
+ # a list of cgroup rules to apply to the container
550
+ #
551
+ # @return [Array<String>, nil]
552
+ optional :device_cgroup_rules,
553
+ DockerEngineRuby::Internal::Type::ArrayOf[String],
554
+ api_name: :DeviceCgroupRules
555
+
556
+ # @!attribute device_requests
557
+ # A list of requests for devices to be sent to device drivers.
558
+ #
559
+ # @return [Array<DockerEngineRuby::Models::Container::HostConfig::DeviceRequest>, nil]
560
+ optional :device_requests,
561
+ -> {
562
+ DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Container::HostConfig::DeviceRequest]
563
+ },
564
+ api_name: :DeviceRequests
565
+
566
+ # @!attribute devices
567
+ # A list of devices to add to the container.
568
+ #
569
+ # @return [Array<DockerEngineRuby::Models::Container::HostConfig::Device>, nil]
570
+ optional :devices,
571
+ -> {
572
+ DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Container::HostConfig::Device]
573
+ },
574
+ api_name: :Devices
575
+
576
+ # @!attribute dns
577
+ # A list of DNS servers for the container to use.
578
+ #
579
+ # @return [Array<String>, nil]
580
+ optional :dns, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Dns
581
+
582
+ # @!attribute dns_options
583
+ # A list of DNS options.
584
+ #
585
+ # @return [Array<String>, nil]
586
+ optional :dns_options, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :DnsOptions
587
+
588
+ # @!attribute dns_search
589
+ # A list of DNS search domains.
590
+ #
591
+ # @return [Array<String>, nil]
592
+ optional :dns_search, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :DnsSearch
593
+
594
+ # @!attribute extra_hosts
595
+ # A list of hostnames/IP mappings to add to the container's `/etc/hosts` file.
596
+ # Specified in the form `["hostname:IP"]`.
597
+ #
598
+ # @return [Array<String>, nil]
599
+ optional :extra_hosts, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :ExtraHosts
600
+
601
+ # @!attribute group_add
602
+ # A list of additional groups that the container process will run as.
603
+ #
604
+ # @return [Array<String>, nil]
605
+ optional :group_add, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :GroupAdd
606
+
607
+ # @!attribute init
608
+ # Run an init inside the container that forwards signals and reaps processes. This
609
+ # field is omitted if empty, and the default (as configured on the daemon) is
610
+ # used.
611
+ #
612
+ # @return [Boolean, nil]
613
+ optional :init, DockerEngineRuby::Internal::Type::Boolean, api_name: :Init, nil?: true
614
+
615
+ # @!attribute io_maximum_bandwidth
616
+ # Maximum IO in bytes per second for the container system drive (Windows only).
617
+ #
618
+ # @return [Integer, nil]
619
+ optional :io_maximum_bandwidth, Integer, api_name: :IOMaximumBandwidth
620
+
621
+ # @!attribute io_maximum_i_ops
622
+ # Maximum IOps for the container system drive (Windows only)
623
+ #
624
+ # @return [Integer, nil]
625
+ optional :io_maximum_i_ops, Integer, api_name: :IOMaximumIOps
626
+
627
+ # @!attribute ipc_mode
628
+ # IPC sharing mode for the container. Possible values are:
629
+ #
630
+ # - `"none"`: own private IPC namespace, with /dev/shm not mounted
631
+ # - `"private"`: own private IPC namespace
632
+ # - `"shareable"`: own private IPC namespace, with a possibility to share it with
633
+ # other containers
634
+ # - `"container:<name|id>"`: join another (shareable) container's IPC namespace
635
+ # - `"host"`: use the host system's IPC namespace
636
+ #
637
+ # If not specified, daemon default is used, which can either be `"private"` or
638
+ # `"shareable"`, depending on daemon version and configuration.
639
+ #
640
+ # @return [String, nil]
641
+ optional :ipc_mode, String, api_name: :IpcMode
642
+
643
+ # @!attribute isolation
644
+ # Isolation technology of the container. (Windows only)
645
+ #
646
+ # @return [Symbol, DockerEngineRuby::Models::Container::HostConfig::Isolation, nil]
647
+ optional :isolation,
648
+ enum: -> {
649
+ DockerEngineRuby::Container::HostConfig::Isolation
650
+ },
651
+ api_name: :Isolation
652
+
653
+ # @!attribute links
654
+ # A list of links for the container in the form `container_name:alias`.
655
+ #
656
+ # @return [Array<String>, nil]
657
+ optional :links, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Links
658
+
659
+ # @!attribute log_config
660
+ # The logging configuration for this container
661
+ #
662
+ # @return [DockerEngineRuby::Models::Container::HostConfig::LogConfig, nil]
663
+ optional :log_config, -> { DockerEngineRuby::Container::HostConfig::LogConfig }, api_name: :LogConfig
664
+
665
+ # @!attribute masked_paths
666
+ # The list of paths to be masked inside the container (this overrides the default
667
+ # set of paths).
668
+ #
669
+ # @return [Array<String>, nil]
670
+ optional :masked_paths, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :MaskedPaths
671
+
672
+ # @!attribute memory
673
+ # Memory limit in bytes.
674
+ #
675
+ # @return [Integer, nil]
676
+ optional :memory, Integer, api_name: :Memory
677
+
678
+ # @!attribute memory_reservation
679
+ # Memory soft limit in bytes.
680
+ #
681
+ # @return [Integer, nil]
682
+ optional :memory_reservation, Integer, api_name: :MemoryReservation
683
+
684
+ # @!attribute memory_swap
685
+ # Total memory limit (memory + swap). Set as `-1` to enable unlimited swap.
686
+ #
687
+ # @return [Integer, nil]
688
+ optional :memory_swap, Integer, api_name: :MemorySwap
689
+
690
+ # @!attribute memory_swappiness
691
+ # Tune a container's memory swappiness behavior. Accepts an integer between 0
692
+ # and 100.
693
+ #
694
+ # @return [Integer, nil]
695
+ optional :memory_swappiness, Integer, api_name: :MemorySwappiness
696
+
697
+ # @!attribute mounts
698
+ # Specification for mounts to be added to the container.
699
+ #
700
+ # @return [Array<DockerEngineRuby::Models::Container::HostConfig::Mount>, nil]
701
+ optional :mounts,
702
+ -> {
703
+ DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Container::HostConfig::Mount]
704
+ },
705
+ api_name: :Mounts
706
+
707
+ # @!attribute nano_cpus
708
+ # CPU quota in units of 10<sup>-9</sup> CPUs.
709
+ #
710
+ # @return [Integer, nil]
711
+ optional :nano_cpus, Integer, api_name: :NanoCpus
712
+
713
+ # @!attribute network_mode
714
+ # Network mode to use for this container. Supported standard values are: `bridge`,
715
+ # `host`, `none`, and `container:<name|id>`. Any other value is taken as a custom
716
+ # network's name to which this container should connect to.
717
+ #
718
+ # @return [String, nil]
719
+ optional :network_mode, String, api_name: :NetworkMode
720
+
721
+ # @!attribute oom_kill_disable
722
+ # Disable OOM Killer for the container.
723
+ #
724
+ # @return [Boolean, nil]
725
+ optional :oom_kill_disable, DockerEngineRuby::Internal::Type::Boolean, api_name: :OomKillDisable
726
+
727
+ # @!attribute oom_score_adj
728
+ # An integer value containing the score given to the container in order to tune
729
+ # OOM killer preferences.
730
+ #
731
+ # @return [Integer, nil]
732
+ optional :oom_score_adj, Integer, api_name: :OomScoreAdj
733
+
734
+ # @!attribute pid_mode
735
+ # Set the PID (Process) Namespace mode for the container. It can be either:
736
+ #
737
+ # - `"container:<name|id>"`: joins another container's PID namespace
738
+ # - `"host"`: use the host's PID namespace inside the container
739
+ #
740
+ # @return [String, nil]
741
+ optional :pid_mode, String, api_name: :PidMode
742
+
743
+ # @!attribute pids_limit
744
+ # Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not
745
+ # change.
746
+ #
747
+ # @return [Integer, nil]
748
+ optional :pids_limit, Integer, api_name: :PidsLimit, nil?: true
749
+
750
+ # @!attribute port_bindings
751
+ # PortMap describes the mapping of container ports to host ports, using the
752
+ # container's port-number and protocol as key in the format `<port>/<protocol>`,
753
+ # for example, `80/udp`.
754
+ #
755
+ # If a container's port is mapped for multiple protocols, separate entries are
756
+ # added to the mapping table.
757
+ #
758
+ # @return [Hash{Symbol=>Array<DockerEngineRuby::Models::Container::HostConfig::PortBinding>}, nil]
759
+ optional :port_bindings,
760
+ -> {
761
+ DockerEngineRuby::Internal::Type::HashOf[DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Container::HostConfig::PortBinding]]
762
+ },
763
+ api_name: :PortBindings
764
+
765
+ # @!attribute privileged
766
+ # Gives the container full access to the host.
767
+ #
768
+ # @return [Boolean, nil]
769
+ optional :privileged, DockerEngineRuby::Internal::Type::Boolean, api_name: :Privileged
770
+
771
+ # @!attribute publish_all_ports
772
+ # Allocates an ephemeral host port for all of a container's exposed ports.
773
+ #
774
+ # Ports are de-allocated when the container stops and allocated when the container
775
+ # starts. The allocated port might be changed when restarting the container.
776
+ #
777
+ # The port is selected from the ephemeral port range that depends on the kernel.
778
+ # For example, on Linux the range is defined by
779
+ # `/proc/sys/net/ipv4/ip_local_port_range`.
780
+ #
781
+ # @return [Boolean, nil]
782
+ optional :publish_all_ports, DockerEngineRuby::Internal::Type::Boolean, api_name: :PublishAllPorts
783
+
784
+ # @!attribute readonly_paths
785
+ # The list of paths to be set as read-only inside the container (this overrides
786
+ # the default set of paths).
787
+ #
788
+ # @return [Array<String>, nil]
789
+ optional :readonly_paths, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :ReadonlyPaths
790
+
791
+ # @!attribute readonly_rootfs
792
+ # Mount the container's root filesystem as read only.
793
+ #
794
+ # @return [Boolean, nil]
795
+ optional :readonly_rootfs, DockerEngineRuby::Internal::Type::Boolean, api_name: :ReadonlyRootfs
796
+
797
+ # @!attribute restart_policy
798
+ # The behavior to apply when the container exits. The default is not to restart.
799
+ #
800
+ # An ever increasing delay (double the previous delay, starting at 100ms) is added
801
+ # before each restart to prevent flooding the server.
802
+ #
803
+ # @return [DockerEngineRuby::Models::Container::HostConfig::RestartPolicy, nil]
804
+ optional :restart_policy,
805
+ -> { DockerEngineRuby::Container::HostConfig::RestartPolicy },
806
+ api_name: :RestartPolicy
807
+
808
+ # @!attribute runtime
809
+ # Runtime to use with this container.
810
+ #
811
+ # @return [String, nil]
812
+ optional :runtime, String, api_name: :Runtime, nil?: true
813
+
814
+ # @!attribute security_opt
815
+ # A list of string values to customize labels for MLS systems, such as SELinux.
816
+ #
817
+ # @return [Array<String>, nil]
818
+ optional :security_opt, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :SecurityOpt
819
+
820
+ # @!attribute shm_size
821
+ # Size of `/dev/shm` in bytes. If omitted, the system uses 64MB.
822
+ #
823
+ # @return [Integer, nil]
824
+ optional :shm_size, Integer, api_name: :ShmSize
825
+
826
+ # @!attribute storage_opt
827
+ # Storage driver options for this container, in the form `{"size": "120G"}`.
828
+ #
829
+ # @return [Hash{Symbol=>String}, nil]
830
+ optional :storage_opt, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :StorageOpt
831
+
832
+ # @!attribute sysctls
833
+ # A list of kernel parameters (sysctls) to set in the container.
834
+ #
835
+ # This field is omitted if not set.
836
+ #
837
+ # @return [Hash{Symbol=>String}, nil]
838
+ optional :sysctls, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Sysctls, nil?: true
839
+
840
+ # @!attribute tmpfs
841
+ # A map of container directories which should be replaced by tmpfs mounts, and
842
+ # their corresponding mount options. For example:
843
+ #
844
+ # ```
845
+ # { "/run": "rw,noexec,nosuid,size=65536k" }
846
+ # ```
847
+ #
848
+ # @return [Hash{Symbol=>String}, nil]
849
+ optional :tmpfs, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Tmpfs
850
+
851
+ # @!attribute ulimits
852
+ # A list of resource limits to set in the container. For example:
853
+ #
854
+ # ```
855
+ # {"Name": "nofile", "Soft": 1024, "Hard": 2048}
856
+ # ```
857
+ #
858
+ # @return [Array<DockerEngineRuby::Models::Container::HostConfig::Ulimit>, nil]
859
+ optional :ulimits,
860
+ -> {
861
+ DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Container::HostConfig::Ulimit]
862
+ },
863
+ api_name: :Ulimits
864
+
865
+ # @!attribute userns_mode
866
+ # Sets the usernamespace mode for the container when usernamespace remapping
867
+ # option is enabled.
868
+ #
869
+ # @return [String, nil]
870
+ optional :userns_mode, String, api_name: :UsernsMode
871
+
872
+ # @!attribute uts_mode
873
+ # UTS namespace to use for the container.
874
+ #
875
+ # @return [String, nil]
876
+ optional :uts_mode, String, api_name: :UTSMode
877
+
878
+ # @!attribute volume_driver
879
+ # Driver that this container uses to mount volumes.
880
+ #
881
+ # @return [String, nil]
882
+ optional :volume_driver, String, api_name: :VolumeDriver
883
+
884
+ # @!attribute volumes_from
885
+ # A list of volumes to inherit from another container, specified in the form
886
+ # `<container name>[:<ro|rw>]`.
887
+ #
888
+ # @return [Array<String>, nil]
889
+ optional :volumes_from, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :VolumesFrom
890
+
891
+ # @!method initialize(annotations: nil, auto_remove: nil, binds: nil, blkio_device_read_bps: nil, blkio_device_read_i_ops: nil, blkio_device_write_bps: nil, blkio_device_write_i_ops: nil, blkio_weight: nil, blkio_weight_device: nil, cap_add: nil, cap_drop: nil, cgroup: nil, cgroupns_mode: nil, cgroup_parent: nil, console_size: nil, container_id_file: nil, cpu_count: nil, cpu_percent: nil, cpu_period: nil, cpu_quota: nil, cpu_realtime_period: nil, cpu_realtime_runtime: nil, cpuset_cpus: nil, cpuset_mems: nil, cpu_shares: nil, device_cgroup_rules: nil, device_requests: nil, devices: nil, dns: nil, dns_options: nil, dns_search: nil, extra_hosts: nil, group_add: nil, init: nil, io_maximum_bandwidth: nil, io_maximum_i_ops: nil, ipc_mode: nil, isolation: nil, links: nil, log_config: nil, masked_paths: nil, memory: nil, memory_reservation: nil, memory_swap: nil, memory_swappiness: nil, mounts: nil, nano_cpus: nil, network_mode: nil, oom_kill_disable: nil, oom_score_adj: nil, pid_mode: nil, pids_limit: nil, port_bindings: nil, privileged: nil, publish_all_ports: nil, readonly_paths: nil, readonly_rootfs: nil, restart_policy: nil, runtime: nil, security_opt: nil, shm_size: nil, storage_opt: nil, sysctls: nil, tmpfs: nil, ulimits: nil, userns_mode: nil, uts_mode: nil, volume_driver: nil, volumes_from: nil)
892
+ # Some parameter documentations has been truncated, see
893
+ # {DockerEngineRuby::Models::Container::HostConfig} for more details.
894
+ #
895
+ # Container configuration that depends on the host we are running on
896
+ #
897
+ # @param annotations [Hash{Symbol=>String}] Arbitrary non-identifying metadata attached to container and
898
+ #
899
+ # @param auto_remove [Boolean] Automatically remove the container when the container's process
900
+ #
901
+ # @param binds [Array<String>] A list of volume bindings for this container. Each volume binding
902
+ #
903
+ # @param blkio_device_read_bps [Array<DockerEngineRuby::Models::Container::HostConfig::BlkioDeviceReadBp>] Limit read rate (bytes per second) from a device, in the form:
904
+ #
905
+ # @param blkio_device_read_i_ops [Array<DockerEngineRuby::Models::Container::HostConfig::BlkioDeviceReadIOp>] Limit read rate (IO per second) from a device, in the form:
906
+ #
907
+ # @param blkio_device_write_bps [Array<DockerEngineRuby::Models::Container::HostConfig::BlkioDeviceWriteBp>] Limit write rate (bytes per second) to a device, in the form:
908
+ #
909
+ # @param blkio_device_write_i_ops [Array<DockerEngineRuby::Models::Container::HostConfig::BlkioDeviceWriteIOp>] Limit write rate (IO per second) to a device, in the form:
910
+ #
911
+ # @param blkio_weight [Integer] Block IO weight (relative weight).
912
+ #
913
+ # @param blkio_weight_device [Array<DockerEngineRuby::Models::Container::HostConfig::BlkioWeightDevice>] Block IO weight (relative device weight) in the form:
914
+ #
915
+ # @param cap_add [Array<String>] A list of kernel capabilities to add to the container. Conflicts
916
+ #
917
+ # @param cap_drop [Array<String>] A list of kernel capabilities to drop from the container. Conflicts
918
+ #
919
+ # @param cgroup [String] Cgroup to use for the container.
920
+ #
921
+ # @param cgroupns_mode [Symbol, DockerEngineRuby::Models::Container::HostConfig::CgroupnsMode] cgroup namespace mode for the container. Possible values are:
922
+ #
923
+ # @param cgroup_parent [String] Path to `cgroups` under which the container's `cgroup` is created. If
924
+ #
925
+ # @param console_size [Array<Integer>, nil] Initial console size, as an `[height, width]` array.
926
+ #
927
+ # @param container_id_file [String] Path to a file where the container ID is written
928
+ #
929
+ # @param cpu_count [Integer] The number of usable CPUs (Windows only).
930
+ #
931
+ # @param cpu_percent [Integer] The usable percentage of the available CPUs (Windows only).
932
+ #
933
+ # @param cpu_period [Integer] The length of a CPU period in microseconds.
934
+ #
935
+ # @param cpu_quota [Integer] Microseconds of CPU time that the container can get in a CPU period.
936
+ #
937
+ # @param cpu_realtime_period [Integer] The length of a CPU real-time period in microseconds. Set to 0 to
938
+ #
939
+ # @param cpu_realtime_runtime [Integer] The length of a CPU real-time runtime in microseconds. Set to 0 to
940
+ #
941
+ # @param cpuset_cpus [String] CPUs in which to allow execution (e.g., `0-3`, `0,1`).
942
+ #
943
+ # @param cpuset_mems [String] Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only
944
+ #
945
+ # @param cpu_shares [Integer] An integer value representing this container's relative CPU weight
946
+ #
947
+ # @param device_cgroup_rules [Array<String>] a list of cgroup rules to apply to the container
948
+ #
949
+ # @param device_requests [Array<DockerEngineRuby::Models::Container::HostConfig::DeviceRequest>] A list of requests for devices to be sent to device drivers.
950
+ #
951
+ # @param devices [Array<DockerEngineRuby::Models::Container::HostConfig::Device>] A list of devices to add to the container.
952
+ #
953
+ # @param dns [Array<String>] A list of DNS servers for the container to use.
954
+ #
955
+ # @param dns_options [Array<String>] A list of DNS options.
956
+ #
957
+ # @param dns_search [Array<String>] A list of DNS search domains.
958
+ #
959
+ # @param extra_hosts [Array<String>] A list of hostnames/IP mappings to add to the container's `/etc/hosts`
960
+ #
961
+ # @param group_add [Array<String>] A list of additional groups that the container process will run as.
962
+ #
963
+ # @param init [Boolean, nil] Run an init inside the container that forwards signals and reaps
964
+ #
965
+ # @param io_maximum_bandwidth [Integer] Maximum IO in bytes per second for the container system drive
966
+ #
967
+ # @param io_maximum_i_ops [Integer] Maximum IOps for the container system drive (Windows only)
968
+ #
969
+ # @param ipc_mode [String] IPC sharing mode for the container. Possible values are:
970
+ #
971
+ # @param isolation [Symbol, DockerEngineRuby::Models::Container::HostConfig::Isolation] Isolation technology of the container. (Windows only)
972
+ #
973
+ # @param links [Array<String>] A list of links for the container in the form `container_name:alias`.
974
+ #
975
+ # @param log_config [DockerEngineRuby::Models::Container::HostConfig::LogConfig] The logging configuration for this container
976
+ #
977
+ # @param masked_paths [Array<String>] The list of paths to be masked inside the container (this overrides
978
+ #
979
+ # @param memory [Integer] Memory limit in bytes.
980
+ #
981
+ # @param memory_reservation [Integer] Memory soft limit in bytes.
982
+ #
983
+ # @param memory_swap [Integer] Total memory limit (memory + swap). Set as `-1` to enable unlimited
984
+ #
985
+ # @param memory_swappiness [Integer] Tune a container's memory swappiness behavior. Accepts an integer
986
+ #
987
+ # @param mounts [Array<DockerEngineRuby::Models::Container::HostConfig::Mount>] Specification for mounts to be added to the container.
988
+ #
989
+ # @param nano_cpus [Integer] CPU quota in units of 10<sup>-9</sup> CPUs.
990
+ #
991
+ # @param network_mode [String] Network mode to use for this container. Supported standard values
992
+ #
993
+ # @param oom_kill_disable [Boolean] Disable OOM Killer for the container.
994
+ #
995
+ # @param oom_score_adj [Integer] An integer value containing the score given to the container in
996
+ #
997
+ # @param pid_mode [String] Set the PID (Process) Namespace mode for the container. It can be
998
+ #
999
+ # @param pids_limit [Integer, nil] Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null`
1000
+ #
1001
+ # @param port_bindings [Hash{Symbol=>Array<DockerEngineRuby::Models::Container::HostConfig::PortBinding>}] PortMap describes the mapping of container ports to host ports, using the
1002
+ #
1003
+ # @param privileged [Boolean] Gives the container full access to the host.
1004
+ #
1005
+ # @param publish_all_ports [Boolean] Allocates an ephemeral host port for all of a container's
1006
+ #
1007
+ # @param readonly_paths [Array<String>] The list of paths to be set as read-only inside the container
1008
+ #
1009
+ # @param readonly_rootfs [Boolean] Mount the container's root filesystem as read only.
1010
+ #
1011
+ # @param restart_policy [DockerEngineRuby::Models::Container::HostConfig::RestartPolicy] The behavior to apply when the container exits. The default is not to
1012
+ #
1013
+ # @param runtime [String, nil] Runtime to use with this container.
1014
+ #
1015
+ # @param security_opt [Array<String>] A list of string values to customize labels for MLS systems, such
1016
+ #
1017
+ # @param shm_size [Integer] Size of `/dev/shm` in bytes. If omitted, the system uses 64MB.
1018
+ #
1019
+ # @param storage_opt [Hash{Symbol=>String}] Storage driver options for this container, in the form `{"size": "120G"}`.
1020
+ #
1021
+ # @param sysctls [Hash{Symbol=>String}, nil] A list of kernel parameters (sysctls) to set in the container.
1022
+ #
1023
+ # @param tmpfs [Hash{Symbol=>String}] A map of container directories which should be replaced by tmpfs
1024
+ #
1025
+ # @param ulimits [Array<DockerEngineRuby::Models::Container::HostConfig::Ulimit>] A list of resource limits to set in the container. For example:
1026
+ #
1027
+ # @param userns_mode [String] Sets the usernamespace mode for the container when usernamespace
1028
+ #
1029
+ # @param uts_mode [String] UTS namespace to use for the container.
1030
+ #
1031
+ # @param volume_driver [String] Driver that this container uses to mount volumes.
1032
+ #
1033
+ # @param volumes_from [Array<String>] A list of volumes to inherit from another container, specified in
1034
+
1035
+ class BlkioDeviceReadBp < DockerEngineRuby::Internal::Type::BaseModel
1036
+ # @!attribute path
1037
+ # Device path
1038
+ #
1039
+ # @return [String, nil]
1040
+ optional :path, String, api_name: :Path
1041
+
1042
+ # @!attribute rate
1043
+ # Rate
1044
+ #
1045
+ # @return [Integer, nil]
1046
+ optional :rate, Integer, api_name: :Rate
1047
+
1048
+ # @!method initialize(path: nil, rate: nil)
1049
+ # @param path [String] Device path
1050
+ #
1051
+ # @param rate [Integer] Rate
1052
+ end
1053
+
1054
+ class BlkioDeviceReadIOp < DockerEngineRuby::Internal::Type::BaseModel
1055
+ # @!attribute path
1056
+ # Device path
1057
+ #
1058
+ # @return [String, nil]
1059
+ optional :path, String, api_name: :Path
1060
+
1061
+ # @!attribute rate
1062
+ # Rate
1063
+ #
1064
+ # @return [Integer, nil]
1065
+ optional :rate, Integer, api_name: :Rate
1066
+
1067
+ # @!method initialize(path: nil, rate: nil)
1068
+ # @param path [String] Device path
1069
+ #
1070
+ # @param rate [Integer] Rate
1071
+ end
1072
+
1073
+ class BlkioDeviceWriteBp < DockerEngineRuby::Internal::Type::BaseModel
1074
+ # @!attribute path
1075
+ # Device path
1076
+ #
1077
+ # @return [String, nil]
1078
+ optional :path, String, api_name: :Path
1079
+
1080
+ # @!attribute rate
1081
+ # Rate
1082
+ #
1083
+ # @return [Integer, nil]
1084
+ optional :rate, Integer, api_name: :Rate
1085
+
1086
+ # @!method initialize(path: nil, rate: nil)
1087
+ # @param path [String] Device path
1088
+ #
1089
+ # @param rate [Integer] Rate
1090
+ end
1091
+
1092
+ class BlkioDeviceWriteIOp < DockerEngineRuby::Internal::Type::BaseModel
1093
+ # @!attribute path
1094
+ # Device path
1095
+ #
1096
+ # @return [String, nil]
1097
+ optional :path, String, api_name: :Path
1098
+
1099
+ # @!attribute rate
1100
+ # Rate
1101
+ #
1102
+ # @return [Integer, nil]
1103
+ optional :rate, Integer, api_name: :Rate
1104
+
1105
+ # @!method initialize(path: nil, rate: nil)
1106
+ # @param path [String] Device path
1107
+ #
1108
+ # @param rate [Integer] Rate
1109
+ end
1110
+
1111
+ class BlkioWeightDevice < DockerEngineRuby::Internal::Type::BaseModel
1112
+ # @!attribute path
1113
+ #
1114
+ # @return [String, nil]
1115
+ optional :path, String, api_name: :Path
1116
+
1117
+ # @!attribute weight
1118
+ #
1119
+ # @return [Integer, nil]
1120
+ optional :weight, Integer, api_name: :Weight
1121
+
1122
+ # @!method initialize(path: nil, weight: nil)
1123
+ # @param path [String]
1124
+ # @param weight [Integer]
1125
+ end
1126
+
1127
+ # cgroup namespace mode for the container. Possible values are:
1128
+ #
1129
+ # - `"private"`: the container runs in its own private cgroup namespace
1130
+ # - `"host"`: use the host system's cgroup namespace
1131
+ #
1132
+ # If not specified, the daemon default is used, which can either be `"private"` or
1133
+ # `"host"`, depending on daemon version, kernel support and configuration.
1134
+ #
1135
+ # @see DockerEngineRuby::Models::Container::HostConfig#cgroupns_mode
1136
+ module CgroupnsMode
1137
+ extend DockerEngineRuby::Internal::Type::Enum
1138
+
1139
+ PRIVATE = :private
1140
+ HOST = :host
1141
+
1142
+ # @!method self.values
1143
+ # @return [Array<Symbol>]
1144
+ end
1145
+
1146
+ class DeviceRequest < DockerEngineRuby::Internal::Type::BaseModel
1147
+ # @!attribute capabilities
1148
+ # A list of capabilities; an OR list of AND lists of capabilities.
1149
+ #
1150
+ # Note that if a driver is specified the capabilities have no effect on selecting
1151
+ # a driver as the driver name is used directly.
1152
+ #
1153
+ # Note that if no driver is specified the capabilities are used to select a driver
1154
+ # with the required capabilities.
1155
+ #
1156
+ # @return [Array<Array<String>>, nil]
1157
+ optional :capabilities,
1158
+ DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Internal::Type::ArrayOf[String]],
1159
+ api_name: :Capabilities
1160
+
1161
+ # @!attribute count
1162
+ #
1163
+ # @return [Integer, nil]
1164
+ optional :count, Integer, api_name: :Count
1165
+
1166
+ # @!attribute device_ids
1167
+ #
1168
+ # @return [Array<String>, nil]
1169
+ optional :device_ids, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :DeviceIDs
1170
+
1171
+ # @!attribute driver
1172
+ # The name of the device driver to use for this request.
1173
+ #
1174
+ # Note that if this is specified the capabilities are ignored when selecting a
1175
+ # device driver.
1176
+ #
1177
+ # @return [String, nil]
1178
+ optional :driver, String, api_name: :Driver
1179
+
1180
+ # @!attribute options
1181
+ # Driver-specific options, specified as a key/value pairs. These options are
1182
+ # passed directly to the driver.
1183
+ #
1184
+ # @return [Hash{Symbol=>String}, nil]
1185
+ optional :options, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Options
1186
+
1187
+ # @!method initialize(capabilities: nil, count: nil, device_ids: nil, driver: nil, options: nil)
1188
+ # Some parameter documentations has been truncated, see
1189
+ # {DockerEngineRuby::Models::Container::HostConfig::DeviceRequest} for more
1190
+ # details.
1191
+ #
1192
+ # A request for devices to be sent to device drivers
1193
+ #
1194
+ # @param capabilities [Array<Array<String>>] A list of capabilities; an OR list of AND lists of capabilities.
1195
+ #
1196
+ # @param count [Integer]
1197
+ #
1198
+ # @param device_ids [Array<String>]
1199
+ #
1200
+ # @param driver [String] The name of the device driver to use for this request.
1201
+ #
1202
+ # @param options [Hash{Symbol=>String}] Driver-specific options, specified as a key/value pairs. These options
1203
+ end
1204
+
1205
+ class Device < DockerEngineRuby::Internal::Type::BaseModel
1206
+ # @!attribute cgroup_permissions
1207
+ #
1208
+ # @return [String, nil]
1209
+ optional :cgroup_permissions, String, api_name: :CgroupPermissions
1210
+
1211
+ # @!attribute path_in_container
1212
+ #
1213
+ # @return [String, nil]
1214
+ optional :path_in_container, String, api_name: :PathInContainer
1215
+
1216
+ # @!attribute path_on_host
1217
+ #
1218
+ # @return [String, nil]
1219
+ optional :path_on_host, String, api_name: :PathOnHost
1220
+
1221
+ # @!method initialize(cgroup_permissions: nil, path_in_container: nil, path_on_host: nil)
1222
+ # A device mapping between the host and container
1223
+ #
1224
+ # @param cgroup_permissions [String]
1225
+ # @param path_in_container [String]
1226
+ # @param path_on_host [String]
1227
+ end
1228
+
1229
+ # Isolation technology of the container. (Windows only)
1230
+ #
1231
+ # @see DockerEngineRuby::Models::Container::HostConfig#isolation
1232
+ module Isolation
1233
+ extend DockerEngineRuby::Internal::Type::Enum
1234
+
1235
+ DEFAULT = :default
1236
+ PROCESS = :process
1237
+ HYPERV = :hyperv
1238
+ EMPTY = :""
1239
+
1240
+ # @!method self.values
1241
+ # @return [Array<Symbol>]
1242
+ end
1243
+
1244
+ # @see DockerEngineRuby::Models::Container::HostConfig#log_config
1245
+ class LogConfig < DockerEngineRuby::Internal::Type::BaseModel
1246
+ # @!attribute config
1247
+ # Driver-specific configuration options for the logging driver.
1248
+ #
1249
+ # @return [Hash{Symbol=>String}, nil]
1250
+ optional :config, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Config
1251
+
1252
+ # @!attribute type
1253
+ # Name of the logging driver used for the container or "none" if logging is
1254
+ # disabled.
1255
+ #
1256
+ # @return [Symbol, DockerEngineRuby::Models::Container::HostConfig::LogConfig::Type, nil]
1257
+ optional :type,
1258
+ enum: -> {
1259
+ DockerEngineRuby::Container::HostConfig::LogConfig::Type
1260
+ },
1261
+ api_name: :Type
1262
+
1263
+ # @!method initialize(config: nil, type: nil)
1264
+ # Some parameter documentations has been truncated, see
1265
+ # {DockerEngineRuby::Models::Container::HostConfig::LogConfig} for more details.
1266
+ #
1267
+ # The logging configuration for this container
1268
+ #
1269
+ # @param config [Hash{Symbol=>String}] Driver-specific configuration options for the logging driver.
1270
+ #
1271
+ # @param type [Symbol, DockerEngineRuby::Models::Container::HostConfig::LogConfig::Type] Name of the logging driver used for the container or "none"
1272
+
1273
+ # Name of the logging driver used for the container or "none" if logging is
1274
+ # disabled.
1275
+ #
1276
+ # @see DockerEngineRuby::Models::Container::HostConfig::LogConfig#type
1277
+ module Type
1278
+ extend DockerEngineRuby::Internal::Type::Enum
1279
+
1280
+ LOCAL = :local
1281
+ JSON_FILE = :"json-file"
1282
+ SYSLOG = :syslog
1283
+ JOURNALD = :journald
1284
+ GELF = :gelf
1285
+ FLUENTD = :fluentd
1286
+ AWSLOGS = :awslogs
1287
+ SPLUNK = :splunk
1288
+ ETWLOGS = :etwlogs
1289
+ NONE = :none
1290
+
1291
+ # @!method self.values
1292
+ # @return [Array<Symbol>]
1293
+ end
1294
+ end
1295
+
1296
+ class Mount < DockerEngineRuby::Internal::Type::BaseModel
1297
+ # @!attribute bind_options
1298
+ # Optional configuration for the `bind` type.
1299
+ #
1300
+ # @return [DockerEngineRuby::Models::Container::HostConfig::Mount::BindOptions, nil]
1301
+ optional :bind_options,
1302
+ -> { DockerEngineRuby::Container::HostConfig::Mount::BindOptions },
1303
+ api_name: :BindOptions
1304
+
1305
+ # @!attribute consistency
1306
+ # The consistency requirement for the mount: `default`, `consistent`, `cached`, or
1307
+ # `delegated`.
1308
+ #
1309
+ # @return [String, nil]
1310
+ optional :consistency, String, api_name: :Consistency
1311
+
1312
+ # @!attribute image_options
1313
+ # Optional configuration for the `image` type.
1314
+ #
1315
+ # @return [DockerEngineRuby::Models::Container::HostConfig::Mount::ImageOptions, nil]
1316
+ optional :image_options,
1317
+ -> { DockerEngineRuby::Container::HostConfig::Mount::ImageOptions },
1318
+ api_name: :ImageOptions
1319
+
1320
+ # @!attribute read_only
1321
+ # Whether the mount should be read-only.
1322
+ #
1323
+ # @return [Boolean, nil]
1324
+ optional :read_only, DockerEngineRuby::Internal::Type::Boolean, api_name: :ReadOnly
1325
+
1326
+ # @!attribute source
1327
+ # Mount source (e.g. a volume name, a host path). The source cannot be specified
1328
+ # when using `Type=tmpfs`. For `Type=bind`, the source path must either exist, or
1329
+ # the `CreateMountpoint` must be set to `true` to create the source path on the
1330
+ # host if missing.
1331
+ #
1332
+ # For `Type=npipe`, the pipe must exist prior to creating the container.
1333
+ #
1334
+ # @return [String, nil]
1335
+ optional :source, String, api_name: :Source
1336
+
1337
+ # @!attribute target
1338
+ # Container path.
1339
+ #
1340
+ # @return [String, nil]
1341
+ optional :target, String, api_name: :Target
1342
+
1343
+ # @!attribute tmpfs_options
1344
+ # Optional configuration for the `tmpfs` type.
1345
+ #
1346
+ # @return [DockerEngineRuby::Models::Container::HostConfig::Mount::TmpfsOptions, nil]
1347
+ optional :tmpfs_options,
1348
+ -> { DockerEngineRuby::Container::HostConfig::Mount::TmpfsOptions },
1349
+ api_name: :TmpfsOptions
1350
+
1351
+ # @!attribute type
1352
+ # The mount type. Available types:
1353
+ #
1354
+ # - `bind` a mount of a file or directory from the host into the container.
1355
+ # - `cluster` a Swarm cluster volume.
1356
+ # - `image` an OCI image.
1357
+ # - `npipe` a named pipe from the host into the container.
1358
+ # - `tmpfs` a `tmpfs`.
1359
+ # - `volume` a docker volume with the given `Name`.
1360
+ #
1361
+ # @return [Symbol, DockerEngineRuby::Models::Container::HostConfig::Mount::Type, nil]
1362
+ optional :type, enum: -> { DockerEngineRuby::Container::HostConfig::Mount::Type }, api_name: :Type
1363
+
1364
+ # @!attribute volume_options
1365
+ # Optional configuration for the `volume` type.
1366
+ #
1367
+ # @return [DockerEngineRuby::Models::Container::HostConfig::Mount::VolumeOptions, nil]
1368
+ optional :volume_options,
1369
+ -> { DockerEngineRuby::Container::HostConfig::Mount::VolumeOptions },
1370
+ api_name: :VolumeOptions
1371
+
1372
+ # @!method initialize(bind_options: nil, consistency: nil, image_options: nil, read_only: nil, source: nil, target: nil, tmpfs_options: nil, type: nil, volume_options: nil)
1373
+ # Some parameter documentations has been truncated, see
1374
+ # {DockerEngineRuby::Models::Container::HostConfig::Mount} for more details.
1375
+ #
1376
+ # @param bind_options [DockerEngineRuby::Models::Container::HostConfig::Mount::BindOptions] Optional configuration for the `bind` type.
1377
+ #
1378
+ # @param consistency [String] The consistency requirement for the mount: `default`, `consistent`, `cached`, or
1379
+ #
1380
+ # @param image_options [DockerEngineRuby::Models::Container::HostConfig::Mount::ImageOptions] Optional configuration for the `image` type.
1381
+ #
1382
+ # @param read_only [Boolean] Whether the mount should be read-only.
1383
+ #
1384
+ # @param source [String] Mount source (e.g. a volume name, a host path). The source cannot be
1385
+ #
1386
+ # @param target [String] Container path.
1387
+ #
1388
+ # @param tmpfs_options [DockerEngineRuby::Models::Container::HostConfig::Mount::TmpfsOptions] Optional configuration for the `tmpfs` type.
1389
+ #
1390
+ # @param type [Symbol, DockerEngineRuby::Models::Container::HostConfig::Mount::Type] The mount type. Available types:
1391
+ #
1392
+ # @param volume_options [DockerEngineRuby::Models::Container::HostConfig::Mount::VolumeOptions] Optional configuration for the `volume` type.
1393
+
1394
+ # @see DockerEngineRuby::Models::Container::HostConfig::Mount#bind_options
1395
+ class BindOptions < DockerEngineRuby::Internal::Type::BaseModel
1396
+ # @!attribute create_mountpoint
1397
+ # Create mount point on host if missing
1398
+ #
1399
+ # @return [Boolean, nil]
1400
+ optional :create_mountpoint,
1401
+ DockerEngineRuby::Internal::Type::Boolean,
1402
+ api_name: :CreateMountpoint
1403
+
1404
+ # @!attribute non_recursive
1405
+ # Disable recursive bind mount.
1406
+ #
1407
+ # @return [Boolean, nil]
1408
+ optional :non_recursive, DockerEngineRuby::Internal::Type::Boolean, api_name: :NonRecursive
1409
+
1410
+ # @!attribute propagation
1411
+ # A propagation mode with the value `[r]private`, `[r]shared`, or `[r]slave`.
1412
+ #
1413
+ # @return [Symbol, DockerEngineRuby::Models::Container::HostConfig::Mount::BindOptions::Propagation, nil]
1414
+ optional :propagation,
1415
+ enum: -> { DockerEngineRuby::Container::HostConfig::Mount::BindOptions::Propagation },
1416
+ api_name: :Propagation
1417
+
1418
+ # @!attribute read_only_force_recursive
1419
+ # Raise an error if the mount cannot be made recursively read-only.
1420
+ #
1421
+ # @return [Boolean, nil]
1422
+ optional :read_only_force_recursive,
1423
+ DockerEngineRuby::Internal::Type::Boolean,
1424
+ api_name: :ReadOnlyForceRecursive
1425
+
1426
+ # @!attribute read_only_non_recursive
1427
+ # Make the mount non-recursively read-only, but still leave the mount recursive
1428
+ # (unless NonRecursive is set to `true` in conjunction).
1429
+ #
1430
+ # Added in v1.44, before that version all read-only mounts were non-recursive by
1431
+ # default. To match the previous behaviour this will default to `true` for clients
1432
+ # on versions prior to v1.44.
1433
+ #
1434
+ # @return [Boolean, nil]
1435
+ optional :read_only_non_recursive,
1436
+ DockerEngineRuby::Internal::Type::Boolean,
1437
+ api_name: :ReadOnlyNonRecursive
1438
+
1439
+ # @!method initialize(create_mountpoint: nil, non_recursive: nil, propagation: nil, read_only_force_recursive: nil, read_only_non_recursive: nil)
1440
+ # Some parameter documentations has been truncated, see
1441
+ # {DockerEngineRuby::Models::Container::HostConfig::Mount::BindOptions} for more
1442
+ # details.
1443
+ #
1444
+ # Optional configuration for the `bind` type.
1445
+ #
1446
+ # @param create_mountpoint [Boolean] Create mount point on host if missing
1447
+ #
1448
+ # @param non_recursive [Boolean] Disable recursive bind mount.
1449
+ #
1450
+ # @param propagation [Symbol, DockerEngineRuby::Models::Container::HostConfig::Mount::BindOptions::Propagation] A propagation mode with the value `[r]private`, `[r]shared`, or `[r]slave`.
1451
+ #
1452
+ # @param read_only_force_recursive [Boolean] Raise an error if the mount cannot be made recursively read-only.
1453
+ #
1454
+ # @param read_only_non_recursive [Boolean] Make the mount non-recursively read-only, but still leave the mount recursive
1455
+
1456
+ # A propagation mode with the value `[r]private`, `[r]shared`, or `[r]slave`.
1457
+ #
1458
+ # @see DockerEngineRuby::Models::Container::HostConfig::Mount::BindOptions#propagation
1459
+ module Propagation
1460
+ extend DockerEngineRuby::Internal::Type::Enum
1461
+
1462
+ PRIVATE = :private
1463
+ RPRIVATE = :rprivate
1464
+ SHARED = :shared
1465
+ RSHARED = :rshared
1466
+ SLAVE = :slave
1467
+ RSLAVE = :rslave
1468
+
1469
+ # @!method self.values
1470
+ # @return [Array<Symbol>]
1471
+ end
1472
+ end
1473
+
1474
+ # @see DockerEngineRuby::Models::Container::HostConfig::Mount#image_options
1475
+ class ImageOptions < DockerEngineRuby::Internal::Type::BaseModel
1476
+ # @!attribute subpath
1477
+ # Source path inside the image. Must be relative without any back traversals.
1478
+ #
1479
+ # @return [String, nil]
1480
+ optional :subpath, String, api_name: :Subpath
1481
+
1482
+ # @!method initialize(subpath: nil)
1483
+ # Optional configuration for the `image` type.
1484
+ #
1485
+ # @param subpath [String] Source path inside the image. Must be relative without any back traversals.
1486
+ end
1487
+
1488
+ # @see DockerEngineRuby::Models::Container::HostConfig::Mount#tmpfs_options
1489
+ class TmpfsOptions < DockerEngineRuby::Internal::Type::BaseModel
1490
+ # @!attribute mode
1491
+ # The permission mode for the tmpfs mount in an integer. The value must not be in
1492
+ # octal format (e.g. 755) but rather the decimal representation of the octal value
1493
+ # (e.g. 493).
1494
+ #
1495
+ # @return [Integer, nil]
1496
+ optional :mode, Integer, api_name: :Mode
1497
+
1498
+ # @!attribute options
1499
+ # The options to be passed to the tmpfs mount. An array of arrays. Flag options
1500
+ # should be provided as 1-length arrays. Other types should be provided as as
1501
+ # 2-length arrays, where the first item is the key and the second the value.
1502
+ #
1503
+ # @return [Array<Array<String>>, nil]
1504
+ optional :options,
1505
+ DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Internal::Type::ArrayOf[String]],
1506
+ api_name: :Options
1507
+
1508
+ # @!attribute size_bytes
1509
+ # The size for the tmpfs mount in bytes.
1510
+ #
1511
+ # @return [Integer, nil]
1512
+ optional :size_bytes, Integer, api_name: :SizeBytes
1513
+
1514
+ # @!method initialize(mode: nil, options: nil, size_bytes: nil)
1515
+ # Some parameter documentations has been truncated, see
1516
+ # {DockerEngineRuby::Models::Container::HostConfig::Mount::TmpfsOptions} for more
1517
+ # details.
1518
+ #
1519
+ # Optional configuration for the `tmpfs` type.
1520
+ #
1521
+ # @param mode [Integer] The permission mode for the tmpfs mount in an integer.
1522
+ #
1523
+ # @param options [Array<Array<String>>] The options to be passed to the tmpfs mount. An array of arrays.
1524
+ #
1525
+ # @param size_bytes [Integer] The size for the tmpfs mount in bytes.
1526
+ end
1527
+
1528
+ # The mount type. Available types:
1529
+ #
1530
+ # - `bind` a mount of a file or directory from the host into the container.
1531
+ # - `cluster` a Swarm cluster volume.
1532
+ # - `image` an OCI image.
1533
+ # - `npipe` a named pipe from the host into the container.
1534
+ # - `tmpfs` a `tmpfs`.
1535
+ # - `volume` a docker volume with the given `Name`.
1536
+ #
1537
+ # @see DockerEngineRuby::Models::Container::HostConfig::Mount#type
1538
+ module Type
1539
+ extend DockerEngineRuby::Internal::Type::Enum
1540
+
1541
+ BIND = :bind
1542
+ CLUSTER = :cluster
1543
+ IMAGE = :image
1544
+ NPIPE = :npipe
1545
+ TMPFS = :tmpfs
1546
+ VOLUME = :volume
1547
+
1548
+ # @!method self.values
1549
+ # @return [Array<Symbol>]
1550
+ end
1551
+
1552
+ # @see DockerEngineRuby::Models::Container::HostConfig::Mount#volume_options
1553
+ class VolumeOptions < DockerEngineRuby::Internal::Type::BaseModel
1554
+ # @!attribute driver_config
1555
+ # Map of driver specific options
1556
+ #
1557
+ # @return [DockerEngineRuby::Models::Container::HostConfig::Mount::VolumeOptions::DriverConfig, nil]
1558
+ optional :driver_config,
1559
+ -> { DockerEngineRuby::Container::HostConfig::Mount::VolumeOptions::DriverConfig },
1560
+ api_name: :DriverConfig
1561
+
1562
+ # @!attribute labels
1563
+ # User-defined key/value metadata.
1564
+ #
1565
+ # @return [Hash{Symbol=>String}, nil]
1566
+ optional :labels, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Labels
1567
+
1568
+ # @!attribute no_copy
1569
+ # Populate volume with data from the target.
1570
+ #
1571
+ # @return [Boolean, nil]
1572
+ optional :no_copy, DockerEngineRuby::Internal::Type::Boolean, api_name: :NoCopy
1573
+
1574
+ # @!attribute subpath
1575
+ # Source path inside the volume. Must be relative without any back traversals.
1576
+ #
1577
+ # @return [String, nil]
1578
+ optional :subpath, String, api_name: :Subpath
1579
+
1580
+ # @!method initialize(driver_config: nil, labels: nil, no_copy: nil, subpath: nil)
1581
+ # Optional configuration for the `volume` type.
1582
+ #
1583
+ # @param driver_config [DockerEngineRuby::Models::Container::HostConfig::Mount::VolumeOptions::DriverConfig] Map of driver specific options
1584
+ #
1585
+ # @param labels [Hash{Symbol=>String}] User-defined key/value metadata.
1586
+ #
1587
+ # @param no_copy [Boolean] Populate volume with data from the target.
1588
+ #
1589
+ # @param subpath [String] Source path inside the volume. Must be relative without any back traversals.
1590
+
1591
+ # @see DockerEngineRuby::Models::Container::HostConfig::Mount::VolumeOptions#driver_config
1592
+ class DriverConfig < DockerEngineRuby::Internal::Type::BaseModel
1593
+ # @!attribute name
1594
+ # Name of the driver to use to create the volume.
1595
+ #
1596
+ # @return [String, nil]
1597
+ optional :name, String, api_name: :Name
1598
+
1599
+ # @!attribute options
1600
+ # key/value map of driver specific options.
1601
+ #
1602
+ # @return [Hash{Symbol=>String}, nil]
1603
+ optional :options, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Options
1604
+
1605
+ # @!method initialize(name: nil, options: nil)
1606
+ # Map of driver specific options
1607
+ #
1608
+ # @param name [String] Name of the driver to use to create the volume.
1609
+ #
1610
+ # @param options [Hash{Symbol=>String}] key/value map of driver specific options.
1611
+ end
1612
+ end
1613
+ end
1614
+
1615
+ class PortBinding < DockerEngineRuby::Internal::Type::BaseModel
1616
+ # @!attribute host_ip
1617
+ # Host IP address that the container's port is mapped to.
1618
+ #
1619
+ # @return [String, nil]
1620
+ optional :host_ip, String, api_name: :HostIp
1621
+
1622
+ # @!attribute host_port
1623
+ # Host port number that the container's port is mapped to.
1624
+ #
1625
+ # @return [String, nil]
1626
+ optional :host_port, String, api_name: :HostPort
1627
+
1628
+ # @!method initialize(host_ip: nil, host_port: nil)
1629
+ # PortBinding represents a binding between a host IP address and a host port.
1630
+ #
1631
+ # @param host_ip [String] Host IP address that the container's port is mapped to.
1632
+ #
1633
+ # @param host_port [String] Host port number that the container's port is mapped to.
1634
+ end
1635
+
1636
+ # @see DockerEngineRuby::Models::Container::HostConfig#restart_policy
1637
+ class RestartPolicy < DockerEngineRuby::Internal::Type::BaseModel
1638
+ # @!attribute maximum_retry_count
1639
+ # If `on-failure` is used, the number of times to retry before giving up.
1640
+ #
1641
+ # @return [Integer, nil]
1642
+ optional :maximum_retry_count, Integer, api_name: :MaximumRetryCount
1643
+
1644
+ # @!attribute name
1645
+ # - Empty string means not to restart
1646
+ # - `no` Do not automatically restart
1647
+ # - `always` Always restart
1648
+ # - `unless-stopped` Restart always except when the user has manually stopped the
1649
+ # container
1650
+ # - `on-failure` Restart only when the container exit code is non-zero
1651
+ #
1652
+ # @return [Symbol, DockerEngineRuby::Models::Container::HostConfig::RestartPolicy::Name, nil]
1653
+ optional :name,
1654
+ enum: -> {
1655
+ DockerEngineRuby::Container::HostConfig::RestartPolicy::Name
1656
+ },
1657
+ api_name: :Name
1658
+
1659
+ # @!method initialize(maximum_retry_count: nil, name: nil)
1660
+ # Some parameter documentations has been truncated, see
1661
+ # {DockerEngineRuby::Models::Container::HostConfig::RestartPolicy} for more
1662
+ # details.
1663
+ #
1664
+ # The behavior to apply when the container exits. The default is not to restart.
1665
+ #
1666
+ # An ever increasing delay (double the previous delay, starting at 100ms) is added
1667
+ # before each restart to prevent flooding the server.
1668
+ #
1669
+ # @param maximum_retry_count [Integer] If `on-failure` is used, the number of times to retry before giving up.
1670
+ #
1671
+ # @param name [Symbol, DockerEngineRuby::Models::Container::HostConfig::RestartPolicy::Name] - Empty string means not to restart
1672
+
1673
+ # - Empty string means not to restart
1674
+ # - `no` Do not automatically restart
1675
+ # - `always` Always restart
1676
+ # - `unless-stopped` Restart always except when the user has manually stopped the
1677
+ # container
1678
+ # - `on-failure` Restart only when the container exit code is non-zero
1679
+ #
1680
+ # @see DockerEngineRuby::Models::Container::HostConfig::RestartPolicy#name
1681
+ module Name
1682
+ extend DockerEngineRuby::Internal::Type::Enum
1683
+
1684
+ EMPTY = :""
1685
+ NO = :no
1686
+ ALWAYS = :always
1687
+ UNLESS_STOPPED = :"unless-stopped"
1688
+ ON_FAILURE = :"on-failure"
1689
+
1690
+ # @!method self.values
1691
+ # @return [Array<Symbol>]
1692
+ end
1693
+ end
1694
+
1695
+ class Ulimit < DockerEngineRuby::Internal::Type::BaseModel
1696
+ # @!attribute hard
1697
+ # Hard limit
1698
+ #
1699
+ # @return [Integer, nil]
1700
+ optional :hard, Integer, api_name: :Hard
1701
+
1702
+ # @!attribute name
1703
+ # Name of ulimit
1704
+ #
1705
+ # @return [String, nil]
1706
+ optional :name, String, api_name: :Name
1707
+
1708
+ # @!attribute soft
1709
+ # Soft limit
1710
+ #
1711
+ # @return [Integer, nil]
1712
+ optional :soft, Integer, api_name: :Soft
1713
+
1714
+ # @!method initialize(hard: nil, name: nil, soft: nil)
1715
+ # @param hard [Integer] Hard limit
1716
+ #
1717
+ # @param name [String] Name of ulimit
1718
+ #
1719
+ # @param soft [Integer] Soft limit
1720
+ end
1721
+ end
1722
+
1723
+ # @see DockerEngineRuby::Models::Container#image_manifest_descriptor
1724
+ class ImageManifestDescriptor < DockerEngineRuby::Internal::Type::BaseModel
1725
+ # @!attribute annotations
1726
+ # Arbitrary metadata relating to the targeted content.
1727
+ #
1728
+ # @return [Hash{Symbol=>String}, nil]
1729
+ optional :annotations, DockerEngineRuby::Internal::Type::HashOf[String], nil?: true
1730
+
1731
+ # @!attribute artifact_type
1732
+ # ArtifactType is the IANA media type of this artifact.
1733
+ #
1734
+ # @return [String, nil]
1735
+ optional :artifact_type, String, api_name: :artifactType, nil?: true
1736
+
1737
+ # @!attribute data
1738
+ # Data is an embedding of the targeted content. This is encoded as a base64 string
1739
+ # when marshalled to JSON (automatically, by encoding/json). If present, Data can
1740
+ # be used directly to avoid fetching the targeted content.
1741
+ #
1742
+ # @return [String, nil]
1743
+ optional :data, String, nil?: true
1744
+
1745
+ # @!attribute digest
1746
+ # The digest of the targeted content.
1747
+ #
1748
+ # @return [String, nil]
1749
+ optional :digest, String
1750
+
1751
+ # @!attribute media_type
1752
+ # The media type of the object this schema refers to.
1753
+ #
1754
+ # @return [String, nil]
1755
+ optional :media_type, String, api_name: :mediaType
1756
+
1757
+ # @!attribute platform
1758
+ # Describes the platform which the image in the manifest runs on, as defined in
1759
+ # the
1760
+ # [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
1761
+ #
1762
+ # @return [DockerEngineRuby::Models::Container::ImageManifestDescriptor::Platform, nil]
1763
+ optional :platform, -> { DockerEngineRuby::Container::ImageManifestDescriptor::Platform }, nil?: true
1764
+
1765
+ # @!attribute size
1766
+ # The size in bytes of the blob.
1767
+ #
1768
+ # @return [Integer, nil]
1769
+ optional :size, Integer
1770
+
1771
+ # @!attribute urls
1772
+ # List of URLs from which this object MAY be downloaded.
1773
+ #
1774
+ # @return [Array<String>, nil]
1775
+ optional :urls, DockerEngineRuby::Internal::Type::ArrayOf[String], nil?: true
1776
+
1777
+ # @!method initialize(annotations: nil, artifact_type: nil, data: nil, digest: nil, media_type: nil, platform: nil, size: nil, urls: nil)
1778
+ # Some parameter documentations has been truncated, see
1779
+ # {DockerEngineRuby::Models::Container::ImageManifestDescriptor} for more details.
1780
+ #
1781
+ # A descriptor struct containing digest, media type, and size, as defined in the
1782
+ # [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md).
1783
+ #
1784
+ # @param annotations [Hash{Symbol=>String}, nil] Arbitrary metadata relating to the targeted content.
1785
+ #
1786
+ # @param artifact_type [String, nil] ArtifactType is the IANA media type of this artifact.
1787
+ #
1788
+ # @param data [String, nil] Data is an embedding of the targeted content. This is encoded as a base64
1789
+ #
1790
+ # @param digest [String] The digest of the targeted content.
1791
+ #
1792
+ # @param media_type [String] The media type of the object this schema refers to.
1793
+ #
1794
+ # @param platform [DockerEngineRuby::Models::Container::ImageManifestDescriptor::Platform, nil] Describes the platform which the image in the manifest runs on, as defined
1795
+ #
1796
+ # @param size [Integer] The size in bytes of the blob.
1797
+ #
1798
+ # @param urls [Array<String>, nil] List of URLs from which this object MAY be downloaded.
1799
+
1800
+ # @see DockerEngineRuby::Models::Container::ImageManifestDescriptor#platform
1801
+ class Platform < DockerEngineRuby::Internal::Type::BaseModel
1802
+ # @!attribute architecture
1803
+ # The CPU architecture, for example `amd64` or `ppc64`.
1804
+ #
1805
+ # @return [String, nil]
1806
+ optional :architecture, String
1807
+
1808
+ # @!attribute os
1809
+ # The operating system, for example `linux` or `windows`.
1810
+ #
1811
+ # @return [String, nil]
1812
+ optional :os, String
1813
+
1814
+ # @!attribute os_features
1815
+ # Optional field specifying an array of strings, each listing a required OS
1816
+ # feature (for example on Windows `win32k`).
1817
+ #
1818
+ # @return [Array<String>, nil]
1819
+ optional :os_features, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :"os.features"
1820
+
1821
+ # @!attribute os_version
1822
+ # Optional field specifying the operating system version, for example on Windows
1823
+ # `10.0.19041.1165`.
1824
+ #
1825
+ # @return [String, nil]
1826
+ optional :os_version, String, api_name: :"os.version"
1827
+
1828
+ # @!attribute variant
1829
+ # Optional field specifying a variant of the CPU, for example `v7` to specify
1830
+ # ARMv7 when architecture is `arm`.
1831
+ #
1832
+ # @return [String, nil]
1833
+ optional :variant, String
1834
+
1835
+ # @!method initialize(architecture: nil, os: nil, os_features: nil, os_version: nil, variant: nil)
1836
+ # Some parameter documentations has been truncated, see
1837
+ # {DockerEngineRuby::Models::Container::ImageManifestDescriptor::Platform} for
1838
+ # more details.
1839
+ #
1840
+ # Describes the platform which the image in the manifest runs on, as defined in
1841
+ # the
1842
+ # [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
1843
+ #
1844
+ # @param architecture [String] The CPU architecture, for example `amd64` or `ppc64`.
1845
+ #
1846
+ # @param os [String] The operating system, for example `linux` or `windows`.
1847
+ #
1848
+ # @param os_features [Array<String>] Optional field specifying an array of strings, each listing a required
1849
+ #
1850
+ # @param os_version [String] Optional field specifying the operating system version, for example on
1851
+ #
1852
+ # @param variant [String] Optional field specifying a variant of the CPU, for example `v7` to
1853
+ end
1854
+ end
1855
+
1856
+ class Mount < DockerEngineRuby::Internal::Type::BaseModel
1857
+ # @!attribute destination
1858
+ # Destination is the path relative to the container root (`/`) where the `Source`
1859
+ # is mounted inside the container.
1860
+ #
1861
+ # @return [String, nil]
1862
+ optional :destination, String, api_name: :Destination
1863
+
1864
+ # @!attribute driver
1865
+ # Driver is the volume driver used to create the volume (if it is a volume).
1866
+ #
1867
+ # @return [String, nil]
1868
+ optional :driver, String, api_name: :Driver
1869
+
1870
+ # @!attribute mode
1871
+ # Mode is a comma separated list of options supplied by the user when creating the
1872
+ # bind/volume mount.
1873
+ #
1874
+ # The default is platform-specific (`"z"` on Linux, empty on Windows).
1875
+ #
1876
+ # @return [String, nil]
1877
+ optional :mode, String, api_name: :Mode
1878
+
1879
+ # @!attribute name
1880
+ # Name is the name reference to the underlying data defined by `Source` e.g., the
1881
+ # volume name.
1882
+ #
1883
+ # @return [String, nil]
1884
+ optional :name, String, api_name: :Name
1885
+
1886
+ # @!attribute propagation
1887
+ # Propagation describes how mounts are propagated from the host into the mount
1888
+ # point, and vice-versa. Refer to the
1889
+ # [Linux kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt)
1890
+ # for details. This field is not used on Windows.
1891
+ #
1892
+ # @return [String, nil]
1893
+ optional :propagation, String, api_name: :Propagation
1894
+
1895
+ # @!attribute rw
1896
+ # Whether the mount is mounted writable (read-write).
1897
+ #
1898
+ # @return [Boolean, nil]
1899
+ optional :rw, DockerEngineRuby::Internal::Type::Boolean, api_name: :RW
1900
+
1901
+ # @!attribute source
1902
+ # Source location of the mount.
1903
+ #
1904
+ # For volumes, this contains the storage location of the volume (within
1905
+ # `/var/lib/docker/volumes/`). For bind-mounts, and `npipe`, this contains the
1906
+ # source (host) part of the bind-mount. For `tmpfs` mount points, this field is
1907
+ # empty.
1908
+ #
1909
+ # @return [String, nil]
1910
+ optional :source, String, api_name: :Source
1911
+
1912
+ # @!attribute type
1913
+ # The mount type. Available types:
1914
+ #
1915
+ # - `bind` a mount of a file or directory from the host into the container.
1916
+ # - `cluster` a Swarm cluster volume.
1917
+ # - `image` an OCI image.
1918
+ # - `npipe` a named pipe from the host into the container.
1919
+ # - `tmpfs` a `tmpfs`.
1920
+ # - `volume` a docker volume with the given `Name`.
1921
+ #
1922
+ # @return [Symbol, DockerEngineRuby::Models::Container::Mount::Type, nil]
1923
+ optional :type, enum: -> { DockerEngineRuby::Container::Mount::Type }, api_name: :Type
1924
+
1925
+ # @!method initialize(destination: nil, driver: nil, mode: nil, name: nil, propagation: nil, rw: nil, source: nil, type: nil)
1926
+ # Some parameter documentations has been truncated, see
1927
+ # {DockerEngineRuby::Models::Container::Mount} for more details.
1928
+ #
1929
+ # MountPoint represents a mount point configuration inside the container. This is
1930
+ # used for reporting the mountpoints in use by a container.
1931
+ #
1932
+ # @param destination [String] Destination is the path relative to the container root (`/`) where
1933
+ #
1934
+ # @param driver [String] Driver is the volume driver used to create the volume (if it is a volume).
1935
+ #
1936
+ # @param mode [String] Mode is a comma separated list of options supplied by the user when
1937
+ #
1938
+ # @param name [String] Name is the name reference to the underlying data defined by `Source`
1939
+ #
1940
+ # @param propagation [String] Propagation describes how mounts are propagated from the host into the
1941
+ #
1942
+ # @param rw [Boolean] Whether the mount is mounted writable (read-write).
1943
+ #
1944
+ # @param source [String] Source location of the mount.
1945
+ #
1946
+ # @param type [Symbol, DockerEngineRuby::Models::Container::Mount::Type] The mount type. Available types:
1947
+
1948
+ # The mount type. Available types:
1949
+ #
1950
+ # - `bind` a mount of a file or directory from the host into the container.
1951
+ # - `cluster` a Swarm cluster volume.
1952
+ # - `image` an OCI image.
1953
+ # - `npipe` a named pipe from the host into the container.
1954
+ # - `tmpfs` a `tmpfs`.
1955
+ # - `volume` a docker volume with the given `Name`.
1956
+ #
1957
+ # @see DockerEngineRuby::Models::Container::Mount#type
1958
+ module Type
1959
+ extend DockerEngineRuby::Internal::Type::Enum
1960
+
1961
+ BIND = :bind
1962
+ CLUSTER = :cluster
1963
+ IMAGE = :image
1964
+ NPIPE = :npipe
1965
+ TMPFS = :tmpfs
1966
+ VOLUME = :volume
1967
+
1968
+ # @!method self.values
1969
+ # @return [Array<Symbol>]
1970
+ end
1971
+ end
1972
+
1973
+ # @see DockerEngineRuby::Models::Container#network_settings
1974
+ class NetworkSettings < DockerEngineRuby::Internal::Type::BaseModel
1975
+ # @!attribute networks
1976
+ # Information about all networks that the container is connected to.
1977
+ #
1978
+ # @return [Hash{Symbol=>DockerEngineRuby::Models::Container::NetworkSettings::Network}, nil]
1979
+ optional :networks,
1980
+ -> {
1981
+ DockerEngineRuby::Internal::Type::HashOf[DockerEngineRuby::Container::NetworkSettings::Network]
1982
+ },
1983
+ api_name: :Networks
1984
+
1985
+ # @!attribute ports
1986
+ # PortMap describes the mapping of container ports to host ports, using the
1987
+ # container's port-number and protocol as key in the format `<port>/<protocol>`,
1988
+ # for example, `80/udp`.
1989
+ #
1990
+ # If a container's port is mapped for multiple protocols, separate entries are
1991
+ # added to the mapping table.
1992
+ #
1993
+ # @return [Hash{Symbol=>Array<DockerEngineRuby::Models::Container::NetworkSettings::Port>}, nil]
1994
+ optional :ports,
1995
+ -> {
1996
+ DockerEngineRuby::Internal::Type::HashOf[DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Container::NetworkSettings::Port]]
1997
+ },
1998
+ api_name: :Ports
1999
+
2000
+ # @!attribute sandbox_id
2001
+ # SandboxID uniquely represents a container's network stack.
2002
+ #
2003
+ # @return [String, nil]
2004
+ optional :sandbox_id, String, api_name: :SandboxID
2005
+
2006
+ # @!attribute sandbox_key
2007
+ # SandboxKey is the full path of the netns handle
2008
+ #
2009
+ # @return [String, nil]
2010
+ optional :sandbox_key, String, api_name: :SandboxKey
2011
+
2012
+ # @!method initialize(networks: nil, ports: nil, sandbox_id: nil, sandbox_key: nil)
2013
+ # Some parameter documentations has been truncated, see
2014
+ # {DockerEngineRuby::Models::Container::NetworkSettings} for more details.
2015
+ #
2016
+ # NetworkSettings exposes the network settings in the API
2017
+ #
2018
+ # @param networks [Hash{Symbol=>DockerEngineRuby::Models::Container::NetworkSettings::Network}] Information about all networks that the container is connected to.
2019
+ #
2020
+ # @param ports [Hash{Symbol=>Array<DockerEngineRuby::Models::Container::NetworkSettings::Port>}] PortMap describes the mapping of container ports to host ports, using the
2021
+ #
2022
+ # @param sandbox_id [String] SandboxID uniquely represents a container's network stack.
2023
+ #
2024
+ # @param sandbox_key [String] SandboxKey is the full path of the netns handle
2025
+
2026
+ class Network < DockerEngineRuby::Internal::Type::BaseModel
2027
+ # @!attribute aliases
2028
+ #
2029
+ # @return [Array<String>, nil]
2030
+ optional :aliases, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Aliases
2031
+
2032
+ # @!attribute dns_names
2033
+ # List of all DNS names an endpoint has on a specific network. This list is based
2034
+ # on the container name, network aliases, container short ID, and hostname.
2035
+ #
2036
+ # These DNS names are non-fully qualified but can contain several dots. You can
2037
+ # get fully qualified DNS names by appending `.<network-name>`. For instance, if
2038
+ # container name is `my.ctr` and the network is named `testnet`, `DNSNames` will
2039
+ # contain `my.ctr` and the FQDN will be `my.ctr.testnet`.
2040
+ #
2041
+ # @return [Array<String>, nil]
2042
+ optional :dns_names, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :DNSNames
2043
+
2044
+ # @!attribute driver_opts
2045
+ # DriverOpts is a mapping of driver options and values. These options are passed
2046
+ # directly to the driver and are driver specific.
2047
+ #
2048
+ # @return [Hash{Symbol=>String}, nil]
2049
+ optional :driver_opts,
2050
+ DockerEngineRuby::Internal::Type::HashOf[String],
2051
+ api_name: :DriverOpts,
2052
+ nil?: true
2053
+
2054
+ # @!attribute endpoint_id
2055
+ # Unique ID for the service endpoint in a Sandbox.
2056
+ #
2057
+ # @return [String, nil]
2058
+ optional :endpoint_id, String, api_name: :EndpointID
2059
+
2060
+ # @!attribute gateway
2061
+ # Gateway address for this network.
2062
+ #
2063
+ # @return [String, nil]
2064
+ optional :gateway, String, api_name: :Gateway
2065
+
2066
+ # @!attribute global_i_pv6_address
2067
+ # Global IPv6 address.
2068
+ #
2069
+ # @return [String, nil]
2070
+ optional :global_i_pv6_address, String, api_name: :GlobalIPv6Address
2071
+
2072
+ # @!attribute global_i_pv6_prefix_len
2073
+ # Mask length of the global IPv6 address.
2074
+ #
2075
+ # @return [Integer, nil]
2076
+ optional :global_i_pv6_prefix_len, Integer, api_name: :GlobalIPv6PrefixLen
2077
+
2078
+ # @!attribute gw_priority
2079
+ # This property determines which endpoint will provide the default gateway for a
2080
+ # container. The endpoint with the highest priority will be used. If multiple
2081
+ # endpoints have the same priority, endpoints are lexicographically sorted based
2082
+ # on their network name, and the one that sorts first is picked.
2083
+ #
2084
+ # @return [Integer, nil]
2085
+ optional :gw_priority, Integer, api_name: :GwPriority
2086
+
2087
+ # @!attribute ip_address
2088
+ # IPv4 address.
2089
+ #
2090
+ # @return [String, nil]
2091
+ optional :ip_address, String, api_name: :IPAddress
2092
+
2093
+ # @!attribute ipam_config
2094
+ # EndpointIPAMConfig represents an endpoint's IPAM configuration.
2095
+ #
2096
+ # @return [DockerEngineRuby::Models::Container::NetworkSettings::Network::IpamConfig, nil]
2097
+ optional :ipam_config,
2098
+ -> { DockerEngineRuby::Container::NetworkSettings::Network::IpamConfig },
2099
+ api_name: :IPAMConfig,
2100
+ nil?: true
2101
+
2102
+ # @!attribute ip_prefix_len
2103
+ # Mask length of the IPv4 address.
2104
+ #
2105
+ # @return [Integer, nil]
2106
+ optional :ip_prefix_len, Integer, api_name: :IPPrefixLen
2107
+
2108
+ # @!attribute i_pv6_gateway
2109
+ # IPv6 gateway address.
2110
+ #
2111
+ # @return [String, nil]
2112
+ optional :i_pv6_gateway, String, api_name: :IPv6Gateway
2113
+
2114
+ # @!attribute links
2115
+ #
2116
+ # @return [Array<String>, nil]
2117
+ optional :links, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Links
2118
+
2119
+ # @!attribute mac_address
2120
+ # MAC address for the endpoint on this network. The network driver might ignore
2121
+ # this parameter.
2122
+ #
2123
+ # @return [String, nil]
2124
+ optional :mac_address, String, api_name: :MacAddress
2125
+
2126
+ # @!attribute network_id
2127
+ # Unique ID of the network.
2128
+ #
2129
+ # @return [String, nil]
2130
+ optional :network_id, String, api_name: :NetworkID
2131
+
2132
+ # @!method initialize(aliases: nil, dns_names: nil, driver_opts: nil, endpoint_id: nil, gateway: nil, global_i_pv6_address: nil, global_i_pv6_prefix_len: nil, gw_priority: nil, ip_address: nil, ipam_config: nil, ip_prefix_len: nil, i_pv6_gateway: nil, links: nil, mac_address: nil, network_id: nil)
2133
+ # Some parameter documentations has been truncated, see
2134
+ # {DockerEngineRuby::Models::Container::NetworkSettings::Network} for more
2135
+ # details.
2136
+ #
2137
+ # Configuration for a network endpoint.
2138
+ #
2139
+ # @param aliases [Array<String>]
2140
+ #
2141
+ # @param dns_names [Array<String>] List of all DNS names an endpoint has on a specific network. This
2142
+ #
2143
+ # @param driver_opts [Hash{Symbol=>String}, nil] DriverOpts is a mapping of driver options and values. These options
2144
+ #
2145
+ # @param endpoint_id [String] Unique ID for the service endpoint in a Sandbox.
2146
+ #
2147
+ # @param gateway [String] Gateway address for this network.
2148
+ #
2149
+ # @param global_i_pv6_address [String] Global IPv6 address.
2150
+ #
2151
+ # @param global_i_pv6_prefix_len [Integer] Mask length of the global IPv6 address.
2152
+ #
2153
+ # @param gw_priority [Integer] This property determines which endpoint will provide the default
2154
+ #
2155
+ # @param ip_address [String] IPv4 address.
2156
+ #
2157
+ # @param ipam_config [DockerEngineRuby::Models::Container::NetworkSettings::Network::IpamConfig, nil] EndpointIPAMConfig represents an endpoint's IPAM configuration.
2158
+ #
2159
+ # @param ip_prefix_len [Integer] Mask length of the IPv4 address.
2160
+ #
2161
+ # @param i_pv6_gateway [String] IPv6 gateway address.
2162
+ #
2163
+ # @param links [Array<String>]
2164
+ #
2165
+ # @param mac_address [String] MAC address for the endpoint on this network. The network driver might ignore th
2166
+ #
2167
+ # @param network_id [String] Unique ID of the network.
2168
+
2169
+ # @see DockerEngineRuby::Models::Container::NetworkSettings::Network#ipam_config
2170
+ class IpamConfig < DockerEngineRuby::Internal::Type::BaseModel
2171
+ # @!attribute i_pv4_address
2172
+ #
2173
+ # @return [String, nil]
2174
+ optional :i_pv4_address, String, api_name: :IPv4Address
2175
+
2176
+ # @!attribute i_pv6_address
2177
+ #
2178
+ # @return [String, nil]
2179
+ optional :i_pv6_address, String, api_name: :IPv6Address
2180
+
2181
+ # @!attribute link_local_ips
2182
+ #
2183
+ # @return [Array<String>, nil]
2184
+ optional :link_local_ips,
2185
+ DockerEngineRuby::Internal::Type::ArrayOf[String],
2186
+ api_name: :LinkLocalIPs
2187
+
2188
+ # @!method initialize(i_pv4_address: nil, i_pv6_address: nil, link_local_ips: nil)
2189
+ # EndpointIPAMConfig represents an endpoint's IPAM configuration.
2190
+ #
2191
+ # @param i_pv4_address [String]
2192
+ # @param i_pv6_address [String]
2193
+ # @param link_local_ips [Array<String>]
2194
+ end
2195
+ end
2196
+
2197
+ class Port < DockerEngineRuby::Internal::Type::BaseModel
2198
+ # @!attribute host_ip
2199
+ # Host IP address that the container's port is mapped to.
2200
+ #
2201
+ # @return [String, nil]
2202
+ optional :host_ip, String, api_name: :HostIp
2203
+
2204
+ # @!attribute host_port
2205
+ # Host port number that the container's port is mapped to.
2206
+ #
2207
+ # @return [String, nil]
2208
+ optional :host_port, String, api_name: :HostPort
2209
+
2210
+ # @!method initialize(host_ip: nil, host_port: nil)
2211
+ # PortBinding represents a binding between a host IP address and a host port.
2212
+ #
2213
+ # @param host_ip [String] Host IP address that the container's port is mapped to.
2214
+ #
2215
+ # @param host_port [String] Host port number that the container's port is mapped to.
2216
+ end
2217
+ end
2218
+
2219
+ # @see DockerEngineRuby::Models::Container#state
2220
+ class State < DockerEngineRuby::Internal::Type::BaseModel
2221
+ # @!attribute dead
2222
+ #
2223
+ # @return [Boolean, nil]
2224
+ optional :dead, DockerEngineRuby::Internal::Type::Boolean, api_name: :Dead
2225
+
2226
+ # @!attribute error
2227
+ #
2228
+ # @return [String, nil]
2229
+ optional :error, String, api_name: :Error
2230
+
2231
+ # @!attribute exit_code
2232
+ # The last exit code of this container
2233
+ #
2234
+ # @return [Integer, nil]
2235
+ optional :exit_code, Integer, api_name: :ExitCode
2236
+
2237
+ # @!attribute finished_at
2238
+ # The time when this container last exited.
2239
+ #
2240
+ # @return [String, nil]
2241
+ optional :finished_at, String, api_name: :FinishedAt
2242
+
2243
+ # @!attribute health
2244
+ # Health stores information about the container's healthcheck results.
2245
+ #
2246
+ # @return [DockerEngineRuby::Models::Container::State::Health, nil]
2247
+ optional :health, -> { DockerEngineRuby::Container::State::Health }, api_name: :Health, nil?: true
2248
+
2249
+ # @!attribute oom_killed
2250
+ # Whether a process within this container has been killed because it ran out of
2251
+ # memory since the container was last started.
2252
+ #
2253
+ # @return [Boolean, nil]
2254
+ optional :oom_killed, DockerEngineRuby::Internal::Type::Boolean, api_name: :OOMKilled
2255
+
2256
+ # @!attribute paused
2257
+ # Whether this container is paused.
2258
+ #
2259
+ # @return [Boolean, nil]
2260
+ optional :paused, DockerEngineRuby::Internal::Type::Boolean, api_name: :Paused
2261
+
2262
+ # @!attribute pid
2263
+ # The process ID of this container
2264
+ #
2265
+ # @return [Integer, nil]
2266
+ optional :pid, Integer, api_name: :Pid
2267
+
2268
+ # @!attribute restarting
2269
+ # Whether this container is restarting.
2270
+ #
2271
+ # @return [Boolean, nil]
2272
+ optional :restarting, DockerEngineRuby::Internal::Type::Boolean, api_name: :Restarting
2273
+
2274
+ # @!attribute running
2275
+ # Whether this container is running.
2276
+ #
2277
+ # Note that a running container can be _paused_. The `Running` and `Paused`
2278
+ # booleans are not mutually exclusive:
2279
+ #
2280
+ # When pausing a container (on Linux), the freezer cgroup is used to suspend all
2281
+ # processes in the container. Freezing the process requires the process to be
2282
+ # running. As a result, paused containers are both `Running` _and_ `Paused`.
2283
+ #
2284
+ # Use the `Status` field instead to determine if a container's state is "running".
2285
+ #
2286
+ # @return [Boolean, nil]
2287
+ optional :running, DockerEngineRuby::Internal::Type::Boolean, api_name: :Running
2288
+
2289
+ # @!attribute started_at
2290
+ # The time when this container was last started.
2291
+ #
2292
+ # @return [String, nil]
2293
+ optional :started_at, String, api_name: :StartedAt
2294
+
2295
+ # @!attribute status
2296
+ # String representation of the container state. Can be one of "created",
2297
+ # "running", "paused", "restarting", "removing", "exited", or "dead".
2298
+ #
2299
+ # @return [Symbol, DockerEngineRuby::Models::Container::State::Status, nil]
2300
+ optional :status, enum: -> { DockerEngineRuby::Container::State::Status }, api_name: :Status
2301
+
2302
+ # @!method initialize(dead: nil, error: nil, exit_code: nil, finished_at: nil, health: nil, oom_killed: nil, paused: nil, pid: nil, restarting: nil, running: nil, started_at: nil, status: nil)
2303
+ # Some parameter documentations has been truncated, see
2304
+ # {DockerEngineRuby::Models::Container::State} for more details.
2305
+ #
2306
+ # ContainerState stores container's running state. It's part of ContainerJSONBase
2307
+ # and will be returned by the "inspect" command.
2308
+ #
2309
+ # @param dead [Boolean]
2310
+ #
2311
+ # @param error [String]
2312
+ #
2313
+ # @param exit_code [Integer] The last exit code of this container
2314
+ #
2315
+ # @param finished_at [String] The time when this container last exited.
2316
+ #
2317
+ # @param health [DockerEngineRuby::Models::Container::State::Health, nil] Health stores information about the container's healthcheck results.
2318
+ #
2319
+ # @param oom_killed [Boolean] Whether a process within this container has been killed because it ran
2320
+ #
2321
+ # @param paused [Boolean] Whether this container is paused.
2322
+ #
2323
+ # @param pid [Integer] The process ID of this container
2324
+ #
2325
+ # @param restarting [Boolean] Whether this container is restarting.
2326
+ #
2327
+ # @param running [Boolean] Whether this container is running.
2328
+ #
2329
+ # @param started_at [String] The time when this container was last started.
2330
+ #
2331
+ # @param status [Symbol, DockerEngineRuby::Models::Container::State::Status] String representation of the container state. Can be one of "created",
2332
+
2333
+ # @see DockerEngineRuby::Models::Container::State#health
2334
+ class Health < DockerEngineRuby::Internal::Type::BaseModel
2335
+ # @!attribute failing_streak
2336
+ # FailingStreak is the number of consecutive failures
2337
+ #
2338
+ # @return [Integer, nil]
2339
+ optional :failing_streak, Integer, api_name: :FailingStreak
2340
+
2341
+ # @!attribute log
2342
+ # Log contains the last few results (oldest first)
2343
+ #
2344
+ # @return [Array<DockerEngineRuby::Models::Container::State::Health::Log, nil>, nil]
2345
+ optional :log,
2346
+ -> {
2347
+ DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Container::State::Health::Log,
2348
+ nil?: true]
2349
+ },
2350
+ api_name: :Log
2351
+
2352
+ # @!attribute status
2353
+ # Status is one of `none`, `starting`, `healthy` or `unhealthy`
2354
+ #
2355
+ # - "none" Indicates there is no healthcheck
2356
+ # - "starting" Starting indicates that the container is not yet ready
2357
+ # - "healthy" Healthy indicates that the container is running correctly
2358
+ # - "unhealthy" Unhealthy indicates that the container has a problem
2359
+ #
2360
+ # @return [Symbol, DockerEngineRuby::Models::Container::State::Health::Status, nil]
2361
+ optional :status, enum: -> { DockerEngineRuby::Container::State::Health::Status }, api_name: :Status
2362
+
2363
+ # @!method initialize(failing_streak: nil, log: nil, status: nil)
2364
+ # Some parameter documentations has been truncated, see
2365
+ # {DockerEngineRuby::Models::Container::State::Health} for more details.
2366
+ #
2367
+ # Health stores information about the container's healthcheck results.
2368
+ #
2369
+ # @param failing_streak [Integer] FailingStreak is the number of consecutive failures
2370
+ #
2371
+ # @param log [Array<DockerEngineRuby::Models::Container::State::Health::Log, nil>] Log contains the last few results (oldest first)
2372
+ #
2373
+ # @param status [Symbol, DockerEngineRuby::Models::Container::State::Health::Status] Status is one of `none`, `starting`, `healthy` or `unhealthy`
2374
+
2375
+ class Log < DockerEngineRuby::Internal::Type::BaseModel
2376
+ # @!attribute end_
2377
+ # Date and time at which this check ended in
2378
+ # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
2379
+ #
2380
+ # @return [String, nil]
2381
+ optional :end_, String, api_name: :End
2382
+
2383
+ # @!attribute exit_code
2384
+ # ExitCode meanings:
2385
+ #
2386
+ # - `0` healthy
2387
+ # - `1` unhealthy
2388
+ # - `2` reserved (considered unhealthy)
2389
+ # - other values: error running probe
2390
+ #
2391
+ # @return [Integer, nil]
2392
+ optional :exit_code, Integer, api_name: :ExitCode
2393
+
2394
+ # @!attribute output
2395
+ # Output from last check
2396
+ #
2397
+ # @return [String, nil]
2398
+ optional :output, String, api_name: :Output
2399
+
2400
+ # @!attribute start
2401
+ # Date and time at which this check started in
2402
+ # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
2403
+ #
2404
+ # @return [Time, nil]
2405
+ optional :start, Time, api_name: :Start
2406
+
2407
+ # @!method initialize(end_: nil, exit_code: nil, output: nil, start: nil)
2408
+ # Some parameter documentations has been truncated, see
2409
+ # {DockerEngineRuby::Models::Container::State::Health::Log} for more details.
2410
+ #
2411
+ # HealthcheckResult stores information about a single run of a healthcheck probe
2412
+ #
2413
+ # @param end_ [String] Date and time at which this check ended in
2414
+ #
2415
+ # @param exit_code [Integer] ExitCode meanings:
2416
+ #
2417
+ # @param output [String] Output from last check
2418
+ #
2419
+ # @param start [Time] Date and time at which this check started in
2420
+ end
2421
+
2422
+ # Status is one of `none`, `starting`, `healthy` or `unhealthy`
2423
+ #
2424
+ # - "none" Indicates there is no healthcheck
2425
+ # - "starting" Starting indicates that the container is not yet ready
2426
+ # - "healthy" Healthy indicates that the container is running correctly
2427
+ # - "unhealthy" Unhealthy indicates that the container has a problem
2428
+ #
2429
+ # @see DockerEngineRuby::Models::Container::State::Health#status
2430
+ module Status
2431
+ extend DockerEngineRuby::Internal::Type::Enum
2432
+
2433
+ NONE = :none
2434
+ STARTING = :starting
2435
+ HEALTHY = :healthy
2436
+ UNHEALTHY = :unhealthy
2437
+
2438
+ # @!method self.values
2439
+ # @return [Array<Symbol>]
2440
+ end
2441
+ end
2442
+
2443
+ # String representation of the container state. Can be one of "created",
2444
+ # "running", "paused", "restarting", "removing", "exited", or "dead".
2445
+ #
2446
+ # @see DockerEngineRuby::Models::Container::State#status
2447
+ module Status
2448
+ extend DockerEngineRuby::Internal::Type::Enum
2449
+
2450
+ CREATED = :created
2451
+ RUNNING = :running
2452
+ PAUSED = :paused
2453
+ RESTARTING = :restarting
2454
+ REMOVING = :removing
2455
+ EXITED = :exited
2456
+ DEAD = :dead
2457
+
2458
+ # @!method self.values
2459
+ # @return [Array<Symbol>]
2460
+ end
2461
+ end
2462
+
2463
+ # @see DockerEngineRuby::Models::Container#storage
2464
+ class Storage < DockerEngineRuby::Internal::Type::BaseModel
2465
+ # @!attribute root_fs
2466
+ # Information about the storage used for the container's root filesystem.
2467
+ #
2468
+ # @return [DockerEngineRuby::Models::Container::Storage::RootFs, nil]
2469
+ optional :root_fs, -> { DockerEngineRuby::Container::Storage::RootFs }, api_name: :RootFS
2470
+
2471
+ # @!method initialize(root_fs: nil)
2472
+ # Some parameter documentations has been truncated, see
2473
+ # {DockerEngineRuby::Models::Container::Storage} for more details.
2474
+ #
2475
+ # Information about the storage used by the container.
2476
+ #
2477
+ # @param root_fs [DockerEngineRuby::Models::Container::Storage::RootFs] Information about the storage used for the container's root filesystem.
2478
+
2479
+ # @see DockerEngineRuby::Models::Container::Storage#root_fs
2480
+ class RootFs < DockerEngineRuby::Internal::Type::BaseModel
2481
+ # @!attribute snapshot
2482
+ # Information about a snapshot backend of the container's root filesystem.
2483
+ #
2484
+ # @return [DockerEngineRuby::Models::Container::Storage::RootFs::Snapshot, nil]
2485
+ optional :snapshot,
2486
+ -> {
2487
+ DockerEngineRuby::Container::Storage::RootFs::Snapshot
2488
+ },
2489
+ api_name: :Snapshot
2490
+
2491
+ # @!method initialize(snapshot: nil)
2492
+ # Some parameter documentations has been truncated, see
2493
+ # {DockerEngineRuby::Models::Container::Storage::RootFs} for more details.
2494
+ #
2495
+ # Information about the storage used for the container's root filesystem.
2496
+ #
2497
+ # @param snapshot [DockerEngineRuby::Models::Container::Storage::RootFs::Snapshot] Information about a snapshot backend of the container's root filesystem.
2498
+
2499
+ # @see DockerEngineRuby::Models::Container::Storage::RootFs#snapshot
2500
+ class Snapshot < DockerEngineRuby::Internal::Type::BaseModel
2501
+ # @!attribute name
2502
+ # Name of the snapshotter.
2503
+ #
2504
+ # @return [String, nil]
2505
+ optional :name, String, api_name: :Name
2506
+
2507
+ # @!method initialize(name: nil)
2508
+ # Information about a snapshot backend of the container's root filesystem.
2509
+ #
2510
+ # @param name [String] Name of the snapshotter.
2511
+ end
2512
+ end
2513
+ end
2514
+ end
2515
+ end
2516
+ end