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,1030 @@
1
+ # typed: strong
2
+
3
+ module DockerEngineAPI
4
+ module Models
5
+ class Spec < DockerEngineAPI::Internal::Type::BaseModel
6
+ OrHash =
7
+ T.type_alias do
8
+ T.any(DockerEngineAPI::Spec, DockerEngineAPI::Internal::AnyHash)
9
+ end
10
+
11
+ # Properties that can be configured to access and load balance a service.
12
+ sig { returns(T.nilable(DockerEngineAPI::Spec::EndpointSpec)) }
13
+ attr_reader :endpoint_spec
14
+
15
+ sig do
16
+ params(endpoint_spec: DockerEngineAPI::Spec::EndpointSpec::OrHash).void
17
+ end
18
+ attr_writer :endpoint_spec
19
+
20
+ # User-defined key/value metadata.
21
+ sig { returns(T.nilable(T::Hash[Symbol, String])) }
22
+ attr_reader :labels
23
+
24
+ sig { params(labels: T::Hash[Symbol, String]).void }
25
+ attr_writer :labels
26
+
27
+ # Scheduling mode for the service.
28
+ sig { returns(T.nilable(DockerEngineAPI::Spec::Mode)) }
29
+ attr_reader :mode
30
+
31
+ sig { params(mode: DockerEngineAPI::Spec::Mode::OrHash).void }
32
+ attr_writer :mode
33
+
34
+ # Name of the service.
35
+ sig { returns(T.nilable(String)) }
36
+ attr_reader :name
37
+
38
+ sig { params(name: String).void }
39
+ attr_writer :name
40
+
41
+ # Specifies which networks the service should attach to.
42
+ #
43
+ # Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec
44
+ # should be used instead.
45
+ sig { returns(T.nilable(T::Array[DockerEngineAPI::Spec::Network])) }
46
+ attr_reader :networks
47
+
48
+ sig do
49
+ params(networks: T::Array[DockerEngineAPI::Spec::Network::OrHash]).void
50
+ end
51
+ attr_writer :networks
52
+
53
+ # Specification for the rollback strategy of the service.
54
+ sig { returns(T.nilable(DockerEngineAPI::Spec::RollbackConfig)) }
55
+ attr_reader :rollback_config
56
+
57
+ sig do
58
+ params(
59
+ rollback_config: DockerEngineAPI::Spec::RollbackConfig::OrHash
60
+ ).void
61
+ end
62
+ attr_writer :rollback_config
63
+
64
+ # User modifiable task configuration.
65
+ sig { returns(T.nilable(DockerEngineAPI::Spec)) }
66
+ attr_reader :task_template
67
+
68
+ sig { params(task_template: DockerEngineAPI::Spec::OrHash).void }
69
+ attr_writer :task_template
70
+
71
+ # Specification for the update strategy of the service.
72
+ sig { returns(T.nilable(DockerEngineAPI::Spec::UpdateConfig)) }
73
+ attr_reader :update_config
74
+
75
+ sig do
76
+ params(update_config: DockerEngineAPI::Spec::UpdateConfig::OrHash).void
77
+ end
78
+ attr_writer :update_config
79
+
80
+ # User modifiable configuration for a service.
81
+ sig do
82
+ params(
83
+ endpoint_spec: DockerEngineAPI::Spec::EndpointSpec::OrHash,
84
+ labels: T::Hash[Symbol, String],
85
+ mode: DockerEngineAPI::Spec::Mode::OrHash,
86
+ name: String,
87
+ networks: T::Array[DockerEngineAPI::Spec::Network::OrHash],
88
+ rollback_config: DockerEngineAPI::Spec::RollbackConfig::OrHash,
89
+ task_template: DockerEngineAPI::Spec::OrHash,
90
+ update_config: DockerEngineAPI::Spec::UpdateConfig::OrHash
91
+ ).returns(T.attached_class)
92
+ end
93
+ def self.new(
94
+ # Properties that can be configured to access and load balance a service.
95
+ endpoint_spec: nil,
96
+ # User-defined key/value metadata.
97
+ labels: nil,
98
+ # Scheduling mode for the service.
99
+ mode: nil,
100
+ # Name of the service.
101
+ name: nil,
102
+ # Specifies which networks the service should attach to.
103
+ #
104
+ # Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec
105
+ # should be used instead.
106
+ networks: nil,
107
+ # Specification for the rollback strategy of the service.
108
+ rollback_config: nil,
109
+ # User modifiable task configuration.
110
+ task_template: nil,
111
+ # Specification for the update strategy of the service.
112
+ update_config: nil
113
+ )
114
+ end
115
+
116
+ sig do
117
+ override.returns(
118
+ {
119
+ endpoint_spec: DockerEngineAPI::Spec::EndpointSpec,
120
+ labels: T::Hash[Symbol, String],
121
+ mode: DockerEngineAPI::Spec::Mode,
122
+ name: String,
123
+ networks: T::Array[DockerEngineAPI::Spec::Network],
124
+ rollback_config: DockerEngineAPI::Spec::RollbackConfig,
125
+ task_template: DockerEngineAPI::Spec,
126
+ update_config: DockerEngineAPI::Spec::UpdateConfig
127
+ }
128
+ )
129
+ end
130
+ def to_hash
131
+ end
132
+
133
+ class EndpointSpec < DockerEngineAPI::Internal::Type::BaseModel
134
+ OrHash =
135
+ T.type_alias do
136
+ T.any(
137
+ DockerEngineAPI::Spec::EndpointSpec,
138
+ DockerEngineAPI::Internal::AnyHash
139
+ )
140
+ end
141
+
142
+ # The mode of resolution to use for internal load balancing between tasks.
143
+ sig do
144
+ returns(
145
+ T.nilable(DockerEngineAPI::Spec::EndpointSpec::Mode::OrSymbol)
146
+ )
147
+ end
148
+ attr_reader :mode
149
+
150
+ sig do
151
+ params(mode: DockerEngineAPI::Spec::EndpointSpec::Mode::OrSymbol).void
152
+ end
153
+ attr_writer :mode
154
+
155
+ # List of exposed ports that this service is accessible on from the outside. Ports
156
+ # can only be provided if `vip` resolution mode is used.
157
+ sig do
158
+ returns(
159
+ T.nilable(T::Array[DockerEngineAPI::Spec::EndpointSpec::Port])
160
+ )
161
+ end
162
+ attr_reader :ports
163
+
164
+ sig do
165
+ params(
166
+ ports: T::Array[DockerEngineAPI::Spec::EndpointSpec::Port::OrHash]
167
+ ).void
168
+ end
169
+ attr_writer :ports
170
+
171
+ # Properties that can be configured to access and load balance a service.
172
+ sig do
173
+ params(
174
+ mode: DockerEngineAPI::Spec::EndpointSpec::Mode::OrSymbol,
175
+ ports: T::Array[DockerEngineAPI::Spec::EndpointSpec::Port::OrHash]
176
+ ).returns(T.attached_class)
177
+ end
178
+ def self.new(
179
+ # The mode of resolution to use for internal load balancing between tasks.
180
+ mode: nil,
181
+ # List of exposed ports that this service is accessible on from the outside. Ports
182
+ # can only be provided if `vip` resolution mode is used.
183
+ ports: nil
184
+ )
185
+ end
186
+
187
+ sig do
188
+ override.returns(
189
+ {
190
+ mode: DockerEngineAPI::Spec::EndpointSpec::Mode::OrSymbol,
191
+ ports: T::Array[DockerEngineAPI::Spec::EndpointSpec::Port]
192
+ }
193
+ )
194
+ end
195
+ def to_hash
196
+ end
197
+
198
+ # The mode of resolution to use for internal load balancing between tasks.
199
+ module Mode
200
+ extend DockerEngineAPI::Internal::Type::Enum
201
+
202
+ TaggedSymbol =
203
+ T.type_alias do
204
+ T.all(Symbol, DockerEngineAPI::Spec::EndpointSpec::Mode)
205
+ end
206
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
207
+
208
+ VIP =
209
+ T.let(:vip, DockerEngineAPI::Spec::EndpointSpec::Mode::TaggedSymbol)
210
+ DNSRR =
211
+ T.let(
212
+ :dnsrr,
213
+ DockerEngineAPI::Spec::EndpointSpec::Mode::TaggedSymbol
214
+ )
215
+
216
+ sig do
217
+ override.returns(
218
+ T::Array[DockerEngineAPI::Spec::EndpointSpec::Mode::TaggedSymbol]
219
+ )
220
+ end
221
+ def self.values
222
+ end
223
+ end
224
+
225
+ class Port < DockerEngineAPI::Internal::Type::BaseModel
226
+ OrHash =
227
+ T.type_alias do
228
+ T.any(
229
+ DockerEngineAPI::Spec::EndpointSpec::Port,
230
+ DockerEngineAPI::Internal::AnyHash
231
+ )
232
+ end
233
+
234
+ sig { returns(T.nilable(String)) }
235
+ attr_reader :name
236
+
237
+ sig { params(name: String).void }
238
+ attr_writer :name
239
+
240
+ sig do
241
+ returns(
242
+ T.nilable(
243
+ DockerEngineAPI::Spec::EndpointSpec::Port::Protocol::OrSymbol
244
+ )
245
+ )
246
+ end
247
+ attr_reader :protocol
248
+
249
+ sig do
250
+ params(
251
+ protocol:
252
+ DockerEngineAPI::Spec::EndpointSpec::Port::Protocol::OrSymbol
253
+ ).void
254
+ end
255
+ attr_writer :protocol
256
+
257
+ # The port on the swarm hosts.
258
+ sig { returns(T.nilable(Integer)) }
259
+ attr_reader :published_port
260
+
261
+ sig { params(published_port: Integer).void }
262
+ attr_writer :published_port
263
+
264
+ # The mode in which port is published.
265
+ #
266
+ # <p><br /></p>
267
+ #
268
+ # - "ingress" makes the target port accessible on every node, regardless of
269
+ # whether there is a task for the service running on that node or not.
270
+ # - "host" bypasses the routing mesh and publish the port directly on the swarm
271
+ # node where that service is running.
272
+ sig do
273
+ returns(
274
+ T.nilable(
275
+ DockerEngineAPI::Spec::EndpointSpec::Port::PublishMode::OrSymbol
276
+ )
277
+ )
278
+ end
279
+ attr_reader :publish_mode
280
+
281
+ sig do
282
+ params(
283
+ publish_mode:
284
+ DockerEngineAPI::Spec::EndpointSpec::Port::PublishMode::OrSymbol
285
+ ).void
286
+ end
287
+ attr_writer :publish_mode
288
+
289
+ # The port inside the container.
290
+ sig { returns(T.nilable(Integer)) }
291
+ attr_reader :target_port
292
+
293
+ sig { params(target_port: Integer).void }
294
+ attr_writer :target_port
295
+
296
+ sig do
297
+ params(
298
+ name: String,
299
+ protocol:
300
+ DockerEngineAPI::Spec::EndpointSpec::Port::Protocol::OrSymbol,
301
+ published_port: Integer,
302
+ publish_mode:
303
+ DockerEngineAPI::Spec::EndpointSpec::Port::PublishMode::OrSymbol,
304
+ target_port: Integer
305
+ ).returns(T.attached_class)
306
+ end
307
+ def self.new(
308
+ name: nil,
309
+ protocol: nil,
310
+ # The port on the swarm hosts.
311
+ published_port: nil,
312
+ # The mode in which port is published.
313
+ #
314
+ # <p><br /></p>
315
+ #
316
+ # - "ingress" makes the target port accessible on every node, regardless of
317
+ # whether there is a task for the service running on that node or not.
318
+ # - "host" bypasses the routing mesh and publish the port directly on the swarm
319
+ # node where that service is running.
320
+ publish_mode: nil,
321
+ # The port inside the container.
322
+ target_port: nil
323
+ )
324
+ end
325
+
326
+ sig do
327
+ override.returns(
328
+ {
329
+ name: String,
330
+ protocol:
331
+ DockerEngineAPI::Spec::EndpointSpec::Port::Protocol::OrSymbol,
332
+ published_port: Integer,
333
+ publish_mode:
334
+ DockerEngineAPI::Spec::EndpointSpec::Port::PublishMode::OrSymbol,
335
+ target_port: Integer
336
+ }
337
+ )
338
+ end
339
+ def to_hash
340
+ end
341
+
342
+ module Protocol
343
+ extend DockerEngineAPI::Internal::Type::Enum
344
+
345
+ TaggedSymbol =
346
+ T.type_alias do
347
+ T.all(
348
+ Symbol,
349
+ DockerEngineAPI::Spec::EndpointSpec::Port::Protocol
350
+ )
351
+ end
352
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
353
+
354
+ TCP =
355
+ T.let(
356
+ :tcp,
357
+ DockerEngineAPI::Spec::EndpointSpec::Port::Protocol::TaggedSymbol
358
+ )
359
+ UDP =
360
+ T.let(
361
+ :udp,
362
+ DockerEngineAPI::Spec::EndpointSpec::Port::Protocol::TaggedSymbol
363
+ )
364
+ SCTP =
365
+ T.let(
366
+ :sctp,
367
+ DockerEngineAPI::Spec::EndpointSpec::Port::Protocol::TaggedSymbol
368
+ )
369
+
370
+ sig do
371
+ override.returns(
372
+ T::Array[
373
+ DockerEngineAPI::Spec::EndpointSpec::Port::Protocol::TaggedSymbol
374
+ ]
375
+ )
376
+ end
377
+ def self.values
378
+ end
379
+ end
380
+
381
+ # The mode in which port is published.
382
+ #
383
+ # <p><br /></p>
384
+ #
385
+ # - "ingress" makes the target port accessible on every node, regardless of
386
+ # whether there is a task for the service running on that node or not.
387
+ # - "host" bypasses the routing mesh and publish the port directly on the swarm
388
+ # node where that service is running.
389
+ module PublishMode
390
+ extend DockerEngineAPI::Internal::Type::Enum
391
+
392
+ TaggedSymbol =
393
+ T.type_alias do
394
+ T.all(
395
+ Symbol,
396
+ DockerEngineAPI::Spec::EndpointSpec::Port::PublishMode
397
+ )
398
+ end
399
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
400
+
401
+ INGRESS =
402
+ T.let(
403
+ :ingress,
404
+ DockerEngineAPI::Spec::EndpointSpec::Port::PublishMode::TaggedSymbol
405
+ )
406
+ HOST =
407
+ T.let(
408
+ :host,
409
+ DockerEngineAPI::Spec::EndpointSpec::Port::PublishMode::TaggedSymbol
410
+ )
411
+
412
+ sig do
413
+ override.returns(
414
+ T::Array[
415
+ DockerEngineAPI::Spec::EndpointSpec::Port::PublishMode::TaggedSymbol
416
+ ]
417
+ )
418
+ end
419
+ def self.values
420
+ end
421
+ end
422
+ end
423
+ end
424
+
425
+ class Mode < DockerEngineAPI::Internal::Type::BaseModel
426
+ OrHash =
427
+ T.type_alias do
428
+ T.any(
429
+ DockerEngineAPI::Spec::Mode,
430
+ DockerEngineAPI::Internal::AnyHash
431
+ )
432
+ end
433
+
434
+ sig { returns(T.nilable(T.anything)) }
435
+ attr_reader :global
436
+
437
+ sig { params(global: T.anything).void }
438
+ attr_writer :global
439
+
440
+ # The mode used for services which run a task to the completed state on each valid
441
+ # node.
442
+ sig { returns(T.nilable(T.anything)) }
443
+ attr_reader :global_job
444
+
445
+ sig { params(global_job: T.anything).void }
446
+ attr_writer :global_job
447
+
448
+ sig { returns(T.nilable(DockerEngineAPI::Spec::Mode::Replicated)) }
449
+ attr_reader :replicated
450
+
451
+ sig do
452
+ params(
453
+ replicated: DockerEngineAPI::Spec::Mode::Replicated::OrHash
454
+ ).void
455
+ end
456
+ attr_writer :replicated
457
+
458
+ # The mode used for services with a finite number of tasks that run to a completed
459
+ # state.
460
+ sig { returns(T.nilable(DockerEngineAPI::Spec::Mode::ReplicatedJob)) }
461
+ attr_reader :replicated_job
462
+
463
+ sig do
464
+ params(
465
+ replicated_job: DockerEngineAPI::Spec::Mode::ReplicatedJob::OrHash
466
+ ).void
467
+ end
468
+ attr_writer :replicated_job
469
+
470
+ # Scheduling mode for the service.
471
+ sig do
472
+ params(
473
+ global: T.anything,
474
+ global_job: T.anything,
475
+ replicated: DockerEngineAPI::Spec::Mode::Replicated::OrHash,
476
+ replicated_job: DockerEngineAPI::Spec::Mode::ReplicatedJob::OrHash
477
+ ).returns(T.attached_class)
478
+ end
479
+ def self.new(
480
+ global: nil,
481
+ # The mode used for services which run a task to the completed state on each valid
482
+ # node.
483
+ global_job: nil,
484
+ replicated: nil,
485
+ # The mode used for services with a finite number of tasks that run to a completed
486
+ # state.
487
+ replicated_job: nil
488
+ )
489
+ end
490
+
491
+ sig do
492
+ override.returns(
493
+ {
494
+ global: T.anything,
495
+ global_job: T.anything,
496
+ replicated: DockerEngineAPI::Spec::Mode::Replicated,
497
+ replicated_job: DockerEngineAPI::Spec::Mode::ReplicatedJob
498
+ }
499
+ )
500
+ end
501
+ def to_hash
502
+ end
503
+
504
+ class Replicated < DockerEngineAPI::Internal::Type::BaseModel
505
+ OrHash =
506
+ T.type_alias do
507
+ T.any(
508
+ DockerEngineAPI::Spec::Mode::Replicated,
509
+ DockerEngineAPI::Internal::AnyHash
510
+ )
511
+ end
512
+
513
+ sig { returns(T.nilable(Integer)) }
514
+ attr_reader :replicas
515
+
516
+ sig { params(replicas: Integer).void }
517
+ attr_writer :replicas
518
+
519
+ sig { params(replicas: Integer).returns(T.attached_class) }
520
+ def self.new(replicas: nil)
521
+ end
522
+
523
+ sig { override.returns({ replicas: Integer }) }
524
+ def to_hash
525
+ end
526
+ end
527
+
528
+ class ReplicatedJob < DockerEngineAPI::Internal::Type::BaseModel
529
+ OrHash =
530
+ T.type_alias do
531
+ T.any(
532
+ DockerEngineAPI::Spec::Mode::ReplicatedJob,
533
+ DockerEngineAPI::Internal::AnyHash
534
+ )
535
+ end
536
+
537
+ # The maximum number of replicas to run simultaneously.
538
+ sig { returns(T.nilable(Integer)) }
539
+ attr_reader :max_concurrent
540
+
541
+ sig { params(max_concurrent: Integer).void }
542
+ attr_writer :max_concurrent
543
+
544
+ # The total number of replicas desired to reach the Completed state. If unset,
545
+ # will default to the value of `MaxConcurrent`
546
+ sig { returns(T.nilable(Integer)) }
547
+ attr_reader :total_completions
548
+
549
+ sig { params(total_completions: Integer).void }
550
+ attr_writer :total_completions
551
+
552
+ # The mode used for services with a finite number of tasks that run to a completed
553
+ # state.
554
+ sig do
555
+ params(max_concurrent: Integer, total_completions: Integer).returns(
556
+ T.attached_class
557
+ )
558
+ end
559
+ def self.new(
560
+ # The maximum number of replicas to run simultaneously.
561
+ max_concurrent: nil,
562
+ # The total number of replicas desired to reach the Completed state. If unset,
563
+ # will default to the value of `MaxConcurrent`
564
+ total_completions: nil
565
+ )
566
+ end
567
+
568
+ sig do
569
+ override.returns(
570
+ { max_concurrent: Integer, total_completions: Integer }
571
+ )
572
+ end
573
+ def to_hash
574
+ end
575
+ end
576
+ end
577
+
578
+ class Network < DockerEngineAPI::Internal::Type::BaseModel
579
+ OrHash =
580
+ T.type_alias do
581
+ T.any(
582
+ DockerEngineAPI::Spec::Network,
583
+ DockerEngineAPI::Internal::AnyHash
584
+ )
585
+ end
586
+
587
+ # Discoverable alternate names for the service on this network.
588
+ sig { returns(T.nilable(T::Array[String])) }
589
+ attr_reader :aliases
590
+
591
+ sig { params(aliases: T::Array[String]).void }
592
+ attr_writer :aliases
593
+
594
+ # Driver attachment options for the network target.
595
+ sig { returns(T.nilable(T::Hash[Symbol, String])) }
596
+ attr_reader :driver_opts
597
+
598
+ sig { params(driver_opts: T::Hash[Symbol, String]).void }
599
+ attr_writer :driver_opts
600
+
601
+ # The target network for attachment. Must be a network name or ID.
602
+ sig { returns(T.nilable(String)) }
603
+ attr_reader :target
604
+
605
+ sig { params(target: String).void }
606
+ attr_writer :target
607
+
608
+ # Specifies how a service should be attached to a particular network.
609
+ sig do
610
+ params(
611
+ aliases: T::Array[String],
612
+ driver_opts: T::Hash[Symbol, String],
613
+ target: String
614
+ ).returns(T.attached_class)
615
+ end
616
+ def self.new(
617
+ # Discoverable alternate names for the service on this network.
618
+ aliases: nil,
619
+ # Driver attachment options for the network target.
620
+ driver_opts: nil,
621
+ # The target network for attachment. Must be a network name or ID.
622
+ target: nil
623
+ )
624
+ end
625
+
626
+ sig do
627
+ override.returns(
628
+ {
629
+ aliases: T::Array[String],
630
+ driver_opts: T::Hash[Symbol, String],
631
+ target: String
632
+ }
633
+ )
634
+ end
635
+ def to_hash
636
+ end
637
+ end
638
+
639
+ class RollbackConfig < DockerEngineAPI::Internal::Type::BaseModel
640
+ OrHash =
641
+ T.type_alias do
642
+ T.any(
643
+ DockerEngineAPI::Spec::RollbackConfig,
644
+ DockerEngineAPI::Internal::AnyHash
645
+ )
646
+ end
647
+
648
+ # Amount of time between rollback iterations, in nanoseconds.
649
+ sig { returns(T.nilable(Integer)) }
650
+ attr_reader :delay
651
+
652
+ sig { params(delay: Integer).void }
653
+ attr_writer :delay
654
+
655
+ # Action to take if an rolled back task fails to run, or stops running during the
656
+ # rollback.
657
+ sig do
658
+ returns(
659
+ T.nilable(
660
+ DockerEngineAPI::Spec::RollbackConfig::FailureAction::OrSymbol
661
+ )
662
+ )
663
+ end
664
+ attr_reader :failure_action
665
+
666
+ sig do
667
+ params(
668
+ failure_action:
669
+ DockerEngineAPI::Spec::RollbackConfig::FailureAction::OrSymbol
670
+ ).void
671
+ end
672
+ attr_writer :failure_action
673
+
674
+ # The fraction of tasks that may fail during a rollback before the failure action
675
+ # is invoked, specified as a floating point number between 0 and 1.
676
+ sig { returns(T.nilable(Float)) }
677
+ attr_reader :max_failure_ratio
678
+
679
+ sig { params(max_failure_ratio: Float).void }
680
+ attr_writer :max_failure_ratio
681
+
682
+ # Amount of time to monitor each rolled back task for failures, in nanoseconds.
683
+ sig { returns(T.nilable(Integer)) }
684
+ attr_reader :monitor
685
+
686
+ sig { params(monitor: Integer).void }
687
+ attr_writer :monitor
688
+
689
+ # The order of operations when rolling back a task. Either the old task is shut
690
+ # down before the new task is started, or the new task is started before the old
691
+ # task is shut down.
692
+ sig do
693
+ returns(
694
+ T.nilable(DockerEngineAPI::Spec::RollbackConfig::Order::OrSymbol)
695
+ )
696
+ end
697
+ attr_reader :order
698
+
699
+ sig do
700
+ params(
701
+ order: DockerEngineAPI::Spec::RollbackConfig::Order::OrSymbol
702
+ ).void
703
+ end
704
+ attr_writer :order
705
+
706
+ # Maximum number of tasks to be rolled back in one iteration (0 means unlimited
707
+ # parallelism).
708
+ sig { returns(T.nilable(Integer)) }
709
+ attr_reader :parallelism
710
+
711
+ sig { params(parallelism: Integer).void }
712
+ attr_writer :parallelism
713
+
714
+ # Specification for the rollback strategy of the service.
715
+ sig do
716
+ params(
717
+ delay: Integer,
718
+ failure_action:
719
+ DockerEngineAPI::Spec::RollbackConfig::FailureAction::OrSymbol,
720
+ max_failure_ratio: Float,
721
+ monitor: Integer,
722
+ order: DockerEngineAPI::Spec::RollbackConfig::Order::OrSymbol,
723
+ parallelism: Integer
724
+ ).returns(T.attached_class)
725
+ end
726
+ def self.new(
727
+ # Amount of time between rollback iterations, in nanoseconds.
728
+ delay: nil,
729
+ # Action to take if an rolled back task fails to run, or stops running during the
730
+ # rollback.
731
+ failure_action: nil,
732
+ # The fraction of tasks that may fail during a rollback before the failure action
733
+ # is invoked, specified as a floating point number between 0 and 1.
734
+ max_failure_ratio: nil,
735
+ # Amount of time to monitor each rolled back task for failures, in nanoseconds.
736
+ monitor: nil,
737
+ # The order of operations when rolling back a task. Either the old task is shut
738
+ # down before the new task is started, or the new task is started before the old
739
+ # task is shut down.
740
+ order: nil,
741
+ # Maximum number of tasks to be rolled back in one iteration (0 means unlimited
742
+ # parallelism).
743
+ parallelism: nil
744
+ )
745
+ end
746
+
747
+ sig do
748
+ override.returns(
749
+ {
750
+ delay: Integer,
751
+ failure_action:
752
+ DockerEngineAPI::Spec::RollbackConfig::FailureAction::OrSymbol,
753
+ max_failure_ratio: Float,
754
+ monitor: Integer,
755
+ order: DockerEngineAPI::Spec::RollbackConfig::Order::OrSymbol,
756
+ parallelism: Integer
757
+ }
758
+ )
759
+ end
760
+ def to_hash
761
+ end
762
+
763
+ # Action to take if an rolled back task fails to run, or stops running during the
764
+ # rollback.
765
+ module FailureAction
766
+ extend DockerEngineAPI::Internal::Type::Enum
767
+
768
+ TaggedSymbol =
769
+ T.type_alias do
770
+ T.all(
771
+ Symbol,
772
+ DockerEngineAPI::Spec::RollbackConfig::FailureAction
773
+ )
774
+ end
775
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
776
+
777
+ CONTINUE =
778
+ T.let(
779
+ :continue,
780
+ DockerEngineAPI::Spec::RollbackConfig::FailureAction::TaggedSymbol
781
+ )
782
+ PAUSE =
783
+ T.let(
784
+ :pause,
785
+ DockerEngineAPI::Spec::RollbackConfig::FailureAction::TaggedSymbol
786
+ )
787
+
788
+ sig do
789
+ override.returns(
790
+ T::Array[
791
+ DockerEngineAPI::Spec::RollbackConfig::FailureAction::TaggedSymbol
792
+ ]
793
+ )
794
+ end
795
+ def self.values
796
+ end
797
+ end
798
+
799
+ # The order of operations when rolling back a task. Either the old task is shut
800
+ # down before the new task is started, or the new task is started before the old
801
+ # task is shut down.
802
+ module Order
803
+ extend DockerEngineAPI::Internal::Type::Enum
804
+
805
+ TaggedSymbol =
806
+ T.type_alias do
807
+ T.all(Symbol, DockerEngineAPI::Spec::RollbackConfig::Order)
808
+ end
809
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
810
+
811
+ STOP_FIRST =
812
+ T.let(
813
+ :"stop-first",
814
+ DockerEngineAPI::Spec::RollbackConfig::Order::TaggedSymbol
815
+ )
816
+ START_FIRST =
817
+ T.let(
818
+ :"start-first",
819
+ DockerEngineAPI::Spec::RollbackConfig::Order::TaggedSymbol
820
+ )
821
+
822
+ sig do
823
+ override.returns(
824
+ T::Array[
825
+ DockerEngineAPI::Spec::RollbackConfig::Order::TaggedSymbol
826
+ ]
827
+ )
828
+ end
829
+ def self.values
830
+ end
831
+ end
832
+ end
833
+
834
+ class UpdateConfig < DockerEngineAPI::Internal::Type::BaseModel
835
+ OrHash =
836
+ T.type_alias do
837
+ T.any(
838
+ DockerEngineAPI::Spec::UpdateConfig,
839
+ DockerEngineAPI::Internal::AnyHash
840
+ )
841
+ end
842
+
843
+ # Amount of time between updates, in nanoseconds.
844
+ sig { returns(T.nilable(Integer)) }
845
+ attr_reader :delay
846
+
847
+ sig { params(delay: Integer).void }
848
+ attr_writer :delay
849
+
850
+ # Action to take if an updated task fails to run, or stops running during the
851
+ # update.
852
+ sig do
853
+ returns(
854
+ T.nilable(
855
+ DockerEngineAPI::Spec::UpdateConfig::FailureAction::OrSymbol
856
+ )
857
+ )
858
+ end
859
+ attr_reader :failure_action
860
+
861
+ sig do
862
+ params(
863
+ failure_action:
864
+ DockerEngineAPI::Spec::UpdateConfig::FailureAction::OrSymbol
865
+ ).void
866
+ end
867
+ attr_writer :failure_action
868
+
869
+ # The fraction of tasks that may fail during an update before the failure action
870
+ # is invoked, specified as a floating point number between 0 and 1.
871
+ sig { returns(T.nilable(Float)) }
872
+ attr_reader :max_failure_ratio
873
+
874
+ sig { params(max_failure_ratio: Float).void }
875
+ attr_writer :max_failure_ratio
876
+
877
+ # Amount of time to monitor each updated task for failures, in nanoseconds.
878
+ sig { returns(T.nilable(Integer)) }
879
+ attr_reader :monitor
880
+
881
+ sig { params(monitor: Integer).void }
882
+ attr_writer :monitor
883
+
884
+ # The order of operations when rolling out an updated task. Either the old task is
885
+ # shut down before the new task is started, or the new task is started before the
886
+ # old task is shut down.
887
+ sig do
888
+ returns(
889
+ T.nilable(DockerEngineAPI::Spec::UpdateConfig::Order::OrSymbol)
890
+ )
891
+ end
892
+ attr_reader :order
893
+
894
+ sig do
895
+ params(
896
+ order: DockerEngineAPI::Spec::UpdateConfig::Order::OrSymbol
897
+ ).void
898
+ end
899
+ attr_writer :order
900
+
901
+ # Maximum number of tasks to be updated in one iteration (0 means unlimited
902
+ # parallelism).
903
+ sig { returns(T.nilable(Integer)) }
904
+ attr_reader :parallelism
905
+
906
+ sig { params(parallelism: Integer).void }
907
+ attr_writer :parallelism
908
+
909
+ # Specification for the update strategy of the service.
910
+ sig do
911
+ params(
912
+ delay: Integer,
913
+ failure_action:
914
+ DockerEngineAPI::Spec::UpdateConfig::FailureAction::OrSymbol,
915
+ max_failure_ratio: Float,
916
+ monitor: Integer,
917
+ order: DockerEngineAPI::Spec::UpdateConfig::Order::OrSymbol,
918
+ parallelism: Integer
919
+ ).returns(T.attached_class)
920
+ end
921
+ def self.new(
922
+ # Amount of time between updates, in nanoseconds.
923
+ delay: nil,
924
+ # Action to take if an updated task fails to run, or stops running during the
925
+ # update.
926
+ failure_action: nil,
927
+ # The fraction of tasks that may fail during an update before the failure action
928
+ # is invoked, specified as a floating point number between 0 and 1.
929
+ max_failure_ratio: nil,
930
+ # Amount of time to monitor each updated task for failures, in nanoseconds.
931
+ monitor: nil,
932
+ # The order of operations when rolling out an updated task. Either the old task is
933
+ # shut down before the new task is started, or the new task is started before the
934
+ # old task is shut down.
935
+ order: nil,
936
+ # Maximum number of tasks to be updated in one iteration (0 means unlimited
937
+ # parallelism).
938
+ parallelism: nil
939
+ )
940
+ end
941
+
942
+ sig do
943
+ override.returns(
944
+ {
945
+ delay: Integer,
946
+ failure_action:
947
+ DockerEngineAPI::Spec::UpdateConfig::FailureAction::OrSymbol,
948
+ max_failure_ratio: Float,
949
+ monitor: Integer,
950
+ order: DockerEngineAPI::Spec::UpdateConfig::Order::OrSymbol,
951
+ parallelism: Integer
952
+ }
953
+ )
954
+ end
955
+ def to_hash
956
+ end
957
+
958
+ # Action to take if an updated task fails to run, or stops running during the
959
+ # update.
960
+ module FailureAction
961
+ extend DockerEngineAPI::Internal::Type::Enum
962
+
963
+ TaggedSymbol =
964
+ T.type_alias do
965
+ T.all(Symbol, DockerEngineAPI::Spec::UpdateConfig::FailureAction)
966
+ end
967
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
968
+
969
+ CONTINUE =
970
+ T.let(
971
+ :continue,
972
+ DockerEngineAPI::Spec::UpdateConfig::FailureAction::TaggedSymbol
973
+ )
974
+ PAUSE =
975
+ T.let(
976
+ :pause,
977
+ DockerEngineAPI::Spec::UpdateConfig::FailureAction::TaggedSymbol
978
+ )
979
+ ROLLBACK =
980
+ T.let(
981
+ :rollback,
982
+ DockerEngineAPI::Spec::UpdateConfig::FailureAction::TaggedSymbol
983
+ )
984
+
985
+ sig do
986
+ override.returns(
987
+ T::Array[
988
+ DockerEngineAPI::Spec::UpdateConfig::FailureAction::TaggedSymbol
989
+ ]
990
+ )
991
+ end
992
+ def self.values
993
+ end
994
+ end
995
+
996
+ # The order of operations when rolling out an updated task. Either the old task is
997
+ # shut down before the new task is started, or the new task is started before the
998
+ # old task is shut down.
999
+ module Order
1000
+ extend DockerEngineAPI::Internal::Type::Enum
1001
+
1002
+ TaggedSymbol =
1003
+ T.type_alias do
1004
+ T.all(Symbol, DockerEngineAPI::Spec::UpdateConfig::Order)
1005
+ end
1006
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1007
+
1008
+ STOP_FIRST =
1009
+ T.let(
1010
+ :"stop-first",
1011
+ DockerEngineAPI::Spec::UpdateConfig::Order::TaggedSymbol
1012
+ )
1013
+ START_FIRST =
1014
+ T.let(
1015
+ :"start-first",
1016
+ DockerEngineAPI::Spec::UpdateConfig::Order::TaggedSymbol
1017
+ )
1018
+
1019
+ sig do
1020
+ override.returns(
1021
+ T::Array[DockerEngineAPI::Spec::UpdateConfig::Order::TaggedSymbol]
1022
+ )
1023
+ end
1024
+ def self.values
1025
+ end
1026
+ end
1027
+ end
1028
+ end
1029
+ end
1030
+ end