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,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module DockerEngineAPI
4
+ module Models
5
+ # @see DockerEngineAPI::Resources::Containers#top
6
+ class ContainerTopParams < DockerEngineAPI::Internal::Type::BaseModel
7
+ extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
8
+ include DockerEngineAPI::Internal::Type::RequestParameters
9
+
10
+ # @!attribute ps_args
11
+ # The arguments to pass to `ps`. For example, `aux`
12
+ #
13
+ # @return [String, nil]
14
+ optional :ps_args, String
15
+
16
+ # @!method initialize(ps_args: nil, request_options: {})
17
+ # @param ps_args [String] The arguments to pass to `ps`. For example, `aux`
18
+ #
19
+ # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,14 @@
1
+ # frozen_string_literal: true
2
+
3
+ module DockerEngineAPI
4
+ module Models
5
+ # @see DockerEngineAPI::Resources::Containers#unpause
6
+ class ContainerUnpauseParams < DockerEngineAPI::Internal::Type::BaseModel
7
+ extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
8
+ include DockerEngineAPI::Internal::Type::RequestParameters
9
+
10
+ # @!method initialize(request_options: {})
11
+ # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
12
+ end
13
+ end
14
+ end
@@ -0,0 +1,606 @@
1
+ # frozen_string_literal: true
2
+
3
+ module DockerEngineAPI
4
+ module Models
5
+ # @see DockerEngineAPI::Resources::Containers#update
6
+ class ContainerUpdateParams < DockerEngineAPI::Internal::Type::BaseModel
7
+ extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
8
+ include DockerEngineAPI::Internal::Type::RequestParameters
9
+
10
+ # @!attribute blkio_device_read_bps
11
+ # Limit read rate (bytes per second) from a device, in the form:
12
+ #
13
+ # ```
14
+ # [{"Path": "device_path", "Rate": rate}]
15
+ # ```
16
+ #
17
+ # @return [Array<DockerEngineAPI::Models::ContainerUpdateParams::BlkioDeviceReadBp>, nil]
18
+ optional :blkio_device_read_bps,
19
+ -> {
20
+ DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::ContainerUpdateParams::BlkioDeviceReadBp]
21
+ },
22
+ api_name: :BlkioDeviceReadBps
23
+
24
+ # @!attribute blkio_device_read_i_ops
25
+ # Limit read rate (IO per second) from a device, in the form:
26
+ #
27
+ # ```
28
+ # [{"Path": "device_path", "Rate": rate}]
29
+ # ```
30
+ #
31
+ # @return [Array<DockerEngineAPI::Models::ContainerUpdateParams::BlkioDeviceReadIOp>, nil]
32
+ optional :blkio_device_read_i_ops,
33
+ -> {
34
+ DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::ContainerUpdateParams::BlkioDeviceReadIOp]
35
+ },
36
+ api_name: :BlkioDeviceReadIOps
37
+
38
+ # @!attribute blkio_device_write_bps
39
+ # Limit write rate (bytes per second) to a device, in the form:
40
+ #
41
+ # ```
42
+ # [{"Path": "device_path", "Rate": rate}]
43
+ # ```
44
+ #
45
+ # @return [Array<DockerEngineAPI::Models::ContainerUpdateParams::BlkioDeviceWriteBp>, nil]
46
+ optional :blkio_device_write_bps,
47
+ -> {
48
+ DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::ContainerUpdateParams::BlkioDeviceWriteBp]
49
+ },
50
+ api_name: :BlkioDeviceWriteBps
51
+
52
+ # @!attribute blkio_device_write_i_ops
53
+ # Limit write rate (IO per second) to a device, in the form:
54
+ #
55
+ # ```
56
+ # [{"Path": "device_path", "Rate": rate}]
57
+ # ```
58
+ #
59
+ # @return [Array<DockerEngineAPI::Models::ContainerUpdateParams::BlkioDeviceWriteIOp>, nil]
60
+ optional :blkio_device_write_i_ops,
61
+ -> {
62
+ DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::ContainerUpdateParams::BlkioDeviceWriteIOp]
63
+ },
64
+ api_name: :BlkioDeviceWriteIOps
65
+
66
+ # @!attribute blkio_weight
67
+ # Block IO weight (relative weight).
68
+ #
69
+ # @return [Integer, nil]
70
+ optional :blkio_weight, Integer, api_name: :BlkioWeight
71
+
72
+ # @!attribute blkio_weight_device
73
+ # Block IO weight (relative device weight) in the form:
74
+ #
75
+ # ```
76
+ # [{"Path": "device_path", "Weight": weight}]
77
+ # ```
78
+ #
79
+ # @return [Array<DockerEngineAPI::Models::ContainerUpdateParams::BlkioWeightDevice>, nil]
80
+ optional :blkio_weight_device,
81
+ -> {
82
+ DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::ContainerUpdateParams::BlkioWeightDevice]
83
+ },
84
+ api_name: :BlkioWeightDevice
85
+
86
+ # @!attribute cgroup_parent
87
+ # Path to `cgroups` under which the container's `cgroup` is created. If the path
88
+ # is not absolute, the path is considered to be relative to the `cgroups` path of
89
+ # the init process. Cgroups are created if they do not already exist.
90
+ #
91
+ # @return [String, nil]
92
+ optional :cgroup_parent, String, api_name: :CgroupParent
93
+
94
+ # @!attribute cpu_count
95
+ # The number of usable CPUs (Windows only).
96
+ #
97
+ # On Windows Server containers, the processor resource controls are mutually
98
+ # exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and
99
+ # `CPUPercent` last.
100
+ #
101
+ # @return [Integer, nil]
102
+ optional :cpu_count, Integer, api_name: :CpuCount
103
+
104
+ # @!attribute cpu_percent
105
+ # The usable percentage of the available CPUs (Windows only).
106
+ #
107
+ # On Windows Server containers, the processor resource controls are mutually
108
+ # exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and
109
+ # `CPUPercent` last.
110
+ #
111
+ # @return [Integer, nil]
112
+ optional :cpu_percent, Integer, api_name: :CpuPercent
113
+
114
+ # @!attribute cpu_period
115
+ # The length of a CPU period in microseconds.
116
+ #
117
+ # @return [Integer, nil]
118
+ optional :cpu_period, Integer, api_name: :CpuPeriod
119
+
120
+ # @!attribute cpu_quota
121
+ # Microseconds of CPU time that the container can get in a CPU period.
122
+ #
123
+ # @return [Integer, nil]
124
+ optional :cpu_quota, Integer, api_name: :CpuQuota
125
+
126
+ # @!attribute cpu_realtime_period
127
+ # The length of a CPU real-time period in microseconds. Set to 0 to allocate no
128
+ # time allocated to real-time tasks.
129
+ #
130
+ # @return [Integer, nil]
131
+ optional :cpu_realtime_period, Integer, api_name: :CpuRealtimePeriod
132
+
133
+ # @!attribute cpu_realtime_runtime
134
+ # The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no
135
+ # time allocated to real-time tasks.
136
+ #
137
+ # @return [Integer, nil]
138
+ optional :cpu_realtime_runtime, Integer, api_name: :CpuRealtimeRuntime
139
+
140
+ # @!attribute cpuset_cpus
141
+ # CPUs in which to allow execution (e.g., `0-3`, `0,1`).
142
+ #
143
+ # @return [String, nil]
144
+ optional :cpuset_cpus, String, api_name: :CpusetCpus
145
+
146
+ # @!attribute cpuset_mems
147
+ # Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on
148
+ # NUMA systems.
149
+ #
150
+ # @return [String, nil]
151
+ optional :cpuset_mems, String, api_name: :CpusetMems
152
+
153
+ # @!attribute cpu_shares
154
+ # An integer value representing this container's relative CPU weight versus other
155
+ # containers.
156
+ #
157
+ # @return [Integer, nil]
158
+ optional :cpu_shares, Integer, api_name: :CpuShares
159
+
160
+ # @!attribute device_cgroup_rules
161
+ # a list of cgroup rules to apply to the container
162
+ #
163
+ # @return [Array<String>, nil]
164
+ optional :device_cgroup_rules,
165
+ DockerEngineAPI::Internal::Type::ArrayOf[String],
166
+ api_name: :DeviceCgroupRules
167
+
168
+ # @!attribute device_requests
169
+ # A list of requests for devices to be sent to device drivers.
170
+ #
171
+ # @return [Array<DockerEngineAPI::Models::ContainerUpdateParams::DeviceRequest>, nil]
172
+ optional :device_requests,
173
+ -> {
174
+ DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::ContainerUpdateParams::DeviceRequest]
175
+ },
176
+ api_name: :DeviceRequests
177
+
178
+ # @!attribute devices
179
+ # A list of devices to add to the container.
180
+ #
181
+ # @return [Array<DockerEngineAPI::Models::ContainerUpdateParams::Device>, nil]
182
+ optional :devices,
183
+ -> {
184
+ DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::ContainerUpdateParams::Device]
185
+ },
186
+ api_name: :Devices
187
+
188
+ # @!attribute init
189
+ # Run an init inside the container that forwards signals and reaps processes. This
190
+ # field is omitted if empty, and the default (as configured on the daemon) is
191
+ # used.
192
+ #
193
+ # @return [Boolean, nil]
194
+ optional :init, DockerEngineAPI::Internal::Type::Boolean, api_name: :Init, nil?: true
195
+
196
+ # @!attribute io_maximum_bandwidth
197
+ # Maximum IO in bytes per second for the container system drive (Windows only).
198
+ #
199
+ # @return [Integer, nil]
200
+ optional :io_maximum_bandwidth, Integer, api_name: :IOMaximumBandwidth
201
+
202
+ # @!attribute io_maximum_i_ops
203
+ # Maximum IOps for the container system drive (Windows only)
204
+ #
205
+ # @return [Integer, nil]
206
+ optional :io_maximum_i_ops, Integer, api_name: :IOMaximumIOps
207
+
208
+ # @!attribute memory
209
+ # Memory limit in bytes.
210
+ #
211
+ # @return [Integer, nil]
212
+ optional :memory, Integer, api_name: :Memory
213
+
214
+ # @!attribute memory_reservation
215
+ # Memory soft limit in bytes.
216
+ #
217
+ # @return [Integer, nil]
218
+ optional :memory_reservation, Integer, api_name: :MemoryReservation
219
+
220
+ # @!attribute memory_swap
221
+ # Total memory limit (memory + swap). Set as `-1` to enable unlimited swap.
222
+ #
223
+ # @return [Integer, nil]
224
+ optional :memory_swap, Integer, api_name: :MemorySwap
225
+
226
+ # @!attribute memory_swappiness
227
+ # Tune a container's memory swappiness behavior. Accepts an integer between 0
228
+ # and 100.
229
+ #
230
+ # @return [Integer, nil]
231
+ optional :memory_swappiness, Integer, api_name: :MemorySwappiness
232
+
233
+ # @!attribute nano_cpus
234
+ # CPU quota in units of 10<sup>-9</sup> CPUs.
235
+ #
236
+ # @return [Integer, nil]
237
+ optional :nano_cpus, Integer, api_name: :NanoCpus
238
+
239
+ # @!attribute oom_kill_disable
240
+ # Disable OOM Killer for the container.
241
+ #
242
+ # @return [Boolean, nil]
243
+ optional :oom_kill_disable, DockerEngineAPI::Internal::Type::Boolean, api_name: :OomKillDisable
244
+
245
+ # @!attribute pids_limit
246
+ # Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not
247
+ # change.
248
+ #
249
+ # @return [Integer, nil]
250
+ optional :pids_limit, Integer, api_name: :PidsLimit, nil?: true
251
+
252
+ # @!attribute restart_policy
253
+ # The behavior to apply when the container exits. The default is not to restart.
254
+ #
255
+ # An ever increasing delay (double the previous delay, starting at 100ms) is added
256
+ # before each restart to prevent flooding the server.
257
+ #
258
+ # @return [DockerEngineAPI::Models::ContainerUpdateParams::RestartPolicy, nil]
259
+ optional :restart_policy,
260
+ -> { DockerEngineAPI::ContainerUpdateParams::RestartPolicy },
261
+ api_name: :RestartPolicy
262
+
263
+ # @!attribute ulimits
264
+ # A list of resource limits to set in the container. For example:
265
+ #
266
+ # ```
267
+ # {"Name": "nofile", "Soft": 1024, "Hard": 2048}
268
+ # ```
269
+ #
270
+ # @return [Array<DockerEngineAPI::Models::ContainerUpdateParams::Ulimit>, nil]
271
+ optional :ulimits,
272
+ -> {
273
+ DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::ContainerUpdateParams::Ulimit]
274
+ },
275
+ api_name: :Ulimits
276
+
277
+ # @!method initialize(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, cgroup_parent: 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, init: nil, io_maximum_bandwidth: nil, io_maximum_i_ops: nil, memory: nil, memory_reservation: nil, memory_swap: nil, memory_swappiness: nil, nano_cpus: nil, oom_kill_disable: nil, pids_limit: nil, restart_policy: nil, ulimits: nil, request_options: {})
278
+ # Some parameter documentations has been truncated, see
279
+ # {DockerEngineAPI::Models::ContainerUpdateParams} for more details.
280
+ #
281
+ # @param blkio_device_read_bps [Array<DockerEngineAPI::Models::ContainerUpdateParams::BlkioDeviceReadBp>] Limit read rate (bytes per second) from a device, in the form:
282
+ #
283
+ # @param blkio_device_read_i_ops [Array<DockerEngineAPI::Models::ContainerUpdateParams::BlkioDeviceReadIOp>] Limit read rate (IO per second) from a device, in the form:
284
+ #
285
+ # @param blkio_device_write_bps [Array<DockerEngineAPI::Models::ContainerUpdateParams::BlkioDeviceWriteBp>] Limit write rate (bytes per second) to a device, in the form:
286
+ #
287
+ # @param blkio_device_write_i_ops [Array<DockerEngineAPI::Models::ContainerUpdateParams::BlkioDeviceWriteIOp>] Limit write rate (IO per second) to a device, in the form:
288
+ #
289
+ # @param blkio_weight [Integer] Block IO weight (relative weight).
290
+ #
291
+ # @param blkio_weight_device [Array<DockerEngineAPI::Models::ContainerUpdateParams::BlkioWeightDevice>] Block IO weight (relative device weight) in the form:
292
+ #
293
+ # @param cgroup_parent [String] Path to `cgroups` under which the container's `cgroup` is created. If
294
+ #
295
+ # @param cpu_count [Integer] The number of usable CPUs (Windows only).
296
+ #
297
+ # @param cpu_percent [Integer] The usable percentage of the available CPUs (Windows only).
298
+ #
299
+ # @param cpu_period [Integer] The length of a CPU period in microseconds.
300
+ #
301
+ # @param cpu_quota [Integer] Microseconds of CPU time that the container can get in a CPU period.
302
+ #
303
+ # @param cpu_realtime_period [Integer] The length of a CPU real-time period in microseconds. Set to 0 to
304
+ #
305
+ # @param cpu_realtime_runtime [Integer] The length of a CPU real-time runtime in microseconds. Set to 0 to
306
+ #
307
+ # @param cpuset_cpus [String] CPUs in which to allow execution (e.g., `0-3`, `0,1`).
308
+ #
309
+ # @param cpuset_mems [String] Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only
310
+ #
311
+ # @param cpu_shares [Integer] An integer value representing this container's relative CPU weight
312
+ #
313
+ # @param device_cgroup_rules [Array<String>] a list of cgroup rules to apply to the container
314
+ #
315
+ # @param device_requests [Array<DockerEngineAPI::Models::ContainerUpdateParams::DeviceRequest>] A list of requests for devices to be sent to device drivers.
316
+ #
317
+ # @param devices [Array<DockerEngineAPI::Models::ContainerUpdateParams::Device>] A list of devices to add to the container.
318
+ #
319
+ # @param init [Boolean, nil] Run an init inside the container that forwards signals and reaps
320
+ #
321
+ # @param io_maximum_bandwidth [Integer] Maximum IO in bytes per second for the container system drive
322
+ #
323
+ # @param io_maximum_i_ops [Integer] Maximum IOps for the container system drive (Windows only)
324
+ #
325
+ # @param memory [Integer] Memory limit in bytes.
326
+ #
327
+ # @param memory_reservation [Integer] Memory soft limit in bytes.
328
+ #
329
+ # @param memory_swap [Integer] Total memory limit (memory + swap). Set as `-1` to enable unlimited
330
+ #
331
+ # @param memory_swappiness [Integer] Tune a container's memory swappiness behavior. Accepts an integer
332
+ #
333
+ # @param nano_cpus [Integer] CPU quota in units of 10<sup>-9</sup> CPUs.
334
+ #
335
+ # @param oom_kill_disable [Boolean] Disable OOM Killer for the container.
336
+ #
337
+ # @param pids_limit [Integer, nil] Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null`
338
+ #
339
+ # @param restart_policy [DockerEngineAPI::Models::ContainerUpdateParams::RestartPolicy] The behavior to apply when the container exits. The default is not to
340
+ #
341
+ # @param ulimits [Array<DockerEngineAPI::Models::ContainerUpdateParams::Ulimit>] A list of resource limits to set in the container. For example:
342
+ #
343
+ # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
344
+
345
+ class BlkioDeviceReadBp < DockerEngineAPI::Internal::Type::BaseModel
346
+ # @!attribute path
347
+ # Device path
348
+ #
349
+ # @return [String, nil]
350
+ optional :path, String, api_name: :Path
351
+
352
+ # @!attribute rate
353
+ # Rate
354
+ #
355
+ # @return [Integer, nil]
356
+ optional :rate, Integer, api_name: :Rate
357
+
358
+ # @!method initialize(path: nil, rate: nil)
359
+ # @param path [String] Device path
360
+ #
361
+ # @param rate [Integer] Rate
362
+ end
363
+
364
+ class BlkioDeviceReadIOp < DockerEngineAPI::Internal::Type::BaseModel
365
+ # @!attribute path
366
+ # Device path
367
+ #
368
+ # @return [String, nil]
369
+ optional :path, String, api_name: :Path
370
+
371
+ # @!attribute rate
372
+ # Rate
373
+ #
374
+ # @return [Integer, nil]
375
+ optional :rate, Integer, api_name: :Rate
376
+
377
+ # @!method initialize(path: nil, rate: nil)
378
+ # @param path [String] Device path
379
+ #
380
+ # @param rate [Integer] Rate
381
+ end
382
+
383
+ class BlkioDeviceWriteBp < DockerEngineAPI::Internal::Type::BaseModel
384
+ # @!attribute path
385
+ # Device path
386
+ #
387
+ # @return [String, nil]
388
+ optional :path, String, api_name: :Path
389
+
390
+ # @!attribute rate
391
+ # Rate
392
+ #
393
+ # @return [Integer, nil]
394
+ optional :rate, Integer, api_name: :Rate
395
+
396
+ # @!method initialize(path: nil, rate: nil)
397
+ # @param path [String] Device path
398
+ #
399
+ # @param rate [Integer] Rate
400
+ end
401
+
402
+ class BlkioDeviceWriteIOp < DockerEngineAPI::Internal::Type::BaseModel
403
+ # @!attribute path
404
+ # Device path
405
+ #
406
+ # @return [String, nil]
407
+ optional :path, String, api_name: :Path
408
+
409
+ # @!attribute rate
410
+ # Rate
411
+ #
412
+ # @return [Integer, nil]
413
+ optional :rate, Integer, api_name: :Rate
414
+
415
+ # @!method initialize(path: nil, rate: nil)
416
+ # @param path [String] Device path
417
+ #
418
+ # @param rate [Integer] Rate
419
+ end
420
+
421
+ class BlkioWeightDevice < DockerEngineAPI::Internal::Type::BaseModel
422
+ # @!attribute path
423
+ #
424
+ # @return [String, nil]
425
+ optional :path, String, api_name: :Path
426
+
427
+ # @!attribute weight
428
+ #
429
+ # @return [Integer, nil]
430
+ optional :weight, Integer, api_name: :Weight
431
+
432
+ # @!method initialize(path: nil, weight: nil)
433
+ # @param path [String]
434
+ # @param weight [Integer]
435
+ end
436
+
437
+ class DeviceRequest < DockerEngineAPI::Internal::Type::BaseModel
438
+ # @!attribute capabilities
439
+ # A list of capabilities; an OR list of AND lists of capabilities.
440
+ #
441
+ # Note that if a driver is specified the capabilities have no effect on selecting
442
+ # a driver as the driver name is used directly.
443
+ #
444
+ # Note that if no driver is specified the capabilities are used to select a driver
445
+ # with the required capabilities.
446
+ #
447
+ # @return [Array<Array<String>>, nil]
448
+ optional :capabilities,
449
+ DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Internal::Type::ArrayOf[String]],
450
+ api_name: :Capabilities
451
+
452
+ # @!attribute count
453
+ #
454
+ # @return [Integer, nil]
455
+ optional :count, Integer, api_name: :Count
456
+
457
+ # @!attribute device_ids
458
+ #
459
+ # @return [Array<String>, nil]
460
+ optional :device_ids, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :DeviceIDs
461
+
462
+ # @!attribute driver
463
+ # The name of the device driver to use for this request.
464
+ #
465
+ # Note that if this is specified the capabilities are ignored when selecting a
466
+ # device driver.
467
+ #
468
+ # @return [String, nil]
469
+ optional :driver, String, api_name: :Driver
470
+
471
+ # @!attribute options
472
+ # Driver-specific options, specified as a key/value pairs. These options are
473
+ # passed directly to the driver.
474
+ #
475
+ # @return [Hash{Symbol=>String}, nil]
476
+ optional :options, DockerEngineAPI::Internal::Type::HashOf[String], api_name: :Options
477
+
478
+ # @!method initialize(capabilities: nil, count: nil, device_ids: nil, driver: nil, options: nil)
479
+ # Some parameter documentations has been truncated, see
480
+ # {DockerEngineAPI::Models::ContainerUpdateParams::DeviceRequest} for more
481
+ # details.
482
+ #
483
+ # A request for devices to be sent to device drivers
484
+ #
485
+ # @param capabilities [Array<Array<String>>] A list of capabilities; an OR list of AND lists of capabilities.
486
+ #
487
+ # @param count [Integer]
488
+ #
489
+ # @param device_ids [Array<String>]
490
+ #
491
+ # @param driver [String] The name of the device driver to use for this request.
492
+ #
493
+ # @param options [Hash{Symbol=>String}] Driver-specific options, specified as a key/value pairs. These options
494
+ end
495
+
496
+ class Device < DockerEngineAPI::Internal::Type::BaseModel
497
+ # @!attribute cgroup_permissions
498
+ #
499
+ # @return [String, nil]
500
+ optional :cgroup_permissions, String, api_name: :CgroupPermissions
501
+
502
+ # @!attribute path_in_container
503
+ #
504
+ # @return [String, nil]
505
+ optional :path_in_container, String, api_name: :PathInContainer
506
+
507
+ # @!attribute path_on_host
508
+ #
509
+ # @return [String, nil]
510
+ optional :path_on_host, String, api_name: :PathOnHost
511
+
512
+ # @!method initialize(cgroup_permissions: nil, path_in_container: nil, path_on_host: nil)
513
+ # A device mapping between the host and container
514
+ #
515
+ # @param cgroup_permissions [String]
516
+ # @param path_in_container [String]
517
+ # @param path_on_host [String]
518
+ end
519
+
520
+ class RestartPolicy < DockerEngineAPI::Internal::Type::BaseModel
521
+ # @!attribute maximum_retry_count
522
+ # If `on-failure` is used, the number of times to retry before giving up.
523
+ #
524
+ # @return [Integer, nil]
525
+ optional :maximum_retry_count, Integer, api_name: :MaximumRetryCount
526
+
527
+ # @!attribute name
528
+ # - Empty string means not to restart
529
+ # - `no` Do not automatically restart
530
+ # - `always` Always restart
531
+ # - `unless-stopped` Restart always except when the user has manually stopped the
532
+ # container
533
+ # - `on-failure` Restart only when the container exit code is non-zero
534
+ #
535
+ # @return [Symbol, DockerEngineAPI::Models::ContainerUpdateParams::RestartPolicy::Name, nil]
536
+ optional :name,
537
+ enum: -> {
538
+ DockerEngineAPI::ContainerUpdateParams::RestartPolicy::Name
539
+ },
540
+ api_name: :Name
541
+
542
+ # @!method initialize(maximum_retry_count: nil, name: nil)
543
+ # Some parameter documentations has been truncated, see
544
+ # {DockerEngineAPI::Models::ContainerUpdateParams::RestartPolicy} for more
545
+ # details.
546
+ #
547
+ # The behavior to apply when the container exits. The default is not to restart.
548
+ #
549
+ # An ever increasing delay (double the previous delay, starting at 100ms) is added
550
+ # before each restart to prevent flooding the server.
551
+ #
552
+ # @param maximum_retry_count [Integer] If `on-failure` is used, the number of times to retry before giving up.
553
+ #
554
+ # @param name [Symbol, DockerEngineAPI::Models::ContainerUpdateParams::RestartPolicy::Name] - Empty string means not to restart
555
+
556
+ # - Empty string means not to restart
557
+ # - `no` Do not automatically restart
558
+ # - `always` Always restart
559
+ # - `unless-stopped` Restart always except when the user has manually stopped the
560
+ # container
561
+ # - `on-failure` Restart only when the container exit code is non-zero
562
+ #
563
+ # @see DockerEngineAPI::Models::ContainerUpdateParams::RestartPolicy#name
564
+ module Name
565
+ extend DockerEngineAPI::Internal::Type::Enum
566
+
567
+ EMPTY = :""
568
+ NO = :no
569
+ ALWAYS = :always
570
+ UNLESS_STOPPED = :"unless-stopped"
571
+ ON_FAILURE = :"on-failure"
572
+
573
+ # @!method self.values
574
+ # @return [Array<Symbol>]
575
+ end
576
+ end
577
+
578
+ class Ulimit < DockerEngineAPI::Internal::Type::BaseModel
579
+ # @!attribute hard
580
+ # Hard limit
581
+ #
582
+ # @return [Integer, nil]
583
+ optional :hard, Integer, api_name: :Hard
584
+
585
+ # @!attribute name
586
+ # Name of ulimit
587
+ #
588
+ # @return [String, nil]
589
+ optional :name, String, api_name: :Name
590
+
591
+ # @!attribute soft
592
+ # Soft limit
593
+ #
594
+ # @return [Integer, nil]
595
+ optional :soft, Integer, api_name: :Soft
596
+
597
+ # @!method initialize(hard: nil, name: nil, soft: nil)
598
+ # @param hard [Integer] Hard limit
599
+ #
600
+ # @param name [String] Name of ulimit
601
+ #
602
+ # @param soft [Integer] Soft limit
603
+ end
604
+ end
605
+ end
606
+ end
@@ -0,0 +1,41 @@
1
+ # frozen_string_literal: true
2
+
3
+ module DockerEngineAPI
4
+ module Models
5
+ # @see DockerEngineAPI::Resources::Containers#wait
6
+ class ContainerWaitParams < DockerEngineAPI::Internal::Type::BaseModel
7
+ extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
8
+ include DockerEngineAPI::Internal::Type::RequestParameters
9
+
10
+ # @!attribute condition
11
+ # Wait until a container state reaches the given condition.
12
+ #
13
+ # Defaults to `not-running` if omitted or empty.
14
+ #
15
+ # @return [Symbol, DockerEngineAPI::Models::ContainerWaitParams::Condition, nil]
16
+ optional :condition, enum: -> { DockerEngineAPI::ContainerWaitParams::Condition }
17
+
18
+ # @!method initialize(condition: nil, request_options: {})
19
+ # Some parameter documentations has been truncated, see
20
+ # {DockerEngineAPI::Models::ContainerWaitParams} for more details.
21
+ #
22
+ # @param condition [Symbol, DockerEngineAPI::Models::ContainerWaitParams::Condition] Wait until a container state reaches the given condition.
23
+ #
24
+ # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
25
+
26
+ # Wait until a container state reaches the given condition.
27
+ #
28
+ # Defaults to `not-running` if omitted or empty.
29
+ module Condition
30
+ extend DockerEngineAPI::Internal::Type::Enum
31
+
32
+ NOT_RUNNING = :"not-running"
33
+ NEXT_EXIT = :"next-exit"
34
+ REMOVED = :removed
35
+
36
+ # @!method self.values
37
+ # @return [Array<Symbol>]
38
+ end
39
+ end
40
+ end
41
+ end