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,74 @@
1
+ # frozen_string_literal: true
2
+
3
+ module DockerEngineAPI
4
+ module Models
5
+ # @see DockerEngineAPI::Resources::Services#logs
6
+ class ServiceLogsParams < DockerEngineAPI::Internal::Type::BaseModel
7
+ extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
8
+ include DockerEngineAPI::Internal::Type::RequestParameters
9
+
10
+ # @!attribute details
11
+ # Show service context and extra details provided to logs.
12
+ #
13
+ # @return [Boolean, nil]
14
+ optional :details, DockerEngineAPI::Internal::Type::Boolean
15
+
16
+ # @!attribute follow
17
+ # Keep connection after returning logs.
18
+ #
19
+ # @return [Boolean, nil]
20
+ optional :follow, DockerEngineAPI::Internal::Type::Boolean
21
+
22
+ # @!attribute since
23
+ # Only return logs since this time, as a UNIX timestamp
24
+ #
25
+ # @return [Integer, nil]
26
+ optional :since, Integer
27
+
28
+ # @!attribute stderr
29
+ # Return logs from `stderr`
30
+ #
31
+ # @return [Boolean, nil]
32
+ optional :stderr, DockerEngineAPI::Internal::Type::Boolean
33
+
34
+ # @!attribute stdout
35
+ # Return logs from `stdout`
36
+ #
37
+ # @return [Boolean, nil]
38
+ optional :stdout, DockerEngineAPI::Internal::Type::Boolean
39
+
40
+ # @!attribute tail
41
+ # Only return this number of log lines from the end of the logs. Specify as an
42
+ # integer or `all` to output all log lines.
43
+ #
44
+ # @return [String, nil]
45
+ optional :tail, String
46
+
47
+ # @!attribute timestamps
48
+ # Add timestamps to every log line
49
+ #
50
+ # @return [Boolean, nil]
51
+ optional :timestamps, DockerEngineAPI::Internal::Type::Boolean
52
+
53
+ # @!method initialize(details: nil, follow: nil, since: nil, stderr: nil, stdout: nil, tail: nil, timestamps: nil, request_options: {})
54
+ # Some parameter documentations has been truncated, see
55
+ # {DockerEngineAPI::Models::ServiceLogsParams} for more details.
56
+ #
57
+ # @param details [Boolean] Show service context and extra details provided to logs.
58
+ #
59
+ # @param follow [Boolean] Keep connection after returning logs.
60
+ #
61
+ # @param since [Integer] Only return logs since this time, as a UNIX timestamp
62
+ #
63
+ # @param stderr [Boolean] Return logs from `stderr`
64
+ #
65
+ # @param stdout [Boolean] Return logs from `stdout`
66
+ #
67
+ # @param tail [String] Only return this number of log lines from the end of the logs.
68
+ #
69
+ # @param timestamps [Boolean] Add timestamps to every log line
70
+ #
71
+ # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
72
+ end
73
+ end
74
+ end
@@ -0,0 +1,78 @@
1
+ # frozen_string_literal: true
2
+
3
+ module DockerEngineAPI
4
+ module Models
5
+ # @see DockerEngineAPI::Resources::Services#update
6
+ class ServiceUpdateParams < DockerEngineAPI::Internal::Type::BaseModel
7
+ extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
8
+ include DockerEngineAPI::Internal::Type::RequestParameters
9
+
10
+ # @!attribute version
11
+ # The version number of the service object being updated. This is required to
12
+ # avoid conflicting writes. This version number should be the value as currently
13
+ # set on the service _before_ the update. You can find the current version by
14
+ # calling `GET /services/{id}`
15
+ #
16
+ # @return [Integer]
17
+ required :version, Integer
18
+
19
+ # @!attribute spec
20
+ # User modifiable configuration for a service.
21
+ #
22
+ # @return [DockerEngineAPI::Models::ServiceUpdateParams::Spec]
23
+ required :spec, -> { DockerEngineAPI::ServiceUpdateParams::Spec }
24
+
25
+ # @!attribute registry_auth_from
26
+ # If the `X-Registry-Auth` header is not specified, this parameter indicates where
27
+ # to find registry authorization credentials.
28
+ #
29
+ # @return [Symbol, DockerEngineAPI::Models::ServiceUpdateParams::RegistryAuthFrom, nil]
30
+ optional :registry_auth_from, enum: -> { DockerEngineAPI::ServiceUpdateParams::RegistryAuthFrom }
31
+
32
+ # @!attribute rollback
33
+ # Set to this parameter to `previous` to cause a server-side rollback to the
34
+ # previous service spec. The supplied spec will be ignored in this case.
35
+ #
36
+ # @return [String, nil]
37
+ optional :rollback, String
38
+
39
+ # @!attribute x_registry_auth
40
+ #
41
+ # @return [String, nil]
42
+ optional :x_registry_auth, String
43
+
44
+ # @!method initialize(version:, spec:, registry_auth_from: nil, rollback: nil, x_registry_auth: nil, request_options: {})
45
+ # Some parameter documentations has been truncated, see
46
+ # {DockerEngineAPI::Models::ServiceUpdateParams} for more details.
47
+ #
48
+ # @param version [Integer] The version number of the service object being updated. This is
49
+ #
50
+ # @param spec [DockerEngineAPI::Models::ServiceUpdateParams::Spec] User modifiable configuration for a service.
51
+ #
52
+ # @param registry_auth_from [Symbol, DockerEngineAPI::Models::ServiceUpdateParams::RegistryAuthFrom] If the `X-Registry-Auth` header is not specified, this parameter
53
+ #
54
+ # @param rollback [String] Set to this parameter to `previous` to cause a server-side rollback
55
+ #
56
+ # @param x_registry_auth [String]
57
+ #
58
+ # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
59
+
60
+ class Spec < DockerEngineAPI::Models::Spec
61
+ # @!method initialize
62
+ # User modifiable configuration for a service.
63
+ end
64
+
65
+ # If the `X-Registry-Auth` header is not specified, this parameter indicates where
66
+ # to find registry authorization credentials.
67
+ module RegistryAuthFrom
68
+ extend DockerEngineAPI::Internal::Type::Enum
69
+
70
+ SPEC = :spec
71
+ PREVIOUS_SPEC = :"previous-spec"
72
+
73
+ # @!method self.values
74
+ # @return [Array<Symbol>]
75
+ end
76
+ end
77
+ end
78
+ end
@@ -0,0 +1,510 @@
1
+ # frozen_string_literal: true
2
+
3
+ module DockerEngineAPI
4
+ module Models
5
+ class Spec < DockerEngineAPI::Internal::Type::BaseModel
6
+ # @!attribute endpoint_spec
7
+ # Properties that can be configured to access and load balance a service.
8
+ #
9
+ # @return [DockerEngineAPI::Models::Spec::EndpointSpec, nil]
10
+ optional :endpoint_spec, -> { DockerEngineAPI::Spec::EndpointSpec }, api_name: :EndpointSpec
11
+
12
+ # @!attribute labels
13
+ # User-defined key/value metadata.
14
+ #
15
+ # @return [Hash{Symbol=>String}, nil]
16
+ optional :labels, DockerEngineAPI::Internal::Type::HashOf[String], api_name: :Labels
17
+
18
+ # @!attribute mode
19
+ # Scheduling mode for the service.
20
+ #
21
+ # @return [DockerEngineAPI::Models::Spec::Mode, nil]
22
+ optional :mode, -> { DockerEngineAPI::Spec::Mode }, api_name: :Mode
23
+
24
+ # @!attribute name
25
+ # Name of the service.
26
+ #
27
+ # @return [String, nil]
28
+ optional :name, String, api_name: :Name
29
+
30
+ # @!attribute networks
31
+ # Specifies which networks the service should attach to.
32
+ #
33
+ # Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec
34
+ # should be used instead.
35
+ #
36
+ # @return [Array<DockerEngineAPI::Models::Spec::Network>, nil]
37
+ optional :networks,
38
+ -> { DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Spec::Network] },
39
+ api_name: :Networks
40
+
41
+ # @!attribute rollback_config
42
+ # Specification for the rollback strategy of the service.
43
+ #
44
+ # @return [DockerEngineAPI::Models::Spec::RollbackConfig, nil]
45
+ optional :rollback_config, -> { DockerEngineAPI::Spec::RollbackConfig }, api_name: :RollbackConfig
46
+
47
+ # @!attribute task_template
48
+ # User modifiable task configuration.
49
+ #
50
+ # @return [DockerEngineAPI::Models::Spec, nil]
51
+ optional :task_template, -> { DockerEngineAPI::Spec }, api_name: :TaskTemplate
52
+
53
+ # @!attribute update_config
54
+ # Specification for the update strategy of the service.
55
+ #
56
+ # @return [DockerEngineAPI::Models::Spec::UpdateConfig, nil]
57
+ optional :update_config, -> { DockerEngineAPI::Spec::UpdateConfig }, api_name: :UpdateConfig
58
+
59
+ # @!method initialize(endpoint_spec: nil, labels: nil, mode: nil, name: nil, networks: nil, rollback_config: nil, task_template: nil, update_config: nil)
60
+ # Some parameter documentations has been truncated, see
61
+ # {DockerEngineAPI::Models::Spec} for more details.
62
+ #
63
+ # User modifiable configuration for a service.
64
+ #
65
+ # @param endpoint_spec [DockerEngineAPI::Models::Spec::EndpointSpec] Properties that can be configured to access and load balance a service.
66
+ #
67
+ # @param labels [Hash{Symbol=>String}] User-defined key/value metadata.
68
+ #
69
+ # @param mode [DockerEngineAPI::Models::Spec::Mode] Scheduling mode for the service.
70
+ #
71
+ # @param name [String] Name of the service.
72
+ #
73
+ # @param networks [Array<DockerEngineAPI::Models::Spec::Network>] Specifies which networks the service should attach to.
74
+ #
75
+ # @param rollback_config [DockerEngineAPI::Models::Spec::RollbackConfig] Specification for the rollback strategy of the service.
76
+ #
77
+ # @param task_template [DockerEngineAPI::Models::Spec] User modifiable task configuration.
78
+ #
79
+ # @param update_config [DockerEngineAPI::Models::Spec::UpdateConfig] Specification for the update strategy of the service.
80
+
81
+ # @see DockerEngineAPI::Models::Spec#endpoint_spec
82
+ class EndpointSpec < DockerEngineAPI::Internal::Type::BaseModel
83
+ # @!attribute mode
84
+ # The mode of resolution to use for internal load balancing between tasks.
85
+ #
86
+ # @return [Symbol, DockerEngineAPI::Models::Spec::EndpointSpec::Mode, nil]
87
+ optional :mode, enum: -> { DockerEngineAPI::Spec::EndpointSpec::Mode }, api_name: :Mode
88
+
89
+ # @!attribute ports
90
+ # List of exposed ports that this service is accessible on from the outside. Ports
91
+ # can only be provided if `vip` resolution mode is used.
92
+ #
93
+ # @return [Array<DockerEngineAPI::Models::Spec::EndpointSpec::Port>, nil]
94
+ optional :ports,
95
+ -> { DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Spec::EndpointSpec::Port] },
96
+ api_name: :Ports
97
+
98
+ # @!method initialize(mode: nil, ports: nil)
99
+ # Some parameter documentations has been truncated, see
100
+ # {DockerEngineAPI::Models::Spec::EndpointSpec} for more details.
101
+ #
102
+ # Properties that can be configured to access and load balance a service.
103
+ #
104
+ # @param mode [Symbol, DockerEngineAPI::Models::Spec::EndpointSpec::Mode] The mode of resolution to use for internal load balancing between tasks.
105
+ #
106
+ # @param ports [Array<DockerEngineAPI::Models::Spec::EndpointSpec::Port>] List of exposed ports that this service is accessible on from the
107
+
108
+ # The mode of resolution to use for internal load balancing between tasks.
109
+ #
110
+ # @see DockerEngineAPI::Models::Spec::EndpointSpec#mode
111
+ module Mode
112
+ extend DockerEngineAPI::Internal::Type::Enum
113
+
114
+ VIP = :vip
115
+ DNSRR = :dnsrr
116
+
117
+ # @!method self.values
118
+ # @return [Array<Symbol>]
119
+ end
120
+
121
+ class Port < DockerEngineAPI::Internal::Type::BaseModel
122
+ # @!attribute name
123
+ #
124
+ # @return [String, nil]
125
+ optional :name, String, api_name: :Name
126
+
127
+ # @!attribute protocol
128
+ #
129
+ # @return [Symbol, DockerEngineAPI::Models::Spec::EndpointSpec::Port::Protocol, nil]
130
+ optional :protocol,
131
+ enum: -> {
132
+ DockerEngineAPI::Spec::EndpointSpec::Port::Protocol
133
+ },
134
+ api_name: :Protocol
135
+
136
+ # @!attribute published_port
137
+ # The port on the swarm hosts.
138
+ #
139
+ # @return [Integer, nil]
140
+ optional :published_port, Integer, api_name: :PublishedPort
141
+
142
+ # @!attribute publish_mode
143
+ # The mode in which port is published.
144
+ #
145
+ # <p><br /></p>
146
+ #
147
+ # - "ingress" makes the target port accessible on every node, regardless of
148
+ # whether there is a task for the service running on that node or not.
149
+ # - "host" bypasses the routing mesh and publish the port directly on the swarm
150
+ # node where that service is running.
151
+ #
152
+ # @return [Symbol, DockerEngineAPI::Models::Spec::EndpointSpec::Port::PublishMode, nil]
153
+ optional :publish_mode,
154
+ enum: -> { DockerEngineAPI::Spec::EndpointSpec::Port::PublishMode },
155
+ api_name: :PublishMode
156
+
157
+ # @!attribute target_port
158
+ # The port inside the container.
159
+ #
160
+ # @return [Integer, nil]
161
+ optional :target_port, Integer, api_name: :TargetPort
162
+
163
+ # @!method initialize(name: nil, protocol: nil, published_port: nil, publish_mode: nil, target_port: nil)
164
+ # Some parameter documentations has been truncated, see
165
+ # {DockerEngineAPI::Models::Spec::EndpointSpec::Port} for more details.
166
+ #
167
+ # @param name [String]
168
+ #
169
+ # @param protocol [Symbol, DockerEngineAPI::Models::Spec::EndpointSpec::Port::Protocol]
170
+ #
171
+ # @param published_port [Integer] The port on the swarm hosts.
172
+ #
173
+ # @param publish_mode [Symbol, DockerEngineAPI::Models::Spec::EndpointSpec::Port::PublishMode] The mode in which port is published.
174
+ #
175
+ # @param target_port [Integer] The port inside the container.
176
+
177
+ # @see DockerEngineAPI::Models::Spec::EndpointSpec::Port#protocol
178
+ module Protocol
179
+ extend DockerEngineAPI::Internal::Type::Enum
180
+
181
+ TCP = :tcp
182
+ UDP = :udp
183
+ SCTP = :sctp
184
+
185
+ # @!method self.values
186
+ # @return [Array<Symbol>]
187
+ end
188
+
189
+ # The mode in which port is published.
190
+ #
191
+ # <p><br /></p>
192
+ #
193
+ # - "ingress" makes the target port accessible on every node, regardless of
194
+ # whether there is a task for the service running on that node or not.
195
+ # - "host" bypasses the routing mesh and publish the port directly on the swarm
196
+ # node where that service is running.
197
+ #
198
+ # @see DockerEngineAPI::Models::Spec::EndpointSpec::Port#publish_mode
199
+ module PublishMode
200
+ extend DockerEngineAPI::Internal::Type::Enum
201
+
202
+ INGRESS = :ingress
203
+ HOST = :host
204
+
205
+ # @!method self.values
206
+ # @return [Array<Symbol>]
207
+ end
208
+ end
209
+ end
210
+
211
+ # @see DockerEngineAPI::Models::Spec#mode
212
+ class Mode < DockerEngineAPI::Internal::Type::BaseModel
213
+ # @!attribute global
214
+ #
215
+ # @return [Object, nil]
216
+ optional :global, DockerEngineAPI::Internal::Type::Unknown, api_name: :Global
217
+
218
+ # @!attribute global_job
219
+ # The mode used for services which run a task to the completed state on each valid
220
+ # node.
221
+ #
222
+ # @return [Object, nil]
223
+ optional :global_job, DockerEngineAPI::Internal::Type::Unknown, api_name: :GlobalJob
224
+
225
+ # @!attribute replicated
226
+ #
227
+ # @return [DockerEngineAPI::Models::Spec::Mode::Replicated, nil]
228
+ optional :replicated, -> { DockerEngineAPI::Spec::Mode::Replicated }, api_name: :Replicated
229
+
230
+ # @!attribute replicated_job
231
+ # The mode used for services with a finite number of tasks that run to a completed
232
+ # state.
233
+ #
234
+ # @return [DockerEngineAPI::Models::Spec::Mode::ReplicatedJob, nil]
235
+ optional :replicated_job, -> { DockerEngineAPI::Spec::Mode::ReplicatedJob }, api_name: :ReplicatedJob
236
+
237
+ # @!method initialize(global: nil, global_job: nil, replicated: nil, replicated_job: nil)
238
+ # Some parameter documentations has been truncated, see
239
+ # {DockerEngineAPI::Models::Spec::Mode} for more details.
240
+ #
241
+ # Scheduling mode for the service.
242
+ #
243
+ # @param global [Object]
244
+ #
245
+ # @param global_job [Object] The mode used for services which run a task to the completed state
246
+ #
247
+ # @param replicated [DockerEngineAPI::Models::Spec::Mode::Replicated]
248
+ #
249
+ # @param replicated_job [DockerEngineAPI::Models::Spec::Mode::ReplicatedJob] The mode used for services with a finite number of tasks that run
250
+
251
+ # @see DockerEngineAPI::Models::Spec::Mode#replicated
252
+ class Replicated < DockerEngineAPI::Internal::Type::BaseModel
253
+ # @!attribute replicas
254
+ #
255
+ # @return [Integer, nil]
256
+ optional :replicas, Integer, api_name: :Replicas
257
+
258
+ # @!method initialize(replicas: nil)
259
+ # @param replicas [Integer]
260
+ end
261
+
262
+ # @see DockerEngineAPI::Models::Spec::Mode#replicated_job
263
+ class ReplicatedJob < DockerEngineAPI::Internal::Type::BaseModel
264
+ # @!attribute max_concurrent
265
+ # The maximum number of replicas to run simultaneously.
266
+ #
267
+ # @return [Integer, nil]
268
+ optional :max_concurrent, Integer, api_name: :MaxConcurrent
269
+
270
+ # @!attribute total_completions
271
+ # The total number of replicas desired to reach the Completed state. If unset,
272
+ # will default to the value of `MaxConcurrent`
273
+ #
274
+ # @return [Integer, nil]
275
+ optional :total_completions, Integer, api_name: :TotalCompletions
276
+
277
+ # @!method initialize(max_concurrent: nil, total_completions: nil)
278
+ # Some parameter documentations has been truncated, see
279
+ # {DockerEngineAPI::Models::Spec::Mode::ReplicatedJob} for more details.
280
+ #
281
+ # The mode used for services with a finite number of tasks that run to a completed
282
+ # state.
283
+ #
284
+ # @param max_concurrent [Integer] The maximum number of replicas to run simultaneously.
285
+ #
286
+ # @param total_completions [Integer] The total number of replicas desired to reach the Completed
287
+ end
288
+ end
289
+
290
+ class Network < DockerEngineAPI::Internal::Type::BaseModel
291
+ # @!attribute aliases
292
+ # Discoverable alternate names for the service on this network.
293
+ #
294
+ # @return [Array<String>, nil]
295
+ optional :aliases, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :Aliases
296
+
297
+ # @!attribute driver_opts
298
+ # Driver attachment options for the network target.
299
+ #
300
+ # @return [Hash{Symbol=>String}, nil]
301
+ optional :driver_opts, DockerEngineAPI::Internal::Type::HashOf[String], api_name: :DriverOpts
302
+
303
+ # @!attribute target
304
+ # The target network for attachment. Must be a network name or ID.
305
+ #
306
+ # @return [String, nil]
307
+ optional :target, String, api_name: :Target
308
+
309
+ # @!method initialize(aliases: nil, driver_opts: nil, target: nil)
310
+ # Some parameter documentations has been truncated, see
311
+ # {DockerEngineAPI::Models::Spec::Network} for more details.
312
+ #
313
+ # Specifies how a service should be attached to a particular network.
314
+ #
315
+ # @param aliases [Array<String>] Discoverable alternate names for the service on this network.
316
+ #
317
+ # @param driver_opts [Hash{Symbol=>String}] Driver attachment options for the network target.
318
+ #
319
+ # @param target [String] The target network for attachment. Must be a network name or ID.
320
+ end
321
+
322
+ # @see DockerEngineAPI::Models::Spec#rollback_config
323
+ class RollbackConfig < DockerEngineAPI::Internal::Type::BaseModel
324
+ # @!attribute delay
325
+ # Amount of time between rollback iterations, in nanoseconds.
326
+ #
327
+ # @return [Integer, nil]
328
+ optional :delay, Integer, api_name: :Delay
329
+
330
+ # @!attribute failure_action
331
+ # Action to take if an rolled back task fails to run, or stops running during the
332
+ # rollback.
333
+ #
334
+ # @return [Symbol, DockerEngineAPI::Models::Spec::RollbackConfig::FailureAction, nil]
335
+ optional :failure_action,
336
+ enum: -> { DockerEngineAPI::Spec::RollbackConfig::FailureAction },
337
+ api_name: :FailureAction
338
+
339
+ # @!attribute max_failure_ratio
340
+ # The fraction of tasks that may fail during a rollback before the failure action
341
+ # is invoked, specified as a floating point number between 0 and 1.
342
+ #
343
+ # @return [Float, nil]
344
+ optional :max_failure_ratio, Float, api_name: :MaxFailureRatio
345
+
346
+ # @!attribute monitor
347
+ # Amount of time to monitor each rolled back task for failures, in nanoseconds.
348
+ #
349
+ # @return [Integer, nil]
350
+ optional :monitor, Integer, api_name: :Monitor
351
+
352
+ # @!attribute order
353
+ # The order of operations when rolling back a task. Either the old task is shut
354
+ # down before the new task is started, or the new task is started before the old
355
+ # task is shut down.
356
+ #
357
+ # @return [Symbol, DockerEngineAPI::Models::Spec::RollbackConfig::Order, nil]
358
+ optional :order, enum: -> { DockerEngineAPI::Spec::RollbackConfig::Order }, api_name: :Order
359
+
360
+ # @!attribute parallelism
361
+ # Maximum number of tasks to be rolled back in one iteration (0 means unlimited
362
+ # parallelism).
363
+ #
364
+ # @return [Integer, nil]
365
+ optional :parallelism, Integer, api_name: :Parallelism
366
+
367
+ # @!method initialize(delay: nil, failure_action: nil, max_failure_ratio: nil, monitor: nil, order: nil, parallelism: nil)
368
+ # Some parameter documentations has been truncated, see
369
+ # {DockerEngineAPI::Models::Spec::RollbackConfig} for more details.
370
+ #
371
+ # Specification for the rollback strategy of the service.
372
+ #
373
+ # @param delay [Integer] Amount of time between rollback iterations, in nanoseconds.
374
+ #
375
+ # @param failure_action [Symbol, DockerEngineAPI::Models::Spec::RollbackConfig::FailureAction] Action to take if an rolled back task fails to run, or stops
376
+ #
377
+ # @param max_failure_ratio [Float] The fraction of tasks that may fail during a rollback before the
378
+ #
379
+ # @param monitor [Integer] Amount of time to monitor each rolled back task for failures, in
380
+ #
381
+ # @param order [Symbol, DockerEngineAPI::Models::Spec::RollbackConfig::Order] The order of operations when rolling back a task. Either the old
382
+ #
383
+ # @param parallelism [Integer] Maximum number of tasks to be rolled back in one iteration (0 means
384
+
385
+ # Action to take if an rolled back task fails to run, or stops running during the
386
+ # rollback.
387
+ #
388
+ # @see DockerEngineAPI::Models::Spec::RollbackConfig#failure_action
389
+ module FailureAction
390
+ extend DockerEngineAPI::Internal::Type::Enum
391
+
392
+ CONTINUE = :continue
393
+ PAUSE = :pause
394
+
395
+ # @!method self.values
396
+ # @return [Array<Symbol>]
397
+ end
398
+
399
+ # The order of operations when rolling back a task. Either the old task is shut
400
+ # down before the new task is started, or the new task is started before the old
401
+ # task is shut down.
402
+ #
403
+ # @see DockerEngineAPI::Models::Spec::RollbackConfig#order
404
+ module Order
405
+ extend DockerEngineAPI::Internal::Type::Enum
406
+
407
+ STOP_FIRST = :"stop-first"
408
+ START_FIRST = :"start-first"
409
+
410
+ # @!method self.values
411
+ # @return [Array<Symbol>]
412
+ end
413
+ end
414
+
415
+ # @see DockerEngineAPI::Models::Spec#update_config
416
+ class UpdateConfig < DockerEngineAPI::Internal::Type::BaseModel
417
+ # @!attribute delay
418
+ # Amount of time between updates, in nanoseconds.
419
+ #
420
+ # @return [Integer, nil]
421
+ optional :delay, Integer, api_name: :Delay
422
+
423
+ # @!attribute failure_action
424
+ # Action to take if an updated task fails to run, or stops running during the
425
+ # update.
426
+ #
427
+ # @return [Symbol, DockerEngineAPI::Models::Spec::UpdateConfig::FailureAction, nil]
428
+ optional :failure_action,
429
+ enum: -> { DockerEngineAPI::Spec::UpdateConfig::FailureAction },
430
+ api_name: :FailureAction
431
+
432
+ # @!attribute max_failure_ratio
433
+ # The fraction of tasks that may fail during an update before the failure action
434
+ # is invoked, specified as a floating point number between 0 and 1.
435
+ #
436
+ # @return [Float, nil]
437
+ optional :max_failure_ratio, Float, api_name: :MaxFailureRatio
438
+
439
+ # @!attribute monitor
440
+ # Amount of time to monitor each updated task for failures, in nanoseconds.
441
+ #
442
+ # @return [Integer, nil]
443
+ optional :monitor, Integer, api_name: :Monitor
444
+
445
+ # @!attribute order
446
+ # The order of operations when rolling out an updated task. Either the old task is
447
+ # shut down before the new task is started, or the new task is started before the
448
+ # old task is shut down.
449
+ #
450
+ # @return [Symbol, DockerEngineAPI::Models::Spec::UpdateConfig::Order, nil]
451
+ optional :order, enum: -> { DockerEngineAPI::Spec::UpdateConfig::Order }, api_name: :Order
452
+
453
+ # @!attribute parallelism
454
+ # Maximum number of tasks to be updated in one iteration (0 means unlimited
455
+ # parallelism).
456
+ #
457
+ # @return [Integer, nil]
458
+ optional :parallelism, Integer, api_name: :Parallelism
459
+
460
+ # @!method initialize(delay: nil, failure_action: nil, max_failure_ratio: nil, monitor: nil, order: nil, parallelism: nil)
461
+ # Some parameter documentations has been truncated, see
462
+ # {DockerEngineAPI::Models::Spec::UpdateConfig} for more details.
463
+ #
464
+ # Specification for the update strategy of the service.
465
+ #
466
+ # @param delay [Integer] Amount of time between updates, in nanoseconds.
467
+ #
468
+ # @param failure_action [Symbol, DockerEngineAPI::Models::Spec::UpdateConfig::FailureAction] Action to take if an updated task fails to run, or stops running
469
+ #
470
+ # @param max_failure_ratio [Float] The fraction of tasks that may fail during an update before the
471
+ #
472
+ # @param monitor [Integer] Amount of time to monitor each updated task for failures, in
473
+ #
474
+ # @param order [Symbol, DockerEngineAPI::Models::Spec::UpdateConfig::Order] The order of operations when rolling out an updated task. Either
475
+ #
476
+ # @param parallelism [Integer] Maximum number of tasks to be updated in one iteration (0 means
477
+
478
+ # Action to take if an updated task fails to run, or stops running during the
479
+ # update.
480
+ #
481
+ # @see DockerEngineAPI::Models::Spec::UpdateConfig#failure_action
482
+ module FailureAction
483
+ extend DockerEngineAPI::Internal::Type::Enum
484
+
485
+ CONTINUE = :continue
486
+ PAUSE = :pause
487
+ ROLLBACK = :rollback
488
+
489
+ # @!method self.values
490
+ # @return [Array<Symbol>]
491
+ end
492
+
493
+ # The order of operations when rolling out an updated task. Either the old task is
494
+ # shut down before the new task is started, or the new task is started before the
495
+ # old task is shut down.
496
+ #
497
+ # @see DockerEngineAPI::Models::Spec::UpdateConfig#order
498
+ module Order
499
+ extend DockerEngineAPI::Internal::Type::Enum
500
+
501
+ STOP_FIRST = :"stop-first"
502
+ START_FIRST = :"start-first"
503
+
504
+ # @!method self.values
505
+ # @return [Array<Symbol>]
506
+ end
507
+ end
508
+ end
509
+ end
510
+ end