docker-engine-ruby 0.2.2 → 0.4.0

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 (338) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +16 -0
  3. data/README.md +1 -1
  4. data/lib/docker_engine_ruby/models/config.rb +6 -6
  5. data/lib/docker_engine_ruby/models/config_create_params.rb +1 -11
  6. data/lib/docker_engine_ruby/models/config_list_params.rb +1 -14
  7. data/lib/docker_engine_ruby/models/config_list_response.rb +1 -1
  8. data/lib/docker_engine_ruby/models/config_object.rb +77 -0
  9. data/lib/docker_engine_ruby/models/config_spec.rb +68 -0
  10. data/lib/docker_engine_ruby/models/config_update_params.rb +1 -7
  11. data/lib/docker_engine_ruby/models/connect_request.rb +5 -5
  12. data/lib/docker_engine_ruby/models/container.rb +61 -143
  13. data/lib/docker_engine_ruby/models/container_archive_params.rb +1 -3
  14. data/lib/docker_engine_ruby/models/container_attach_params.rb +6 -29
  15. data/lib/docker_engine_ruby/models/container_create_params.rb +3 -1701
  16. data/lib/docker_engine_ruby/models/container_delete_params.rb +3 -9
  17. data/lib/docker_engine_ruby/models/container_exec_params.rb +11 -39
  18. data/lib/docker_engine_ruby/models/container_inspect_params.rb +1 -3
  19. data/lib/docker_engine_ruby/models/container_kill_params.rb +1 -6
  20. data/lib/docker_engine_ruby/models/container_list_params.rb +4 -36
  21. data/lib/docker_engine_ruby/models/container_logs_params.rb +7 -25
  22. data/lib/docker_engine_ruby/models/container_prune_params.rb +1 -16
  23. data/lib/docker_engine_ruby/models/container_prune_response.rb +2 -5
  24. data/lib/docker_engine_ruby/models/container_rename_params.rb +1 -3
  25. data/lib/docker_engine_ruby/models/container_resize_params.rb +2 -6
  26. data/lib/docker_engine_ruby/models/container_restart_params.rb +2 -9
  27. data/lib/docker_engine_ruby/models/container_start_params.rb +1 -8
  28. data/lib/docker_engine_ruby/models/container_stats_params.rb +2 -11
  29. data/lib/docker_engine_ruby/models/container_stop_params.rb +2 -9
  30. data/lib/docker_engine_ruby/models/container_top_params.rb +1 -3
  31. data/lib/docker_engine_ruby/models/container_update_params.rb +4 -80
  32. data/lib/docker_engine_ruby/models/container_wait_params.rb +1 -11
  33. data/lib/docker_engine_ruby/models/create_request.rb +17 -121
  34. data/lib/docker_engine_ruby/models/exec_inspect_response.rb +1 -12
  35. data/lib/docker_engine_ruby/models/exec_resize_params.rb +2 -6
  36. data/lib/docker_engine_ruby/models/exec_start_params.rb +3 -9
  37. data/lib/docker_engine_ruby/models/filesystem_change.rb +3 -3
  38. data/lib/docker_engine_ruby/models/image.rb +33 -66
  39. data/lib/docker_engine_ruby/models/image_build_params.rb +25 -122
  40. data/lib/docker_engine_ruby/models/image_build_prune_params.rb +5 -32
  41. data/lib/docker_engine_ruby/models/image_build_prune_response.rb +1 -3
  42. data/lib/docker_engine_ruby/models/image_commit_params.rb +7 -21
  43. data/lib/docker_engine_ruby/models/image_delete_params.rb +3 -14
  44. data/lib/docker_engine_ruby/models/image_get_all_params.rb +2 -13
  45. data/lib/docker_engine_ruby/models/image_get_params.rb +1 -10
  46. data/lib/docker_engine_ruby/models/image_history_params.rb +1 -15
  47. data/lib/docker_engine_ruby/models/image_inspect_params.rb +1 -3
  48. data/lib/docker_engine_ruby/models/image_list_params.rb +5 -29
  49. data/lib/docker_engine_ruby/models/image_list_response.rb +1 -1
  50. data/lib/docker_engine_ruby/models/image_load_params.rb +2 -14
  51. data/lib/docker_engine_ruby/models/image_prune_params.rb +1 -16
  52. data/lib/docker_engine_ruby/models/image_prune_response.rb +2 -5
  53. data/lib/docker_engine_ruby/models/image_pull_params.rb +13 -60
  54. data/lib/docker_engine_ruby/models/image_push_params.rb +2 -19
  55. data/lib/docker_engine_ruby/models/image_search_params.rb +3 -16
  56. data/lib/docker_engine_ruby/models/image_search_response.rb +1 -13
  57. data/lib/docker_engine_ruby/models/image_summary.rb +638 -0
  58. data/lib/docker_engine_ruby/models/image_tag_params.rb +2 -6
  59. data/lib/docker_engine_ruby/models/info.rb +27 -56
  60. data/lib/docker_engine_ruby/models/inspect.rb +5 -7
  61. data/lib/docker_engine_ruby/models/list_response.rb +0 -3
  62. data/lib/docker_engine_ruby/models/network.rb +7 -4
  63. data/lib/docker_engine_ruby/models/network_create_params.rb +11 -26
  64. data/lib/docker_engine_ruby/models/network_create_response.rb +27 -0
  65. data/lib/docker_engine_ruby/models/network_inspect_params.rb +2 -6
  66. data/lib/docker_engine_ruby/models/network_inspect_response.rb +219 -89
  67. data/lib/docker_engine_ruby/models/network_list_params.rb +1 -21
  68. data/lib/docker_engine_ruby/models/network_list_response.rb +1 -1
  69. data/lib/docker_engine_ruby/models/network_prune_params.rb +1 -16
  70. data/lib/docker_engine_ruby/models/network_prune_response.rb +1 -2
  71. data/lib/docker_engine_ruby/models/network_summary.rb +260 -0
  72. data/lib/docker_engine_ruby/models/node.rb +12 -25
  73. data/lib/docker_engine_ruby/models/node_delete_params.rb +1 -3
  74. data/lib/docker_engine_ruby/models/node_list_params.rb +1 -15
  75. data/lib/docker_engine_ruby/models/node_spec.rb +67 -0
  76. data/lib/docker_engine_ruby/models/node_update_params.rb +1 -7
  77. data/lib/docker_engine_ruby/models/plugin.rb +2 -24
  78. data/lib/docker_engine_ruby/models/plugin_create_params.rb +1 -8
  79. data/lib/docker_engine_ruby/models/plugin_delete_params.rb +1 -7
  80. data/lib/docker_engine_ruby/models/plugin_disable_params.rb +1 -6
  81. data/lib/docker_engine_ruby/models/plugin_enable_params.rb +1 -3
  82. data/lib/docker_engine_ruby/models/plugin_list_params.rb +1 -12
  83. data/lib/docker_engine_ruby/models/plugin_privileges_params.rb +1 -7
  84. data/lib/docker_engine_ruby/models/plugin_pull_params.rb +8 -21
  85. data/lib/docker_engine_ruby/models/plugin_set_params.rb +3 -3
  86. data/lib/docker_engine_ruby/models/plugin_upgrade_params.rb +4 -13
  87. data/lib/docker_engine_ruby/models/secret.rb +9 -9
  88. data/lib/docker_engine_ruby/models/secret_create_params.rb +1 -11
  89. data/lib/docker_engine_ruby/models/secret_list_params.rb +1 -14
  90. data/lib/docker_engine_ruby/models/secret_spec.rb +99 -0
  91. data/lib/docker_engine_ruby/models/secret_update_params.rb +1 -7
  92. data/lib/docker_engine_ruby/models/service.rb +21 -36
  93. data/lib/docker_engine_ruby/models/service_create_params.rb +1 -15
  94. data/lib/docker_engine_ruby/models/service_create_response.rb +32 -0
  95. data/lib/docker_engine_ruby/models/service_inspect_params.rb +1 -3
  96. data/lib/docker_engine_ruby/models/service_list_params.rb +2 -17
  97. data/lib/docker_engine_ruby/models/service_logs_params.rb +7 -25
  98. data/lib/docker_engine_ruby/models/{spec.rb → service_spec.rb} +93 -158
  99. data/lib/docker_engine_ruby/models/service_update_params.rb +4 -34
  100. data/lib/docker_engine_ruby/models/service_update_response.rb +17 -0
  101. data/lib/docker_engine_ruby/models/stats_response.rb +143 -68
  102. data/lib/docker_engine_ruby/models/summary.rb +12 -32
  103. data/lib/docker_engine_ruby/models/swarm.rb +9 -12
  104. data/lib/docker_engine_ruby/models/swarm_init_params.rb +10 -38
  105. data/lib/docker_engine_ruby/models/swarm_join_params.rb +5 -31
  106. data/lib/docker_engine_ruby/models/swarm_leave_params.rb +1 -7
  107. data/lib/docker_engine_ruby/models/swarm_spec.rb +270 -0
  108. data/lib/docker_engine_ruby/models/swarm_unlock_key_response.rb +1 -2
  109. data/lib/docker_engine_ruby/models/swarm_unlock_params.rb +1 -3
  110. data/lib/docker_engine_ruby/models/swarm_update_params.rb +4 -16
  111. data/lib/docker_engine_ruby/models/system_data_usage_params.rb +43 -16
  112. data/lib/docker_engine_ruby/models/system_data_usage_response.rb +0 -19
  113. data/lib/docker_engine_ruby/models/system_events_params.rb +3 -29
  114. data/lib/docker_engine_ruby/models/system_events_response.rb +0 -3
  115. data/lib/docker_engine_ruby/models/task.rb +13 -15
  116. data/lib/docker_engine_ruby/models/task_list_params.rb +1 -16
  117. data/lib/docker_engine_ruby/models/task_logs_params.rb +7 -25
  118. data/lib/docker_engine_ruby/models/task_spec.rb +1439 -0
  119. data/lib/docker_engine_ruby/models/version.rb +8 -17
  120. data/lib/docker_engine_ruby/models/volume.rb +38 -194
  121. data/lib/docker_engine_ruby/models/volume_delete_params.rb +1 -3
  122. data/lib/docker_engine_ruby/models/volume_list_params.rb +1 -15
  123. data/lib/docker_engine_ruby/models/volume_prune_params.rb +1 -14
  124. data/lib/docker_engine_ruby/models/volume_prune_response.rb +2 -5
  125. data/lib/docker_engine_ruby/models/volume_update_params.rb +18 -127
  126. data/lib/docker_engine_ruby/models.rb +23 -1
  127. data/lib/docker_engine_ruby/resources/auth.rb +1 -2
  128. data/lib/docker_engine_ruby/resources/configs.rb +14 -23
  129. data/lib/docker_engine_ruby/resources/containers.rb +88 -337
  130. data/lib/docker_engine_ruby/resources/distribution.rb +2 -3
  131. data/lib/docker_engine_ruby/resources/exec.rb +11 -22
  132. data/lib/docker_engine_ruby/resources/images.rb +100 -230
  133. data/lib/docker_engine_ruby/resources/networks.rb +26 -45
  134. data/lib/docker_engine_ruby/resources/nodes.rb +8 -18
  135. data/lib/docker_engine_ruby/resources/plugins.rb +27 -74
  136. data/lib/docker_engine_ruby/resources/secrets.rb +10 -19
  137. data/lib/docker_engine_ruby/resources/services.rb +27 -56
  138. data/lib/docker_engine_ruby/resources/swarm.rb +28 -40
  139. data/lib/docker_engine_ruby/resources/system.rb +8 -49
  140. data/lib/docker_engine_ruby/resources/tasks.rb +12 -32
  141. data/lib/docker_engine_ruby/resources/volumes.rb +8 -22
  142. data/lib/docker_engine_ruby/version.rb +1 -1
  143. data/lib/docker_engine_ruby.rb +16 -5
  144. data/rbi/docker_engine_ruby/models/config.rbi +9 -7
  145. data/rbi/docker_engine_ruby/models/config_create_params.rbi +2 -34
  146. data/rbi/docker_engine_ruby/models/config_list_params.rbi +1 -22
  147. data/rbi/docker_engine_ruby/models/config_list_response.rbi +3 -1
  148. data/rbi/docker_engine_ruby/models/config_object.rbi +130 -0
  149. data/rbi/docker_engine_ruby/models/config_spec.rbi +127 -0
  150. data/rbi/docker_engine_ruby/models/config_update_params.rbi +1 -8
  151. data/rbi/docker_engine_ruby/models/connect_request.rbi +7 -12
  152. data/rbi/docker_engine_ruby/models/container.rbi +73 -194
  153. data/rbi/docker_engine_ruby/models/container_archive_params.rbi +1 -6
  154. data/rbi/docker_engine_ruby/models/container_attach_params.rbi +0 -28
  155. data/rbi/docker_engine_ruby/models/container_create_params.rbi +1 -3250
  156. data/rbi/docker_engine_ruby/models/container_delete_params.rbi +1 -12
  157. data/rbi/docker_engine_ruby/models/container_exec_params.rbi +0 -28
  158. data/rbi/docker_engine_ruby/models/container_inspect_params.rbi +1 -6
  159. data/rbi/docker_engine_ruby/models/container_kill_params.rbi +1 -6
  160. data/rbi/docker_engine_ruby/models/container_list_params.rbi +0 -50
  161. data/rbi/docker_engine_ruby/models/container_logs_params.rbi +0 -16
  162. data/rbi/docker_engine_ruby/models/container_prune_params.rbi +1 -26
  163. data/rbi/docker_engine_ruby/models/container_prune_response.rbi +1 -8
  164. data/rbi/docker_engine_ruby/models/container_rename_params.rbi +1 -6
  165. data/rbi/docker_engine_ruby/models/container_resize_params.rbi +1 -9
  166. data/rbi/docker_engine_ruby/models/container_restart_params.rbi +1 -9
  167. data/rbi/docker_engine_ruby/models/container_start_params.rbi +1 -10
  168. data/rbi/docker_engine_ruby/models/container_stats_params.rbi +1 -13
  169. data/rbi/docker_engine_ruby/models/container_stop_params.rbi +1 -9
  170. data/rbi/docker_engine_ruby/models/container_top_params.rbi +1 -6
  171. data/rbi/docker_engine_ruby/models/container_update_params.rbi +1 -170
  172. data/rbi/docker_engine_ruby/models/container_wait_params.rbi +1 -13
  173. data/rbi/docker_engine_ruby/models/create_request.rbi +7 -139
  174. data/rbi/docker_engine_ruby/models/exec_inspect_response.rbi +0 -2
  175. data/rbi/docker_engine_ruby/models/exec_resize_params.rbi +1 -9
  176. data/rbi/docker_engine_ruby/models/exec_start_params.rbi +0 -6
  177. data/rbi/docker_engine_ruby/models/filesystem_change.rbi +10 -13
  178. data/rbi/docker_engine_ruby/models/image.rbi +48 -106
  179. data/rbi/docker_engine_ruby/models/image_build_params.rbi +0 -127
  180. data/rbi/docker_engine_ruby/models/image_build_prune_params.rbi +0 -38
  181. data/rbi/docker_engine_ruby/models/image_build_prune_response.rbi +1 -6
  182. data/rbi/docker_engine_ruby/models/image_commit_params.rbi +0 -14
  183. data/rbi/docker_engine_ruby/models/image_delete_params.rbi +0 -10
  184. data/rbi/docker_engine_ruby/models/image_get_all_params.rbi +1 -17
  185. data/rbi/docker_engine_ruby/models/image_get_params.rbi +1 -14
  186. data/rbi/docker_engine_ruby/models/image_history_params.rbi +1 -24
  187. data/rbi/docker_engine_ruby/models/image_inspect_params.rbi +1 -6
  188. data/rbi/docker_engine_ruby/models/image_list_params.rbi +0 -32
  189. data/rbi/docker_engine_ruby/models/image_list_response.rbi +3 -1
  190. data/rbi/docker_engine_ruby/models/image_load_params.rbi +1 -18
  191. data/rbi/docker_engine_ruby/models/image_prune_params.rbi +1 -26
  192. data/rbi/docker_engine_ruby/models/image_prune_response.rbi +1 -8
  193. data/rbi/docker_engine_ruby/models/image_pull_params.rbi +6 -79
  194. data/rbi/docker_engine_ruby/models/image_push_params.rbi +0 -22
  195. data/rbi/docker_engine_ruby/models/image_search_params.rbi +1 -20
  196. data/rbi/docker_engine_ruby/models/image_search_response.rbi +0 -10
  197. data/rbi/docker_engine_ruby/models/image_summary.rbi +1073 -0
  198. data/rbi/docker_engine_ruby/models/image_tag_params.rbi +1 -9
  199. data/rbi/docker_engine_ruby/models/info.rbi +33 -80
  200. data/rbi/docker_engine_ruby/models/inspect.rbi +6 -12
  201. data/rbi/docker_engine_ruby/models/network.rbi +7 -4
  202. data/rbi/docker_engine_ruby/models/network_create_params.rbi +0 -30
  203. data/rbi/docker_engine_ruby/models/network_create_response.rbi +37 -0
  204. data/rbi/docker_engine_ruby/models/network_inspect_params.rbi +1 -9
  205. data/rbi/docker_engine_ruby/models/network_inspect_response.rbi +345 -198
  206. data/rbi/docker_engine_ruby/models/network_list_params.rbi +1 -36
  207. data/rbi/docker_engine_ruby/models/network_list_response.rbi +3 -1
  208. data/rbi/docker_engine_ruby/models/network_prune_params.rbi +1 -26
  209. data/rbi/docker_engine_ruby/models/network_prune_response.rbi +1 -5
  210. data/rbi/docker_engine_ruby/models/network_summary.rbi +444 -0
  211. data/rbi/docker_engine_ruby/models/node.rbi +15 -21
  212. data/rbi/docker_engine_ruby/models/node_delete_params.rbi +1 -6
  213. data/rbi/docker_engine_ruby/models/node_list_params.rbi +1 -24
  214. data/rbi/docker_engine_ruby/models/node_spec.rbi +126 -0
  215. data/rbi/docker_engine_ruby/models/node_update_params.rbi +1 -8
  216. data/rbi/docker_engine_ruby/models/plugin.rbi +1 -11
  217. data/rbi/docker_engine_ruby/models/plugin_create_params.rbi +1 -9
  218. data/rbi/docker_engine_ruby/models/plugin_delete_params.rbi +1 -8
  219. data/rbi/docker_engine_ruby/models/plugin_disable_params.rbi +1 -6
  220. data/rbi/docker_engine_ruby/models/plugin_enable_params.rbi +1 -6
  221. data/rbi/docker_engine_ruby/models/plugin_list_params.rbi +1 -18
  222. data/rbi/docker_engine_ruby/models/plugin_privileges_params.rbi +1 -8
  223. data/rbi/docker_engine_ruby/models/plugin_pull_params.rbi +6 -21
  224. data/rbi/docker_engine_ruby/models/plugin_set_params.rbi +3 -6
  225. data/rbi/docker_engine_ruby/models/plugin_upgrade_params.rbi +3 -17
  226. data/rbi/docker_engine_ruby/models/secret.rbi +12 -12
  227. data/rbi/docker_engine_ruby/models/secret_create_params.rbi +2 -34
  228. data/rbi/docker_engine_ruby/models/secret_list_params.rbi +1 -22
  229. data/rbi/docker_engine_ruby/models/secret_spec.rbi +181 -0
  230. data/rbi/docker_engine_ruby/models/secret_update_params.rbi +1 -8
  231. data/rbi/docker_engine_ruby/models/service.rbi +24 -44
  232. data/rbi/docker_engine_ruby/models/service_create_params.rbi +1 -36
  233. data/rbi/docker_engine_ruby/models/service_create_response.rbi +50 -0
  234. data/rbi/docker_engine_ruby/models/service_inspect_params.rbi +1 -6
  235. data/rbi/docker_engine_ruby/models/service_list_params.rbi +1 -25
  236. data/rbi/docker_engine_ruby/models/service_logs_params.rbi +0 -16
  237. data/rbi/docker_engine_ruby/models/{spec.rbi → service_spec.rbi} +157 -186
  238. data/rbi/docker_engine_ruby/models/service_update_params.rbi +0 -50
  239. data/rbi/docker_engine_ruby/models/service_update_response.rbi +33 -0
  240. data/rbi/docker_engine_ruby/models/stats_response.rbi +213 -141
  241. data/rbi/docker_engine_ruby/models/summary.rbi +16 -53
  242. data/rbi/docker_engine_ruby/models/swarm.rbi +12 -12
  243. data/rbi/docker_engine_ruby/models/swarm_init_params.rbi +4 -54
  244. data/rbi/docker_engine_ruby/models/swarm_join_params.rbi +0 -36
  245. data/rbi/docker_engine_ruby/models/swarm_leave_params.rbi +1 -8
  246. data/rbi/docker_engine_ruby/models/swarm_spec.rbi +568 -0
  247. data/rbi/docker_engine_ruby/models/swarm_unlock_key_response.rbi +1 -5
  248. data/rbi/docker_engine_ruby/models/swarm_unlock_params.rbi +1 -6
  249. data/rbi/docker_engine_ruby/models/swarm_update_params.rbi +0 -10
  250. data/rbi/docker_engine_ruby/models/system_data_usage_params.rbi +79 -27
  251. data/rbi/docker_engine_ruby/models/system_events_params.rbi +1 -46
  252. data/rbi/docker_engine_ruby/models/task.rbi +16 -20
  253. data/rbi/docker_engine_ruby/models/task_list_params.rbi +1 -26
  254. data/rbi/docker_engine_ruby/models/task_logs_params.rbi +0 -16
  255. data/rbi/docker_engine_ruby/models/task_spec.rbi +3011 -0
  256. data/rbi/docker_engine_ruby/models/version.rbi +8 -22
  257. data/rbi/docker_engine_ruby/models/volume.rbi +25 -225
  258. data/rbi/docker_engine_ruby/models/volume_delete_params.rbi +1 -6
  259. data/rbi/docker_engine_ruby/models/volume_list_params.rbi +1 -24
  260. data/rbi/docker_engine_ruby/models/volume_prune_params.rbi +1 -22
  261. data/rbi/docker_engine_ruby/models/volume_prune_response.rbi +1 -8
  262. data/rbi/docker_engine_ruby/models/volume_update_params.rbi +7 -143
  263. data/rbi/docker_engine_ruby/models.rbi +23 -1
  264. data/rbi/docker_engine_ruby/resources/auth.rbi +1 -2
  265. data/rbi/docker_engine_ruby/resources/configs.rbi +11 -32
  266. data/rbi/docker_engine_ruby/resources/containers.rbi +36 -388
  267. data/rbi/docker_engine_ruby/resources/distribution.rbi +2 -6
  268. data/rbi/docker_engine_ruby/resources/exec.rbi +5 -24
  269. data/rbi/docker_engine_ruby/resources/images.rbi +73 -366
  270. data/rbi/docker_engine_ruby/resources/networks.rbi +9 -78
  271. data/rbi/docker_engine_ruby/resources/nodes.rbi +7 -31
  272. data/rbi/docker_engine_ruby/resources/plugins.rbi +22 -91
  273. data/rbi/docker_engine_ruby/resources/secrets.rbi +9 -30
  274. data/rbi/docker_engine_ruby/resources/services.rbi +14 -62
  275. data/rbi/docker_engine_ruby/resources/swarm.rbi +8 -61
  276. data/rbi/docker_engine_ruby/resources/system.rbi +11 -66
  277. data/rbi/docker_engine_ruby/resources/tasks.rbi +3 -34
  278. data/rbi/docker_engine_ruby/resources/volumes.rbi +7 -43
  279. data/sig/docker_engine_ruby/models/config.rbs +11 -9
  280. data/sig/docker_engine_ruby/models/config_create_params.rbs +3 -24
  281. data/sig/docker_engine_ruby/models/config_list_response.rbs +1 -1
  282. data/sig/docker_engine_ruby/models/config_object.rbs +64 -0
  283. data/sig/docker_engine_ruby/models/config_spec.rbs +59 -0
  284. data/sig/docker_engine_ruby/models/connect_request.rbs +12 -12
  285. data/sig/docker_engine_ruby/models/container.rbs +62 -62
  286. data/sig/docker_engine_ruby/models/container_create_params.rbs +1 -1321
  287. data/sig/docker_engine_ruby/models/container_update_params.rbs +0 -51
  288. data/sig/docker_engine_ruby/models/create_request.rbs +5 -5
  289. data/sig/docker_engine_ruby/models/filesystem_change.rbs +1 -1
  290. data/sig/docker_engine_ruby/models/image.rbs +51 -53
  291. data/sig/docker_engine_ruby/models/image_list_response.rbs +1 -1
  292. data/sig/docker_engine_ruby/models/image_pull_params.rbs +5 -7
  293. data/sig/docker_engine_ruby/models/image_summary.rbs +457 -0
  294. data/sig/docker_engine_ruby/models/info.rbs +61 -41
  295. data/sig/docker_engine_ruby/models/inspect.rbs +12 -8
  296. data/sig/docker_engine_ruby/models/network.rbs +5 -5
  297. data/sig/docker_engine_ruby/models/network_create_response.rbs +15 -0
  298. data/sig/docker_engine_ruby/models/network_inspect_response.rbs +179 -90
  299. data/sig/docker_engine_ruby/models/network_list_response.rbs +1 -1
  300. data/sig/docker_engine_ruby/models/network_summary.rbs +238 -0
  301. data/sig/docker_engine_ruby/models/node.rbs +23 -19
  302. data/sig/docker_engine_ruby/models/node_spec.rbs +70 -0
  303. data/sig/docker_engine_ruby/models/plugin_pull_params.rbs +5 -9
  304. data/sig/docker_engine_ruby/models/plugin_set_params.rbs +2 -4
  305. data/sig/docker_engine_ruby/models/plugin_upgrade_params.rbs +2 -6
  306. data/sig/docker_engine_ruby/models/secret.rbs +15 -15
  307. data/sig/docker_engine_ruby/models/secret_create_params.rbs +3 -24
  308. data/sig/docker_engine_ruby/models/secret_spec.rbs +82 -0
  309. data/sig/docker_engine_ruby/models/service.rbs +32 -30
  310. data/sig/docker_engine_ruby/models/service_create_params.rbs +1 -16
  311. data/sig/docker_engine_ruby/models/service_create_response.rbs +17 -0
  312. data/sig/docker_engine_ruby/models/service_spec.rbs +471 -0
  313. data/sig/docker_engine_ruby/models/service_update_params.rbs +0 -13
  314. data/sig/docker_engine_ruby/models/service_update_response.rbs +15 -0
  315. data/sig/docker_engine_ruby/models/stats_response.rbs +188 -74
  316. data/sig/docker_engine_ruby/models/summary.rbs +20 -16
  317. data/sig/docker_engine_ruby/models/swarm.rbs +15 -15
  318. data/sig/docker_engine_ruby/models/swarm_init_params.rbs +5 -5
  319. data/sig/docker_engine_ruby/models/swarm_spec.rbs +293 -0
  320. data/sig/docker_engine_ruby/models/system_data_usage_params.rbs +25 -10
  321. data/sig/docker_engine_ruby/models/task.rbs +20 -20
  322. data/sig/docker_engine_ruby/models/task_spec.rbs +1480 -0
  323. data/sig/docker_engine_ruby/models/version.rbs +13 -4
  324. data/sig/docker_engine_ruby/models/volume.rbs +27 -25
  325. data/sig/docker_engine_ruby/models/volume_update_params.rbs +5 -5
  326. data/sig/docker_engine_ruby/models.rbs +23 -1
  327. data/sig/docker_engine_ruby/resources/configs.rbs +3 -3
  328. data/sig/docker_engine_ruby/resources/containers.rbs +1 -2
  329. data/sig/docker_engine_ruby/resources/images.rbs +3 -3
  330. data/sig/docker_engine_ruby/resources/networks.rbs +2 -2
  331. data/sig/docker_engine_ruby/resources/nodes.rbs +1 -1
  332. data/sig/docker_engine_ruby/resources/plugins.rbs +3 -3
  333. data/sig/docker_engine_ruby/resources/secrets.rbs +2 -2
  334. data/sig/docker_engine_ruby/resources/services.rbs +4 -4
  335. data/sig/docker_engine_ruby/resources/swarm.rbs +2 -2
  336. data/sig/docker_engine_ruby/resources/system.rbs +1 -1
  337. metadata +37 -4
  338. data/sig/docker_engine_ruby/models/spec.rbs +0 -467
@@ -117,36 +117,27 @@ module DockerEngineRuby
117
117
 
118
118
  class Component < DockerEngineRuby::Internal::Type::BaseModel
119
119
  # @!attribute name
120
- # Name of the component
121
120
  #
122
121
  # @return [String]
123
122
  required :name, String, api_name: :Name
124
123
 
125
124
  # @!attribute version
126
- # Version of the component
127
125
  #
128
126
  # @return [String]
129
127
  required :version, String, api_name: :Version
130
128
 
131
129
  # @!attribute details
132
- # Key/value pairs of strings with additional information about the component.
133
- # These values are intended for informational purposes only, and their content is
134
- # not defined, and not part of the API specification.
135
130
  #
136
- # These messages can be printed by the client as information to the user.
137
- #
138
- # @return [Object, nil]
139
- optional :details, DockerEngineRuby::Internal::Type::Unknown, api_name: :Details, nil?: true
131
+ # @return [Hash{Symbol=>Object}, nil]
132
+ optional :details,
133
+ DockerEngineRuby::Internal::Type::HashOf[DockerEngineRuby::Internal::Type::Unknown],
134
+ api_name: :Details,
135
+ nil?: true
140
136
 
141
137
  # @!method initialize(name:, version:, details: nil)
142
- # Some parameter documentations has been truncated, see
143
- # {DockerEngineRuby::Models::Version::Component} for more details.
144
- #
145
- # @param name [String] Name of the component
146
- #
147
- # @param version [String] Version of the component
148
- #
149
- # @param details [Object, nil] Key/value pairs of strings with additional information about the
138
+ # @param name [String]
139
+ # @param version [String]
140
+ # @param details [Hash{Symbol=>Object}, nil]
150
141
  end
151
142
 
152
143
  # @see DockerEngineRuby::Models::Version#platform
@@ -51,8 +51,8 @@ module DockerEngineRuby
51
51
  # @!attribute created_at
52
52
  # Date/Time the volume was created.
53
53
  #
54
- # @return [String, nil]
55
- optional :created_at, String, api_name: :CreatedAt
54
+ # @return [Time, nil]
55
+ optional :created_at, Time, api_name: :CreatedAt
56
56
 
57
57
  # @!attribute status
58
58
  # Low-level details about the volume, provided by the volume driver. Details are
@@ -61,9 +61,9 @@ module DockerEngineRuby
61
61
  # The `Status` field is optional, and is omitted if the volume driver does not
62
62
  # support this feature.
63
63
  #
64
- # @return [Hash{Symbol=>Object}, nil]
64
+ # @return [Hash{Symbol=>Hash{Symbol=>Object}}, nil]
65
65
  optional :status,
66
- DockerEngineRuby::Internal::Type::HashOf[DockerEngineRuby::Internal::Type::Unknown],
66
+ DockerEngineRuby::Internal::Type::HashOf[DockerEngineRuby::Internal::Type::HashOf[DockerEngineRuby::Internal::Type::Unknown]],
67
67
  api_name: :Status
68
68
 
69
69
  # @!attribute usage_data
@@ -91,9 +91,9 @@ module DockerEngineRuby
91
91
  #
92
92
  # @param cluster_volume [DockerEngineRuby::Models::Volume::ClusterVolume] Options and information specific to, and only present on, Swarm CSI
93
93
  #
94
- # @param created_at [String] Date/Time the volume was created.
94
+ # @param created_at [Time] Date/Time the volume was created.
95
95
  #
96
- # @param status [Hash{Symbol=>Object}] Low-level details about the volume, provided by the volume driver.
96
+ # @param status [Hash{Symbol=>Hash{Symbol=>Object}}] Low-level details about the volume, provided by the volume driver.
97
97
  #
98
98
  # @param usage_data [DockerEngineRuby::Models::Volume::UsageData, nil] Usage details about the volume. This information is used by the
99
99
 
@@ -115,8 +115,8 @@ module DockerEngineRuby
115
115
  class ClusterVolume < DockerEngineRuby::Internal::Type::BaseModel
116
116
  # @!attribute created_at
117
117
  #
118
- # @return [String, nil]
119
- optional :created_at, String, api_name: :CreatedAt
118
+ # @return [Time, nil]
119
+ optional :created_at, Time, api_name: :CreatedAt
120
120
 
121
121
  # @!attribute id
122
122
  # The Swarm ID of this volume. Because cluster volumes are Swarm objects, they
@@ -151,8 +151,8 @@ module DockerEngineRuby
151
151
 
152
152
  # @!attribute updated_at
153
153
  #
154
- # @return [String, nil]
155
- optional :updated_at, String, api_name: :UpdatedAt
154
+ # @return [Time, nil]
155
+ optional :updated_at, Time, api_name: :UpdatedAt
156
156
 
157
157
  # @!attribute version
158
158
  # The version number of the object such as node, service, etc. This is needed to
@@ -175,7 +175,7 @@ module DockerEngineRuby
175
175
  # Options and information specific to, and only present on, Swarm CSI cluster
176
176
  # volumes.
177
177
  #
178
- # @param created_at [String]
178
+ # @param created_at [Time]
179
179
  #
180
180
  # @param id [String] The Swarm ID of this volume. Because cluster volumes are Swarm
181
181
  #
@@ -185,14 +185,13 @@ module DockerEngineRuby
185
185
  #
186
186
  # @param spec [DockerEngineRuby::Models::Volume::ClusterVolume::Spec] Cluster-specific options used to create the volume.
187
187
  #
188
- # @param updated_at [String]
188
+ # @param updated_at [Time]
189
189
  #
190
190
  # @param version [DockerEngineRuby::Models::Volume::ClusterVolume::Version] The version number of the object such as node, service, etc. This is needed
191
191
 
192
192
  # @see DockerEngineRuby::Models::Volume::ClusterVolume#info
193
193
  class Info < DockerEngineRuby::Internal::Type::BaseModel
194
194
  # @!attribute accessible_topology
195
- # The topology this volume is actually accessible from.
196
195
  #
197
196
  # @return [Array<Hash{Symbol=>String}>, nil]
198
197
  optional :accessible_topology,
@@ -200,53 +199,36 @@ module DockerEngineRuby
200
199
  api_name: :AccessibleTopology
201
200
 
202
201
  # @!attribute capacity_bytes
203
- # The capacity of the volume in bytes. A value of 0 indicates that the capacity is
204
- # unknown.
205
202
  #
206
203
  # @return [Integer, nil]
207
204
  optional :capacity_bytes, Integer, api_name: :CapacityBytes
208
205
 
209
206
  # @!attribute volume_context
210
- # A map of strings to strings returned from the storage plugin when the volume is
211
- # created.
212
207
  #
213
208
  # @return [Hash{Symbol=>String}, nil]
214
209
  optional :volume_context, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :VolumeContext
215
210
 
216
211
  # @!attribute volume_id
217
- # The ID of the volume as returned by the CSI storage plugin. This is distinct
218
- # from the volume's ID as provided by Docker. This ID is never used by the user
219
- # when communicating with Docker to refer to this volume. If the ID is blank, then
220
- # the Volume has not been successfully created in the plugin yet.
221
212
  #
222
213
  # @return [String, nil]
223
214
  optional :volume_id, String, api_name: :VolumeID
224
215
 
225
216
  # @!method initialize(accessible_topology: nil, capacity_bytes: nil, volume_context: nil, volume_id: nil)
226
- # Some parameter documentations has been truncated, see
227
- # {DockerEngineRuby::Models::Volume::ClusterVolume::Info} for more details.
228
- #
229
217
  # Information about the global status of the volume.
230
218
  #
231
- # @param accessible_topology [Array<Hash{Symbol=>String}>] The topology this volume is actually accessible from.
232
- #
233
- # @param capacity_bytes [Integer] The capacity of the volume in bytes. A value of 0 indicates that
234
- #
235
- # @param volume_context [Hash{Symbol=>String}] A map of strings to strings returned from the storage plugin when
236
- #
237
- # @param volume_id [String] The ID of the volume as returned by the CSI storage plugin. This
219
+ # @param accessible_topology [Array<Hash{Symbol=>String}>]
220
+ # @param capacity_bytes [Integer]
221
+ # @param volume_context [Hash{Symbol=>String}]
222
+ # @param volume_id [String]
238
223
  end
239
224
 
240
225
  class PublishStatus < DockerEngineRuby::Internal::Type::BaseModel
241
226
  # @!attribute node_id
242
- # The ID of the Swarm node the volume is published on.
243
227
  #
244
228
  # @return [String, nil]
245
229
  optional :node_id, String, api_name: :NodeID
246
230
 
247
231
  # @!attribute publish_context
248
- # A map of strings to strings returned by the CSI controller plugin when a volume
249
- # is published.
250
232
  #
251
233
  # @return [Hash{Symbol=>String}, nil]
252
234
  optional :publish_context,
@@ -254,15 +236,6 @@ module DockerEngineRuby
254
236
  api_name: :PublishContext
255
237
 
256
238
  # @!attribute state
257
- # The published state of the volume.
258
- #
259
- # - `pending-publish` The volume should be published to this node, but the call to
260
- # the controller plugin to do so has not yet been successfully completed.
261
- # - `published` The volume is published successfully to the node.
262
- # - `pending-node-unpublish` The volume should be unpublished from the node, and
263
- # the manager is awaiting confirmation from the worker that it has done so.
264
- # - `pending-controller-unpublish` The volume is successfully unpublished from the
265
- # node, but has not yet been successfully unpublished on the controller.
266
239
  #
267
240
  # @return [Symbol, DockerEngineRuby::Models::Volume::ClusterVolume::PublishStatus::State, nil]
268
241
  optional :state,
@@ -270,26 +243,10 @@ module DockerEngineRuby
270
243
  api_name: :State
271
244
 
272
245
  # @!method initialize(node_id: nil, publish_context: nil, state: nil)
273
- # Some parameter documentations has been truncated, see
274
- # {DockerEngineRuby::Models::Volume::ClusterVolume::PublishStatus} for more
275
- # details.
276
- #
277
- # @param node_id [String] The ID of the Swarm node the volume is published on.
278
- #
279
- # @param publish_context [Hash{Symbol=>String}] A map of strings to strings returned by the CSI controller
280
- #
281
- # @param state [Symbol, DockerEngineRuby::Models::Volume::ClusterVolume::PublishStatus::State] The published state of the volume.
246
+ # @param node_id [String]
247
+ # @param publish_context [Hash{Symbol=>String}]
248
+ # @param state [Symbol, DockerEngineRuby::Models::Volume::ClusterVolume::PublishStatus::State]
282
249
 
283
- # The published state of the volume.
284
- #
285
- # - `pending-publish` The volume should be published to this node, but the call to
286
- # the controller plugin to do so has not yet been successfully completed.
287
- # - `published` The volume is published successfully to the node.
288
- # - `pending-node-unpublish` The volume should be unpublished from the node, and
289
- # the manager is awaiting confirmation from the worker that it has done so.
290
- # - `pending-controller-unpublish` The volume is successfully unpublished from the
291
- # node, but has not yet been successfully unpublished on the controller.
292
- #
293
250
  # @see DockerEngineRuby::Models::Volume::ClusterVolume::PublishStatus#state
294
251
  module State
295
252
  extend DockerEngineRuby::Internal::Type::Enum
@@ -337,9 +294,6 @@ module DockerEngineRuby
337
294
  # @see DockerEngineRuby::Models::Volume::ClusterVolume::Spec#access_mode
338
295
  class AccessMode < DockerEngineRuby::Internal::Type::BaseModel
339
296
  # @!attribute accessibility_requirements
340
- # Requirements for the accessible topology of the volume. These fields are
341
- # optional. For an in-depth description of what these fields mean, see the CSI
342
- # specification.
343
297
  #
344
298
  # @return [DockerEngineRuby::Models::Volume::ClusterVolume::Spec::AccessMode::AccessibilityRequirements, nil]
345
299
  optional :accessibility_requirements,
@@ -349,13 +303,6 @@ module DockerEngineRuby
349
303
  api_name: :AccessibilityRequirements
350
304
 
351
305
  # @!attribute availability
352
- # The availability of the volume for use in tasks.
353
- #
354
- # - `active` The volume is fully available for scheduling on the cluster
355
- # - `pause` No new workloads should use the volume, but existing workloads are not
356
- # stopped.
357
- # - `drain` All workloads using this volume should be stopped and rescheduled, and
358
- # no new ones should be started.
359
306
  #
360
307
  # @return [Symbol, DockerEngineRuby::Models::Volume::ClusterVolume::Spec::AccessMode::Availability, nil]
361
308
  optional :availability,
@@ -363,8 +310,6 @@ module DockerEngineRuby
363
310
  api_name: :Availability
364
311
 
365
312
  # @!attribute capacity_range
366
- # The desired capacity that the volume should be created with. If empty, the
367
- # plugin will decide the capacity.
368
313
  #
369
314
  # @return [DockerEngineRuby::Models::Volume::ClusterVolume::Spec::AccessMode::CapacityRange, nil]
370
315
  optional :capacity_range,
@@ -372,26 +317,13 @@ module DockerEngineRuby
372
317
  api_name: :CapacityRange
373
318
 
374
319
  # @!attribute mount_volume
375
- # Options for using this volume as a Mount-type volume.
376
- #
377
- # Either MountVolume or BlockVolume, but not both, must be
378
- # present.
379
- #
380
- # properties: FsType: type: "string" description: | Specifies the filesystem type
381
- # for the mount volume. Optional. MountFlags: type: "array" description: | Flags
382
- # to pass when mounting the volume. Optional. items: type: "string" BlockVolume:
383
- # type: "object" description: | Options for using this volume as a Block-type
384
- # volume. Intentionally empty.
385
320
  #
386
- # @return [Object, nil]
387
- optional :mount_volume, DockerEngineRuby::Internal::Type::Unknown, api_name: :MountVolume
321
+ # @return [Hash{Symbol=>Object}, nil]
322
+ optional :mount_volume,
323
+ DockerEngineRuby::Internal::Type::HashOf[DockerEngineRuby::Internal::Type::Unknown],
324
+ api_name: :MountVolume
388
325
 
389
326
  # @!attribute scope
390
- # The set of nodes this volume can be used on at one time.
391
- #
392
- # - `single` The volume may only be scheduled to one node at a time.
393
- # - `multi` the volume may be scheduled to any supported number of nodes at a
394
- # time.
395
327
  #
396
328
  # @return [Symbol, DockerEngineRuby::Models::Volume::ClusterVolume::Spec::AccessMode::Scope, nil]
397
329
  optional :scope,
@@ -399,8 +331,6 @@ module DockerEngineRuby
399
331
  api_name: :Scope
400
332
 
401
333
  # @!attribute secrets
402
- # Swarm Secrets that are passed to the CSI storage plugin when operating on this
403
- # volume.
404
334
  #
405
335
  # @return [Array<DockerEngineRuby::Models::Volume::ClusterVolume::Spec::AccessMode::Secret>, nil]
406
336
  optional :secrets,
@@ -410,14 +340,6 @@ module DockerEngineRuby
410
340
  api_name: :Secrets
411
341
 
412
342
  # @!attribute sharing
413
- # The number and way that different tasks can use this volume at one time.
414
- #
415
- # - `none` The volume may only be used by one task at a time.
416
- # - `readonly` The volume may be used by any number of tasks, but they all must
417
- # mount the volume as readonly
418
- # - `onewriter` The volume may be used by any number of tasks, but only one may
419
- # mount it as read/write.
420
- # - `all` The volume may have any number of readers and writers.
421
343
  #
422
344
  # @return [Symbol, DockerEngineRuby::Models::Volume::ClusterVolume::Spec::AccessMode::Sharing, nil]
423
345
  optional :sharing,
@@ -425,30 +347,19 @@ module DockerEngineRuby
425
347
  api_name: :Sharing
426
348
 
427
349
  # @!method initialize(accessibility_requirements: nil, availability: nil, capacity_range: nil, mount_volume: nil, scope: nil, secrets: nil, sharing: nil)
428
- # Some parameter documentations has been truncated, see
429
- # {DockerEngineRuby::Models::Volume::ClusterVolume::Spec::AccessMode} for more
430
- # details.
431
- #
432
350
  # Defines how the volume is used by tasks.
433
351
  #
434
- # @param accessibility_requirements [DockerEngineRuby::Models::Volume::ClusterVolume::Spec::AccessMode::AccessibilityRequirements] Requirements for the accessible topology of the volume. These
435
- #
436
- # @param availability [Symbol, DockerEngineRuby::Models::Volume::ClusterVolume::Spec::AccessMode::Availability] The availability of the volume for use in tasks.
437
- #
438
- # @param capacity_range [DockerEngineRuby::Models::Volume::ClusterVolume::Spec::AccessMode::CapacityRange] The desired capacity that the volume should be created with. If
439
- #
440
- # @param mount_volume [Object] Options for using this volume as a Mount-type volume.
441
- #
442
- # @param scope [Symbol, DockerEngineRuby::Models::Volume::ClusterVolume::Spec::AccessMode::Scope] The set of nodes this volume can be used on at one time.
443
- #
444
- # @param secrets [Array<DockerEngineRuby::Models::Volume::ClusterVolume::Spec::AccessMode::Secret>] Swarm Secrets that are passed to the CSI storage plugin when
445
- #
446
- # @param sharing [Symbol, DockerEngineRuby::Models::Volume::ClusterVolume::Spec::AccessMode::Sharing] The number and way that different tasks can use this volume
352
+ # @param accessibility_requirements [DockerEngineRuby::Models::Volume::ClusterVolume::Spec::AccessMode::AccessibilityRequirements]
353
+ # @param availability [Symbol, DockerEngineRuby::Models::Volume::ClusterVolume::Spec::AccessMode::Availability]
354
+ # @param capacity_range [DockerEngineRuby::Models::Volume::ClusterVolume::Spec::AccessMode::CapacityRange]
355
+ # @param mount_volume [Hash{Symbol=>Object}]
356
+ # @param scope [Symbol, DockerEngineRuby::Models::Volume::ClusterVolume::Spec::AccessMode::Scope]
357
+ # @param secrets [Array<DockerEngineRuby::Models::Volume::ClusterVolume::Spec::AccessMode::Secret>]
358
+ # @param sharing [Symbol, DockerEngineRuby::Models::Volume::ClusterVolume::Spec::AccessMode::Sharing]
447
359
 
448
360
  # @see DockerEngineRuby::Models::Volume::ClusterVolume::Spec::AccessMode#accessibility_requirements
449
361
  class AccessibilityRequirements < DockerEngineRuby::Internal::Type::BaseModel
450
362
  # @!attribute preferred
451
- # A list of topologies that the volume should attempt to be provisioned in.
452
363
  #
453
364
  # @return [Array<Hash{Symbol=>String}>, nil]
454
365
  optional :preferred,
@@ -456,8 +367,6 @@ module DockerEngineRuby
456
367
  api_name: :Preferred
457
368
 
458
369
  # @!attribute requisite
459
- # A list of required topologies, at least one of which the volume must be
460
- # accessible from.
461
370
  #
462
371
  # @return [Array<Hash{Symbol=>String}>, nil]
463
372
  optional :requisite,
@@ -465,27 +374,10 @@ module DockerEngineRuby
465
374
  api_name: :Requisite
466
375
 
467
376
  # @!method initialize(preferred: nil, requisite: nil)
468
- # Some parameter documentations has been truncated, see
469
- # {DockerEngineRuby::Models::Volume::ClusterVolume::Spec::AccessMode::AccessibilityRequirements}
470
- # for more details.
471
- #
472
- # Requirements for the accessible topology of the volume. These fields are
473
- # optional. For an in-depth description of what these fields mean, see the CSI
474
- # specification.
475
- #
476
- # @param preferred [Array<Hash{Symbol=>String}>] A list of topologies that the volume should attempt to be
477
- #
478
- # @param requisite [Array<Hash{Symbol=>String}>] A list of required topologies, at least one of which the
377
+ # @param preferred [Array<Hash{Symbol=>String}>]
378
+ # @param requisite [Array<Hash{Symbol=>String}>]
479
379
  end
480
380
 
481
- # The availability of the volume for use in tasks.
482
- #
483
- # - `active` The volume is fully available for scheduling on the cluster
484
- # - `pause` No new workloads should use the volume, but existing workloads are not
485
- # stopped.
486
- # - `drain` All workloads using this volume should be stopped and rescheduled, and
487
- # no new ones should be started.
488
- #
489
381
  # @see DockerEngineRuby::Models::Volume::ClusterVolume::Spec::AccessMode#availability
490
382
  module Availability
491
383
  extend DockerEngineRuby::Internal::Type::Enum
@@ -501,38 +393,20 @@ module DockerEngineRuby
501
393
  # @see DockerEngineRuby::Models::Volume::ClusterVolume::Spec::AccessMode#capacity_range
502
394
  class CapacityRange < DockerEngineRuby::Internal::Type::BaseModel
503
395
  # @!attribute limit_bytes
504
- # The volume must not be bigger than this. The value of 0 indicates an unspecified
505
- # maximum.
506
396
  #
507
397
  # @return [Integer, nil]
508
398
  optional :limit_bytes, Integer, api_name: :LimitBytes
509
399
 
510
400
  # @!attribute required_bytes
511
- # The volume must be at least this big. The value of 0 indicates an unspecified
512
- # minimum
513
401
  #
514
402
  # @return [Integer, nil]
515
403
  optional :required_bytes, Integer, api_name: :RequiredBytes
516
404
 
517
405
  # @!method initialize(limit_bytes: nil, required_bytes: nil)
518
- # Some parameter documentations has been truncated, see
519
- # {DockerEngineRuby::Models::Volume::ClusterVolume::Spec::AccessMode::CapacityRange}
520
- # for more details.
521
- #
522
- # The desired capacity that the volume should be created with. If empty, the
523
- # plugin will decide the capacity.
524
- #
525
- # @param limit_bytes [Integer] The volume must not be bigger than this. The value of 0
526
- #
527
- # @param required_bytes [Integer] The volume must be at least this big. The value of 0
406
+ # @param limit_bytes [Integer]
407
+ # @param required_bytes [Integer]
528
408
  end
529
409
 
530
- # The set of nodes this volume can be used on at one time.
531
- #
532
- # - `single` The volume may only be scheduled to one node at a time.
533
- # - `multi` the volume may be scheduled to any supported number of nodes at a
534
- # time.
535
- #
536
410
  # @see DockerEngineRuby::Models::Volume::ClusterVolume::Spec::AccessMode#scope
537
411
  module Scope
538
412
  extend DockerEngineRuby::Internal::Type::Enum
@@ -546,41 +420,20 @@ module DockerEngineRuby
546
420
 
547
421
  class Secret < DockerEngineRuby::Internal::Type::BaseModel
548
422
  # @!attribute key
549
- # Key is the name of the key of the key-value pair passed to the plugin.
550
423
  #
551
424
  # @return [String, nil]
552
425
  optional :key, String, api_name: :Key
553
426
 
554
427
  # @!attribute secret
555
- # Secret is the swarm Secret object from which to read data. This can be a Secret
556
- # name or ID. The Secret data is retrieved by swarm and used as the value of the
557
- # key-value pair passed to the plugin.
558
428
  #
559
429
  # @return [String, nil]
560
430
  optional :secret, String, api_name: :Secret
561
431
 
562
432
  # @!method initialize(key: nil, secret: nil)
563
- # Some parameter documentations has been truncated, see
564
- # {DockerEngineRuby::Models::Volume::ClusterVolume::Spec::AccessMode::Secret} for
565
- # more details.
566
- #
567
- # One cluster volume secret entry. Defines a key-value pair that is passed to the
568
- # plugin.
569
- #
570
- # @param key [String] Key is the name of the key of the key-value pair passed to
571
- #
572
- # @param secret [String] Secret is the swarm Secret object from which to read data.
433
+ # @param key [String]
434
+ # @param secret [String]
573
435
  end
574
436
 
575
- # The number and way that different tasks can use this volume at one time.
576
- #
577
- # - `none` The volume may only be used by one task at a time.
578
- # - `readonly` The volume may be used by any number of tasks, but they all must
579
- # mount the volume as readonly
580
- # - `onewriter` The volume may be used by any number of tasks, but only one may
581
- # mount it as read/write.
582
- # - `all` The volume may have any number of readers and writers.
583
- #
584
437
  # @see DockerEngineRuby::Models::Volume::ClusterVolume::Spec::AccessMode#sharing
585
438
  module Sharing
586
439
  extend DockerEngineRuby::Internal::Type::Enum
@@ -621,30 +474,21 @@ module DockerEngineRuby
621
474
  # @see DockerEngineRuby::Models::Volume#usage_data
622
475
  class UsageData < DockerEngineRuby::Internal::Type::BaseModel
623
476
  # @!attribute ref_count
624
- # The number of containers referencing this volume. This field is set to `-1` if
625
- # the reference-count is not available.
626
477
  #
627
478
  # @return [Integer]
628
479
  required :ref_count, Integer, api_name: :RefCount
629
480
 
630
481
  # @!attribute size
631
- # Amount of disk space used by the volume (in bytes). This information is only
632
- # available for volumes created with the `"local"` volume driver. For volumes
633
- # created with other volume drivers, this field is set to `-1` ("not available")
634
482
  #
635
483
  # @return [Integer]
636
484
  required :size, Integer, api_name: :Size
637
485
 
638
486
  # @!method initialize(ref_count:, size:)
639
- # Some parameter documentations has been truncated, see
640
- # {DockerEngineRuby::Models::Volume::UsageData} for more details.
641
- #
642
487
  # Usage details about the volume. This information is used by the `GET /system/df`
643
488
  # endpoint, and omitted in other endpoints.
644
489
  #
645
- # @param ref_count [Integer] The number of containers referencing this volume. This field
646
- #
647
- # @param size [Integer] Amount of disk space used by the volume (in bytes). This information
490
+ # @param ref_count [Integer]
491
+ # @param size [Integer]
648
492
  end
649
493
  end
650
494
  end
@@ -8,14 +8,12 @@ module DockerEngineRuby
8
8
  include DockerEngineRuby::Internal::Type::RequestParameters
9
9
 
10
10
  # @!attribute force
11
- # Force the removal of the volume
12
11
  #
13
12
  # @return [Boolean, nil]
14
13
  optional :force, DockerEngineRuby::Internal::Type::Boolean
15
14
 
16
15
  # @!method initialize(force: nil, request_options: {})
17
- # @param force [Boolean] Force the removal of the volume
18
- #
16
+ # @param force [Boolean]
19
17
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
20
18
  end
21
19
  end
@@ -8,26 +8,12 @@ module DockerEngineRuby
8
8
  include DockerEngineRuby::Internal::Type::RequestParameters
9
9
 
10
10
  # @!attribute filters
11
- # JSON encoded value of the filters (a `map[string][]string`) to process on the
12
- # volumes list. Available filters:
13
- #
14
- # - `dangling=<boolean>` When set to `true` (or `1`), returns all volumes that are
15
- # not in use by a container. When set to `false` (or `0`), only volumes that are
16
- # in use by one or more containers are returned.
17
- # - `driver=<volume-driver-name>` Matches volumes based on their driver.
18
- # - `label=<key>` or `label=<key>:<value>` Matches volumes based on the presence
19
- # of a `label` alone or a `label` and a value.
20
- # - `name=<volume-name>` Matches all or part of a volume name.
21
11
  #
22
12
  # @return [String, nil]
23
13
  optional :filters, String
24
14
 
25
15
  # @!method initialize(filters: nil, request_options: {})
26
- # Some parameter documentations has been truncated, see
27
- # {DockerEngineRuby::Models::VolumeListParams} for more details.
28
- #
29
- # @param filters [String] JSON encoded value of the filters (a `map[string][]string`) to
30
- #
16
+ # @param filters [String]
31
17
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
32
18
  end
33
19
  end
@@ -8,25 +8,12 @@ module DockerEngineRuby
8
8
  include DockerEngineRuby::Internal::Type::RequestParameters
9
9
 
10
10
  # @!attribute filters
11
- # Filters to process on the prune list, encoded as JSON (a `map[string][]string`).
12
- #
13
- # Available filters:
14
- #
15
- # - `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or
16
- # `label!=<key>=<value>`) Prune volumes with (or without, in case `label!=...`
17
- # is used) the specified labels.
18
- # - `all` (`all=true`) - Consider all (local) volumes for pruning and not just
19
- # anonymous volumes.
20
11
  #
21
12
  # @return [String, nil]
22
13
  optional :filters, String
23
14
 
24
15
  # @!method initialize(filters: nil, request_options: {})
25
- # Some parameter documentations has been truncated, see
26
- # {DockerEngineRuby::Models::VolumePruneParams} for more details.
27
- #
28
- # @param filters [String] Filters to process on the prune list, encoded as JSON (a `map[string][]string`).
29
- #
16
+ # @param filters [String]
30
17
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
31
18
  end
32
19
  end
@@ -5,21 +5,18 @@ module DockerEngineRuby
5
5
  # @see DockerEngineRuby::Resources::Volumes#prune
6
6
  class VolumePruneResponse < DockerEngineRuby::Internal::Type::BaseModel
7
7
  # @!attribute space_reclaimed
8
- # Disk space reclaimed in bytes
9
8
  #
10
9
  # @return [Integer, nil]
11
10
  optional :space_reclaimed, Integer, api_name: :SpaceReclaimed
12
11
 
13
12
  # @!attribute volumes_deleted
14
- # Volumes that were deleted
15
13
  #
16
14
  # @return [Array<String>, nil]
17
15
  optional :volumes_deleted, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :VolumesDeleted
18
16
 
19
17
  # @!method initialize(space_reclaimed: nil, volumes_deleted: nil)
20
- # @param space_reclaimed [Integer] Disk space reclaimed in bytes
21
- #
22
- # @param volumes_deleted [Array<String>] Volumes that were deleted
18
+ # @param space_reclaimed [Integer]
19
+ # @param volumes_deleted [Array<String>]
23
20
  end
24
21
  end
25
22
  end