docker-engine-api 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (608) hide show
  1. checksums.yaml +7 -0
  2. data/.ignore +2 -0
  3. data/CHANGELOG.md +33 -0
  4. data/README.md +232 -0
  5. data/SECURITY.md +27 -0
  6. data/lib/docker_engine_api/client.rb +109 -0
  7. data/lib/docker_engine_api/errors.rb +228 -0
  8. data/lib/docker_engine_api/file_part.rb +58 -0
  9. data/lib/docker_engine_api/internal/transport/base_client.rb +571 -0
  10. data/lib/docker_engine_api/internal/transport/pooled_net_requester.rb +210 -0
  11. data/lib/docker_engine_api/internal/type/array_of.rb +168 -0
  12. data/lib/docker_engine_api/internal/type/base_model.rb +534 -0
  13. data/lib/docker_engine_api/internal/type/base_page.rb +55 -0
  14. data/lib/docker_engine_api/internal/type/boolean.rb +77 -0
  15. data/lib/docker_engine_api/internal/type/converter.rb +327 -0
  16. data/lib/docker_engine_api/internal/type/enum.rb +131 -0
  17. data/lib/docker_engine_api/internal/type/file_input.rb +111 -0
  18. data/lib/docker_engine_api/internal/type/hash_of.rb +188 -0
  19. data/lib/docker_engine_api/internal/type/request_parameters.rb +42 -0
  20. data/lib/docker_engine_api/internal/type/union.rb +245 -0
  21. data/lib/docker_engine_api/internal/type/unknown.rb +81 -0
  22. data/lib/docker_engine_api/internal/util.rb +920 -0
  23. data/lib/docker_engine_api/internal.rb +20 -0
  24. data/lib/docker_engine_api/models/auth_login_params.rb +32 -0
  25. data/lib/docker_engine_api/models/auth_response.rb +27 -0
  26. data/lib/docker_engine_api/models/config.rb +307 -0
  27. data/lib/docker_engine_api/models/config_create_params.rb +24 -0
  28. data/lib/docker_engine_api/models/config_create_response.rb +19 -0
  29. data/lib/docker_engine_api/models/config_delete_params.rb +14 -0
  30. data/lib/docker_engine_api/models/config_inspect_params.rb +14 -0
  31. data/lib/docker_engine_api/models/config_list_params.rb +33 -0
  32. data/lib/docker_engine_api/models/config_list_response.rb +8 -0
  33. data/lib/docker_engine_api/models/config_update_params.rb +26 -0
  34. data/lib/docker_engine_api/models/connect_request.rb +198 -0
  35. data/lib/docker_engine_api/models/container.rb +2515 -0
  36. data/lib/docker_engine_api/models/container_archive_params.rb +22 -0
  37. data/lib/docker_engine_api/models/container_attach_params.rb +73 -0
  38. data/lib/docker_engine_api/models/container_changes_params.rb +14 -0
  39. data/lib/docker_engine_api/models/container_changes_response.rb +9 -0
  40. data/lib/docker_engine_api/models/container_create_params.rb +1720 -0
  41. data/lib/docker_engine_api/models/container_delete_params.rb +38 -0
  42. data/lib/docker_engine_api/models/container_exec_params.rb +111 -0
  43. data/lib/docker_engine_api/models/container_exec_response.rb +19 -0
  44. data/lib/docker_engine_api/models/container_export_params.rb +14 -0
  45. data/lib/docker_engine_api/models/container_inspect_params.rb +22 -0
  46. data/lib/docker_engine_api/models/container_kill_params.rb +25 -0
  47. data/lib/docker_engine_api/models/container_list_params.rb +70 -0
  48. data/lib/docker_engine_api/models/container_list_response.rb +8 -0
  49. data/lib/docker_engine_api/models/container_logs_params.rb +74 -0
  50. data/lib/docker_engine_api/models/container_pause_params.rb +14 -0
  51. data/lib/docker_engine_api/models/container_prune_params.rb +35 -0
  52. data/lib/docker_engine_api/models/container_prune_response.rb +27 -0
  53. data/lib/docker_engine_api/models/container_rename_params.rb +22 -0
  54. data/lib/docker_engine_api/models/container_resize_params.rb +30 -0
  55. data/lib/docker_engine_api/models/container_restart_params.rb +33 -0
  56. data/lib/docker_engine_api/models/container_start_params.rb +27 -0
  57. data/lib/docker_engine_api/models/container_stats_params.rb +35 -0
  58. data/lib/docker_engine_api/models/container_stop_params.rb +33 -0
  59. data/lib/docker_engine_api/models/container_top_params.rb +22 -0
  60. data/lib/docker_engine_api/models/container_unpause_params.rb +14 -0
  61. data/lib/docker_engine_api/models/container_update_params.rb +606 -0
  62. data/lib/docker_engine_api/models/container_wait_params.rb +41 -0
  63. data/lib/docker_engine_api/models/create_request.rb +348 -0
  64. data/lib/docker_engine_api/models/create_response.rb +27 -0
  65. data/lib/docker_engine_api/models/delete_item.rb +24 -0
  66. data/lib/docker_engine_api/models/disconnect_request.rb +27 -0
  67. data/lib/docker_engine_api/models/distribution_inspect_params.rb +14 -0
  68. data/lib/docker_engine_api/models/error.rb +18 -0
  69. data/lib/docker_engine_api/models/exec_inspect_params.rb +14 -0
  70. data/lib/docker_engine_api/models/exec_inspect_response.rb +87 -0
  71. data/lib/docker_engine_api/models/exec_resize_params.rb +30 -0
  72. data/lib/docker_engine_api/models/exec_start_params.rb +41 -0
  73. data/lib/docker_engine_api/models/filesystem_change.rb +55 -0
  74. data/lib/docker_engine_api/models/history_item.rb +47 -0
  75. data/lib/docker_engine_api/models/image.rb +1395 -0
  76. data/lib/docker_engine_api/models/image_build_params.rb +283 -0
  77. data/lib/docker_engine_api/models/image_build_prune_params.rb +71 -0
  78. data/lib/docker_engine_api/models/image_build_prune_response.rb +24 -0
  79. data/lib/docker_engine_api/models/image_commit_params.rb +70 -0
  80. data/lib/docker_engine_api/models/image_commit_response.rb +19 -0
  81. data/lib/docker_engine_api/models/image_delete_params.rb +43 -0
  82. data/lib/docker_engine_api/models/image_delete_response.rb +8 -0
  83. data/lib/docker_engine_api/models/image_get_all_params.rb +37 -0
  84. data/lib/docker_engine_api/models/image_get_params.rb +29 -0
  85. data/lib/docker_engine_api/models/image_history_params.rb +34 -0
  86. data/lib/docker_engine_api/models/image_history_response.rb +8 -0
  87. data/lib/docker_engine_api/models/image_inspect_params.rb +22 -0
  88. data/lib/docker_engine_api/models/image_list_params.rb +68 -0
  89. data/lib/docker_engine_api/models/image_list_response.rb +8 -0
  90. data/lib/docker_engine_api/models/image_load_params.rb +44 -0
  91. data/lib/docker_engine_api/models/image_prune_params.rb +35 -0
  92. data/lib/docker_engine_api/models/image_prune_response.rb +27 -0
  93. data/lib/docker_engine_api/models/image_pull_params.rb +115 -0
  94. data/lib/docker_engine_api/models/image_push_params.rb +49 -0
  95. data/lib/docker_engine_api/models/image_search_params.rb +45 -0
  96. data/lib/docker_engine_api/models/image_search_response.rb +55 -0
  97. data/lib/docker_engine_api/models/image_tag_params.rb +30 -0
  98. data/lib/docker_engine_api/models/info.rb +1488 -0
  99. data/lib/docker_engine_api/models/inspect.rb +221 -0
  100. data/lib/docker_engine_api/models/inspect_response.rb +39 -0
  101. data/lib/docker_engine_api/models/list_response.rb +32 -0
  102. data/lib/docker_engine_api/models/network.rb +253 -0
  103. data/lib/docker_engine_api/models/network_connect_params.rb +14 -0
  104. data/lib/docker_engine_api/models/network_create_params.rb +210 -0
  105. data/lib/docker_engine_api/models/network_delete_params.rb +14 -0
  106. data/lib/docker_engine_api/models/network_disconnect_params.rb +14 -0
  107. data/lib/docker_engine_api/models/network_inspect_params.rb +30 -0
  108. data/lib/docker_engine_api/models/network_inspect_response.rb +131 -0
  109. data/lib/docker_engine_api/models/network_list_params.rb +40 -0
  110. data/lib/docker_engine_api/models/network_list_response.rb +8 -0
  111. data/lib/docker_engine_api/models/network_prune_params.rb +35 -0
  112. data/lib/docker_engine_api/models/network_prune_response.rb +17 -0
  113. data/lib/docker_engine_api/models/node.rb +459 -0
  114. data/lib/docker_engine_api/models/node_delete_params.rb +22 -0
  115. data/lib/docker_engine_api/models/node_inspect_params.rb +14 -0
  116. data/lib/docker_engine_api/models/node_list_params.rb +34 -0
  117. data/lib/docker_engine_api/models/node_list_response.rb +8 -0
  118. data/lib/docker_engine_api/models/node_update_params.rb +26 -0
  119. data/lib/docker_engine_api/models/plugin.rb +532 -0
  120. data/lib/docker_engine_api/models/plugin_create_params.rb +33 -0
  121. data/lib/docker_engine_api/models/plugin_delete_params.rb +26 -0
  122. data/lib/docker_engine_api/models/plugin_disable_params.rb +25 -0
  123. data/lib/docker_engine_api/models/plugin_enable_params.rb +22 -0
  124. data/lib/docker_engine_api/models/plugin_inspect_params.rb +14 -0
  125. data/lib/docker_engine_api/models/plugin_list_params.rb +31 -0
  126. data/lib/docker_engine_api/models/plugin_list_response.rb +8 -0
  127. data/lib/docker_engine_api/models/plugin_privileges_params.rb +26 -0
  128. data/lib/docker_engine_api/models/plugin_privileges_response.rb +8 -0
  129. data/lib/docker_engine_api/models/plugin_pull_params.rb +51 -0
  130. data/lib/docker_engine_api/models/plugin_push_params.rb +14 -0
  131. data/lib/docker_engine_api/models/plugin_set_params.rb +20 -0
  132. data/lib/docker_engine_api/models/plugin_upgrade_params.rb +41 -0
  133. data/lib/docker_engine_api/models/privilege.rb +29 -0
  134. data/lib/docker_engine_api/models/secret.rb +77 -0
  135. data/lib/docker_engine_api/models/secret_create_params.rb +24 -0
  136. data/lib/docker_engine_api/models/secret_create_response.rb +19 -0
  137. data/lib/docker_engine_api/models/secret_delete_params.rb +14 -0
  138. data/lib/docker_engine_api/models/secret_inspect_params.rb +14 -0
  139. data/lib/docker_engine_api/models/secret_list_params.rb +33 -0
  140. data/lib/docker_engine_api/models/secret_list_response.rb +8 -0
  141. data/lib/docker_engine_api/models/secret_update_params.rb +26 -0
  142. data/lib/docker_engine_api/models/service.rb +524 -0
  143. data/lib/docker_engine_api/models/service_create_params.rb +34 -0
  144. data/lib/docker_engine_api/models/service_delete_params.rb +14 -0
  145. data/lib/docker_engine_api/models/service_inspect_params.rb +22 -0
  146. data/lib/docker_engine_api/models/service_list_params.rb +41 -0
  147. data/lib/docker_engine_api/models/service_list_response.rb +8 -0
  148. data/lib/docker_engine_api/models/service_logs_params.rb +74 -0
  149. data/lib/docker_engine_api/models/service_update_params.rb +78 -0
  150. data/lib/docker_engine_api/models/spec.rb +510 -0
  151. data/lib/docker_engine_api/models/stats_response.rb +950 -0
  152. data/lib/docker_engine_api/models/summary.rb +767 -0
  153. data/lib/docker_engine_api/models/swarm.rb +198 -0
  154. data/lib/docker_engine_api/models/swarm_init_params.rb +101 -0
  155. data/lib/docker_engine_api/models/swarm_init_response.rb +7 -0
  156. data/lib/docker_engine_api/models/swarm_inspect_params.rb +14 -0
  157. data/lib/docker_engine_api/models/swarm_join_params.rb +70 -0
  158. data/lib/docker_engine_api/models/swarm_leave_params.rb +26 -0
  159. data/lib/docker_engine_api/models/swarm_unlock_key_params.rb +14 -0
  160. data/lib/docker_engine_api/models/swarm_unlock_key_response.rb +17 -0
  161. data/lib/docker_engine_api/models/swarm_unlock_params.rb +22 -0
  162. data/lib/docker_engine_api/models/swarm_update_params.rb +50 -0
  163. data/lib/docker_engine_api/models/system_data_usage_params.rb +46 -0
  164. data/lib/docker_engine_api/models/system_data_usage_response.rb +260 -0
  165. data/lib/docker_engine_api/models/system_events_params.rb +58 -0
  166. data/lib/docker_engine_api/models/system_events_response.rb +126 -0
  167. data/lib/docker_engine_api/models/system_info_params.rb +14 -0
  168. data/lib/docker_engine_api/models/system_ping_params.rb +14 -0
  169. data/lib/docker_engine_api/models/system_ping_response.rb +7 -0
  170. data/lib/docker_engine_api/models/system_version_params.rb +14 -0
  171. data/lib/docker_engine_api/models/task.rb +471 -0
  172. data/lib/docker_engine_api/models/task_inspect_params.rb +14 -0
  173. data/lib/docker_engine_api/models/task_list_params.rb +35 -0
  174. data/lib/docker_engine_api/models/task_list_response.rb +8 -0
  175. data/lib/docker_engine_api/models/task_logs_params.rb +74 -0
  176. data/lib/docker_engine_api/models/top_response.rb +33 -0
  177. data/lib/docker_engine_api/models/update_response.rb +19 -0
  178. data/lib/docker_engine_api/models/version.rb +164 -0
  179. data/lib/docker_engine_api/models/volume.rb +651 -0
  180. data/lib/docker_engine_api/models/volume_create_params.rb +14 -0
  181. data/lib/docker_engine_api/models/volume_delete_params.rb +22 -0
  182. data/lib/docker_engine_api/models/volume_inspect_params.rb +14 -0
  183. data/lib/docker_engine_api/models/volume_list_params.rb +34 -0
  184. data/lib/docker_engine_api/models/volume_prune_params.rb +33 -0
  185. data/lib/docker_engine_api/models/volume_prune_response.rb +25 -0
  186. data/lib/docker_engine_api/models/volume_update_params.rb +325 -0
  187. data/lib/docker_engine_api/models/wait_response.rb +41 -0
  188. data/lib/docker_engine_api/models.rb +312 -0
  189. data/lib/docker_engine_api/request_options.rb +78 -0
  190. data/lib/docker_engine_api/resources/auth.rb +38 -0
  191. data/lib/docker_engine_api/resources/configs.rb +130 -0
  192. data/lib/docker_engine_api/resources/containers.rb +854 -0
  193. data/lib/docker_engine_api/resources/distribution.rb +34 -0
  194. data/lib/docker_engine_api/resources/exec.rb +91 -0
  195. data/lib/docker_engine_api/resources/images.rb +676 -0
  196. data/lib/docker_engine_api/resources/networks.rb +218 -0
  197. data/lib/docker_engine_api/resources/nodes.rb +113 -0
  198. data/lib/docker_engine_api/resources/plugins.rb +317 -0
  199. data/lib/docker_engine_api/resources/secrets.rb +130 -0
  200. data/lib/docker_engine_api/resources/services.rb +195 -0
  201. data/lib/docker_engine_api/resources/swarm.rb +183 -0
  202. data/lib/docker_engine_api/resources/system.rb +155 -0
  203. data/lib/docker_engine_api/resources/tasks.rb +103 -0
  204. data/lib/docker_engine_api/resources/volumes.rb +161 -0
  205. data/lib/docker_engine_api/version.rb +5 -0
  206. data/lib/docker_engine_api.rb +234 -0
  207. data/manifest.yaml +17 -0
  208. data/rbi/docker_engine_api/client.rbi +80 -0
  209. data/rbi/docker_engine_api/errors.rbi +205 -0
  210. data/rbi/docker_engine_api/file_part.rbi +37 -0
  211. data/rbi/docker_engine_api/internal/transport/base_client.rbi +304 -0
  212. data/rbi/docker_engine_api/internal/transport/pooled_net_requester.rbi +84 -0
  213. data/rbi/docker_engine_api/internal/type/array_of.rbi +108 -0
  214. data/rbi/docker_engine_api/internal/type/base_model.rbi +314 -0
  215. data/rbi/docker_engine_api/internal/type/base_page.rbi +43 -0
  216. data/rbi/docker_engine_api/internal/type/boolean.rbi +58 -0
  217. data/rbi/docker_engine_api/internal/type/converter.rbi +225 -0
  218. data/rbi/docker_engine_api/internal/type/enum.rbi +82 -0
  219. data/rbi/docker_engine_api/internal/type/file_input.rbi +59 -0
  220. data/rbi/docker_engine_api/internal/type/hash_of.rbi +108 -0
  221. data/rbi/docker_engine_api/internal/type/request_parameters.rbi +31 -0
  222. data/rbi/docker_engine_api/internal/type/union.rbi +134 -0
  223. data/rbi/docker_engine_api/internal/type/unknown.rbi +58 -0
  224. data/rbi/docker_engine_api/internal/util.rbi +487 -0
  225. data/rbi/docker_engine_api/internal.rbi +18 -0
  226. data/rbi/docker_engine_api/models/auth_login_params.rbi +65 -0
  227. data/rbi/docker_engine_api/models/auth_response.rbi +42 -0
  228. data/rbi/docker_engine_api/models/config.rbi +442 -0
  229. data/rbi/docker_engine_api/models/config_create_params.rbi +64 -0
  230. data/rbi/docker_engine_api/models/config_create_response.rbi +31 -0
  231. data/rbi/docker_engine_api/models/config_delete_params.rbi +32 -0
  232. data/rbi/docker_engine_api/models/config_inspect_params.rbi +32 -0
  233. data/rbi/docker_engine_api/models/config_list_params.rbi +62 -0
  234. data/rbi/docker_engine_api/models/config_list_response.rbi +11 -0
  235. data/rbi/docker_engine_api/models/config_update_params.rbi +45 -0
  236. data/rbi/docker_engine_api/models/connect_request.rbi +343 -0
  237. data/rbi/docker_engine_api/models/container.rbi +4645 -0
  238. data/rbi/docker_engine_api/models/container_archive_params.rbi +43 -0
  239. data/rbi/docker_engine_api/models/container_attach_params.rbi +120 -0
  240. data/rbi/docker_engine_api/models/container_changes_params.rbi +32 -0
  241. data/rbi/docker_engine_api/models/container_changes_response.rbi +13 -0
  242. data/rbi/docker_engine_api/models/container_create_params.rbi +3301 -0
  243. data/rbi/docker_engine_api/models/container_delete_params.rbi +71 -0
  244. data/rbi/docker_engine_api/models/container_exec_params.rbi +162 -0
  245. data/rbi/docker_engine_api/models/container_exec_response.rbi +31 -0
  246. data/rbi/docker_engine_api/models/container_export_params.rbi +32 -0
  247. data/rbi/docker_engine_api/models/container_inspect_params.rbi +46 -0
  248. data/rbi/docker_engine_api/models/container_kill_params.rbi +46 -0
  249. data/rbi/docker_engine_api/models/container_list_params.rbi +124 -0
  250. data/rbi/docker_engine_api/models/container_list_response.rbi +11 -0
  251. data/rbi/docker_engine_api/models/container_logs_params.rbi +117 -0
  252. data/rbi/docker_engine_api/models/container_pause_params.rbi +32 -0
  253. data/rbi/docker_engine_api/models/container_prune_params.rbi +66 -0
  254. data/rbi/docker_engine_api/models/container_prune_response.rbi +51 -0
  255. data/rbi/docker_engine_api/models/container_rename_params.rbi +43 -0
  256. data/rbi/docker_engine_api/models/container_resize_params.rbi +54 -0
  257. data/rbi/docker_engine_api/models/container_restart_params.rbi +60 -0
  258. data/rbi/docker_engine_api/models/container_start_params.rbi +53 -0
  259. data/rbi/docker_engine_api/models/container_stats_params.rbi +64 -0
  260. data/rbi/docker_engine_api/models/container_stop_params.rbi +60 -0
  261. data/rbi/docker_engine_api/models/container_top_params.rbi +46 -0
  262. data/rbi/docker_engine_api/models/container_unpause_params.rbi +32 -0
  263. data/rbi/docker_engine_api/models/container_update_params.rbi +1121 -0
  264. data/rbi/docker_engine_api/models/container_wait_params.rbi +101 -0
  265. data/rbi/docker_engine_api/models/create_request.rbi +708 -0
  266. data/rbi/docker_engine_api/models/create_response.rbi +39 -0
  267. data/rbi/docker_engine_api/models/delete_item.rbi +41 -0
  268. data/rbi/docker_engine_api/models/disconnect_request.rbi +43 -0
  269. data/rbi/docker_engine_api/models/distribution_inspect_params.rbi +32 -0
  270. data/rbi/docker_engine_api/models/error.rbi +28 -0
  271. data/rbi/docker_engine_api/models/exec_inspect_params.rbi +32 -0
  272. data/rbi/docker_engine_api/models/exec_inspect_response.rbi +135 -0
  273. data/rbi/docker_engine_api/models/exec_resize_params.rbi +54 -0
  274. data/rbi/docker_engine_api/models/exec_start_params.rbi +68 -0
  275. data/rbi/docker_engine_api/models/filesystem_change.rbi +93 -0
  276. data/rbi/docker_engine_api/models/history_item.rbi +62 -0
  277. data/rbi/docker_engine_api/models/image.rbi +2353 -0
  278. data/rbi/docker_engine_api/models/image_build_params.rbi +434 -0
  279. data/rbi/docker_engine_api/models/image_build_prune_params.rbi +121 -0
  280. data/rbi/docker_engine_api/models/image_build_prune_response.rbi +49 -0
  281. data/rbi/docker_engine_api/models/image_commit_params.rbi +115 -0
  282. data/rbi/docker_engine_api/models/image_commit_response.rbi +31 -0
  283. data/rbi/docker_engine_api/models/image_delete_params.rbi +75 -0
  284. data/rbi/docker_engine_api/models/image_delete_response.rbi +11 -0
  285. data/rbi/docker_engine_api/models/image_get_all_params.rbi +68 -0
  286. data/rbi/docker_engine_api/models/image_get_params.rbi +57 -0
  287. data/rbi/docker_engine_api/models/image_history_params.rbi +64 -0
  288. data/rbi/docker_engine_api/models/image_history_response.rbi +11 -0
  289. data/rbi/docker_engine_api/models/image_inspect_params.rbi +49 -0
  290. data/rbi/docker_engine_api/models/image_list_params.rbi +115 -0
  291. data/rbi/docker_engine_api/models/image_list_response.rbi +11 -0
  292. data/rbi/docker_engine_api/models/image_load_params.rbi +74 -0
  293. data/rbi/docker_engine_api/models/image_prune_params.rbi +66 -0
  294. data/rbi/docker_engine_api/models/image_prune_response.rbi +58 -0
  295. data/rbi/docker_engine_api/models/image_pull_params.rbi +189 -0
  296. data/rbi/docker_engine_api/models/image_push_params.rbi +84 -0
  297. data/rbi/docker_engine_api/models/image_search_params.rbi +76 -0
  298. data/rbi/docker_engine_api/models/image_search_response.rbi +95 -0
  299. data/rbi/docker_engine_api/models/image_tag_params.rbi +60 -0
  300. data/rbi/docker_engine_api/models/info.rbi +2564 -0
  301. data/rbi/docker_engine_api/models/inspect.rbi +359 -0
  302. data/rbi/docker_engine_api/models/inspect_response.rbi +77 -0
  303. data/rbi/docker_engine_api/models/list_response.rbi +55 -0
  304. data/rbi/docker_engine_api/models/network.rbi +427 -0
  305. data/rbi/docker_engine_api/models/network_connect_params.rbi +32 -0
  306. data/rbi/docker_engine_api/models/network_create_params.rbi +373 -0
  307. data/rbi/docker_engine_api/models/network_delete_params.rbi +32 -0
  308. data/rbi/docker_engine_api/models/network_disconnect_params.rbi +32 -0
  309. data/rbi/docker_engine_api/models/network_inspect_params.rbi +60 -0
  310. data/rbi/docker_engine_api/models/network_inspect_response.rbi +336 -0
  311. data/rbi/docker_engine_api/models/network_list_params.rbi +76 -0
  312. data/rbi/docker_engine_api/models/network_list_response.rbi +11 -0
  313. data/rbi/docker_engine_api/models/network_prune_params.rbi +66 -0
  314. data/rbi/docker_engine_api/models/network_prune_response.rbi +35 -0
  315. data/rbi/docker_engine_api/models/node.rbi +909 -0
  316. data/rbi/docker_engine_api/models/node_delete_params.rbi +49 -0
  317. data/rbi/docker_engine_api/models/node_inspect_params.rbi +32 -0
  318. data/rbi/docker_engine_api/models/node_list_params.rbi +64 -0
  319. data/rbi/docker_engine_api/models/node_list_response.rbi +11 -0
  320. data/rbi/docker_engine_api/models/node_update_params.rbi +45 -0
  321. data/rbi/docker_engine_api/models/plugin.rbi +835 -0
  322. data/rbi/docker_engine_api/models/plugin_create_params.rbi +54 -0
  323. data/rbi/docker_engine_api/models/plugin_delete_params.rbi +51 -0
  324. data/rbi/docker_engine_api/models/plugin_disable_params.rbi +49 -0
  325. data/rbi/docker_engine_api/models/plugin_enable_params.rbi +46 -0
  326. data/rbi/docker_engine_api/models/plugin_inspect_params.rbi +32 -0
  327. data/rbi/docker_engine_api/models/plugin_list_params.rbi +58 -0
  328. data/rbi/docker_engine_api/models/plugin_list_response.rbi +11 -0
  329. data/rbi/docker_engine_api/models/plugin_privileges_params.rbi +45 -0
  330. data/rbi/docker_engine_api/models/plugin_privileges_response.rbi +11 -0
  331. data/rbi/docker_engine_api/models/plugin_pull_params.rbi +83 -0
  332. data/rbi/docker_engine_api/models/plugin_push_params.rbi +32 -0
  333. data/rbi/docker_engine_api/models/plugin_set_params.rbi +44 -0
  334. data/rbi/docker_engine_api/models/plugin_upgrade_params.rbi +68 -0
  335. data/rbi/docker_engine_api/models/privilege.rbi +49 -0
  336. data/rbi/docker_engine_api/models/secret.rbi +125 -0
  337. data/rbi/docker_engine_api/models/secret_create_params.rbi +64 -0
  338. data/rbi/docker_engine_api/models/secret_create_response.rbi +31 -0
  339. data/rbi/docker_engine_api/models/secret_delete_params.rbi +32 -0
  340. data/rbi/docker_engine_api/models/secret_inspect_params.rbi +32 -0
  341. data/rbi/docker_engine_api/models/secret_list_params.rbi +62 -0
  342. data/rbi/docker_engine_api/models/secret_list_response.rbi +11 -0
  343. data/rbi/docker_engine_api/models/secret_update_params.rbi +45 -0
  344. data/rbi/docker_engine_api/models/service.rbi +1093 -0
  345. data/rbi/docker_engine_api/models/service_create_params.rbi +79 -0
  346. data/rbi/docker_engine_api/models/service_delete_params.rbi +32 -0
  347. data/rbi/docker_engine_api/models/service_inspect_params.rbi +49 -0
  348. data/rbi/docker_engine_api/models/service_list_params.rbi +76 -0
  349. data/rbi/docker_engine_api/models/service_list_response.rbi +11 -0
  350. data/rbi/docker_engine_api/models/service_logs_params.rbi +117 -0
  351. data/rbi/docker_engine_api/models/service_update_params.rbi +168 -0
  352. data/rbi/docker_engine_api/models/spec.rbi +1030 -0
  353. data/rbi/docker_engine_api/models/stats_response.rbi +1772 -0
  354. data/rbi/docker_engine_api/models/summary.rbi +1332 -0
  355. data/rbi/docker_engine_api/models/swarm.rbi +315 -0
  356. data/rbi/docker_engine_api/models/swarm_init_params.rbi +162 -0
  357. data/rbi/docker_engine_api/models/swarm_init_response.rbi +7 -0
  358. data/rbi/docker_engine_api/models/swarm_inspect_params.rbi +32 -0
  359. data/rbi/docker_engine_api/models/swarm_join_params.rbi +119 -0
  360. data/rbi/docker_engine_api/models/swarm_leave_params.rbi +51 -0
  361. data/rbi/docker_engine_api/models/swarm_unlock_key_params.rbi +32 -0
  362. data/rbi/docker_engine_api/models/swarm_unlock_key_response.rbi +33 -0
  363. data/rbi/docker_engine_api/models/swarm_unlock_params.rbi +49 -0
  364. data/rbi/docker_engine_api/models/swarm_update_params.rbi +81 -0
  365. data/rbi/docker_engine_api/models/system_data_usage_params.rbi +111 -0
  366. data/rbi/docker_engine_api/models/system_data_usage_response.rbi +460 -0
  367. data/rbi/docker_engine_api/models/system_events_params.rbi +105 -0
  368. data/rbi/docker_engine_api/models/system_events_response.rbi +286 -0
  369. data/rbi/docker_engine_api/models/system_info_params.rbi +32 -0
  370. data/rbi/docker_engine_api/models/system_ping_params.rbi +32 -0
  371. data/rbi/docker_engine_api/models/system_ping_response.rbi +7 -0
  372. data/rbi/docker_engine_api/models/system_version_params.rbi +32 -0
  373. data/rbi/docker_engine_api/models/task.rbi +921 -0
  374. data/rbi/docker_engine_api/models/task_inspect_params.rbi +32 -0
  375. data/rbi/docker_engine_api/models/task_list_params.rbi +66 -0
  376. data/rbi/docker_engine_api/models/task_list_response.rbi +11 -0
  377. data/rbi/docker_engine_api/models/task_logs_params.rbi +117 -0
  378. data/rbi/docker_engine_api/models/top_response.rbi +54 -0
  379. data/rbi/docker_engine_api/models/update_response.rbi +34 -0
  380. data/rbi/docker_engine_api/models/version.rbi +256 -0
  381. data/rbi/docker_engine_api/models/volume.rbi +1230 -0
  382. data/rbi/docker_engine_api/models/volume_create_params.rbi +32 -0
  383. data/rbi/docker_engine_api/models/volume_delete_params.rbi +49 -0
  384. data/rbi/docker_engine_api/models/volume_inspect_params.rbi +32 -0
  385. data/rbi/docker_engine_api/models/volume_list_params.rbi +64 -0
  386. data/rbi/docker_engine_api/models/volume_prune_params.rbi +62 -0
  387. data/rbi/docker_engine_api/models/volume_prune_response.rbi +51 -0
  388. data/rbi/docker_engine_api/models/volume_update_params.rbi +668 -0
  389. data/rbi/docker_engine_api/models/wait_response.rbi +78 -0
  390. data/rbi/docker_engine_api/models.rbi +271 -0
  391. data/rbi/docker_engine_api/request_options.rbi +64 -0
  392. data/rbi/docker_engine_api/resources/auth.rbi +30 -0
  393. data/rbi/docker_engine_api/resources/configs.rbi +93 -0
  394. data/rbi/docker_engine_api/resources/containers.rbi +843 -0
  395. data/rbi/docker_engine_api/resources/distribution.rbi +26 -0
  396. data/rbi/docker_engine_api/resources/exec.rbi +72 -0
  397. data/rbi/docker_engine_api/resources/images.rbi +739 -0
  398. data/rbi/docker_engine_api/resources/networks.rbi +200 -0
  399. data/rbi/docker_engine_api/resources/nodes.rbi +87 -0
  400. data/rbi/docker_engine_api/resources/plugins.rbi +228 -0
  401. data/rbi/docker_engine_api/resources/secrets.rbi +93 -0
  402. data/rbi/docker_engine_api/resources/services.rbi +166 -0
  403. data/rbi/docker_engine_api/resources/swarm.rbi +178 -0
  404. data/rbi/docker_engine_api/resources/system.rbi +123 -0
  405. data/rbi/docker_engine_api/resources/tasks.rbi +90 -0
  406. data/rbi/docker_engine_api/resources/volumes.rbi +123 -0
  407. data/rbi/docker_engine_api/version.rbi +5 -0
  408. data/sig/docker_engine_api/client.rbs +49 -0
  409. data/sig/docker_engine_api/errors.rbs +117 -0
  410. data/sig/docker_engine_api/file_part.rbs +21 -0
  411. data/sig/docker_engine_api/internal/transport/base_client.rbs +131 -0
  412. data/sig/docker_engine_api/internal/transport/pooled_net_requester.rbs +48 -0
  413. data/sig/docker_engine_api/internal/type/array_of.rbs +48 -0
  414. data/sig/docker_engine_api/internal/type/base_model.rbs +104 -0
  415. data/sig/docker_engine_api/internal/type/base_page.rbs +24 -0
  416. data/sig/docker_engine_api/internal/type/boolean.rbs +26 -0
  417. data/sig/docker_engine_api/internal/type/converter.rbs +79 -0
  418. data/sig/docker_engine_api/internal/type/enum.rbs +32 -0
  419. data/sig/docker_engine_api/internal/type/file_input.rbs +25 -0
  420. data/sig/docker_engine_api/internal/type/hash_of.rbs +48 -0
  421. data/sig/docker_engine_api/internal/type/request_parameters.rbs +20 -0
  422. data/sig/docker_engine_api/internal/type/union.rbs +52 -0
  423. data/sig/docker_engine_api/internal/type/unknown.rbs +26 -0
  424. data/sig/docker_engine_api/internal/util.rbs +185 -0
  425. data/sig/docker_engine_api/internal.rbs +10 -0
  426. data/sig/docker_engine_api/models/auth_login_params.rbs +38 -0
  427. data/sig/docker_engine_api/models/auth_response.rbs +17 -0
  428. data/sig/docker_engine_api/models/config.rbs +225 -0
  429. data/sig/docker_engine_api/models/config_create_params.rbs +36 -0
  430. data/sig/docker_engine_api/models/config_create_response.rbs +13 -0
  431. data/sig/docker_engine_api/models/config_delete_params.rbs +15 -0
  432. data/sig/docker_engine_api/models/config_inspect_params.rbs +15 -0
  433. data/sig/docker_engine_api/models/config_list_params.rbs +25 -0
  434. data/sig/docker_engine_api/models/config_list_response.rbs +7 -0
  435. data/sig/docker_engine_api/models/config_update_params.rbs +23 -0
  436. data/sig/docker_engine_api/models/connect_request.rbs +175 -0
  437. data/sig/docker_engine_api/models/container.rbs +1973 -0
  438. data/sig/docker_engine_api/models/container_archive_params.rbs +23 -0
  439. data/sig/docker_engine_api/models/container_attach_params.rbs +63 -0
  440. data/sig/docker_engine_api/models/container_changes_params.rbs +15 -0
  441. data/sig/docker_engine_api/models/container_changes_response.rbs +7 -0
  442. data/sig/docker_engine_api/models/container_create_params.rbs +1352 -0
  443. data/sig/docker_engine_api/models/container_delete_params.rbs +38 -0
  444. data/sig/docker_engine_api/models/container_exec_params.rbs +96 -0
  445. data/sig/docker_engine_api/models/container_exec_response.rbs +13 -0
  446. data/sig/docker_engine_api/models/container_export_params.rbs +15 -0
  447. data/sig/docker_engine_api/models/container_inspect_params.rbs +25 -0
  448. data/sig/docker_engine_api/models/container_kill_params.rbs +25 -0
  449. data/sig/docker_engine_api/models/container_list_params.rbs +44 -0
  450. data/sig/docker_engine_api/models/container_list_response.rbs +7 -0
  451. data/sig/docker_engine_api/models/container_logs_params.rbs +70 -0
  452. data/sig/docker_engine_api/models/container_pause_params.rbs +15 -0
  453. data/sig/docker_engine_api/models/container_prune_params.rbs +25 -0
  454. data/sig/docker_engine_api/models/container_prune_response.rbs +26 -0
  455. data/sig/docker_engine_api/models/container_rename_params.rbs +23 -0
  456. data/sig/docker_engine_api/models/container_resize_params.rbs +28 -0
  457. data/sig/docker_engine_api/models/container_restart_params.rbs +32 -0
  458. data/sig/docker_engine_api/models/container_start_params.rbs +26 -0
  459. data/sig/docker_engine_api/models/container_stats_params.rbs +32 -0
  460. data/sig/docker_engine_api/models/container_stop_params.rbs +32 -0
  461. data/sig/docker_engine_api/models/container_top_params.rbs +25 -0
  462. data/sig/docker_engine_api/models/container_unpause_params.rbs +15 -0
  463. data/sig/docker_engine_api/models/container_update_params.rbs +476 -0
  464. data/sig/docker_engine_api/models/container_wait_params.rbs +40 -0
  465. data/sig/docker_engine_api/models/create_request.rbs +255 -0
  466. data/sig/docker_engine_api/models/create_response.rbs +15 -0
  467. data/sig/docker_engine_api/models/delete_item.rbs +19 -0
  468. data/sig/docker_engine_api/models/disconnect_request.rbs +17 -0
  469. data/sig/docker_engine_api/models/distribution_inspect_params.rbs +15 -0
  470. data/sig/docker_engine_api/models/error.rbs +13 -0
  471. data/sig/docker_engine_api/models/exec_inspect_params.rbs +15 -0
  472. data/sig/docker_engine_api/models/exec_inspect_response.rbs +94 -0
  473. data/sig/docker_engine_api/models/exec_resize_params.rbs +28 -0
  474. data/sig/docker_engine_api/models/exec_start_params.rbs +36 -0
  475. data/sig/docker_engine_api/models/filesystem_change.rbs +34 -0
  476. data/sig/docker_engine_api/models/history_item.rbs +45 -0
  477. data/sig/docker_engine_api/models/image.rbs +1042 -0
  478. data/sig/docker_engine_api/models/image_build_params.rbs +221 -0
  479. data/sig/docker_engine_api/models/image_build_prune_params.rbs +56 -0
  480. data/sig/docker_engine_api/models/image_build_prune_response.rbs +26 -0
  481. data/sig/docker_engine_api/models/image_commit_params.rbs +70 -0
  482. data/sig/docker_engine_api/models/image_commit_response.rbs +13 -0
  483. data/sig/docker_engine_api/models/image_delete_params.rbs +38 -0
  484. data/sig/docker_engine_api/models/image_delete_response.rbs +7 -0
  485. data/sig/docker_engine_api/models/image_get_all_params.rbs +32 -0
  486. data/sig/docker_engine_api/models/image_get_params.rbs +26 -0
  487. data/sig/docker_engine_api/models/image_history_params.rbs +25 -0
  488. data/sig/docker_engine_api/models/image_history_response.rbs +7 -0
  489. data/sig/docker_engine_api/models/image_inspect_params.rbs +25 -0
  490. data/sig/docker_engine_api/models/image_list_params.rbs +56 -0
  491. data/sig/docker_engine_api/models/image_list_response.rbs +7 -0
  492. data/sig/docker_engine_api/models/image_load_params.rbs +40 -0
  493. data/sig/docker_engine_api/models/image_prune_params.rbs +25 -0
  494. data/sig/docker_engine_api/models/image_prune_response.rbs +31 -0
  495. data/sig/docker_engine_api/models/image_pull_params.rbs +84 -0
  496. data/sig/docker_engine_api/models/image_push_params.rbs +36 -0
  497. data/sig/docker_engine_api/models/image_search_params.rbs +36 -0
  498. data/sig/docker_engine_api/models/image_search_response.rbs +55 -0
  499. data/sig/docker_engine_api/models/image_tag_params.rbs +32 -0
  500. data/sig/docker_engine_api/models/info.rbs +1080 -0
  501. data/sig/docker_engine_api/models/inspect.rbs +177 -0
  502. data/sig/docker_engine_api/models/inspect_response.rbs +50 -0
  503. data/sig/docker_engine_api/models/list_response.rbs +28 -0
  504. data/sig/docker_engine_api/models/network.rbs +238 -0
  505. data/sig/docker_engine_api/models/network_connect_params.rbs +15 -0
  506. data/sig/docker_engine_api/models/network_create_params.rbs +203 -0
  507. data/sig/docker_engine_api/models/network_delete_params.rbs +15 -0
  508. data/sig/docker_engine_api/models/network_disconnect_params.rbs +15 -0
  509. data/sig/docker_engine_api/models/network_inspect_params.rbs +32 -0
  510. data/sig/docker_engine_api/models/network_inspect_response.rbs +149 -0
  511. data/sig/docker_engine_api/models/network_list_params.rbs +25 -0
  512. data/sig/docker_engine_api/models/network_list_response.rbs +7 -0
  513. data/sig/docker_engine_api/models/network_prune_params.rbs +25 -0
  514. data/sig/docker_engine_api/models/network_prune_response.rbs +15 -0
  515. data/sig/docker_engine_api/models/node.rbs +434 -0
  516. data/sig/docker_engine_api/models/node_delete_params.rbs +25 -0
  517. data/sig/docker_engine_api/models/node_inspect_params.rbs +15 -0
  518. data/sig/docker_engine_api/models/node_list_params.rbs +25 -0
  519. data/sig/docker_engine_api/models/node_list_response.rbs +7 -0
  520. data/sig/docker_engine_api/models/node_update_params.rbs +23 -0
  521. data/sig/docker_engine_api/models/plugin.rbs +509 -0
  522. data/sig/docker_engine_api/models/plugin_create_params.rbs +28 -0
  523. data/sig/docker_engine_api/models/plugin_delete_params.rbs +25 -0
  524. data/sig/docker_engine_api/models/plugin_disable_params.rbs +25 -0
  525. data/sig/docker_engine_api/models/plugin_enable_params.rbs +25 -0
  526. data/sig/docker_engine_api/models/plugin_inspect_params.rbs +15 -0
  527. data/sig/docker_engine_api/models/plugin_list_params.rbs +25 -0
  528. data/sig/docker_engine_api/models/plugin_list_response.rbs +7 -0
  529. data/sig/docker_engine_api/models/plugin_privileges_params.rbs +23 -0
  530. data/sig/docker_engine_api/models/plugin_privileges_response.rbs +7 -0
  531. data/sig/docker_engine_api/models/plugin_pull_params.rbs +49 -0
  532. data/sig/docker_engine_api/models/plugin_push_params.rbs +15 -0
  533. data/sig/docker_engine_api/models/plugin_set_params.rbs +26 -0
  534. data/sig/docker_engine_api/models/plugin_upgrade_params.rbs +42 -0
  535. data/sig/docker_engine_api/models/privilege.rbs +32 -0
  536. data/sig/docker_engine_api/models/secret.rbs +64 -0
  537. data/sig/docker_engine_api/models/secret_create_params.rbs +36 -0
  538. data/sig/docker_engine_api/models/secret_create_response.rbs +13 -0
  539. data/sig/docker_engine_api/models/secret_delete_params.rbs +15 -0
  540. data/sig/docker_engine_api/models/secret_inspect_params.rbs +15 -0
  541. data/sig/docker_engine_api/models/secret_list_params.rbs +25 -0
  542. data/sig/docker_engine_api/models/secret_list_response.rbs +7 -0
  543. data/sig/docker_engine_api/models/secret_update_params.rbs +23 -0
  544. data/sig/docker_engine_api/models/service.rbs +471 -0
  545. data/sig/docker_engine_api/models/service_create_params.rbs +41 -0
  546. data/sig/docker_engine_api/models/service_delete_params.rbs +15 -0
  547. data/sig/docker_engine_api/models/service_inspect_params.rbs +26 -0
  548. data/sig/docker_engine_api/models/service_list_params.rbs +32 -0
  549. data/sig/docker_engine_api/models/service_list_response.rbs +7 -0
  550. data/sig/docker_engine_api/models/service_logs_params.rbs +70 -0
  551. data/sig/docker_engine_api/models/service_update_params.rbs +73 -0
  552. data/sig/docker_engine_api/models/spec.rbs +467 -0
  553. data/sig/docker_engine_api/models/stats_response.rbs +730 -0
  554. data/sig/docker_engine_api/models/summary.rbs +634 -0
  555. data/sig/docker_engine_api/models/swarm.rbs +159 -0
  556. data/sig/docker_engine_api/models/swarm_init_params.rbs +77 -0
  557. data/sig/docker_engine_api/models/swarm_init_response.rbs +5 -0
  558. data/sig/docker_engine_api/models/swarm_inspect_params.rbs +15 -0
  559. data/sig/docker_engine_api/models/swarm_join_params.rbs +56 -0
  560. data/sig/docker_engine_api/models/swarm_leave_params.rbs +25 -0
  561. data/sig/docker_engine_api/models/swarm_unlock_key_params.rbs +15 -0
  562. data/sig/docker_engine_api/models/swarm_unlock_key_response.rbs +15 -0
  563. data/sig/docker_engine_api/models/swarm_unlock_params.rbs +26 -0
  564. data/sig/docker_engine_api/models/swarm_update_params.rbs +47 -0
  565. data/sig/docker_engine_api/models/system_data_usage_params.rbs +50 -0
  566. data/sig/docker_engine_api/models/system_data_usage_response.rbs +239 -0
  567. data/sig/docker_engine_api/models/system_events_params.rbs +38 -0
  568. data/sig/docker_engine_api/models/system_events_response.rbs +124 -0
  569. data/sig/docker_engine_api/models/system_info_params.rbs +15 -0
  570. data/sig/docker_engine_api/models/system_ping_params.rbs +15 -0
  571. data/sig/docker_engine_api/models/system_ping_response.rbs +5 -0
  572. data/sig/docker_engine_api/models/system_version_params.rbs +15 -0
  573. data/sig/docker_engine_api/models/task.rbs +469 -0
  574. data/sig/docker_engine_api/models/task_inspect_params.rbs +15 -0
  575. data/sig/docker_engine_api/models/task_list_params.rbs +25 -0
  576. data/sig/docker_engine_api/models/task_list_response.rbs +7 -0
  577. data/sig/docker_engine_api/models/task_logs_params.rbs +70 -0
  578. data/sig/docker_engine_api/models/top_response.rbs +26 -0
  579. data/sig/docker_engine_api/models/update_response.rbs +15 -0
  580. data/sig/docker_engine_api/models/version.rbs +127 -0
  581. data/sig/docker_engine_api/models/volume.rbs +478 -0
  582. data/sig/docker_engine_api/models/volume_create_params.rbs +15 -0
  583. data/sig/docker_engine_api/models/volume_delete_params.rbs +25 -0
  584. data/sig/docker_engine_api/models/volume_inspect_params.rbs +15 -0
  585. data/sig/docker_engine_api/models/volume_list_params.rbs +25 -0
  586. data/sig/docker_engine_api/models/volume_prune_params.rbs +25 -0
  587. data/sig/docker_engine_api/models/volume_prune_response.rbs +26 -0
  588. data/sig/docker_engine_api/models/volume_update_params.rbs +235 -0
  589. data/sig/docker_engine_api/models/wait_response.rbs +38 -0
  590. data/sig/docker_engine_api/models.rbs +269 -0
  591. data/sig/docker_engine_api/request_options.rbs +36 -0
  592. data/sig/docker_engine_api/resources/auth.rbs +14 -0
  593. data/sig/docker_engine_api/resources/configs.rbs +34 -0
  594. data/sig/docker_engine_api/resources/containers.rbs +200 -0
  595. data/sig/docker_engine_api/resources/distribution.rbs +12 -0
  596. data/sig/docker_engine_api/resources/exec.rbs +27 -0
  597. data/sig/docker_engine_api/resources/images.rbs +170 -0
  598. data/sig/docker_engine_api/resources/networks.rbs +60 -0
  599. data/sig/docker_engine_api/resources/nodes.rbs +30 -0
  600. data/sig/docker_engine_api/resources/plugins.rbs +73 -0
  601. data/sig/docker_engine_api/resources/secrets.rbs +34 -0
  602. data/sig/docker_engine_api/resources/services.rbs +52 -0
  603. data/sig/docker_engine_api/resources/swarm.rbs +55 -0
  604. data/sig/docker_engine_api/resources/system.rbs +30 -0
  605. data/sig/docker_engine_api/resources/tasks.rbs +29 -0
  606. data/sig/docker_engine_api/resources/volumes.rbs +40 -0
  607. data/sig/docker_engine_api/version.rbs +3 -0
  608. metadata +679 -0
@@ -0,0 +1,2515 @@
1
+ # frozen_string_literal: true
2
+
3
+ module DockerEngineAPI
4
+ module Models
5
+ # @see DockerEngineAPI::Resources::Containers#inspect_
6
+ class Container < DockerEngineAPI::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, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :Args
18
+
19
+ # @!attribute config
20
+ # Configuration for a container that is portable between hosts.
21
+ #
22
+ # @return [DockerEngineAPI::Models::Config, nil]
23
+ optional :config, -> { DockerEngineAPI::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, DockerEngineAPI::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 [DockerEngineAPI::Models::Container::GraphDriver, nil]
50
+ optional :graph_driver, -> { DockerEngineAPI::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 [DockerEngineAPI::Models::Container::HostConfig, nil]
56
+ optional :host_config, -> { DockerEngineAPI::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 [DockerEngineAPI::Models::Container::ImageManifestDescriptor, nil]
94
+ optional :image_manifest_descriptor,
95
+ -> { DockerEngineAPI::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<DockerEngineAPI::Models::Container::Mount>, nil]
118
+ optional :mounts,
119
+ -> { DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::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 [DockerEngineAPI::Models::Container::NetworkSettings, nil]
134
+ optional :network_settings,
135
+ -> {
136
+ DockerEngineAPI::Container::NetworkSettings
137
+ },
138
+ api_name: :NetworkSettings
139
+
140
+ # @!attribute path
141
+ # The path to the command being run
142
+ #
143
+ # @return [String, nil]
144
+ optional :path, String, api_name: :Path
145
+
146
+ # @!attribute platform
147
+ # The platform (operating system) for which the container was created.
148
+ #
149
+ # This field was introduced for the experimental "LCOW" (Linux Containers On
150
+ # Windows) features, which has been removed. In most cases, this field is equal to
151
+ # the host's operating system (`linux` or `windows`).
152
+ #
153
+ # @return [String, nil]
154
+ optional :platform, String, api_name: :Platform
155
+
156
+ # @!attribute process_label
157
+ # SELinux process label set for the container.
158
+ #
159
+ # @return [String, nil]
160
+ optional :process_label, String, api_name: :ProcessLabel
161
+
162
+ # @!attribute resolv_conf_path
163
+ # Location of the `/etc/resolv.conf` generated for the container on the host.
164
+ #
165
+ # This file is managed through the docker daemon, and should not be accessed or
166
+ # modified by other tools.
167
+ #
168
+ # @return [String, nil]
169
+ optional :resolv_conf_path, String, api_name: :ResolvConfPath
170
+
171
+ # @!attribute restart_count
172
+ # Number of times the container was restarted since it was created, or since
173
+ # daemon was started.
174
+ #
175
+ # @return [Integer, nil]
176
+ optional :restart_count, Integer, api_name: :RestartCount
177
+
178
+ # @!attribute size_root_fs
179
+ # The total size of all files in the read-only layers from the image that the
180
+ # container uses. These layers can be shared between containers.
181
+ #
182
+ # This field is omitted by default, and only set when size is requested in the API
183
+ # request.
184
+ #
185
+ # @return [Integer, nil]
186
+ optional :size_root_fs, Integer, api_name: :SizeRootFs, nil?: true
187
+
188
+ # @!attribute size_rw
189
+ # The size of files that have been created or changed by this container.
190
+ #
191
+ # This field is omitted by default, and only set when size is requested in the API
192
+ # request.
193
+ #
194
+ # @return [Integer, nil]
195
+ optional :size_rw, Integer, api_name: :SizeRw, nil?: true
196
+
197
+ # @!attribute state
198
+ # ContainerState stores container's running state. It's part of ContainerJSONBase
199
+ # and will be returned by the "inspect" command.
200
+ #
201
+ # @return [DockerEngineAPI::Models::Container::State, nil]
202
+ optional :state, -> { DockerEngineAPI::Container::State }, api_name: :State, nil?: true
203
+
204
+ # @!attribute storage
205
+ # Information about the storage used by the container.
206
+ #
207
+ # @return [DockerEngineAPI::Models::Container::Storage, nil]
208
+ optional :storage, -> { DockerEngineAPI::Container::Storage }, api_name: :Storage
209
+
210
+ # @!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)
211
+ # Some parameter documentations has been truncated, see
212
+ # {DockerEngineAPI::Models::Container} for more details.
213
+ #
214
+ # @param app_armor_profile [String] The AppArmor profile set for the container.
215
+ #
216
+ # @param args [Array<String>] The arguments to the command being run
217
+ #
218
+ # @param config [DockerEngineAPI::Models::Config] Configuration for a container that is portable between hosts.
219
+ #
220
+ # @param created [String, nil] Date and time at which the container was created, formatted in
221
+ #
222
+ # @param driver [String] The storage-driver used for the container's filesystem (graph-driver
223
+ #
224
+ # @param exec_ids [Array<String>, nil] IDs of exec instances that are running in the container.
225
+ #
226
+ # @param graph_driver [DockerEngineAPI::Models::Container::GraphDriver] Information about the storage driver used to store the container's and
227
+ #
228
+ # @param host_config [DockerEngineAPI::Models::Container::HostConfig] Container configuration that depends on the host we are running on
229
+ #
230
+ # @param hostname_path [String] Location of the `/etc/hostname` generated for the container on the
231
+ #
232
+ # @param hosts_path [String] Location of the `/etc/hosts` generated for the container on the
233
+ #
234
+ # @param id [String] The ID of this container as a 128-bit (64-character) hexadecimal string (32 byte
235
+ #
236
+ # @param image [String] The ID (digest) of the image that this container was created from.
237
+ #
238
+ # @param image_manifest_descriptor [DockerEngineAPI::Models::Container::ImageManifestDescriptor] A descriptor struct containing digest, media type, and size, as defined in
239
+ #
240
+ # @param log_path [String, nil] Location of the file used to buffer the container's logs. Depending on
241
+ #
242
+ # @param mount_label [String] SELinux mount label set for the container.
243
+ #
244
+ # @param mounts [Array<DockerEngineAPI::Models::Container::Mount>] List of mounts used by the container.
245
+ #
246
+ # @param name [String] The name associated with this container.
247
+ #
248
+ # @param network_settings [DockerEngineAPI::Models::Container::NetworkSettings] NetworkSettings exposes the network settings in the API
249
+ #
250
+ # @param path [String] The path to the command being run
251
+ #
252
+ # @param platform [String] The platform (operating system) for which the container was created.
253
+ #
254
+ # @param process_label [String] SELinux process label set for the container.
255
+ #
256
+ # @param resolv_conf_path [String] Location of the `/etc/resolv.conf` generated for the container on the
257
+ #
258
+ # @param restart_count [Integer] Number of times the container was restarted since it was created,
259
+ #
260
+ # @param size_root_fs [Integer, nil] The total size of all files in the read-only layers from the image
261
+ #
262
+ # @param size_rw [Integer, nil] The size of files that have been created or changed by this container.
263
+ #
264
+ # @param state [DockerEngineAPI::Models::Container::State, nil] ContainerState stores container's running state. It's part of ContainerJSONBase
265
+ #
266
+ # @param storage [DockerEngineAPI::Models::Container::Storage] Information about the storage used by the container.
267
+
268
+ # @see DockerEngineAPI::Models::Container#graph_driver
269
+ class GraphDriver < DockerEngineAPI::Internal::Type::BaseModel
270
+ # @!attribute data
271
+ # Low-level storage metadata, provided as key/value pairs.
272
+ #
273
+ # This information is driver-specific, and depends on the storage-driver in use,
274
+ # and should be used for informational purposes only.
275
+ #
276
+ # @return [Hash{Symbol=>String}]
277
+ required :data, DockerEngineAPI::Internal::Type::HashOf[String], api_name: :Data
278
+
279
+ # @!attribute name
280
+ # Name of the storage driver.
281
+ #
282
+ # @return [String]
283
+ required :name, String, api_name: :Name
284
+
285
+ # @!method initialize(data:, name:)
286
+ # Some parameter documentations has been truncated, see
287
+ # {DockerEngineAPI::Models::Container::GraphDriver} for more details.
288
+ #
289
+ # Information about the storage driver used to store the container's and image's
290
+ # filesystem.
291
+ #
292
+ # @param data [Hash{Symbol=>String}] Low-level storage metadata, provided as key/value pairs.
293
+ #
294
+ # @param name [String] Name of the storage driver.
295
+ end
296
+
297
+ # @see DockerEngineAPI::Models::Container#host_config
298
+ class HostConfig < DockerEngineAPI::Internal::Type::BaseModel
299
+ # @!attribute annotations
300
+ # Arbitrary non-identifying metadata attached to container and provided to the
301
+ # runtime when the container is started.
302
+ #
303
+ # @return [Hash{Symbol=>String}, nil]
304
+ optional :annotations, DockerEngineAPI::Internal::Type::HashOf[String], api_name: :Annotations
305
+
306
+ # @!attribute auto_remove
307
+ # Automatically remove the container when the container's process exits. This has
308
+ # no effect if `RestartPolicy` is set.
309
+ #
310
+ # @return [Boolean, nil]
311
+ optional :auto_remove, DockerEngineAPI::Internal::Type::Boolean, api_name: :AutoRemove
312
+
313
+ # @!attribute binds
314
+ # A list of volume bindings for this container. Each volume binding is a string in
315
+ # one of these forms:
316
+ #
317
+ # - `host-src:container-dest[:options]` to bind-mount a host path into the
318
+ # container. Both `host-src`, and `container-dest` must be an _absolute_ path.
319
+ # - `volume-name:container-dest[:options]` to bind-mount a volume managed by a
320
+ # volume driver into the container. `container-dest` must be an _absolute_ path.
321
+ #
322
+ # `options` is an optional, comma-delimited list of:
323
+ #
324
+ # - `nocopy` disables automatic copying of data from the container path to the
325
+ # volume. The `nocopy` flag only applies to named volumes.
326
+ # - `[ro|rw]` mounts a volume read-only or read-write, respectively. If omitted or
327
+ # set to `rw`, volumes are mounted read-write.
328
+ # - `[z|Z]` applies SELinux labels to allow or deny multiple containers to read
329
+ # and write to the same volume.
330
+ # - `z`: a _shared_ content label is applied to the content. This label
331
+ # indicates that multiple containers can share the volume content, for both
332
+ # reading and writing.
333
+ # - `Z`: a _private unshared_ label is applied to the content. This label
334
+ # indicates that only the current container can use a private volume. Labeling
335
+ # systems such as SELinux require proper labels to be placed on volume content
336
+ # that is mounted into a container. Without a label, the security system can
337
+ # prevent a container's processes from using the content. By default, the
338
+ # labels set by the host operating system are not modified.
339
+ # - `[[r]shared|[r]slave|[r]private]` specifies mount
340
+ # [propagation behavior](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt).
341
+ # This only applies to bind-mounted volumes, not internal volumes or named
342
+ # volumes. Mount propagation requires the source mount point (the location where
343
+ # the source directory is mounted in the host operating system) to have the
344
+ # correct propagation properties. For shared volumes, the source mount point
345
+ # must be set to `shared`. For slave volumes, the mount must be set to either
346
+ # `shared` or `slave`.
347
+ #
348
+ # @return [Array<String>, nil]
349
+ optional :binds, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :Binds
350
+
351
+ # @!attribute blkio_device_read_bps
352
+ # Limit read rate (bytes per second) from a device, in the form:
353
+ #
354
+ # ```
355
+ # [{"Path": "device_path", "Rate": rate}]
356
+ # ```
357
+ #
358
+ # @return [Array<DockerEngineAPI::Models::Container::HostConfig::BlkioDeviceReadBp>, nil]
359
+ optional :blkio_device_read_bps,
360
+ -> {
361
+ DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Container::HostConfig::BlkioDeviceReadBp]
362
+ },
363
+ api_name: :BlkioDeviceReadBps
364
+
365
+ # @!attribute blkio_device_read_i_ops
366
+ # Limit read rate (IO per second) from a device, in the form:
367
+ #
368
+ # ```
369
+ # [{"Path": "device_path", "Rate": rate}]
370
+ # ```
371
+ #
372
+ # @return [Array<DockerEngineAPI::Models::Container::HostConfig::BlkioDeviceReadIOp>, nil]
373
+ optional :blkio_device_read_i_ops,
374
+ -> {
375
+ DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Container::HostConfig::BlkioDeviceReadIOp]
376
+ },
377
+ api_name: :BlkioDeviceReadIOps
378
+
379
+ # @!attribute blkio_device_write_bps
380
+ # Limit write rate (bytes per second) to a device, in the form:
381
+ #
382
+ # ```
383
+ # [{"Path": "device_path", "Rate": rate}]
384
+ # ```
385
+ #
386
+ # @return [Array<DockerEngineAPI::Models::Container::HostConfig::BlkioDeviceWriteBp>, nil]
387
+ optional :blkio_device_write_bps,
388
+ -> {
389
+ DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Container::HostConfig::BlkioDeviceWriteBp]
390
+ },
391
+ api_name: :BlkioDeviceWriteBps
392
+
393
+ # @!attribute blkio_device_write_i_ops
394
+ # Limit write rate (IO per second) to a device, in the form:
395
+ #
396
+ # ```
397
+ # [{"Path": "device_path", "Rate": rate}]
398
+ # ```
399
+ #
400
+ # @return [Array<DockerEngineAPI::Models::Container::HostConfig::BlkioDeviceWriteIOp>, nil]
401
+ optional :blkio_device_write_i_ops,
402
+ -> {
403
+ DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Container::HostConfig::BlkioDeviceWriteIOp]
404
+ },
405
+ api_name: :BlkioDeviceWriteIOps
406
+
407
+ # @!attribute blkio_weight
408
+ # Block IO weight (relative weight).
409
+ #
410
+ # @return [Integer, nil]
411
+ optional :blkio_weight, Integer, api_name: :BlkioWeight
412
+
413
+ # @!attribute blkio_weight_device
414
+ # Block IO weight (relative device weight) in the form:
415
+ #
416
+ # ```
417
+ # [{"Path": "device_path", "Weight": weight}]
418
+ # ```
419
+ #
420
+ # @return [Array<DockerEngineAPI::Models::Container::HostConfig::BlkioWeightDevice>, nil]
421
+ optional :blkio_weight_device,
422
+ -> {
423
+ DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Container::HostConfig::BlkioWeightDevice]
424
+ },
425
+ api_name: :BlkioWeightDevice
426
+
427
+ # @!attribute cap_add
428
+ # A list of kernel capabilities to add to the container. Conflicts with option
429
+ # 'Capabilities'.
430
+ #
431
+ # @return [Array<String>, nil]
432
+ optional :cap_add, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :CapAdd
433
+
434
+ # @!attribute cap_drop
435
+ # A list of kernel capabilities to drop from the container. Conflicts with option
436
+ # 'Capabilities'.
437
+ #
438
+ # @return [Array<String>, nil]
439
+ optional :cap_drop, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :CapDrop
440
+
441
+ # @!attribute cgroup
442
+ # Cgroup to use for the container.
443
+ #
444
+ # @return [String, nil]
445
+ optional :cgroup, String, api_name: :Cgroup
446
+
447
+ # @!attribute cgroupns_mode
448
+ # cgroup namespace mode for the container. Possible values are:
449
+ #
450
+ # - `"private"`: the container runs in its own private cgroup namespace
451
+ # - `"host"`: use the host system's cgroup namespace
452
+ #
453
+ # If not specified, the daemon default is used, which can either be `"private"` or
454
+ # `"host"`, depending on daemon version, kernel support and configuration.
455
+ #
456
+ # @return [Symbol, DockerEngineAPI::Models::Container::HostConfig::CgroupnsMode, nil]
457
+ optional :cgroupns_mode,
458
+ enum: -> { DockerEngineAPI::Container::HostConfig::CgroupnsMode },
459
+ api_name: :CgroupnsMode
460
+
461
+ # @!attribute cgroup_parent
462
+ # Path to `cgroups` under which the container's `cgroup` is created. If the path
463
+ # is not absolute, the path is considered to be relative to the `cgroups` path of
464
+ # the init process. Cgroups are created if they do not already exist.
465
+ #
466
+ # @return [String, nil]
467
+ optional :cgroup_parent, String, api_name: :CgroupParent
468
+
469
+ # @!attribute console_size
470
+ # Initial console size, as an `[height, width]` array.
471
+ #
472
+ # @return [Array<Integer>, nil]
473
+ optional :console_size,
474
+ DockerEngineAPI::Internal::Type::ArrayOf[Integer],
475
+ api_name: :ConsoleSize,
476
+ nil?: true
477
+
478
+ # @!attribute container_id_file
479
+ # Path to a file where the container ID is written
480
+ #
481
+ # @return [String, nil]
482
+ optional :container_id_file, String, api_name: :ContainerIDFile
483
+
484
+ # @!attribute cpu_count
485
+ # The number of usable CPUs (Windows only).
486
+ #
487
+ # On Windows Server containers, the processor resource controls are mutually
488
+ # exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and
489
+ # `CPUPercent` last.
490
+ #
491
+ # @return [Integer, nil]
492
+ optional :cpu_count, Integer, api_name: :CpuCount
493
+
494
+ # @!attribute cpu_percent
495
+ # The usable percentage of the available CPUs (Windows only).
496
+ #
497
+ # On Windows Server containers, the processor resource controls are mutually
498
+ # exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and
499
+ # `CPUPercent` last.
500
+ #
501
+ # @return [Integer, nil]
502
+ optional :cpu_percent, Integer, api_name: :CpuPercent
503
+
504
+ # @!attribute cpu_period
505
+ # The length of a CPU period in microseconds.
506
+ #
507
+ # @return [Integer, nil]
508
+ optional :cpu_period, Integer, api_name: :CpuPeriod
509
+
510
+ # @!attribute cpu_quota
511
+ # Microseconds of CPU time that the container can get in a CPU period.
512
+ #
513
+ # @return [Integer, nil]
514
+ optional :cpu_quota, Integer, api_name: :CpuQuota
515
+
516
+ # @!attribute cpu_realtime_period
517
+ # The length of a CPU real-time period in microseconds. Set to 0 to allocate no
518
+ # time allocated to real-time tasks.
519
+ #
520
+ # @return [Integer, nil]
521
+ optional :cpu_realtime_period, Integer, api_name: :CpuRealtimePeriod
522
+
523
+ # @!attribute cpu_realtime_runtime
524
+ # The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no
525
+ # time allocated to real-time tasks.
526
+ #
527
+ # @return [Integer, nil]
528
+ optional :cpu_realtime_runtime, Integer, api_name: :CpuRealtimeRuntime
529
+
530
+ # @!attribute cpuset_cpus
531
+ # CPUs in which to allow execution (e.g., `0-3`, `0,1`).
532
+ #
533
+ # @return [String, nil]
534
+ optional :cpuset_cpus, String, api_name: :CpusetCpus
535
+
536
+ # @!attribute cpuset_mems
537
+ # Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on
538
+ # NUMA systems.
539
+ #
540
+ # @return [String, nil]
541
+ optional :cpuset_mems, String, api_name: :CpusetMems
542
+
543
+ # @!attribute cpu_shares
544
+ # An integer value representing this container's relative CPU weight versus other
545
+ # containers.
546
+ #
547
+ # @return [Integer, nil]
548
+ optional :cpu_shares, Integer, api_name: :CpuShares
549
+
550
+ # @!attribute device_cgroup_rules
551
+ # a list of cgroup rules to apply to the container
552
+ #
553
+ # @return [Array<String>, nil]
554
+ optional :device_cgroup_rules,
555
+ DockerEngineAPI::Internal::Type::ArrayOf[String],
556
+ api_name: :DeviceCgroupRules
557
+
558
+ # @!attribute device_requests
559
+ # A list of requests for devices to be sent to device drivers.
560
+ #
561
+ # @return [Array<DockerEngineAPI::Models::Container::HostConfig::DeviceRequest>, nil]
562
+ optional :device_requests,
563
+ -> {
564
+ DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Container::HostConfig::DeviceRequest]
565
+ },
566
+ api_name: :DeviceRequests
567
+
568
+ # @!attribute devices
569
+ # A list of devices to add to the container.
570
+ #
571
+ # @return [Array<DockerEngineAPI::Models::Container::HostConfig::Device>, nil]
572
+ optional :devices,
573
+ -> {
574
+ DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Container::HostConfig::Device]
575
+ },
576
+ api_name: :Devices
577
+
578
+ # @!attribute dns
579
+ # A list of DNS servers for the container to use.
580
+ #
581
+ # @return [Array<String>, nil]
582
+ optional :dns, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :Dns
583
+
584
+ # @!attribute dns_options
585
+ # A list of DNS options.
586
+ #
587
+ # @return [Array<String>, nil]
588
+ optional :dns_options, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :DnsOptions
589
+
590
+ # @!attribute dns_search
591
+ # A list of DNS search domains.
592
+ #
593
+ # @return [Array<String>, nil]
594
+ optional :dns_search, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :DnsSearch
595
+
596
+ # @!attribute extra_hosts
597
+ # A list of hostnames/IP mappings to add to the container's `/etc/hosts` file.
598
+ # Specified in the form `["hostname:IP"]`.
599
+ #
600
+ # @return [Array<String>, nil]
601
+ optional :extra_hosts, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :ExtraHosts
602
+
603
+ # @!attribute group_add
604
+ # A list of additional groups that the container process will run as.
605
+ #
606
+ # @return [Array<String>, nil]
607
+ optional :group_add, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :GroupAdd
608
+
609
+ # @!attribute init
610
+ # Run an init inside the container that forwards signals and reaps processes. This
611
+ # field is omitted if empty, and the default (as configured on the daemon) is
612
+ # used.
613
+ #
614
+ # @return [Boolean, nil]
615
+ optional :init, DockerEngineAPI::Internal::Type::Boolean, api_name: :Init, nil?: true
616
+
617
+ # @!attribute io_maximum_bandwidth
618
+ # Maximum IO in bytes per second for the container system drive (Windows only).
619
+ #
620
+ # @return [Integer, nil]
621
+ optional :io_maximum_bandwidth, Integer, api_name: :IOMaximumBandwidth
622
+
623
+ # @!attribute io_maximum_i_ops
624
+ # Maximum IOps for the container system drive (Windows only)
625
+ #
626
+ # @return [Integer, nil]
627
+ optional :io_maximum_i_ops, Integer, api_name: :IOMaximumIOps
628
+
629
+ # @!attribute ipc_mode
630
+ # IPC sharing mode for the container. Possible values are:
631
+ #
632
+ # - `"none"`: own private IPC namespace, with /dev/shm not mounted
633
+ # - `"private"`: own private IPC namespace
634
+ # - `"shareable"`: own private IPC namespace, with a possibility to share it with
635
+ # other containers
636
+ # - `"container:<name|id>"`: join another (shareable) container's IPC namespace
637
+ # - `"host"`: use the host system's IPC namespace
638
+ #
639
+ # If not specified, daemon default is used, which can either be `"private"` or
640
+ # `"shareable"`, depending on daemon version and configuration.
641
+ #
642
+ # @return [String, nil]
643
+ optional :ipc_mode, String, api_name: :IpcMode
644
+
645
+ # @!attribute isolation
646
+ # Isolation technology of the container. (Windows only)
647
+ #
648
+ # @return [Symbol, DockerEngineAPI::Models::Container::HostConfig::Isolation, nil]
649
+ optional :isolation,
650
+ enum: -> {
651
+ DockerEngineAPI::Container::HostConfig::Isolation
652
+ },
653
+ api_name: :Isolation
654
+
655
+ # @!attribute links
656
+ # A list of links for the container in the form `container_name:alias`.
657
+ #
658
+ # @return [Array<String>, nil]
659
+ optional :links, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :Links
660
+
661
+ # @!attribute log_config
662
+ # The logging configuration for this container
663
+ #
664
+ # @return [DockerEngineAPI::Models::Container::HostConfig::LogConfig, nil]
665
+ optional :log_config, -> { DockerEngineAPI::Container::HostConfig::LogConfig }, api_name: :LogConfig
666
+
667
+ # @!attribute masked_paths
668
+ # The list of paths to be masked inside the container (this overrides the default
669
+ # set of paths).
670
+ #
671
+ # @return [Array<String>, nil]
672
+ optional :masked_paths, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :MaskedPaths
673
+
674
+ # @!attribute memory
675
+ # Memory limit in bytes.
676
+ #
677
+ # @return [Integer, nil]
678
+ optional :memory, Integer, api_name: :Memory
679
+
680
+ # @!attribute memory_reservation
681
+ # Memory soft limit in bytes.
682
+ #
683
+ # @return [Integer, nil]
684
+ optional :memory_reservation, Integer, api_name: :MemoryReservation
685
+
686
+ # @!attribute memory_swap
687
+ # Total memory limit (memory + swap). Set as `-1` to enable unlimited swap.
688
+ #
689
+ # @return [Integer, nil]
690
+ optional :memory_swap, Integer, api_name: :MemorySwap
691
+
692
+ # @!attribute memory_swappiness
693
+ # Tune a container's memory swappiness behavior. Accepts an integer between 0
694
+ # and 100.
695
+ #
696
+ # @return [Integer, nil]
697
+ optional :memory_swappiness, Integer, api_name: :MemorySwappiness
698
+
699
+ # @!attribute mounts
700
+ # Specification for mounts to be added to the container.
701
+ #
702
+ # @return [Array<DockerEngineAPI::Models::Container::HostConfig::Mount>, nil]
703
+ optional :mounts,
704
+ -> {
705
+ DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Container::HostConfig::Mount]
706
+ },
707
+ api_name: :Mounts
708
+
709
+ # @!attribute nano_cpus
710
+ # CPU quota in units of 10<sup>-9</sup> CPUs.
711
+ #
712
+ # @return [Integer, nil]
713
+ optional :nano_cpus, Integer, api_name: :NanoCpus
714
+
715
+ # @!attribute network_mode
716
+ # Network mode to use for this container. Supported standard values are: `bridge`,
717
+ # `host`, `none`, and `container:<name|id>`. Any other value is taken as a custom
718
+ # network's name to which this container should connect to.
719
+ #
720
+ # @return [String, nil]
721
+ optional :network_mode, String, api_name: :NetworkMode
722
+
723
+ # @!attribute oom_kill_disable
724
+ # Disable OOM Killer for the container.
725
+ #
726
+ # @return [Boolean, nil]
727
+ optional :oom_kill_disable, DockerEngineAPI::Internal::Type::Boolean, api_name: :OomKillDisable
728
+
729
+ # @!attribute oom_score_adj
730
+ # An integer value containing the score given to the container in order to tune
731
+ # OOM killer preferences.
732
+ #
733
+ # @return [Integer, nil]
734
+ optional :oom_score_adj, Integer, api_name: :OomScoreAdj
735
+
736
+ # @!attribute pid_mode
737
+ # Set the PID (Process) Namespace mode for the container. It can be either:
738
+ #
739
+ # - `"container:<name|id>"`: joins another container's PID namespace
740
+ # - `"host"`: use the host's PID namespace inside the container
741
+ #
742
+ # @return [String, nil]
743
+ optional :pid_mode, String, api_name: :PidMode
744
+
745
+ # @!attribute pids_limit
746
+ # Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not
747
+ # change.
748
+ #
749
+ # @return [Integer, nil]
750
+ optional :pids_limit, Integer, api_name: :PidsLimit, nil?: true
751
+
752
+ # @!attribute port_bindings
753
+ # PortMap describes the mapping of container ports to host ports, using the
754
+ # container's port-number and protocol as key in the format `<port>/<protocol>`,
755
+ # for example, `80/udp`.
756
+ #
757
+ # If a container's port is mapped for multiple protocols, separate entries are
758
+ # added to the mapping table.
759
+ #
760
+ # @return [Hash{Symbol=>Array<DockerEngineAPI::Models::Container::HostConfig::PortBinding>}, nil]
761
+ optional :port_bindings,
762
+ -> {
763
+ DockerEngineAPI::Internal::Type::HashOf[DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Container::HostConfig::PortBinding]]
764
+ },
765
+ api_name: :PortBindings
766
+
767
+ # @!attribute privileged
768
+ # Gives the container full access to the host.
769
+ #
770
+ # @return [Boolean, nil]
771
+ optional :privileged, DockerEngineAPI::Internal::Type::Boolean, api_name: :Privileged
772
+
773
+ # @!attribute publish_all_ports
774
+ # Allocates an ephemeral host port for all of a container's exposed ports.
775
+ #
776
+ # Ports are de-allocated when the container stops and allocated when the container
777
+ # starts. The allocated port might be changed when restarting the container.
778
+ #
779
+ # The port is selected from the ephemeral port range that depends on the kernel.
780
+ # For example, on Linux the range is defined by
781
+ # `/proc/sys/net/ipv4/ip_local_port_range`.
782
+ #
783
+ # @return [Boolean, nil]
784
+ optional :publish_all_ports, DockerEngineAPI::Internal::Type::Boolean, api_name: :PublishAllPorts
785
+
786
+ # @!attribute readonly_paths
787
+ # The list of paths to be set as read-only inside the container (this overrides
788
+ # the default set of paths).
789
+ #
790
+ # @return [Array<String>, nil]
791
+ optional :readonly_paths, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :ReadonlyPaths
792
+
793
+ # @!attribute readonly_rootfs
794
+ # Mount the container's root filesystem as read only.
795
+ #
796
+ # @return [Boolean, nil]
797
+ optional :readonly_rootfs, DockerEngineAPI::Internal::Type::Boolean, api_name: :ReadonlyRootfs
798
+
799
+ # @!attribute restart_policy
800
+ # The behavior to apply when the container exits. The default is not to restart.
801
+ #
802
+ # An ever increasing delay (double the previous delay, starting at 100ms) is added
803
+ # before each restart to prevent flooding the server.
804
+ #
805
+ # @return [DockerEngineAPI::Models::Container::HostConfig::RestartPolicy, nil]
806
+ optional :restart_policy,
807
+ -> { DockerEngineAPI::Container::HostConfig::RestartPolicy },
808
+ api_name: :RestartPolicy
809
+
810
+ # @!attribute runtime
811
+ # Runtime to use with this container.
812
+ #
813
+ # @return [String, nil]
814
+ optional :runtime, String, api_name: :Runtime, nil?: true
815
+
816
+ # @!attribute security_opt
817
+ # A list of string values to customize labels for MLS systems, such as SELinux.
818
+ #
819
+ # @return [Array<String>, nil]
820
+ optional :security_opt, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :SecurityOpt
821
+
822
+ # @!attribute shm_size
823
+ # Size of `/dev/shm` in bytes. If omitted, the system uses 64MB.
824
+ #
825
+ # @return [Integer, nil]
826
+ optional :shm_size, Integer, api_name: :ShmSize
827
+
828
+ # @!attribute storage_opt
829
+ # Storage driver options for this container, in the form `{"size": "120G"}`.
830
+ #
831
+ # @return [Hash{Symbol=>String}, nil]
832
+ optional :storage_opt, DockerEngineAPI::Internal::Type::HashOf[String], api_name: :StorageOpt
833
+
834
+ # @!attribute sysctls
835
+ # A list of kernel parameters (sysctls) to set in the container.
836
+ #
837
+ # This field is omitted if not set.
838
+ #
839
+ # @return [Hash{Symbol=>String}, nil]
840
+ optional :sysctls, DockerEngineAPI::Internal::Type::HashOf[String], api_name: :Sysctls, nil?: true
841
+
842
+ # @!attribute tmpfs
843
+ # A map of container directories which should be replaced by tmpfs mounts, and
844
+ # their corresponding mount options. For example:
845
+ #
846
+ # ```
847
+ # { "/run": "rw,noexec,nosuid,size=65536k" }
848
+ # ```
849
+ #
850
+ # @return [Hash{Symbol=>String}, nil]
851
+ optional :tmpfs, DockerEngineAPI::Internal::Type::HashOf[String], api_name: :Tmpfs
852
+
853
+ # @!attribute ulimits
854
+ # A list of resource limits to set in the container. For example:
855
+ #
856
+ # ```
857
+ # {"Name": "nofile", "Soft": 1024, "Hard": 2048}
858
+ # ```
859
+ #
860
+ # @return [Array<DockerEngineAPI::Models::Container::HostConfig::Ulimit>, nil]
861
+ optional :ulimits,
862
+ -> {
863
+ DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Container::HostConfig::Ulimit]
864
+ },
865
+ api_name: :Ulimits
866
+
867
+ # @!attribute userns_mode
868
+ # Sets the usernamespace mode for the container when usernamespace remapping
869
+ # option is enabled.
870
+ #
871
+ # @return [String, nil]
872
+ optional :userns_mode, String, api_name: :UsernsMode
873
+
874
+ # @!attribute uts_mode
875
+ # UTS namespace to use for the container.
876
+ #
877
+ # @return [String, nil]
878
+ optional :uts_mode, String, api_name: :UTSMode
879
+
880
+ # @!attribute volume_driver
881
+ # Driver that this container uses to mount volumes.
882
+ #
883
+ # @return [String, nil]
884
+ optional :volume_driver, String, api_name: :VolumeDriver
885
+
886
+ # @!attribute volumes_from
887
+ # A list of volumes to inherit from another container, specified in the form
888
+ # `<container name>[:<ro|rw>]`.
889
+ #
890
+ # @return [Array<String>, nil]
891
+ optional :volumes_from, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :VolumesFrom
892
+
893
+ # @!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)
894
+ # Some parameter documentations has been truncated, see
895
+ # {DockerEngineAPI::Models::Container::HostConfig} for more details.
896
+ #
897
+ # Container configuration that depends on the host we are running on
898
+ #
899
+ # @param annotations [Hash{Symbol=>String}] Arbitrary non-identifying metadata attached to container and
900
+ #
901
+ # @param auto_remove [Boolean] Automatically remove the container when the container's process
902
+ #
903
+ # @param binds [Array<String>] A list of volume bindings for this container. Each volume binding
904
+ #
905
+ # @param blkio_device_read_bps [Array<DockerEngineAPI::Models::Container::HostConfig::BlkioDeviceReadBp>] Limit read rate (bytes per second) from a device, in the form:
906
+ #
907
+ # @param blkio_device_read_i_ops [Array<DockerEngineAPI::Models::Container::HostConfig::BlkioDeviceReadIOp>] Limit read rate (IO per second) from a device, in the form:
908
+ #
909
+ # @param blkio_device_write_bps [Array<DockerEngineAPI::Models::Container::HostConfig::BlkioDeviceWriteBp>] Limit write rate (bytes per second) to a device, in the form:
910
+ #
911
+ # @param blkio_device_write_i_ops [Array<DockerEngineAPI::Models::Container::HostConfig::BlkioDeviceWriteIOp>] Limit write rate (IO per second) to a device, in the form:
912
+ #
913
+ # @param blkio_weight [Integer] Block IO weight (relative weight).
914
+ #
915
+ # @param blkio_weight_device [Array<DockerEngineAPI::Models::Container::HostConfig::BlkioWeightDevice>] Block IO weight (relative device weight) in the form:
916
+ #
917
+ # @param cap_add [Array<String>] A list of kernel capabilities to add to the container. Conflicts
918
+ #
919
+ # @param cap_drop [Array<String>] A list of kernel capabilities to drop from the container. Conflicts
920
+ #
921
+ # @param cgroup [String] Cgroup to use for the container.
922
+ #
923
+ # @param cgroupns_mode [Symbol, DockerEngineAPI::Models::Container::HostConfig::CgroupnsMode] cgroup namespace mode for the container. Possible values are:
924
+ #
925
+ # @param cgroup_parent [String] Path to `cgroups` under which the container's `cgroup` is created. If
926
+ #
927
+ # @param console_size [Array<Integer>, nil] Initial console size, as an `[height, width]` array.
928
+ #
929
+ # @param container_id_file [String] Path to a file where the container ID is written
930
+ #
931
+ # @param cpu_count [Integer] The number of usable CPUs (Windows only).
932
+ #
933
+ # @param cpu_percent [Integer] The usable percentage of the available CPUs (Windows only).
934
+ #
935
+ # @param cpu_period [Integer] The length of a CPU period in microseconds.
936
+ #
937
+ # @param cpu_quota [Integer] Microseconds of CPU time that the container can get in a CPU period.
938
+ #
939
+ # @param cpu_realtime_period [Integer] The length of a CPU real-time period in microseconds. Set to 0 to
940
+ #
941
+ # @param cpu_realtime_runtime [Integer] The length of a CPU real-time runtime in microseconds. Set to 0 to
942
+ #
943
+ # @param cpuset_cpus [String] CPUs in which to allow execution (e.g., `0-3`, `0,1`).
944
+ #
945
+ # @param cpuset_mems [String] Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only
946
+ #
947
+ # @param cpu_shares [Integer] An integer value representing this container's relative CPU weight
948
+ #
949
+ # @param device_cgroup_rules [Array<String>] a list of cgroup rules to apply to the container
950
+ #
951
+ # @param device_requests [Array<DockerEngineAPI::Models::Container::HostConfig::DeviceRequest>] A list of requests for devices to be sent to device drivers.
952
+ #
953
+ # @param devices [Array<DockerEngineAPI::Models::Container::HostConfig::Device>] A list of devices to add to the container.
954
+ #
955
+ # @param dns [Array<String>] A list of DNS servers for the container to use.
956
+ #
957
+ # @param dns_options [Array<String>] A list of DNS options.
958
+ #
959
+ # @param dns_search [Array<String>] A list of DNS search domains.
960
+ #
961
+ # @param extra_hosts [Array<String>] A list of hostnames/IP mappings to add to the container's `/etc/hosts`
962
+ #
963
+ # @param group_add [Array<String>] A list of additional groups that the container process will run as.
964
+ #
965
+ # @param init [Boolean, nil] Run an init inside the container that forwards signals and reaps
966
+ #
967
+ # @param io_maximum_bandwidth [Integer] Maximum IO in bytes per second for the container system drive
968
+ #
969
+ # @param io_maximum_i_ops [Integer] Maximum IOps for the container system drive (Windows only)
970
+ #
971
+ # @param ipc_mode [String] IPC sharing mode for the container. Possible values are:
972
+ #
973
+ # @param isolation [Symbol, DockerEngineAPI::Models::Container::HostConfig::Isolation] Isolation technology of the container. (Windows only)
974
+ #
975
+ # @param links [Array<String>] A list of links for the container in the form `container_name:alias`.
976
+ #
977
+ # @param log_config [DockerEngineAPI::Models::Container::HostConfig::LogConfig] The logging configuration for this container
978
+ #
979
+ # @param masked_paths [Array<String>] The list of paths to be masked inside the container (this overrides
980
+ #
981
+ # @param memory [Integer] Memory limit in bytes.
982
+ #
983
+ # @param memory_reservation [Integer] Memory soft limit in bytes.
984
+ #
985
+ # @param memory_swap [Integer] Total memory limit (memory + swap). Set as `-1` to enable unlimited
986
+ #
987
+ # @param memory_swappiness [Integer] Tune a container's memory swappiness behavior. Accepts an integer
988
+ #
989
+ # @param mounts [Array<DockerEngineAPI::Models::Container::HostConfig::Mount>] Specification for mounts to be added to the container.
990
+ #
991
+ # @param nano_cpus [Integer] CPU quota in units of 10<sup>-9</sup> CPUs.
992
+ #
993
+ # @param network_mode [String] Network mode to use for this container. Supported standard values
994
+ #
995
+ # @param oom_kill_disable [Boolean] Disable OOM Killer for the container.
996
+ #
997
+ # @param oom_score_adj [Integer] An integer value containing the score given to the container in
998
+ #
999
+ # @param pid_mode [String] Set the PID (Process) Namespace mode for the container. It can be
1000
+ #
1001
+ # @param pids_limit [Integer, nil] Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null`
1002
+ #
1003
+ # @param port_bindings [Hash{Symbol=>Array<DockerEngineAPI::Models::Container::HostConfig::PortBinding>}] PortMap describes the mapping of container ports to host ports, using the
1004
+ #
1005
+ # @param privileged [Boolean] Gives the container full access to the host.
1006
+ #
1007
+ # @param publish_all_ports [Boolean] Allocates an ephemeral host port for all of a container's
1008
+ #
1009
+ # @param readonly_paths [Array<String>] The list of paths to be set as read-only inside the container
1010
+ #
1011
+ # @param readonly_rootfs [Boolean] Mount the container's root filesystem as read only.
1012
+ #
1013
+ # @param restart_policy [DockerEngineAPI::Models::Container::HostConfig::RestartPolicy] The behavior to apply when the container exits. The default is not to
1014
+ #
1015
+ # @param runtime [String, nil] Runtime to use with this container.
1016
+ #
1017
+ # @param security_opt [Array<String>] A list of string values to customize labels for MLS systems, such
1018
+ #
1019
+ # @param shm_size [Integer] Size of `/dev/shm` in bytes. If omitted, the system uses 64MB.
1020
+ #
1021
+ # @param storage_opt [Hash{Symbol=>String}] Storage driver options for this container, in the form `{"size": "120G"}`.
1022
+ #
1023
+ # @param sysctls [Hash{Symbol=>String}, nil] A list of kernel parameters (sysctls) to set in the container.
1024
+ #
1025
+ # @param tmpfs [Hash{Symbol=>String}] A map of container directories which should be replaced by tmpfs
1026
+ #
1027
+ # @param ulimits [Array<DockerEngineAPI::Models::Container::HostConfig::Ulimit>] A list of resource limits to set in the container. For example:
1028
+ #
1029
+ # @param userns_mode [String] Sets the usernamespace mode for the container when usernamespace
1030
+ #
1031
+ # @param uts_mode [String] UTS namespace to use for the container.
1032
+ #
1033
+ # @param volume_driver [String] Driver that this container uses to mount volumes.
1034
+ #
1035
+ # @param volumes_from [Array<String>] A list of volumes to inherit from another container, specified in
1036
+
1037
+ class BlkioDeviceReadBp < DockerEngineAPI::Internal::Type::BaseModel
1038
+ # @!attribute path
1039
+ # Device path
1040
+ #
1041
+ # @return [String, nil]
1042
+ optional :path, String, api_name: :Path
1043
+
1044
+ # @!attribute rate
1045
+ # Rate
1046
+ #
1047
+ # @return [Integer, nil]
1048
+ optional :rate, Integer, api_name: :Rate
1049
+
1050
+ # @!method initialize(path: nil, rate: nil)
1051
+ # @param path [String] Device path
1052
+ #
1053
+ # @param rate [Integer] Rate
1054
+ end
1055
+
1056
+ class BlkioDeviceReadIOp < DockerEngineAPI::Internal::Type::BaseModel
1057
+ # @!attribute path
1058
+ # Device path
1059
+ #
1060
+ # @return [String, nil]
1061
+ optional :path, String, api_name: :Path
1062
+
1063
+ # @!attribute rate
1064
+ # Rate
1065
+ #
1066
+ # @return [Integer, nil]
1067
+ optional :rate, Integer, api_name: :Rate
1068
+
1069
+ # @!method initialize(path: nil, rate: nil)
1070
+ # @param path [String] Device path
1071
+ #
1072
+ # @param rate [Integer] Rate
1073
+ end
1074
+
1075
+ class BlkioDeviceWriteBp < DockerEngineAPI::Internal::Type::BaseModel
1076
+ # @!attribute path
1077
+ # Device path
1078
+ #
1079
+ # @return [String, nil]
1080
+ optional :path, String, api_name: :Path
1081
+
1082
+ # @!attribute rate
1083
+ # Rate
1084
+ #
1085
+ # @return [Integer, nil]
1086
+ optional :rate, Integer, api_name: :Rate
1087
+
1088
+ # @!method initialize(path: nil, rate: nil)
1089
+ # @param path [String] Device path
1090
+ #
1091
+ # @param rate [Integer] Rate
1092
+ end
1093
+
1094
+ class BlkioDeviceWriteIOp < DockerEngineAPI::Internal::Type::BaseModel
1095
+ # @!attribute path
1096
+ # Device path
1097
+ #
1098
+ # @return [String, nil]
1099
+ optional :path, String, api_name: :Path
1100
+
1101
+ # @!attribute rate
1102
+ # Rate
1103
+ #
1104
+ # @return [Integer, nil]
1105
+ optional :rate, Integer, api_name: :Rate
1106
+
1107
+ # @!method initialize(path: nil, rate: nil)
1108
+ # @param path [String] Device path
1109
+ #
1110
+ # @param rate [Integer] Rate
1111
+ end
1112
+
1113
+ class BlkioWeightDevice < DockerEngineAPI::Internal::Type::BaseModel
1114
+ # @!attribute path
1115
+ #
1116
+ # @return [String, nil]
1117
+ optional :path, String, api_name: :Path
1118
+
1119
+ # @!attribute weight
1120
+ #
1121
+ # @return [Integer, nil]
1122
+ optional :weight, Integer, api_name: :Weight
1123
+
1124
+ # @!method initialize(path: nil, weight: nil)
1125
+ # @param path [String]
1126
+ # @param weight [Integer]
1127
+ end
1128
+
1129
+ # cgroup namespace mode for the container. Possible values are:
1130
+ #
1131
+ # - `"private"`: the container runs in its own private cgroup namespace
1132
+ # - `"host"`: use the host system's cgroup namespace
1133
+ #
1134
+ # If not specified, the daemon default is used, which can either be `"private"` or
1135
+ # `"host"`, depending on daemon version, kernel support and configuration.
1136
+ #
1137
+ # @see DockerEngineAPI::Models::Container::HostConfig#cgroupns_mode
1138
+ module CgroupnsMode
1139
+ extend DockerEngineAPI::Internal::Type::Enum
1140
+
1141
+ PRIVATE = :private
1142
+ HOST = :host
1143
+
1144
+ # @!method self.values
1145
+ # @return [Array<Symbol>]
1146
+ end
1147
+
1148
+ class DeviceRequest < DockerEngineAPI::Internal::Type::BaseModel
1149
+ # @!attribute capabilities
1150
+ # A list of capabilities; an OR list of AND lists of capabilities.
1151
+ #
1152
+ # Note that if a driver is specified the capabilities have no effect on selecting
1153
+ # a driver as the driver name is used directly.
1154
+ #
1155
+ # Note that if no driver is specified the capabilities are used to select a driver
1156
+ # with the required capabilities.
1157
+ #
1158
+ # @return [Array<Array<String>>, nil]
1159
+ optional :capabilities,
1160
+ DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Internal::Type::ArrayOf[String]],
1161
+ api_name: :Capabilities
1162
+
1163
+ # @!attribute count
1164
+ #
1165
+ # @return [Integer, nil]
1166
+ optional :count, Integer, api_name: :Count
1167
+
1168
+ # @!attribute device_ids
1169
+ #
1170
+ # @return [Array<String>, nil]
1171
+ optional :device_ids, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :DeviceIDs
1172
+
1173
+ # @!attribute driver
1174
+ # The name of the device driver to use for this request.
1175
+ #
1176
+ # Note that if this is specified the capabilities are ignored when selecting a
1177
+ # device driver.
1178
+ #
1179
+ # @return [String, nil]
1180
+ optional :driver, String, api_name: :Driver
1181
+
1182
+ # @!attribute options
1183
+ # Driver-specific options, specified as a key/value pairs. These options are
1184
+ # passed directly to the driver.
1185
+ #
1186
+ # @return [Hash{Symbol=>String}, nil]
1187
+ optional :options, DockerEngineAPI::Internal::Type::HashOf[String], api_name: :Options
1188
+
1189
+ # @!method initialize(capabilities: nil, count: nil, device_ids: nil, driver: nil, options: nil)
1190
+ # Some parameter documentations has been truncated, see
1191
+ # {DockerEngineAPI::Models::Container::HostConfig::DeviceRequest} for more
1192
+ # details.
1193
+ #
1194
+ # A request for devices to be sent to device drivers
1195
+ #
1196
+ # @param capabilities [Array<Array<String>>] A list of capabilities; an OR list of AND lists of capabilities.
1197
+ #
1198
+ # @param count [Integer]
1199
+ #
1200
+ # @param device_ids [Array<String>]
1201
+ #
1202
+ # @param driver [String] The name of the device driver to use for this request.
1203
+ #
1204
+ # @param options [Hash{Symbol=>String}] Driver-specific options, specified as a key/value pairs. These options
1205
+ end
1206
+
1207
+ class Device < DockerEngineAPI::Internal::Type::BaseModel
1208
+ # @!attribute cgroup_permissions
1209
+ #
1210
+ # @return [String, nil]
1211
+ optional :cgroup_permissions, String, api_name: :CgroupPermissions
1212
+
1213
+ # @!attribute path_in_container
1214
+ #
1215
+ # @return [String, nil]
1216
+ optional :path_in_container, String, api_name: :PathInContainer
1217
+
1218
+ # @!attribute path_on_host
1219
+ #
1220
+ # @return [String, nil]
1221
+ optional :path_on_host, String, api_name: :PathOnHost
1222
+
1223
+ # @!method initialize(cgroup_permissions: nil, path_in_container: nil, path_on_host: nil)
1224
+ # A device mapping between the host and container
1225
+ #
1226
+ # @param cgroup_permissions [String]
1227
+ # @param path_in_container [String]
1228
+ # @param path_on_host [String]
1229
+ end
1230
+
1231
+ # Isolation technology of the container. (Windows only)
1232
+ #
1233
+ # @see DockerEngineAPI::Models::Container::HostConfig#isolation
1234
+ module Isolation
1235
+ extend DockerEngineAPI::Internal::Type::Enum
1236
+
1237
+ DEFAULT = :default
1238
+ PROCESS = :process
1239
+ HYPERV = :hyperv
1240
+ EMPTY = :""
1241
+
1242
+ # @!method self.values
1243
+ # @return [Array<Symbol>]
1244
+ end
1245
+
1246
+ # @see DockerEngineAPI::Models::Container::HostConfig#log_config
1247
+ class LogConfig < DockerEngineAPI::Internal::Type::BaseModel
1248
+ # @!attribute config
1249
+ # Driver-specific configuration options for the logging driver.
1250
+ #
1251
+ # @return [Hash{Symbol=>String}, nil]
1252
+ optional :config, DockerEngineAPI::Internal::Type::HashOf[String], api_name: :Config
1253
+
1254
+ # @!attribute type
1255
+ # Name of the logging driver used for the container or "none" if logging is
1256
+ # disabled.
1257
+ #
1258
+ # @return [Symbol, DockerEngineAPI::Models::Container::HostConfig::LogConfig::Type, nil]
1259
+ optional :type,
1260
+ enum: -> {
1261
+ DockerEngineAPI::Container::HostConfig::LogConfig::Type
1262
+ },
1263
+ api_name: :Type
1264
+
1265
+ # @!method initialize(config: nil, type: nil)
1266
+ # Some parameter documentations has been truncated, see
1267
+ # {DockerEngineAPI::Models::Container::HostConfig::LogConfig} for more details.
1268
+ #
1269
+ # The logging configuration for this container
1270
+ #
1271
+ # @param config [Hash{Symbol=>String}] Driver-specific configuration options for the logging driver.
1272
+ #
1273
+ # @param type [Symbol, DockerEngineAPI::Models::Container::HostConfig::LogConfig::Type] Name of the logging driver used for the container or "none"
1274
+
1275
+ # Name of the logging driver used for the container or "none" if logging is
1276
+ # disabled.
1277
+ #
1278
+ # @see DockerEngineAPI::Models::Container::HostConfig::LogConfig#type
1279
+ module Type
1280
+ extend DockerEngineAPI::Internal::Type::Enum
1281
+
1282
+ LOCAL = :local
1283
+ JSON_FILE = :"json-file"
1284
+ SYSLOG = :syslog
1285
+ JOURNALD = :journald
1286
+ GELF = :gelf
1287
+ FLUENTD = :fluentd
1288
+ AWSLOGS = :awslogs
1289
+ SPLUNK = :splunk
1290
+ ETWLOGS = :etwlogs
1291
+ NONE = :none
1292
+
1293
+ # @!method self.values
1294
+ # @return [Array<Symbol>]
1295
+ end
1296
+ end
1297
+
1298
+ class Mount < DockerEngineAPI::Internal::Type::BaseModel
1299
+ # @!attribute bind_options
1300
+ # Optional configuration for the `bind` type.
1301
+ #
1302
+ # @return [DockerEngineAPI::Models::Container::HostConfig::Mount::BindOptions, nil]
1303
+ optional :bind_options,
1304
+ -> { DockerEngineAPI::Container::HostConfig::Mount::BindOptions },
1305
+ api_name: :BindOptions
1306
+
1307
+ # @!attribute consistency
1308
+ # The consistency requirement for the mount: `default`, `consistent`, `cached`, or
1309
+ # `delegated`.
1310
+ #
1311
+ # @return [String, nil]
1312
+ optional :consistency, String, api_name: :Consistency
1313
+
1314
+ # @!attribute image_options
1315
+ # Optional configuration for the `image` type.
1316
+ #
1317
+ # @return [DockerEngineAPI::Models::Container::HostConfig::Mount::ImageOptions, nil]
1318
+ optional :image_options,
1319
+ -> { DockerEngineAPI::Container::HostConfig::Mount::ImageOptions },
1320
+ api_name: :ImageOptions
1321
+
1322
+ # @!attribute read_only
1323
+ # Whether the mount should be read-only.
1324
+ #
1325
+ # @return [Boolean, nil]
1326
+ optional :read_only, DockerEngineAPI::Internal::Type::Boolean, api_name: :ReadOnly
1327
+
1328
+ # @!attribute source
1329
+ # Mount source (e.g. a volume name, a host path). The source cannot be specified
1330
+ # when using `Type=tmpfs`. For `Type=bind`, the source path must either exist, or
1331
+ # the `CreateMountpoint` must be set to `true` to create the source path on the
1332
+ # host if missing.
1333
+ #
1334
+ # For `Type=npipe`, the pipe must exist prior to creating the container.
1335
+ #
1336
+ # @return [String, nil]
1337
+ optional :source, String, api_name: :Source
1338
+
1339
+ # @!attribute target
1340
+ # Container path.
1341
+ #
1342
+ # @return [String, nil]
1343
+ optional :target, String, api_name: :Target
1344
+
1345
+ # @!attribute tmpfs_options
1346
+ # Optional configuration for the `tmpfs` type.
1347
+ #
1348
+ # @return [DockerEngineAPI::Models::Container::HostConfig::Mount::TmpfsOptions, nil]
1349
+ optional :tmpfs_options,
1350
+ -> { DockerEngineAPI::Container::HostConfig::Mount::TmpfsOptions },
1351
+ api_name: :TmpfsOptions
1352
+
1353
+ # @!attribute type
1354
+ # The mount type. Available types:
1355
+ #
1356
+ # - `bind` a mount of a file or directory from the host into the container.
1357
+ # - `cluster` a Swarm cluster volume.
1358
+ # - `image` an OCI image.
1359
+ # - `npipe` a named pipe from the host into the container.
1360
+ # - `tmpfs` a `tmpfs`.
1361
+ # - `volume` a docker volume with the given `Name`.
1362
+ #
1363
+ # @return [Symbol, DockerEngineAPI::Models::Container::HostConfig::Mount::Type, nil]
1364
+ optional :type, enum: -> { DockerEngineAPI::Container::HostConfig::Mount::Type }, api_name: :Type
1365
+
1366
+ # @!attribute volume_options
1367
+ # Optional configuration for the `volume` type.
1368
+ #
1369
+ # @return [DockerEngineAPI::Models::Container::HostConfig::Mount::VolumeOptions, nil]
1370
+ optional :volume_options,
1371
+ -> { DockerEngineAPI::Container::HostConfig::Mount::VolumeOptions },
1372
+ api_name: :VolumeOptions
1373
+
1374
+ # @!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)
1375
+ # Some parameter documentations has been truncated, see
1376
+ # {DockerEngineAPI::Models::Container::HostConfig::Mount} for more details.
1377
+ #
1378
+ # @param bind_options [DockerEngineAPI::Models::Container::HostConfig::Mount::BindOptions] Optional configuration for the `bind` type.
1379
+ #
1380
+ # @param consistency [String] The consistency requirement for the mount: `default`, `consistent`, `cached`, or
1381
+ #
1382
+ # @param image_options [DockerEngineAPI::Models::Container::HostConfig::Mount::ImageOptions] Optional configuration for the `image` type.
1383
+ #
1384
+ # @param read_only [Boolean] Whether the mount should be read-only.
1385
+ #
1386
+ # @param source [String] Mount source (e.g. a volume name, a host path). The source cannot be
1387
+ #
1388
+ # @param target [String] Container path.
1389
+ #
1390
+ # @param tmpfs_options [DockerEngineAPI::Models::Container::HostConfig::Mount::TmpfsOptions] Optional configuration for the `tmpfs` type.
1391
+ #
1392
+ # @param type [Symbol, DockerEngineAPI::Models::Container::HostConfig::Mount::Type] The mount type. Available types:
1393
+ #
1394
+ # @param volume_options [DockerEngineAPI::Models::Container::HostConfig::Mount::VolumeOptions] Optional configuration for the `volume` type.
1395
+
1396
+ # @see DockerEngineAPI::Models::Container::HostConfig::Mount#bind_options
1397
+ class BindOptions < DockerEngineAPI::Internal::Type::BaseModel
1398
+ # @!attribute create_mountpoint
1399
+ # Create mount point on host if missing
1400
+ #
1401
+ # @return [Boolean, nil]
1402
+ optional :create_mountpoint, DockerEngineAPI::Internal::Type::Boolean, api_name: :CreateMountpoint
1403
+
1404
+ # @!attribute non_recursive
1405
+ # Disable recursive bind mount.
1406
+ #
1407
+ # @return [Boolean, nil]
1408
+ optional :non_recursive, DockerEngineAPI::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, DockerEngineAPI::Models::Container::HostConfig::Mount::BindOptions::Propagation, nil]
1414
+ optional :propagation,
1415
+ enum: -> { DockerEngineAPI::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
+ DockerEngineAPI::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
+ DockerEngineAPI::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
+ # {DockerEngineAPI::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, DockerEngineAPI::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 DockerEngineAPI::Models::Container::HostConfig::Mount::BindOptions#propagation
1459
+ module Propagation
1460
+ extend DockerEngineAPI::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 DockerEngineAPI::Models::Container::HostConfig::Mount#image_options
1475
+ class ImageOptions < DockerEngineAPI::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 DockerEngineAPI::Models::Container::HostConfig::Mount#tmpfs_options
1489
+ class TmpfsOptions < DockerEngineAPI::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
+ DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::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
+ # {DockerEngineAPI::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 DockerEngineAPI::Models::Container::HostConfig::Mount#type
1538
+ module Type
1539
+ extend DockerEngineAPI::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 DockerEngineAPI::Models::Container::HostConfig::Mount#volume_options
1553
+ class VolumeOptions < DockerEngineAPI::Internal::Type::BaseModel
1554
+ # @!attribute driver_config
1555
+ # Map of driver specific options
1556
+ #
1557
+ # @return [DockerEngineAPI::Models::Container::HostConfig::Mount::VolumeOptions::DriverConfig, nil]
1558
+ optional :driver_config,
1559
+ -> { DockerEngineAPI::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, DockerEngineAPI::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, DockerEngineAPI::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 [DockerEngineAPI::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 DockerEngineAPI::Models::Container::HostConfig::Mount::VolumeOptions#driver_config
1592
+ class DriverConfig < DockerEngineAPI::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, DockerEngineAPI::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 < DockerEngineAPI::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 DockerEngineAPI::Models::Container::HostConfig#restart_policy
1637
+ class RestartPolicy < DockerEngineAPI::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, DockerEngineAPI::Models::Container::HostConfig::RestartPolicy::Name, nil]
1653
+ optional :name,
1654
+ enum: -> {
1655
+ DockerEngineAPI::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
+ # {DockerEngineAPI::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, DockerEngineAPI::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 DockerEngineAPI::Models::Container::HostConfig::RestartPolicy#name
1681
+ module Name
1682
+ extend DockerEngineAPI::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 < DockerEngineAPI::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 DockerEngineAPI::Models::Container#image_manifest_descriptor
1724
+ class ImageManifestDescriptor < DockerEngineAPI::Internal::Type::BaseModel
1725
+ # @!attribute annotations
1726
+ # Arbitrary metadata relating to the targeted content.
1727
+ #
1728
+ # @return [Hash{Symbol=>String}, nil]
1729
+ optional :annotations, DockerEngineAPI::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 [DockerEngineAPI::Models::Container::ImageManifestDescriptor::Platform, nil]
1763
+ optional :platform, -> { DockerEngineAPI::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, DockerEngineAPI::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
+ # {DockerEngineAPI::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 [DockerEngineAPI::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 DockerEngineAPI::Models::Container::ImageManifestDescriptor#platform
1801
+ class Platform < DockerEngineAPI::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, DockerEngineAPI::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
+ # {DockerEngineAPI::Models::Container::ImageManifestDescriptor::Platform} for more
1838
+ # 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 < DockerEngineAPI::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, DockerEngineAPI::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, DockerEngineAPI::Models::Container::Mount::Type, nil]
1923
+ optional :type, enum: -> { DockerEngineAPI::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
+ # {DockerEngineAPI::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, DockerEngineAPI::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 DockerEngineAPI::Models::Container::Mount#type
1958
+ module Type
1959
+ extend DockerEngineAPI::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 DockerEngineAPI::Models::Container#network_settings
1974
+ class NetworkSettings < DockerEngineAPI::Internal::Type::BaseModel
1975
+ # @!attribute networks
1976
+ # Information about all networks that the container is connected to.
1977
+ #
1978
+ # @return [Hash{Symbol=>DockerEngineAPI::Models::Container::NetworkSettings::Network}, nil]
1979
+ optional :networks,
1980
+ -> {
1981
+ DockerEngineAPI::Internal::Type::HashOf[DockerEngineAPI::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<DockerEngineAPI::Models::Container::NetworkSettings::Port>}, nil]
1994
+ optional :ports,
1995
+ -> {
1996
+ DockerEngineAPI::Internal::Type::HashOf[DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::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
+ # {DockerEngineAPI::Models::Container::NetworkSettings} for more details.
2015
+ #
2016
+ # NetworkSettings exposes the network settings in the API
2017
+ #
2018
+ # @param networks [Hash{Symbol=>DockerEngineAPI::Models::Container::NetworkSettings::Network}] Information about all networks that the container is connected to.
2019
+ #
2020
+ # @param ports [Hash{Symbol=>Array<DockerEngineAPI::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 < DockerEngineAPI::Internal::Type::BaseModel
2027
+ # @!attribute aliases
2028
+ #
2029
+ # @return [Array<String>, nil]
2030
+ optional :aliases, DockerEngineAPI::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, DockerEngineAPI::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
+ DockerEngineAPI::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 [DockerEngineAPI::Models::Container::NetworkSettings::Network::IpamConfig, nil]
2097
+ optional :ipam_config,
2098
+ -> { DockerEngineAPI::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, DockerEngineAPI::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
+ # {DockerEngineAPI::Models::Container::NetworkSettings::Network} for more details.
2135
+ #
2136
+ # Configuration for a network endpoint.
2137
+ #
2138
+ # @param aliases [Array<String>]
2139
+ #
2140
+ # @param dns_names [Array<String>] List of all DNS names an endpoint has on a specific network. This
2141
+ #
2142
+ # @param driver_opts [Hash{Symbol=>String}, nil] DriverOpts is a mapping of driver options and values. These options
2143
+ #
2144
+ # @param endpoint_id [String] Unique ID for the service endpoint in a Sandbox.
2145
+ #
2146
+ # @param gateway [String] Gateway address for this network.
2147
+ #
2148
+ # @param global_i_pv6_address [String] Global IPv6 address.
2149
+ #
2150
+ # @param global_i_pv6_prefix_len [Integer] Mask length of the global IPv6 address.
2151
+ #
2152
+ # @param gw_priority [Integer] This property determines which endpoint will provide the default
2153
+ #
2154
+ # @param ip_address [String] IPv4 address.
2155
+ #
2156
+ # @param ipam_config [DockerEngineAPI::Models::Container::NetworkSettings::Network::IpamConfig, nil] EndpointIPAMConfig represents an endpoint's IPAM configuration.
2157
+ #
2158
+ # @param ip_prefix_len [Integer] Mask length of the IPv4 address.
2159
+ #
2160
+ # @param i_pv6_gateway [String] IPv6 gateway address.
2161
+ #
2162
+ # @param links [Array<String>]
2163
+ #
2164
+ # @param mac_address [String] MAC address for the endpoint on this network. The network driver might ignore th
2165
+ #
2166
+ # @param network_id [String] Unique ID of the network.
2167
+
2168
+ # @see DockerEngineAPI::Models::Container::NetworkSettings::Network#ipam_config
2169
+ class IpamConfig < DockerEngineAPI::Internal::Type::BaseModel
2170
+ # @!attribute i_pv4_address
2171
+ #
2172
+ # @return [String, nil]
2173
+ optional :i_pv4_address, String, api_name: :IPv4Address
2174
+
2175
+ # @!attribute i_pv6_address
2176
+ #
2177
+ # @return [String, nil]
2178
+ optional :i_pv6_address, String, api_name: :IPv6Address
2179
+
2180
+ # @!attribute link_local_ips
2181
+ #
2182
+ # @return [Array<String>, nil]
2183
+ optional :link_local_ips,
2184
+ DockerEngineAPI::Internal::Type::ArrayOf[String],
2185
+ api_name: :LinkLocalIPs
2186
+
2187
+ # @!method initialize(i_pv4_address: nil, i_pv6_address: nil, link_local_ips: nil)
2188
+ # EndpointIPAMConfig represents an endpoint's IPAM configuration.
2189
+ #
2190
+ # @param i_pv4_address [String]
2191
+ # @param i_pv6_address [String]
2192
+ # @param link_local_ips [Array<String>]
2193
+ end
2194
+ end
2195
+
2196
+ class Port < DockerEngineAPI::Internal::Type::BaseModel
2197
+ # @!attribute host_ip
2198
+ # Host IP address that the container's port is mapped to.
2199
+ #
2200
+ # @return [String, nil]
2201
+ optional :host_ip, String, api_name: :HostIp
2202
+
2203
+ # @!attribute host_port
2204
+ # Host port number that the container's port is mapped to.
2205
+ #
2206
+ # @return [String, nil]
2207
+ optional :host_port, String, api_name: :HostPort
2208
+
2209
+ # @!method initialize(host_ip: nil, host_port: nil)
2210
+ # PortBinding represents a binding between a host IP address and a host port.
2211
+ #
2212
+ # @param host_ip [String] Host IP address that the container's port is mapped to.
2213
+ #
2214
+ # @param host_port [String] Host port number that the container's port is mapped to.
2215
+ end
2216
+ end
2217
+
2218
+ # @see DockerEngineAPI::Models::Container#state
2219
+ class State < DockerEngineAPI::Internal::Type::BaseModel
2220
+ # @!attribute dead
2221
+ #
2222
+ # @return [Boolean, nil]
2223
+ optional :dead, DockerEngineAPI::Internal::Type::Boolean, api_name: :Dead
2224
+
2225
+ # @!attribute error
2226
+ #
2227
+ # @return [String, nil]
2228
+ optional :error, String, api_name: :Error
2229
+
2230
+ # @!attribute exit_code
2231
+ # The last exit code of this container
2232
+ #
2233
+ # @return [Integer, nil]
2234
+ optional :exit_code, Integer, api_name: :ExitCode
2235
+
2236
+ # @!attribute finished_at
2237
+ # The time when this container last exited.
2238
+ #
2239
+ # @return [String, nil]
2240
+ optional :finished_at, String, api_name: :FinishedAt
2241
+
2242
+ # @!attribute health
2243
+ # Health stores information about the container's healthcheck results.
2244
+ #
2245
+ # @return [DockerEngineAPI::Models::Container::State::Health, nil]
2246
+ optional :health, -> { DockerEngineAPI::Container::State::Health }, api_name: :Health, nil?: true
2247
+
2248
+ # @!attribute oom_killed
2249
+ # Whether a process within this container has been killed because it ran out of
2250
+ # memory since the container was last started.
2251
+ #
2252
+ # @return [Boolean, nil]
2253
+ optional :oom_killed, DockerEngineAPI::Internal::Type::Boolean, api_name: :OOMKilled
2254
+
2255
+ # @!attribute paused
2256
+ # Whether this container is paused.
2257
+ #
2258
+ # @return [Boolean, nil]
2259
+ optional :paused, DockerEngineAPI::Internal::Type::Boolean, api_name: :Paused
2260
+
2261
+ # @!attribute pid
2262
+ # The process ID of this container
2263
+ #
2264
+ # @return [Integer, nil]
2265
+ optional :pid, Integer, api_name: :Pid
2266
+
2267
+ # @!attribute restarting
2268
+ # Whether this container is restarting.
2269
+ #
2270
+ # @return [Boolean, nil]
2271
+ optional :restarting, DockerEngineAPI::Internal::Type::Boolean, api_name: :Restarting
2272
+
2273
+ # @!attribute running
2274
+ # Whether this container is running.
2275
+ #
2276
+ # Note that a running container can be _paused_. The `Running` and `Paused`
2277
+ # booleans are not mutually exclusive:
2278
+ #
2279
+ # When pausing a container (on Linux), the freezer cgroup is used to suspend all
2280
+ # processes in the container. Freezing the process requires the process to be
2281
+ # running. As a result, paused containers are both `Running` _and_ `Paused`.
2282
+ #
2283
+ # Use the `Status` field instead to determine if a container's state is "running".
2284
+ #
2285
+ # @return [Boolean, nil]
2286
+ optional :running, DockerEngineAPI::Internal::Type::Boolean, api_name: :Running
2287
+
2288
+ # @!attribute started_at
2289
+ # The time when this container was last started.
2290
+ #
2291
+ # @return [String, nil]
2292
+ optional :started_at, String, api_name: :StartedAt
2293
+
2294
+ # @!attribute status
2295
+ # String representation of the container state. Can be one of "created",
2296
+ # "running", "paused", "restarting", "removing", "exited", or "dead".
2297
+ #
2298
+ # @return [Symbol, DockerEngineAPI::Models::Container::State::Status, nil]
2299
+ optional :status, enum: -> { DockerEngineAPI::Container::State::Status }, api_name: :Status
2300
+
2301
+ # @!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)
2302
+ # Some parameter documentations has been truncated, see
2303
+ # {DockerEngineAPI::Models::Container::State} for more details.
2304
+ #
2305
+ # ContainerState stores container's running state. It's part of ContainerJSONBase
2306
+ # and will be returned by the "inspect" command.
2307
+ #
2308
+ # @param dead [Boolean]
2309
+ #
2310
+ # @param error [String]
2311
+ #
2312
+ # @param exit_code [Integer] The last exit code of this container
2313
+ #
2314
+ # @param finished_at [String] The time when this container last exited.
2315
+ #
2316
+ # @param health [DockerEngineAPI::Models::Container::State::Health, nil] Health stores information about the container's healthcheck results.
2317
+ #
2318
+ # @param oom_killed [Boolean] Whether a process within this container has been killed because it ran
2319
+ #
2320
+ # @param paused [Boolean] Whether this container is paused.
2321
+ #
2322
+ # @param pid [Integer] The process ID of this container
2323
+ #
2324
+ # @param restarting [Boolean] Whether this container is restarting.
2325
+ #
2326
+ # @param running [Boolean] Whether this container is running.
2327
+ #
2328
+ # @param started_at [String] The time when this container was last started.
2329
+ #
2330
+ # @param status [Symbol, DockerEngineAPI::Models::Container::State::Status] String representation of the container state. Can be one of "created",
2331
+
2332
+ # @see DockerEngineAPI::Models::Container::State#health
2333
+ class Health < DockerEngineAPI::Internal::Type::BaseModel
2334
+ # @!attribute failing_streak
2335
+ # FailingStreak is the number of consecutive failures
2336
+ #
2337
+ # @return [Integer, nil]
2338
+ optional :failing_streak, Integer, api_name: :FailingStreak
2339
+
2340
+ # @!attribute log
2341
+ # Log contains the last few results (oldest first)
2342
+ #
2343
+ # @return [Array<DockerEngineAPI::Models::Container::State::Health::Log, nil>, nil]
2344
+ optional :log,
2345
+ -> {
2346
+ DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Container::State::Health::Log,
2347
+ nil?: true]
2348
+ },
2349
+ api_name: :Log
2350
+
2351
+ # @!attribute status
2352
+ # Status is one of `none`, `starting`, `healthy` or `unhealthy`
2353
+ #
2354
+ # - "none" Indicates there is no healthcheck
2355
+ # - "starting" Starting indicates that the container is not yet ready
2356
+ # - "healthy" Healthy indicates that the container is running correctly
2357
+ # - "unhealthy" Unhealthy indicates that the container has a problem
2358
+ #
2359
+ # @return [Symbol, DockerEngineAPI::Models::Container::State::Health::Status, nil]
2360
+ optional :status, enum: -> { DockerEngineAPI::Container::State::Health::Status }, api_name: :Status
2361
+
2362
+ # @!method initialize(failing_streak: nil, log: nil, status: nil)
2363
+ # Some parameter documentations has been truncated, see
2364
+ # {DockerEngineAPI::Models::Container::State::Health} for more details.
2365
+ #
2366
+ # Health stores information about the container's healthcheck results.
2367
+ #
2368
+ # @param failing_streak [Integer] FailingStreak is the number of consecutive failures
2369
+ #
2370
+ # @param log [Array<DockerEngineAPI::Models::Container::State::Health::Log, nil>] Log contains the last few results (oldest first)
2371
+ #
2372
+ # @param status [Symbol, DockerEngineAPI::Models::Container::State::Health::Status] Status is one of `none`, `starting`, `healthy` or `unhealthy`
2373
+
2374
+ class Log < DockerEngineAPI::Internal::Type::BaseModel
2375
+ # @!attribute end_
2376
+ # Date and time at which this check ended in
2377
+ # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
2378
+ #
2379
+ # @return [String, nil]
2380
+ optional :end_, String, api_name: :End
2381
+
2382
+ # @!attribute exit_code
2383
+ # ExitCode meanings:
2384
+ #
2385
+ # - `0` healthy
2386
+ # - `1` unhealthy
2387
+ # - `2` reserved (considered unhealthy)
2388
+ # - other values: error running probe
2389
+ #
2390
+ # @return [Integer, nil]
2391
+ optional :exit_code, Integer, api_name: :ExitCode
2392
+
2393
+ # @!attribute output
2394
+ # Output from last check
2395
+ #
2396
+ # @return [String, nil]
2397
+ optional :output, String, api_name: :Output
2398
+
2399
+ # @!attribute start
2400
+ # Date and time at which this check started in
2401
+ # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
2402
+ #
2403
+ # @return [Time, nil]
2404
+ optional :start, Time, api_name: :Start
2405
+
2406
+ # @!method initialize(end_: nil, exit_code: nil, output: nil, start: nil)
2407
+ # Some parameter documentations has been truncated, see
2408
+ # {DockerEngineAPI::Models::Container::State::Health::Log} for more details.
2409
+ #
2410
+ # HealthcheckResult stores information about a single run of a healthcheck probe
2411
+ #
2412
+ # @param end_ [String] Date and time at which this check ended in
2413
+ #
2414
+ # @param exit_code [Integer] ExitCode meanings:
2415
+ #
2416
+ # @param output [String] Output from last check
2417
+ #
2418
+ # @param start [Time] Date and time at which this check started in
2419
+ end
2420
+
2421
+ # Status is one of `none`, `starting`, `healthy` or `unhealthy`
2422
+ #
2423
+ # - "none" Indicates there is no healthcheck
2424
+ # - "starting" Starting indicates that the container is not yet ready
2425
+ # - "healthy" Healthy indicates that the container is running correctly
2426
+ # - "unhealthy" Unhealthy indicates that the container has a problem
2427
+ #
2428
+ # @see DockerEngineAPI::Models::Container::State::Health#status
2429
+ module Status
2430
+ extend DockerEngineAPI::Internal::Type::Enum
2431
+
2432
+ NONE = :none
2433
+ STARTING = :starting
2434
+ HEALTHY = :healthy
2435
+ UNHEALTHY = :unhealthy
2436
+
2437
+ # @!method self.values
2438
+ # @return [Array<Symbol>]
2439
+ end
2440
+ end
2441
+
2442
+ # String representation of the container state. Can be one of "created",
2443
+ # "running", "paused", "restarting", "removing", "exited", or "dead".
2444
+ #
2445
+ # @see DockerEngineAPI::Models::Container::State#status
2446
+ module Status
2447
+ extend DockerEngineAPI::Internal::Type::Enum
2448
+
2449
+ CREATED = :created
2450
+ RUNNING = :running
2451
+ PAUSED = :paused
2452
+ RESTARTING = :restarting
2453
+ REMOVING = :removing
2454
+ EXITED = :exited
2455
+ DEAD = :dead
2456
+
2457
+ # @!method self.values
2458
+ # @return [Array<Symbol>]
2459
+ end
2460
+ end
2461
+
2462
+ # @see DockerEngineAPI::Models::Container#storage
2463
+ class Storage < DockerEngineAPI::Internal::Type::BaseModel
2464
+ # @!attribute root_fs
2465
+ # Information about the storage used for the container's root filesystem.
2466
+ #
2467
+ # @return [DockerEngineAPI::Models::Container::Storage::RootFs, nil]
2468
+ optional :root_fs, -> { DockerEngineAPI::Container::Storage::RootFs }, api_name: :RootFS
2469
+
2470
+ # @!method initialize(root_fs: nil)
2471
+ # Some parameter documentations has been truncated, see
2472
+ # {DockerEngineAPI::Models::Container::Storage} for more details.
2473
+ #
2474
+ # Information about the storage used by the container.
2475
+ #
2476
+ # @param root_fs [DockerEngineAPI::Models::Container::Storage::RootFs] Information about the storage used for the container's root filesystem.
2477
+
2478
+ # @see DockerEngineAPI::Models::Container::Storage#root_fs
2479
+ class RootFs < DockerEngineAPI::Internal::Type::BaseModel
2480
+ # @!attribute snapshot
2481
+ # Information about a snapshot backend of the container's root filesystem.
2482
+ #
2483
+ # @return [DockerEngineAPI::Models::Container::Storage::RootFs::Snapshot, nil]
2484
+ optional :snapshot,
2485
+ -> {
2486
+ DockerEngineAPI::Container::Storage::RootFs::Snapshot
2487
+ },
2488
+ api_name: :Snapshot
2489
+
2490
+ # @!method initialize(snapshot: nil)
2491
+ # Some parameter documentations has been truncated, see
2492
+ # {DockerEngineAPI::Models::Container::Storage::RootFs} for more details.
2493
+ #
2494
+ # Information about the storage used for the container's root filesystem.
2495
+ #
2496
+ # @param snapshot [DockerEngineAPI::Models::Container::Storage::RootFs::Snapshot] Information about a snapshot backend of the container's root filesystem.
2497
+
2498
+ # @see DockerEngineAPI::Models::Container::Storage::RootFs#snapshot
2499
+ class Snapshot < DockerEngineAPI::Internal::Type::BaseModel
2500
+ # @!attribute name
2501
+ # Name of the snapshotter.
2502
+ #
2503
+ # @return [String, nil]
2504
+ optional :name, String, api_name: :Name
2505
+
2506
+ # @!method initialize(name: nil)
2507
+ # Information about a snapshot backend of the container's root filesystem.
2508
+ #
2509
+ # @param name [String] Name of the snapshotter.
2510
+ end
2511
+ end
2512
+ end
2513
+ end
2514
+ end
2515
+ end