ionoscloud 5.0.0 → 6.0.0.beta.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (594) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -5
  3. data/docs/AttachedVolumes.md +30 -0
  4. data/docs/BackupUnit.md +26 -0
  5. data/docs/BackupUnitProperties.md +22 -0
  6. data/docs/BackupUnitSSO.md +18 -0
  7. data/docs/BackupUnits.md +24 -0
  8. data/docs/BackupUnitsApi.md +594 -0
  9. data/docs/BalancedNics.md +30 -0
  10. data/docs/CHANGELOG.md +1 -0
  11. data/docs/Cdroms.md +30 -0
  12. data/docs/ConnectableDatacenter.md +22 -0
  13. data/docs/Contract.md +20 -0
  14. data/docs/ContractProperties.md +26 -0
  15. data/docs/ContractResourcesApi.md +89 -0
  16. data/docs/Contracts.md +24 -0
  17. data/docs/CpuArchitectureProperties.md +24 -0
  18. data/docs/DataCenterEntities.md +28 -0
  19. data/docs/DataCentersApi.md +516 -0
  20. data/docs/Datacenter.md +28 -0
  21. data/docs/DatacenterElementMetadata.md +32 -0
  22. data/docs/DatacenterProperties.md +30 -0
  23. data/docs/Datacenters.md +30 -0
  24. data/docs/DefaultApi.md +78 -0
  25. data/docs/Error.md +20 -0
  26. data/docs/ErrorMessage.md +20 -0
  27. data/docs/FirewallRule.md +26 -0
  28. data/docs/FirewallRules.md +30 -0
  29. data/docs/FirewallRulesApi.md +552 -0
  30. data/docs/FirewallruleProperties.md +36 -0
  31. data/docs/FlowLog.md +26 -0
  32. data/docs/FlowLogProperties.md +24 -0
  33. data/docs/FlowLogPut.md +24 -0
  34. data/docs/FlowLogs.md +30 -0
  35. data/docs/FlowLogsApi.md +540 -0
  36. data/docs/Group.md +26 -0
  37. data/docs/GroupEntities.md +20 -0
  38. data/docs/GroupMembers.md +24 -0
  39. data/docs/GroupProperties.md +42 -0
  40. data/docs/GroupShare.md +24 -0
  41. data/docs/GroupShareProperties.md +20 -0
  42. data/docs/GroupShares.md +24 -0
  43. data/docs/GroupUsers.md +24 -0
  44. data/docs/Groups.md +24 -0
  45. data/docs/IPBlocksApi.md +512 -0
  46. data/docs/IPFailover.md +20 -0
  47. data/docs/Image.md +26 -0
  48. data/docs/ImageProperties.md +54 -0
  49. data/docs/Images.md +24 -0
  50. data/docs/ImagesApi.md +428 -0
  51. data/docs/Info.md +22 -0
  52. data/docs/IpBlock.md +26 -0
  53. data/docs/IpBlockProperties.md +26 -0
  54. data/docs/IpBlocks.md +24 -0
  55. data/docs/IpConsumer.md +34 -0
  56. data/docs/KubernetesApi.md +1433 -0
  57. data/docs/KubernetesAutoScaling.md +20 -0
  58. data/docs/KubernetesCluster.md +28 -0
  59. data/docs/KubernetesClusterEntities.md +18 -0
  60. data/docs/KubernetesClusterForPost.md +28 -0
  61. data/docs/KubernetesClusterForPut.md +28 -0
  62. data/docs/KubernetesClusterProperties.md +30 -0
  63. data/docs/KubernetesClusterPropertiesForPost.md +26 -0
  64. data/docs/KubernetesClusterPropertiesForPut.md +22 -0
  65. data/docs/KubernetesClusters.md +24 -0
  66. data/docs/KubernetesMaintenanceWindow.md +20 -0
  67. data/docs/KubernetesNode.md +26 -0
  68. data/docs/KubernetesNodeMetadata.md +26 -0
  69. data/docs/KubernetesNodePool.md +26 -0
  70. data/docs/KubernetesNodePoolForPost.md +26 -0
  71. data/docs/KubernetesNodePoolForPut.md +26 -0
  72. data/docs/KubernetesNodePoolLan.md +22 -0
  73. data/docs/KubernetesNodePoolLanRoutes.md +20 -0
  74. data/docs/KubernetesNodePoolProperties.md +50 -0
  75. data/docs/KubernetesNodePoolPropertiesForPost.md +48 -0
  76. data/docs/KubernetesNodePoolPropertiesForPut.md +34 -0
  77. data/docs/KubernetesNodePools.md +24 -0
  78. data/docs/KubernetesNodeProperties.md +24 -0
  79. data/docs/KubernetesNodes.md +24 -0
  80. data/docs/Label.md +26 -0
  81. data/docs/LabelProperties.md +26 -0
  82. data/docs/LabelResource.md +26 -0
  83. data/docs/LabelResourceProperties.md +20 -0
  84. data/docs/LabelResources.md +30 -0
  85. data/docs/Labels.md +24 -0
  86. data/docs/LabelsApi.md +2346 -0
  87. data/docs/Lan.md +28 -0
  88. data/docs/LanEntities.md +18 -0
  89. data/docs/LanNics.md +30 -0
  90. data/docs/LanPost.md +28 -0
  91. data/docs/LanProperties.md +24 -0
  92. data/docs/LanPropertiesPost.md +24 -0
  93. data/docs/Lans.md +30 -0
  94. data/docs/LansApi.md +794 -0
  95. data/docs/LoadBalancersApi.md +885 -0
  96. data/docs/Loadbalancer.md +28 -0
  97. data/docs/LoadbalancerEntities.md +18 -0
  98. data/docs/LoadbalancerProperties.md +22 -0
  99. data/docs/Loadbalancers.md +30 -0
  100. data/docs/Location.md +26 -0
  101. data/docs/LocationProperties.md +24 -0
  102. data/docs/Locations.md +24 -0
  103. data/docs/LocationsApi.md +259 -0
  104. data/docs/NATGatewaysApi.md +1578 -0
  105. data/docs/NatGateway.md +28 -0
  106. data/docs/NatGatewayEntities.md +20 -0
  107. data/docs/NatGatewayLanProperties.md +20 -0
  108. data/docs/NatGatewayProperties.md +22 -0
  109. data/docs/NatGatewayPut.md +24 -0
  110. data/docs/NatGatewayRule.md +26 -0
  111. data/docs/NatGatewayRuleProperties.md +30 -0
  112. data/docs/NatGatewayRuleProtocol.md +15 -0
  113. data/docs/NatGatewayRulePut.md +24 -0
  114. data/docs/NatGatewayRuleType.md +15 -0
  115. data/docs/NatGatewayRules.md +24 -0
  116. data/docs/NatGateways.md +30 -0
  117. data/docs/NetworkInterfacesApi.md +540 -0
  118. data/docs/NetworkLoadBalancer.md +28 -0
  119. data/docs/NetworkLoadBalancerEntities.md +20 -0
  120. data/docs/NetworkLoadBalancerForwardingRule.md +26 -0
  121. data/docs/NetworkLoadBalancerForwardingRuleHealthCheck.md +26 -0
  122. data/docs/NetworkLoadBalancerForwardingRuleProperties.md +30 -0
  123. data/docs/NetworkLoadBalancerForwardingRulePut.md +24 -0
  124. data/docs/NetworkLoadBalancerForwardingRuleTarget.md +24 -0
  125. data/docs/NetworkLoadBalancerForwardingRuleTargetHealthCheck.md +22 -0
  126. data/docs/NetworkLoadBalancerForwardingRules.md +30 -0
  127. data/docs/NetworkLoadBalancerProperties.md +26 -0
  128. data/docs/NetworkLoadBalancerPut.md +24 -0
  129. data/docs/NetworkLoadBalancers.md +30 -0
  130. data/docs/NetworkLoadBalancersApi.md +1590 -0
  131. data/docs/Nic.md +28 -0
  132. data/docs/NicEntities.md +20 -0
  133. data/docs/NicProperties.md +34 -0
  134. data/docs/NicPut.md +24 -0
  135. data/docs/Nics.md +30 -0
  136. data/docs/NoStateMetaData.md +30 -0
  137. data/docs/PaginationLinks.md +22 -0
  138. data/docs/Peer.md +26 -0
  139. data/docs/PrivateCrossConnect.md +26 -0
  140. data/docs/PrivateCrossConnectProperties.md +24 -0
  141. data/docs/PrivateCrossConnects.md +24 -0
  142. data/docs/PrivateCrossConnectsApi.md +430 -0
  143. data/docs/README.md +111 -0
  144. data/docs/RemoteConsoleUrl.md +18 -0
  145. data/docs/Request.md +26 -0
  146. data/docs/RequestMetadata.md +24 -0
  147. data/docs/RequestProperties.md +24 -0
  148. data/docs/RequestStatus.md +24 -0
  149. data/docs/RequestStatusMetadata.md +24 -0
  150. data/docs/RequestTarget.md +20 -0
  151. data/docs/Requests.md +30 -0
  152. data/docs/RequestsApi.md +283 -0
  153. data/docs/Resource.md +28 -0
  154. data/docs/ResourceEntities.md +18 -0
  155. data/docs/ResourceGroups.md +24 -0
  156. data/docs/ResourceLimits.md +60 -0
  157. data/docs/ResourceProperties.md +20 -0
  158. data/docs/ResourceReference.md +22 -0
  159. data/docs/Resources.md +24 -0
  160. data/docs/ResourcesUsers.md +24 -0
  161. data/docs/S3Key.md +26 -0
  162. data/docs/S3KeyMetadata.md +20 -0
  163. data/docs/S3KeyProperties.md +20 -0
  164. data/docs/S3Keys.md +24 -0
  165. data/docs/S3ObjectStorageSSO.md +18 -0
  166. data/docs/Server.md +28 -0
  167. data/docs/ServerEntities.md +22 -0
  168. data/docs/ServerProperties.md +36 -0
  169. data/docs/Servers.md +30 -0
  170. data/docs/ServersApi.md +1908 -0
  171. data/docs/Snapshot.md +26 -0
  172. data/docs/SnapshotProperties.md +48 -0
  173. data/docs/Snapshots.md +24 -0
  174. data/docs/SnapshotsApi.md +428 -0
  175. data/docs/TargetPortRange.md +20 -0
  176. data/docs/Template.md +26 -0
  177. data/docs/TemplateProperties.md +24 -0
  178. data/docs/Templates.md +24 -0
  179. data/docs/TemplatesApi.md +165 -0
  180. data/docs/Token.md +18 -0
  181. data/docs/Type.md +15 -0
  182. data/docs/User.md +28 -0
  183. data/docs/UserManagementApi.md +2033 -0
  184. data/docs/UserMetadata.md +22 -0
  185. data/docs/UserPost.md +18 -0
  186. data/docs/UserProperties.md +32 -0
  187. data/docs/UserPropertiesPost.md +32 -0
  188. data/docs/UserPropertiesPut.md +30 -0
  189. data/docs/UserPut.md +20 -0
  190. data/docs/UserS3KeysApi.md +516 -0
  191. data/docs/Users.md +24 -0
  192. data/docs/UsersEntities.md +20 -0
  193. data/docs/Volume.md +26 -0
  194. data/docs/VolumeProperties.md +54 -0
  195. data/docs/Volumes.md +30 -0
  196. data/docs/VolumesApi.md +709 -0
  197. data/docs/summary.md +395 -0
  198. data/gitbook.yaml +4 -0
  199. data/ionoscloud.gemspec +1 -1
  200. data/lib/ionoscloud.rb +68 -18
  201. data/lib/ionoscloud/api/_api.rb +1 -1
  202. data/lib/ionoscloud/api/{backup_unit_api.rb → backup_units_api.rb} +60 -60
  203. data/lib/ionoscloud/api/{contract_api.rb → contract_resources_api.rb} +12 -12
  204. data/lib/ionoscloud/api/{data_center_api.rb → data_centers_api.rb} +51 -51
  205. data/lib/ionoscloud/api/firewall_rules_api.rb +640 -0
  206. data/lib/ionoscloud/api/flow_logs_api.rb +622 -0
  207. data/lib/ionoscloud/api/{image_api.rb → images_api.rb} +40 -40
  208. data/lib/ionoscloud/api/ip_blocks_api.rb +16 -16
  209. data/lib/ionoscloud/api/kubernetes_api.rb +33 -96
  210. data/lib/ionoscloud/api/{label_api.rb → labels_api.rb} +269 -287
  211. data/lib/ionoscloud/api/{lan_api.rb → lans_api.rb} +105 -105
  212. data/lib/ionoscloud/api/{load_balancer_api.rb → load_balancers_api.rb} +153 -135
  213. data/lib/ionoscloud/api/{location_api.rb → locations_api.rb} +20 -20
  214. data/lib/ionoscloud/api/nat_gateways_api.rb +1690 -0
  215. data/lib/ionoscloud/api/network_interfaces_api.rb +604 -0
  216. data/lib/ionoscloud/api/network_load_balancers_api.rb +1708 -0
  217. data/lib/ionoscloud/api/{private_cross_connect_api.rb → private_cross_connects_api.rb} +61 -43
  218. data/lib/ionoscloud/api/{request_api.rb → requests_api.rb} +56 -32
  219. data/lib/ionoscloud/api/{server_api.rb → servers_api.rb} +535 -191
  220. data/lib/ionoscloud/api/{snapshot_api.rb → snapshots_api.rb} +46 -46
  221. data/lib/ionoscloud/api/templates_api.rb +164 -0
  222. data/lib/ionoscloud/api/user_management_api.rb +29 -524
  223. data/lib/ionoscloud/api/user_s3_keys_api.rb +517 -0
  224. data/lib/ionoscloud/api/{volume_api.rb → volumes_api.rb} +80 -80
  225. data/lib/ionoscloud/api_client.rb +19 -23
  226. data/lib/ionoscloud/api_error.rb +1 -1
  227. data/lib/ionoscloud/configuration.rb +5 -5
  228. data/lib/ionoscloud/models/attached_volumes.rb +1 -1
  229. data/lib/ionoscloud/models/backup_unit.rb +1 -1
  230. data/lib/ionoscloud/models/backup_unit_properties.rb +1 -1
  231. data/lib/ionoscloud/models/backup_unit_sso.rb +1 -1
  232. data/lib/ionoscloud/models/backup_units.rb +3 -3
  233. data/lib/ionoscloud/models/balanced_nics.rb +1 -1
  234. data/lib/ionoscloud/models/cdroms.rb +1 -1
  235. data/lib/ionoscloud/models/connectable_datacenter.rb +1 -1
  236. data/lib/ionoscloud/models/contract.rb +1 -1
  237. data/lib/ionoscloud/models/contract_properties.rb +1 -1
  238. data/lib/ionoscloud/models/contracts.rb +249 -0
  239. data/lib/ionoscloud/models/cpu_architecture_properties.rb +247 -0
  240. data/lib/ionoscloud/models/data_center_entities.rb +23 -5
  241. data/lib/ionoscloud/models/datacenter.rb +1 -1
  242. data/lib/ionoscloud/models/datacenter_element_metadata.rb +1 -1
  243. data/lib/ionoscloud/models/datacenter_properties.rb +16 -26
  244. data/lib/ionoscloud/models/datacenters.rb +1 -1
  245. data/lib/ionoscloud/models/error.rb +1 -1
  246. data/lib/ionoscloud/models/error_message.rb +1 -1
  247. data/lib/ionoscloud/models/firewall_rule.rb +1 -1
  248. data/lib/ionoscloud/models/firewall_rules.rb +1 -1
  249. data/lib/ionoscloud/models/firewallrule_properties.rb +63 -26
  250. data/lib/ionoscloud/models/flow_log.rb +260 -0
  251. data/lib/ionoscloud/models/flow_log_properties.rb +313 -0
  252. data/lib/ionoscloud/models/flow_log_put.rb +251 -0
  253. data/lib/ionoscloud/models/flow_logs.rb +278 -0
  254. data/lib/ionoscloud/models/group.rb +1 -1
  255. data/lib/ionoscloud/models/group_entities.rb +1 -1
  256. data/lib/ionoscloud/models/group_members.rb +1 -1
  257. data/lib/ionoscloud/models/group_properties.rb +35 -5
  258. data/lib/ionoscloud/models/group_share.rb +1 -1
  259. data/lib/ionoscloud/models/group_share_properties.rb +1 -1
  260. data/lib/ionoscloud/models/group_shares.rb +1 -1
  261. data/lib/ionoscloud/models/group_users.rb +1 -1
  262. data/lib/ionoscloud/models/groups.rb +1 -1
  263. data/lib/ionoscloud/models/image.rb +1 -1
  264. data/lib/ionoscloud/models/image_properties.rb +39 -5
  265. data/lib/ionoscloud/models/images.rb +1 -1
  266. data/lib/ionoscloud/models/info.rb +1 -1
  267. data/lib/ionoscloud/models/ip_block.rb +1 -1
  268. data/lib/ionoscloud/models/ip_block_properties.rb +1 -1
  269. data/lib/ionoscloud/models/ip_blocks.rb +1 -1
  270. data/lib/ionoscloud/models/ip_consumer.rb +23 -5
  271. data/lib/ionoscloud/models/ip_failover.rb +1 -1
  272. data/lib/ionoscloud/models/kubernetes_auto_scaling.rb +11 -1
  273. data/lib/ionoscloud/models/kubernetes_cluster.rb +1 -1
  274. data/lib/ionoscloud/models/kubernetes_cluster_entities.rb +1 -1
  275. data/lib/ionoscloud/models/kubernetes_cluster_for_post.rb +303 -0
  276. data/lib/ionoscloud/models/kubernetes_cluster_for_put.rb +303 -0
  277. data/lib/ionoscloud/models/kubernetes_cluster_properties.rb +27 -5
  278. data/lib/ionoscloud/models/kubernetes_cluster_properties_for_post.rb +263 -0
  279. data/lib/ionoscloud/models/{kubernetes_cluster_properties_for_post_and_put.rb → kubernetes_cluster_properties_for_put.rb} +5 -5
  280. data/lib/ionoscloud/models/kubernetes_clusters.rb +2 -2
  281. data/lib/ionoscloud/models/kubernetes_maintenance_window.rb +11 -1
  282. data/lib/ionoscloud/models/kubernetes_node.rb +3 -3
  283. data/lib/ionoscloud/models/kubernetes_node_metadata.rb +1 -1
  284. data/lib/ionoscloud/models/kubernetes_node_pool.rb +1 -1
  285. data/lib/ionoscloud/models/{kubernetes_config.rb → kubernetes_node_pool_for_post.rb} +17 -8
  286. data/lib/ionoscloud/models/kubernetes_node_pool_for_put.rb +1 -1
  287. data/lib/ionoscloud/models/kubernetes_node_pool_lan.rb +27 -5
  288. data/lib/ionoscloud/models/kubernetes_node_pool_lan_routes.rb +227 -0
  289. data/lib/ionoscloud/models/kubernetes_node_pool_properties.rb +2 -2
  290. data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_post.rb +2 -2
  291. data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_put.rb +2 -153
  292. data/lib/ionoscloud/models/kubernetes_node_pools.rb +2 -2
  293. data/lib/ionoscloud/models/kubernetes_node_properties.rb +12 -7
  294. data/lib/ionoscloud/models/kubernetes_nodes.rb +3 -3
  295. data/lib/ionoscloud/models/label.rb +1 -1
  296. data/lib/ionoscloud/models/label_properties.rb +1 -1
  297. data/lib/ionoscloud/models/label_resource.rb +1 -1
  298. data/lib/ionoscloud/models/label_resource_properties.rb +1 -1
  299. data/lib/ionoscloud/models/label_resources.rb +3 -3
  300. data/lib/ionoscloud/models/labels.rb +3 -3
  301. data/lib/ionoscloud/models/lan.rb +1 -1
  302. data/lib/ionoscloud/models/lan_entities.rb +1 -1
  303. data/lib/ionoscloud/models/lan_nics.rb +1 -1
  304. data/lib/ionoscloud/models/lan_post.rb +1 -1
  305. data/lib/ionoscloud/models/lan_properties.rb +1 -1
  306. data/lib/ionoscloud/models/lan_properties_post.rb +1 -1
  307. data/lib/ionoscloud/models/lans.rb +2 -2
  308. data/lib/ionoscloud/models/loadbalancer.rb +1 -1
  309. data/lib/ionoscloud/models/loadbalancer_entities.rb +1 -1
  310. data/lib/ionoscloud/models/loadbalancer_properties.rb +13 -30
  311. data/lib/ionoscloud/models/loadbalancers.rb +1 -1
  312. data/lib/ionoscloud/models/location.rb +1 -1
  313. data/lib/ionoscloud/models/location_properties.rb +16 -26
  314. data/lib/ionoscloud/models/locations.rb +1 -1
  315. data/lib/ionoscloud/models/nat_gateway.rb +269 -0
  316. data/lib/ionoscloud/models/nat_gateway_entities.rb +225 -0
  317. data/lib/ionoscloud/models/nat_gateway_lan_properties.rb +234 -0
  318. data/lib/ionoscloud/models/nat_gateway_properties.rb +251 -0
  319. data/lib/ionoscloud/models/nat_gateway_put.rb +251 -0
  320. data/lib/ionoscloud/models/nat_gateway_rule.rb +260 -0
  321. data/lib/ionoscloud/models/nat_gateway_rule_properties.rb +291 -0
  322. data/lib/ionoscloud/models/nat_gateway_rule_protocol.rb +39 -0
  323. data/lib/ionoscloud/models/nat_gateway_rule_put.rb +251 -0
  324. data/lib/ionoscloud/models/nat_gateway_rule_type.rb +36 -0
  325. data/lib/ionoscloud/models/nat_gateway_rules.rb +249 -0
  326. data/lib/ionoscloud/models/nat_gateways.rb +278 -0
  327. data/lib/ionoscloud/models/network_load_balancer.rb +269 -0
  328. data/lib/ionoscloud/models/network_load_balancer_entities.rb +225 -0
  329. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule.rb +260 -0
  330. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_health_check.rb +257 -0
  331. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_properties.rb +354 -0
  332. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_put.rb +251 -0
  333. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_target.rb +261 -0
  334. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_target_health_check.rb +237 -0
  335. data/lib/ionoscloud/models/network_load_balancer_forwarding_rules.rb +278 -0
  336. data/lib/ionoscloud/models/network_load_balancer_properties.rb +276 -0
  337. data/lib/ionoscloud/models/network_load_balancer_put.rb +251 -0
  338. data/lib/ionoscloud/models/network_load_balancers.rb +278 -0
  339. data/lib/ionoscloud/models/nic.rb +1 -1
  340. data/lib/ionoscloud/models/nic_entities.rb +11 -2
  341. data/lib/ionoscloud/models/nic_properties.rb +63 -9
  342. data/lib/ionoscloud/models/nic_put.rb +251 -0
  343. data/lib/ionoscloud/models/nics.rb +1 -1
  344. data/lib/ionoscloud/models/no_state_meta_data.rb +1 -1
  345. data/lib/ionoscloud/models/pagination_links.rb +1 -1
  346. data/lib/ionoscloud/models/peer.rb +1 -1
  347. data/lib/ionoscloud/models/private_cross_connect.rb +1 -1
  348. data/lib/ionoscloud/models/private_cross_connect_properties.rb +1 -1
  349. data/lib/ionoscloud/models/private_cross_connects.rb +1 -1
  350. data/lib/ionoscloud/models/{kubernetes_config_properties.rb → remote_console_url.rb} +12 -12
  351. data/lib/ionoscloud/models/request.rb +1 -1
  352. data/lib/ionoscloud/models/request_metadata.rb +1 -1
  353. data/lib/ionoscloud/models/request_properties.rb +1 -1
  354. data/lib/ionoscloud/models/request_status.rb +1 -1
  355. data/lib/ionoscloud/models/request_status_metadata.rb +1 -1
  356. data/lib/ionoscloud/models/request_target.rb +1 -1
  357. data/lib/ionoscloud/models/requests.rb +1 -1
  358. data/lib/ionoscloud/models/resource.rb +1 -1
  359. data/lib/ionoscloud/models/resource_entities.rb +1 -1
  360. data/lib/ionoscloud/models/resource_groups.rb +1 -1
  361. data/lib/ionoscloud/models/resource_limits.rb +80 -5
  362. data/lib/ionoscloud/models/resource_properties.rb +1 -1
  363. data/lib/ionoscloud/models/resource_reference.rb +1 -1
  364. data/lib/ionoscloud/models/resources.rb +1 -1
  365. data/lib/ionoscloud/models/resources_users.rb +1 -1
  366. data/lib/ionoscloud/models/s3_key.rb +1 -1
  367. data/lib/ionoscloud/models/s3_key_metadata.rb +1 -1
  368. data/lib/ionoscloud/models/s3_key_properties.rb +3 -3
  369. data/lib/ionoscloud/models/s3_keys.rb +1 -1
  370. data/lib/ionoscloud/models/s3_object_storage_sso.rb +1 -1
  371. data/lib/ionoscloud/models/server.rb +1 -1
  372. data/lib/ionoscloud/models/server_entities.rb +1 -1
  373. data/lib/ionoscloud/models/server_properties.rb +28 -8
  374. data/lib/ionoscloud/models/servers.rb +1 -1
  375. data/lib/ionoscloud/models/snapshot.rb +1 -1
  376. data/lib/ionoscloud/models/snapshot_properties.rb +1 -1
  377. data/lib/ionoscloud/models/snapshots.rb +1 -1
  378. data/lib/ionoscloud/models/target_port_range.rb +227 -0
  379. data/lib/ionoscloud/models/template.rb +260 -0
  380. data/lib/ionoscloud/models/template_properties.rb +267 -0
  381. data/lib/ionoscloud/models/templates.rb +249 -0
  382. data/lib/ionoscloud/models/token.rb +217 -0
  383. data/lib/ionoscloud/models/type.rb +10 -1
  384. data/lib/ionoscloud/models/user.rb +1 -1
  385. data/lib/ionoscloud/models/user_metadata.rb +1 -1
  386. data/lib/ionoscloud/models/user_post.rb +221 -0
  387. data/lib/ionoscloud/models/user_properties.rb +2 -12
  388. data/lib/ionoscloud/models/user_properties_post.rb +287 -0
  389. data/lib/ionoscloud/models/user_properties_put.rb +277 -0
  390. data/lib/ionoscloud/models/user_put.rb +231 -0
  391. data/lib/ionoscloud/models/users.rb +1 -1
  392. data/lib/ionoscloud/models/users_entities.rb +1 -1
  393. data/lib/ionoscloud/models/volume.rb +1 -1
  394. data/lib/ionoscloud/models/volume_properties.rb +31 -20
  395. data/lib/ionoscloud/models/volumes.rb +1 -1
  396. data/lib/ionoscloud/version.rb +2 -2
  397. data/spec/api/_api_spec.rb +1 -1
  398. data/spec/api/{backup_unit_api_spec.rb → backup_units_api_spec.rb} +14 -14
  399. data/spec/api/{contract_api_spec.rb → contract_resources_api_spec.rb} +9 -9
  400. data/spec/api/{data_center_api_spec.rb → data_centers_api_spec.rb} +10 -10
  401. data/spec/api/firewall_rules_api_spec.rb +146 -0
  402. data/spec/api/flow_logs_api_spec.rb +140 -0
  403. data/spec/api/{image_api_spec.rb → images_api_spec.rb} +9 -9
  404. data/spec/api/ip_blocks_api_spec.rb +7 -7
  405. data/spec/api/kubernetes_api_spec.rb +10 -22
  406. data/spec/api/{label_api_spec.rb → labels_api_spec.rb} +21 -23
  407. data/spec/api/{lan_api_spec.rb → lans_api_spec.rb} +21 -21
  408. data/spec/api/{load_balancer_api_spec.rb → load_balancers_api_spec.rb} +27 -25
  409. data/spec/api/{location_api_spec.rb → locations_api_spec.rb} +7 -7
  410. data/spec/api/{nic_api_spec.rb → nat_gateways_api_spec.rb} +188 -103
  411. data/spec/api/network_interfaces_api_spec.rb +140 -0
  412. data/spec/api/network_load_balancers_api_spec.rb +342 -0
  413. data/spec/api/{private_cross_connect_api_spec.rb → private_cross_connects_api_spec.rb} +13 -11
  414. data/spec/api/{request_api_spec.rb → requests_api_spec.rb} +20 -12
  415. data/spec/api/{server_api_spec.rb → servers_api_spec.rb} +84 -20
  416. data/spec/api/{snapshot_api_spec.rb → snapshots_api_spec.rb} +12 -12
  417. data/spec/api/templates_api_spec.rb +60 -0
  418. data/spec/api/user_management_api_spec.rb +7 -100
  419. data/spec/api/user_s3_keys_api_spec.rb +128 -0
  420. data/spec/api/{volume_api_spec.rb → volumes_api_spec.rb} +13 -13
  421. data/spec/api_client_spec.rb +1 -1
  422. data/spec/configuration_spec.rb +4 -4
  423. data/spec/models/attached_volumes_spec.rb +1 -1
  424. data/spec/models/backup_unit_properties_spec.rb +1 -1
  425. data/spec/models/backup_unit_spec.rb +1 -1
  426. data/spec/models/backup_unit_sso_spec.rb +1 -1
  427. data/spec/models/backup_units_spec.rb +2 -2
  428. data/spec/models/balanced_nics_spec.rb +1 -1
  429. data/spec/models/cdroms_spec.rb +1 -1
  430. data/spec/models/connectable_datacenter_spec.rb +1 -1
  431. data/spec/models/contract_properties_spec.rb +1 -1
  432. data/spec/models/contract_spec.rb +1 -1
  433. data/spec/models/contracts_spec.rb +52 -0
  434. data/spec/models/cpu_architecture_properties_spec.rb +52 -0
  435. data/spec/models/data_center_entities_spec.rb +13 -1
  436. data/spec/models/datacenter_element_metadata_spec.rb +1 -1
  437. data/spec/models/datacenter_properties_spec.rb +7 -5
  438. data/spec/models/datacenter_spec.rb +1 -1
  439. data/spec/models/datacenters_spec.rb +1 -1
  440. data/spec/models/error_message_spec.rb +1 -1
  441. data/spec/models/error_spec.rb +1 -1
  442. data/spec/models/firewall_rule_spec.rb +1 -1
  443. data/spec/models/firewall_rules_spec.rb +1 -1
  444. data/spec/models/firewallrule_properties_spec.rb +11 -13
  445. data/spec/models/flow_log_properties_spec.rb +60 -0
  446. data/spec/models/flow_log_put_spec.rb +52 -0
  447. data/spec/models/flow_log_spec.rb +58 -0
  448. data/spec/models/flow_logs_spec.rb +70 -0
  449. data/spec/models/group_entities_spec.rb +1 -1
  450. data/spec/models/group_members_spec.rb +1 -1
  451. data/spec/models/group_properties_spec.rb +19 -1
  452. data/spec/models/group_share_properties_spec.rb +1 -1
  453. data/spec/models/group_share_spec.rb +1 -1
  454. data/spec/models/group_shares_spec.rb +1 -1
  455. data/spec/models/group_spec.rb +1 -1
  456. data/spec/models/group_users_spec.rb +1 -1
  457. data/spec/models/groups_spec.rb +1 -1
  458. data/spec/models/image_properties_spec.rb +17 -1
  459. data/spec/models/image_spec.rb +1 -1
  460. data/spec/models/images_spec.rb +1 -1
  461. data/spec/models/info_spec.rb +1 -1
  462. data/spec/models/ip_block_properties_spec.rb +1 -1
  463. data/spec/models/ip_block_spec.rb +1 -1
  464. data/spec/models/ip_blocks_spec.rb +1 -1
  465. data/spec/models/ip_consumer_spec.rb +13 -1
  466. data/spec/models/ip_failover_spec.rb +1 -1
  467. data/spec/models/kubernetes_auto_scaling_spec.rb +1 -1
  468. data/spec/models/kubernetes_cluster_entities_spec.rb +1 -1
  469. data/spec/models/kubernetes_cluster_for_post_spec.rb +68 -0
  470. data/spec/models/kubernetes_cluster_for_put_spec.rb +68 -0
  471. data/spec/models/kubernetes_cluster_properties_for_post_spec.rb +58 -0
  472. data/spec/models/{kubernetes_cluster_properties_for_post_and_put_spec.rb → kubernetes_cluster_properties_for_put_spec.rb} +7 -7
  473. data/spec/models/kubernetes_cluster_properties_spec.rb +13 -1
  474. data/spec/models/kubernetes_cluster_spec.rb +1 -1
  475. data/spec/models/kubernetes_clusters_spec.rb +1 -1
  476. data/spec/models/kubernetes_maintenance_window_spec.rb +1 -1
  477. data/spec/models/kubernetes_node_metadata_spec.rb +1 -1
  478. data/spec/models/{kubernetes_config_spec.rb → kubernetes_node_pool_for_post_spec.rb} +14 -8
  479. data/spec/models/kubernetes_node_pool_for_put_spec.rb +1 -1
  480. data/spec/models/kubernetes_node_pool_lan_routes_spec.rb +40 -0
  481. data/spec/models/kubernetes_node_pool_lan_spec.rb +13 -1
  482. data/spec/models/kubernetes_node_pool_properties_for_post_spec.rb +1 -1
  483. data/spec/models/kubernetes_node_pool_properties_for_put_spec.rb +1 -51
  484. data/spec/models/kubernetes_node_pool_properties_spec.rb +1 -1
  485. data/spec/models/kubernetes_node_pool_spec.rb +1 -1
  486. data/spec/models/kubernetes_node_pools_spec.rb +1 -1
  487. data/spec/models/kubernetes_node_properties_spec.rb +7 -1
  488. data/spec/models/kubernetes_node_spec.rb +2 -2
  489. data/spec/models/kubernetes_nodes_spec.rb +2 -2
  490. data/spec/models/label_properties_spec.rb +1 -1
  491. data/spec/models/label_resource_properties_spec.rb +1 -1
  492. data/spec/models/label_resource_spec.rb +1 -1
  493. data/spec/models/label_resources_spec.rb +2 -2
  494. data/spec/models/label_spec.rb +1 -1
  495. data/spec/models/labels_spec.rb +2 -2
  496. data/spec/models/lan_entities_spec.rb +1 -1
  497. data/spec/models/lan_nics_spec.rb +1 -1
  498. data/spec/models/lan_post_spec.rb +1 -1
  499. data/spec/models/lan_properties_post_spec.rb +1 -1
  500. data/spec/models/lan_properties_spec.rb +1 -1
  501. data/spec/models/lan_spec.rb +1 -1
  502. data/spec/models/lans_spec.rb +1 -1
  503. data/spec/models/loadbalancer_entities_spec.rb +1 -1
  504. data/spec/models/loadbalancer_properties_spec.rb +1 -5
  505. data/spec/models/loadbalancer_spec.rb +1 -1
  506. data/spec/models/loadbalancers_spec.rb +1 -1
  507. data/spec/models/location_properties_spec.rb +7 -5
  508. data/spec/models/location_spec.rb +1 -1
  509. data/spec/models/locations_spec.rb +1 -1
  510. data/spec/models/nat_gateway_entities_spec.rb +40 -0
  511. data/spec/models/nat_gateway_lan_properties_spec.rb +40 -0
  512. data/spec/models/nat_gateway_properties_spec.rb +46 -0
  513. data/spec/models/nat_gateway_put_spec.rb +52 -0
  514. data/spec/models/nat_gateway_rule_properties_spec.rb +70 -0
  515. data/spec/models/nat_gateway_rule_protocol_spec.rb +28 -0
  516. data/spec/models/nat_gateway_rule_put_spec.rb +52 -0
  517. data/spec/models/nat_gateway_rule_spec.rb +58 -0
  518. data/spec/models/nat_gateway_rule_type_spec.rb +28 -0
  519. data/spec/models/nat_gateway_rules_spec.rb +52 -0
  520. data/spec/models/nat_gateway_spec.rb +64 -0
  521. data/spec/models/nat_gateways_spec.rb +70 -0
  522. data/spec/models/network_load_balancer_entities_spec.rb +40 -0
  523. data/spec/models/network_load_balancer_forwarding_rule_health_check_spec.rb +58 -0
  524. data/spec/models/network_load_balancer_forwarding_rule_properties_spec.rb +78 -0
  525. data/spec/models/network_load_balancer_forwarding_rule_put_spec.rb +52 -0
  526. data/spec/models/network_load_balancer_forwarding_rule_spec.rb +58 -0
  527. data/spec/models/network_load_balancer_forwarding_rule_target_health_check_spec.rb +46 -0
  528. data/spec/models/network_load_balancer_forwarding_rule_target_spec.rb +52 -0
  529. data/spec/models/network_load_balancer_forwarding_rules_spec.rb +70 -0
  530. data/spec/models/network_load_balancer_properties_spec.rb +58 -0
  531. data/spec/models/network_load_balancer_put_spec.rb +52 -0
  532. data/spec/models/network_load_balancer_spec.rb +64 -0
  533. data/spec/models/network_load_balancers_spec.rb +70 -0
  534. data/spec/models/nic_entities_spec.rb +7 -1
  535. data/spec/models/nic_properties_spec.rb +18 -2
  536. data/spec/models/nic_put_spec.rb +52 -0
  537. data/spec/models/nic_spec.rb +1 -1
  538. data/spec/models/nics_spec.rb +1 -1
  539. data/spec/models/no_state_meta_data_spec.rb +1 -1
  540. data/spec/models/pagination_links_spec.rb +1 -1
  541. data/spec/models/peer_spec.rb +1 -1
  542. data/spec/models/private_cross_connect_properties_spec.rb +1 -1
  543. data/spec/models/private_cross_connect_spec.rb +1 -1
  544. data/spec/models/private_cross_connects_spec.rb +1 -1
  545. data/spec/models/{kubernetes_config_properties_spec.rb → remote_console_url_spec.rb} +8 -8
  546. data/spec/models/request_metadata_spec.rb +1 -1
  547. data/spec/models/request_properties_spec.rb +1 -1
  548. data/spec/models/request_spec.rb +1 -1
  549. data/spec/models/request_status_metadata_spec.rb +1 -1
  550. data/spec/models/request_status_spec.rb +1 -1
  551. data/spec/models/request_target_spec.rb +1 -1
  552. data/spec/models/requests_spec.rb +1 -1
  553. data/spec/models/resource_entities_spec.rb +1 -1
  554. data/spec/models/resource_groups_spec.rb +1 -1
  555. data/spec/models/resource_limits_spec.rb +31 -1
  556. data/spec/models/resource_properties_spec.rb +1 -1
  557. data/spec/models/resource_reference_spec.rb +1 -1
  558. data/spec/models/resource_spec.rb +1 -1
  559. data/spec/models/resources_spec.rb +1 -1
  560. data/spec/models/resources_users_spec.rb +1 -1
  561. data/spec/models/s3_key_metadata_spec.rb +1 -1
  562. data/spec/models/s3_key_properties_spec.rb +1 -1
  563. data/spec/models/s3_key_spec.rb +1 -1
  564. data/spec/models/s3_keys_spec.rb +1 -1
  565. data/spec/models/s3_object_storage_sso_spec.rb +1 -1
  566. data/spec/models/server_entities_spec.rb +1 -1
  567. data/spec/models/server_properties_spec.rb +14 -2
  568. data/spec/models/server_spec.rb +1 -1
  569. data/spec/models/servers_spec.rb +1 -1
  570. data/spec/models/snapshot_properties_spec.rb +1 -1
  571. data/spec/models/snapshot_spec.rb +1 -1
  572. data/spec/models/snapshots_spec.rb +1 -1
  573. data/spec/models/target_port_range_spec.rb +40 -0
  574. data/spec/models/template_properties_spec.rb +52 -0
  575. data/spec/models/template_spec.rb +58 -0
  576. data/spec/models/templates_spec.rb +52 -0
  577. data/spec/models/token_spec.rb +34 -0
  578. data/spec/models/type_spec.rb +1 -1
  579. data/spec/models/user_metadata_spec.rb +1 -1
  580. data/spec/models/user_post_spec.rb +34 -0
  581. data/spec/models/user_properties_post_spec.rb +76 -0
  582. data/spec/models/user_properties_put_spec.rb +70 -0
  583. data/spec/models/user_properties_spec.rb +1 -7
  584. data/spec/models/user_put_spec.rb +40 -0
  585. data/spec/models/user_spec.rb +1 -1
  586. data/spec/models/users_entities_spec.rb +1 -1
  587. data/spec/models/users_spec.rb +1 -1
  588. data/spec/models/volume_properties_spec.rb +14 -8
  589. data/spec/models/volume_spec.rb +1 -1
  590. data/spec/models/volumes_spec.rb +1 -1
  591. data/spec/spec_helper.rb +1 -1
  592. metadata +505 -160
  593. data/DOCS.md +0 -14618
  594. data/lib/ionoscloud/api/nic_api.rb +0 -1222
@@ -0,0 +1,28 @@
1
+ # NetworkLoadBalancer
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | The resource's unique identifier | [optional][readonly] |
8
+ | **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
9
+ | **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
10
+ | **metadata** | [**DatacenterElementMetadata**](DatacenterElementMetadata.md) | | [optional] |
11
+ | **properties** | [**NetworkLoadBalancerProperties**](NetworkLoadBalancerProperties.md) | | |
12
+ | **entities** | [**NetworkLoadBalancerEntities**](NetworkLoadBalancerEntities.md) | | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'ionoscloud'
18
+
19
+ instance = Ionoscloud::NetworkLoadBalancer.new(
20
+ id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
21
+ type: "networkloadbalancer",
22
+ href: <RESOURCE-URI>,
23
+ metadata: null,
24
+ properties: null,
25
+ entities: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,20 @@
1
+ # NetworkLoadBalancerEntities
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **flowlogs** | [**FlowLogs**](FlowLogs.md) | | [optional] |
8
+ | **forwardingrules** | [**NetworkLoadBalancerForwardingRules**](NetworkLoadBalancerForwardingRules.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ionoscloud'
14
+
15
+ instance = Ionoscloud::NetworkLoadBalancerEntities.new(
16
+ flowlogs: null,
17
+ forwardingrules: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,26 @@
1
+ # NetworkLoadBalancerForwardingRule
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | The resource&#39;s unique identifier | [optional][readonly] |
8
+ | **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
9
+ | **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
10
+ | **metadata** | [**DatacenterElementMetadata**](DatacenterElementMetadata.md) | | [optional] |
11
+ | **properties** | [**NetworkLoadBalancerForwardingRuleProperties**](NetworkLoadBalancerForwardingRuleProperties.md) | | |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ionoscloud'
17
+
18
+ instance = Ionoscloud::NetworkLoadBalancerForwardingRule.new(
19
+ id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
20
+ type: "forwarding-rule",
21
+ href: <RESOURCE-URI>,
22
+ metadata: null,
23
+ properties: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,26 @@
1
+ # NetworkLoadBalancerForwardingRuleHealthCheck
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **client_timeout** | **Integer** | ClientTimeout is expressed in milliseconds. This inactivity timeout applies when the client is expected to acknowledge or send data. If unset the default of 50 seconds will be used. | [optional] |
8
+ | **check_timeout** | **Integer** | It specifies the time (in milliseconds) for a target VM in this pool to answer the check. If a target VM has CheckInterval set and CheckTimeout is set too, then the smaller value of the two is used after the TCP connection is established. | [optional] |
9
+ | **connect_timeout** | **Integer** | It specifies the maximum time (in milliseconds) to wait for a connection attempt to a target VM to succeed. If unset, the default of 5 seconds will be used. | [optional] |
10
+ | **target_timeout** | **Integer** | TargetTimeout specifies the maximum inactivity time (in milliseconds) on the target VM side. If unset, the default of 50 seconds will be used. | [optional] |
11
+ | **retries** | **Integer** | Retries specifies the number of retries to perform on a target VM after a connection failure. If unset, the default value of 3 will be used. (valid range: [0, 65535]) | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ionoscloud'
17
+
18
+ instance = Ionoscloud::NetworkLoadBalancerForwardingRuleHealthCheck.new(
19
+ client_timeout: 50,
20
+ check_timeout: 2000,
21
+ connect_timeout: 5000,
22
+ target_timeout: 50000,
23
+ retries: 3
24
+ )
25
+ ```
26
+
@@ -0,0 +1,30 @@
1
+ # NetworkLoadBalancerForwardingRuleProperties
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | A name of that Network Load Balancer forwarding rule | |
8
+ | **algorithm** | **String** | Algorithm for the balancing. | |
9
+ | **protocol** | **String** | Protocol of the balancing. | |
10
+ | **listener_ip** | **String** | Listening IP. (inbound) | |
11
+ | **listener_port** | **Integer** | Listening port number. (inbound) (range: 1 to 65535) | |
12
+ | **health_check** | [**NetworkLoadBalancerForwardingRuleHealthCheck**](NetworkLoadBalancerForwardingRuleHealthCheck.md) | | [optional] |
13
+ | **targets** | [**Array&lt;NetworkLoadBalancerForwardingRuleTarget&gt;**](NetworkLoadBalancerForwardingRuleTarget.md) | Array of items in that collection | |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'ionoscloud'
19
+
20
+ instance = Ionoscloud::NetworkLoadBalancerForwardingRuleProperties.new(
21
+ name: My Network Load Balancer forwarding rule,
22
+ algorithm: ROUND_ROBIN,
23
+ protocol: TCP,
24
+ listener_ip: 81.173.1.2,
25
+ listener_port: 8080,
26
+ health_check: null,
27
+ targets: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,24 @@
1
+ # NetworkLoadBalancerForwardingRulePut
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | The resource&#39;s unique identifier | [optional][readonly] |
8
+ | **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
9
+ | **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
10
+ | **properties** | [**NetworkLoadBalancerForwardingRuleProperties**](NetworkLoadBalancerForwardingRuleProperties.md) | | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ionoscloud'
16
+
17
+ instance = Ionoscloud::NetworkLoadBalancerForwardingRulePut.new(
18
+ id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
19
+ type: "forwarding-rule",
20
+ href: <RESOURCE-URI>,
21
+ properties: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,24 @@
1
+ # NetworkLoadBalancerForwardingRuleTarget
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **ip** | **String** | IP of a balanced target VM | |
8
+ | **port** | **Integer** | Port of the balanced target service. (range: 1 to 65535) | |
9
+ | **weight** | **Integer** | Weight parameter is used to adjust the target VM&#39;s weight relative to other target VMs. All target VMs will receive a load proportional to their weight relative to the sum of all weights, so the higher the weight, the higher the load. The default weight is 1, and the maximal value is 256. A value of 0 means the target VM will not participate in load-balancing but will still accept persistent connections. If this parameter is used to distribute the load according to target VM&#39;s capacity, it is recommended to start with values which can both grow and shrink, for instance between 10 and 100 to leave enough room above and below for later adjustments. | |
10
+ | **health_check** | [**NetworkLoadBalancerForwardingRuleTargetHealthCheck**](NetworkLoadBalancerForwardingRuleTargetHealthCheck.md) | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ionoscloud'
16
+
17
+ instance = Ionoscloud::NetworkLoadBalancerForwardingRuleTarget.new(
18
+ ip: 22.231.2.2,
19
+ port: 8080,
20
+ weight: 123,
21
+ health_check: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,22 @@
1
+ # NetworkLoadBalancerForwardingRuleTargetHealthCheck
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **check** | **Boolean** | Check specifies whether the target VM&#39;s health is checked. If turned off, a target VM is always considered available. If turned on, the target VM is available when accepting periodic TCP connections, to ensure that it is really able to serve requests. The address and port to send the tests to are those of the target VM. The health check only consists of a connection attempt. | [optional] |
8
+ | **check_interval** | **Integer** | CheckInterval determines the duration (in milliseconds) between consecutive health checks. If unspecified a default of 2000 ms is used. | [optional] |
9
+ | **maintenance** | **Boolean** | Maintenance specifies if a target VM should be marked as down, even if it is not. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'ionoscloud'
15
+
16
+ instance = Ionoscloud::NetworkLoadBalancerForwardingRuleTargetHealthCheck.new(
17
+ check: null,
18
+ check_interval: 2000,
19
+ maintenance: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,30 @@
1
+ # NetworkLoadBalancerForwardingRules
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | The resource&#39;s unique identifier | [optional][readonly] |
8
+ | **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
9
+ | **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
10
+ | **items** | [**Array&lt;NetworkLoadBalancerForwardingRule&gt;**](NetworkLoadBalancerForwardingRule.md) | Array of items in that collection | [optional][readonly] |
11
+ | **offset** | **Float** | the offset (if specified in the request) | [optional] |
12
+ | **limit** | **Float** | the limit (if specified in the request) | [optional] |
13
+ | **_links** | [**PaginationLinks**](PaginationLinks.md) | | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'ionoscloud'
19
+
20
+ instance = Ionoscloud::NetworkLoadBalancerForwardingRules.new(
21
+ id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
22
+ type: "collection",
23
+ href: <RESOURCE-URI>,
24
+ items: null,
25
+ offset: 0,
26
+ limit: 1000,
27
+ _links: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,26 @@
1
+ # NetworkLoadBalancerProperties
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | A name of that Network Load Balancer | |
8
+ | **listener_lan** | **Integer** | Id of the listening LAN. (inbound) | |
9
+ | **ips** | **Array&lt;String&gt;** | Collection of IP addresses of the Network Load Balancer. (inbound and outbound) IP of the listenerLan must be a customer reserved IP for the public load balancer and private IP for the private load balancer. | [optional] |
10
+ | **target_lan** | **Integer** | Id of the balanced private target LAN. (outbound) | |
11
+ | **lb_private_ips** | **Array&lt;String&gt;** | Collection of private IP addresses with subnet mask of the Network Load Balancer. IPs must contain valid subnet mask. If user will not provide any IP then the system will generate one IP with /24 subnet. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ionoscloud'
17
+
18
+ instance = Ionoscloud::NetworkLoadBalancerProperties.new(
19
+ name: My Network Load Balancer,
20
+ listener_lan: 1,
21
+ ips: [81.173.1.2, 22.231.2.2, 22.231.2.3],
22
+ target_lan: 2,
23
+ lb_private_ips: [81.173.1.5/24, 22.231.2.5/24]
24
+ )
25
+ ```
26
+
@@ -0,0 +1,24 @@
1
+ # NetworkLoadBalancerPut
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | The resource&#39;s unique identifier | [optional][readonly] |
8
+ | **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
9
+ | **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
10
+ | **properties** | [**NetworkLoadBalancerProperties**](NetworkLoadBalancerProperties.md) | | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ionoscloud'
16
+
17
+ instance = Ionoscloud::NetworkLoadBalancerPut.new(
18
+ id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
19
+ type: "networkloadbalancer",
20
+ href: <RESOURCE-URI>,
21
+ properties: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,30 @@
1
+ # NetworkLoadBalancers
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | The resource&#39;s unique identifier | [optional][readonly] |
8
+ | **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
9
+ | **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
10
+ | **items** | [**Array&lt;NetworkLoadBalancer&gt;**](NetworkLoadBalancer.md) | Array of items in that collection | [optional][readonly] |
11
+ | **offset** | **Float** | the offset (if specified in the request) | [optional] |
12
+ | **limit** | **Float** | the limit (if specified in the request) | [optional] |
13
+ | **_links** | [**PaginationLinks**](PaginationLinks.md) | | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'ionoscloud'
19
+
20
+ instance = Ionoscloud::NetworkLoadBalancers.new(
21
+ id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
22
+ type: "collection",
23
+ href: <RESOURCE-URI>,
24
+ items: null,
25
+ offset: 0,
26
+ limit: 1000,
27
+ _links: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,1590 @@
1
+ # NetworkLoadBalancersApi
2
+
3
+ All URIs are relative to *https://api.ionos.com/cloudapi/v6*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**datacenters_networkloadbalancers_delete**](NetworkLoadBalancersApi.md#datacenters_networkloadbalancers_delete) | **DELETE** /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId} | Remove an Network Load Balancer |
8
+ | [**datacenters_networkloadbalancers_find_by_network_load_balancer_id**](NetworkLoadBalancersApi.md#datacenters_networkloadbalancers_find_by_network_load_balancer_id) | **GET** /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId} | Retrieve an Network Load Balancer |
9
+ | [**datacenters_networkloadbalancers_flowlogs_delete**](NetworkLoadBalancersApi.md#datacenters_networkloadbalancers_flowlogs_delete) | **DELETE** /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId} | Remove Flow Log from Network Load Balancer |
10
+ | [**datacenters_networkloadbalancers_flowlogs_find_by_flow_log_id**](NetworkLoadBalancersApi.md#datacenters_networkloadbalancers_flowlogs_find_by_flow_log_id) | **GET** /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId} | Retrieve a Flow Log of the Network Load Balancer |
11
+ | [**datacenters_networkloadbalancers_flowlogs_get**](NetworkLoadBalancersApi.md#datacenters_networkloadbalancers_flowlogs_get) | **GET** /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs | List Network Load Balancer Flow Logs |
12
+ | [**datacenters_networkloadbalancers_flowlogs_patch**](NetworkLoadBalancersApi.md#datacenters_networkloadbalancers_flowlogs_patch) | **PATCH** /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId} | Partially modify a Flow Log of the Network Load Balancer |
13
+ | [**datacenters_networkloadbalancers_flowlogs_post**](NetworkLoadBalancersApi.md#datacenters_networkloadbalancers_flowlogs_post) | **POST** /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs | Add a Network Load Balancer Flow Log |
14
+ | [**datacenters_networkloadbalancers_flowlogs_put**](NetworkLoadBalancersApi.md#datacenters_networkloadbalancers_flowlogs_put) | **PUT** /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId} | Modify a Flow Log of the Network Load Balancer |
15
+ | [**datacenters_networkloadbalancers_forwardingrules_delete**](NetworkLoadBalancersApi.md#datacenters_networkloadbalancers_forwardingrules_delete) | **DELETE** /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId} | Remove Forwarding Rule from Network Load Balancer |
16
+ | [**datacenters_networkloadbalancers_forwardingrules_find_by_forwarding_rule_id**](NetworkLoadBalancersApi.md#datacenters_networkloadbalancers_forwardingrules_find_by_forwarding_rule_id) | **GET** /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId} | Retrieve a Forwarding Rule of the Network Load Balancer |
17
+ | [**datacenters_networkloadbalancers_forwardingrules_get**](NetworkLoadBalancersApi.md#datacenters_networkloadbalancers_forwardingrules_get) | **GET** /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules | List Network Load Balancer Forwarding Rules |
18
+ | [**datacenters_networkloadbalancers_forwardingrules_patch**](NetworkLoadBalancersApi.md#datacenters_networkloadbalancers_forwardingrules_patch) | **PATCH** /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId} | Partially modify a forwarding rule of the Network Load Balancer |
19
+ | [**datacenters_networkloadbalancers_forwardingrules_post**](NetworkLoadBalancersApi.md#datacenters_networkloadbalancers_forwardingrules_post) | **POST** /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules | Add a Network Load Balancer Forwarding Rule |
20
+ | [**datacenters_networkloadbalancers_forwardingrules_put**](NetworkLoadBalancersApi.md#datacenters_networkloadbalancers_forwardingrules_put) | **PUT** /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId} | Modify a forwarding rule of the Network Load Balancer |
21
+ | [**datacenters_networkloadbalancers_get**](NetworkLoadBalancersApi.md#datacenters_networkloadbalancers_get) | **GET** /datacenters/{datacenterId}/networkloadbalancers | List Network Load Balancers |
22
+ | [**datacenters_networkloadbalancers_patch**](NetworkLoadBalancersApi.md#datacenters_networkloadbalancers_patch) | **PATCH** /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId} | Partially update an Network Load Balancer |
23
+ | [**datacenters_networkloadbalancers_post**](NetworkLoadBalancersApi.md#datacenters_networkloadbalancers_post) | **POST** /datacenters/{datacenterId}/networkloadbalancers | Create an Network Load Balancer |
24
+ | [**datacenters_networkloadbalancers_put**](NetworkLoadBalancersApi.md#datacenters_networkloadbalancers_put) | **PUT** /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId} | Update an Network Load Balancer |
25
+
26
+
27
+ ## datacenters_networkloadbalancers_delete
28
+
29
+ > datacenters_networkloadbalancers_delete(datacenter_id, network_load_balancer_id, opts)
30
+
31
+ Remove an Network Load Balancer
32
+
33
+ Removes the specified Network Load Balancer.
34
+
35
+ ### Examples
36
+
37
+ ```ruby
38
+ require 'time'
39
+ require 'ionoscloud'
40
+ # setup authorization
41
+ Ionoscloud.configure do |config|
42
+ # Configure HTTP basic authorization: Basic Authentication
43
+ config.username = 'YOUR USERNAME'
44
+ config.password = 'YOUR PASSWORD'
45
+
46
+ # Configure API key authorization: Token Authentication
47
+ config.api_key['Authorization'] = 'YOUR API KEY'
48
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
49
+ # config.api_key_prefix['Authorization'] = 'Bearer'
50
+ end
51
+
52
+ api_instance = Ionoscloud::NetworkLoadBalancersApi.new
53
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
54
+ network_load_balancer_id = 'network_load_balancer_id_example' # String | The unique ID of the Network Load Balancer
55
+ opts = {
56
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
57
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
58
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
59
+ }
60
+
61
+ begin
62
+ # Remove an Network Load Balancer
63
+ api_instance.datacenters_networkloadbalancers_delete(datacenter_id, network_load_balancer_id, opts)
64
+ rescue Ionoscloud::ApiError => e
65
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_delete: #{e}"
66
+ end
67
+ ```
68
+
69
+ #### Using the datacenters_networkloadbalancers_delete_with_http_info variant
70
+
71
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
72
+
73
+ > <Array(nil, Integer, Hash)> datacenters_networkloadbalancers_delete_with_http_info(datacenter_id, network_load_balancer_id, opts)
74
+
75
+ ```ruby
76
+ begin
77
+ # Remove an Network Load Balancer
78
+ data, status_code, headers = api_instance.datacenters_networkloadbalancers_delete_with_http_info(datacenter_id, network_load_balancer_id, opts)
79
+ p status_code # => 2xx
80
+ p headers # => { ... }
81
+ p data # => nil
82
+ rescue Ionoscloud::ApiError => e
83
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_delete_with_http_info: #{e}"
84
+ end
85
+ ```
86
+
87
+ ### Parameters
88
+
89
+ | Name | Type | Description | Notes |
90
+ | ---- | ---- | ----------- | ----- |
91
+ | **datacenter_id** | **String** | The unique ID of the datacenter | |
92
+ | **network_load_balancer_id** | **String** | The unique ID of the Network Load Balancer | |
93
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
94
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
95
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
96
+
97
+ ### Return type
98
+
99
+ nil (empty response body)
100
+
101
+ ### Authorization
102
+
103
+ Basic Authentication, Token Authentication
104
+
105
+ ### HTTP request headers
106
+
107
+ - **Content-Type**: Not defined
108
+ - **Accept**: application/json
109
+
110
+
111
+ ## datacenters_networkloadbalancers_find_by_network_load_balancer_id
112
+
113
+ > <NetworkLoadBalancer> datacenters_networkloadbalancers_find_by_network_load_balancer_id(datacenter_id, network_load_balancer_id, opts)
114
+
115
+ Retrieve an Network Load Balancer
116
+
117
+ Retrieves the attributes of a given Network Load Balancer.
118
+
119
+ ### Examples
120
+
121
+ ```ruby
122
+ require 'time'
123
+ require 'ionoscloud'
124
+ # setup authorization
125
+ Ionoscloud.configure do |config|
126
+ # Configure HTTP basic authorization: Basic Authentication
127
+ config.username = 'YOUR USERNAME'
128
+ config.password = 'YOUR PASSWORD'
129
+
130
+ # Configure API key authorization: Token Authentication
131
+ config.api_key['Authorization'] = 'YOUR API KEY'
132
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
133
+ # config.api_key_prefix['Authorization'] = 'Bearer'
134
+ end
135
+
136
+ api_instance = Ionoscloud::NetworkLoadBalancersApi.new
137
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
138
+ network_load_balancer_id = 'network_load_balancer_id_example' # String | The unique ID of the Network Load Balancer
139
+ opts = {
140
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
141
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
142
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
143
+ }
144
+
145
+ begin
146
+ # Retrieve an Network Load Balancer
147
+ result = api_instance.datacenters_networkloadbalancers_find_by_network_load_balancer_id(datacenter_id, network_load_balancer_id, opts)
148
+ p result
149
+ rescue Ionoscloud::ApiError => e
150
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_find_by_network_load_balancer_id: #{e}"
151
+ end
152
+ ```
153
+
154
+ #### Using the datacenters_networkloadbalancers_find_by_network_load_balancer_id_with_http_info variant
155
+
156
+ This returns an Array which contains the response data, status code and headers.
157
+
158
+ > <Array(<NetworkLoadBalancer>, Integer, Hash)> datacenters_networkloadbalancers_find_by_network_load_balancer_id_with_http_info(datacenter_id, network_load_balancer_id, opts)
159
+
160
+ ```ruby
161
+ begin
162
+ # Retrieve an Network Load Balancer
163
+ data, status_code, headers = api_instance.datacenters_networkloadbalancers_find_by_network_load_balancer_id_with_http_info(datacenter_id, network_load_balancer_id, opts)
164
+ p status_code # => 2xx
165
+ p headers # => { ... }
166
+ p data # => <NetworkLoadBalancer>
167
+ rescue Ionoscloud::ApiError => e
168
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_find_by_network_load_balancer_id_with_http_info: #{e}"
169
+ end
170
+ ```
171
+
172
+ ### Parameters
173
+
174
+ | Name | Type | Description | Notes |
175
+ | ---- | ---- | ----------- | ----- |
176
+ | **datacenter_id** | **String** | The unique ID of the datacenter | |
177
+ | **network_load_balancer_id** | **String** | The unique ID of the Network Load Balancer | |
178
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
179
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
180
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
181
+
182
+ ### Return type
183
+
184
+ [**NetworkLoadBalancer**](NetworkLoadBalancer.md)
185
+
186
+ ### Authorization
187
+
188
+ Basic Authentication, Token Authentication
189
+
190
+ ### HTTP request headers
191
+
192
+ - **Content-Type**: Not defined
193
+ - **Accept**: application/json
194
+
195
+
196
+ ## datacenters_networkloadbalancers_flowlogs_delete
197
+
198
+ > datacenters_networkloadbalancers_flowlogs_delete(datacenter_id, network_load_balancer_id, flow_log_id, opts)
199
+
200
+ Remove Flow Log from Network Load Balancer
201
+
202
+ This will remove a flow log from the network load balancer.
203
+
204
+ ### Examples
205
+
206
+ ```ruby
207
+ require 'time'
208
+ require 'ionoscloud'
209
+ # setup authorization
210
+ Ionoscloud.configure do |config|
211
+ # Configure HTTP basic authorization: Basic Authentication
212
+ config.username = 'YOUR USERNAME'
213
+ config.password = 'YOUR PASSWORD'
214
+
215
+ # Configure API key authorization: Token Authentication
216
+ config.api_key['Authorization'] = 'YOUR API KEY'
217
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
218
+ # config.api_key_prefix['Authorization'] = 'Bearer'
219
+ end
220
+
221
+ api_instance = Ionoscloud::NetworkLoadBalancersApi.new
222
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
223
+ network_load_balancer_id = 'network_load_balancer_id_example' # String | The unique ID of the Network Load Balancer
224
+ flow_log_id = 'flow_log_id_example' # String | The unique ID of the flow log
225
+ opts = {
226
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
227
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
228
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
229
+ }
230
+
231
+ begin
232
+ # Remove Flow Log from Network Load Balancer
233
+ api_instance.datacenters_networkloadbalancers_flowlogs_delete(datacenter_id, network_load_balancer_id, flow_log_id, opts)
234
+ rescue Ionoscloud::ApiError => e
235
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_flowlogs_delete: #{e}"
236
+ end
237
+ ```
238
+
239
+ #### Using the datacenters_networkloadbalancers_flowlogs_delete_with_http_info variant
240
+
241
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
242
+
243
+ > <Array(nil, Integer, Hash)> datacenters_networkloadbalancers_flowlogs_delete_with_http_info(datacenter_id, network_load_balancer_id, flow_log_id, opts)
244
+
245
+ ```ruby
246
+ begin
247
+ # Remove Flow Log from Network Load Balancer
248
+ data, status_code, headers = api_instance.datacenters_networkloadbalancers_flowlogs_delete_with_http_info(datacenter_id, network_load_balancer_id, flow_log_id, opts)
249
+ p status_code # => 2xx
250
+ p headers # => { ... }
251
+ p data # => nil
252
+ rescue Ionoscloud::ApiError => e
253
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_flowlogs_delete_with_http_info: #{e}"
254
+ end
255
+ ```
256
+
257
+ ### Parameters
258
+
259
+ | Name | Type | Description | Notes |
260
+ | ---- | ---- | ----------- | ----- |
261
+ | **datacenter_id** | **String** | The unique ID of the datacenter | |
262
+ | **network_load_balancer_id** | **String** | The unique ID of the Network Load Balancer | |
263
+ | **flow_log_id** | **String** | The unique ID of the flow log | |
264
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
265
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
266
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
267
+
268
+ ### Return type
269
+
270
+ nil (empty response body)
271
+
272
+ ### Authorization
273
+
274
+ Basic Authentication, Token Authentication
275
+
276
+ ### HTTP request headers
277
+
278
+ - **Content-Type**: Not defined
279
+ - **Accept**: application/json
280
+
281
+
282
+ ## datacenters_networkloadbalancers_flowlogs_find_by_flow_log_id
283
+
284
+ > <FlowLog> datacenters_networkloadbalancers_flowlogs_find_by_flow_log_id(datacenter_id, network_load_balancer_id, flow_log_id, opts)
285
+
286
+ Retrieve a Flow Log of the Network Load Balancer
287
+
288
+ This will return a Flow Log of the Network Load Balancer.
289
+
290
+ ### Examples
291
+
292
+ ```ruby
293
+ require 'time'
294
+ require 'ionoscloud'
295
+ # setup authorization
296
+ Ionoscloud.configure do |config|
297
+ # Configure HTTP basic authorization: Basic Authentication
298
+ config.username = 'YOUR USERNAME'
299
+ config.password = 'YOUR PASSWORD'
300
+
301
+ # Configure API key authorization: Token Authentication
302
+ config.api_key['Authorization'] = 'YOUR API KEY'
303
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
304
+ # config.api_key_prefix['Authorization'] = 'Bearer'
305
+ end
306
+
307
+ api_instance = Ionoscloud::NetworkLoadBalancersApi.new
308
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
309
+ network_load_balancer_id = 'network_load_balancer_id_example' # String | The unique ID of the Network Load Balancer
310
+ flow_log_id = 'flow_log_id_example' # String | The unique ID of the Flow Log
311
+ opts = {
312
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
313
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
314
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
315
+ }
316
+
317
+ begin
318
+ # Retrieve a Flow Log of the Network Load Balancer
319
+ result = api_instance.datacenters_networkloadbalancers_flowlogs_find_by_flow_log_id(datacenter_id, network_load_balancer_id, flow_log_id, opts)
320
+ p result
321
+ rescue Ionoscloud::ApiError => e
322
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_flowlogs_find_by_flow_log_id: #{e}"
323
+ end
324
+ ```
325
+
326
+ #### Using the datacenters_networkloadbalancers_flowlogs_find_by_flow_log_id_with_http_info variant
327
+
328
+ This returns an Array which contains the response data, status code and headers.
329
+
330
+ > <Array(<FlowLog>, Integer, Hash)> datacenters_networkloadbalancers_flowlogs_find_by_flow_log_id_with_http_info(datacenter_id, network_load_balancer_id, flow_log_id, opts)
331
+
332
+ ```ruby
333
+ begin
334
+ # Retrieve a Flow Log of the Network Load Balancer
335
+ data, status_code, headers = api_instance.datacenters_networkloadbalancers_flowlogs_find_by_flow_log_id_with_http_info(datacenter_id, network_load_balancer_id, flow_log_id, opts)
336
+ p status_code # => 2xx
337
+ p headers # => { ... }
338
+ p data # => <FlowLog>
339
+ rescue Ionoscloud::ApiError => e
340
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_flowlogs_find_by_flow_log_id_with_http_info: #{e}"
341
+ end
342
+ ```
343
+
344
+ ### Parameters
345
+
346
+ | Name | Type | Description | Notes |
347
+ | ---- | ---- | ----------- | ----- |
348
+ | **datacenter_id** | **String** | The unique ID of the datacenter | |
349
+ | **network_load_balancer_id** | **String** | The unique ID of the Network Load Balancer | |
350
+ | **flow_log_id** | **String** | The unique ID of the Flow Log | |
351
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
352
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
353
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
354
+
355
+ ### Return type
356
+
357
+ [**FlowLog**](FlowLog.md)
358
+
359
+ ### Authorization
360
+
361
+ Basic Authentication, Token Authentication
362
+
363
+ ### HTTP request headers
364
+
365
+ - **Content-Type**: Not defined
366
+ - **Accept**: application/json
367
+
368
+
369
+ ## datacenters_networkloadbalancers_flowlogs_get
370
+
371
+ > <FlowLogs> datacenters_networkloadbalancers_flowlogs_get(datacenter_id, network_load_balancer_id, opts)
372
+
373
+ List Network Load Balancer Flow Logs
374
+
375
+ You can retrieve a list of Flow Logs of the Network Load Balancer.
376
+
377
+ ### Examples
378
+
379
+ ```ruby
380
+ require 'time'
381
+ require 'ionoscloud'
382
+ # setup authorization
383
+ Ionoscloud.configure do |config|
384
+ # Configure HTTP basic authorization: Basic Authentication
385
+ config.username = 'YOUR USERNAME'
386
+ config.password = 'YOUR PASSWORD'
387
+
388
+ # Configure API key authorization: Token Authentication
389
+ config.api_key['Authorization'] = 'YOUR API KEY'
390
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
391
+ # config.api_key_prefix['Authorization'] = 'Bearer'
392
+ end
393
+
394
+ api_instance = Ionoscloud::NetworkLoadBalancersApi.new
395
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
396
+ network_load_balancer_id = 'network_load_balancer_id_example' # String | The unique ID of the Network Load Balancer
397
+ opts = {
398
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
399
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
400
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
401
+ }
402
+
403
+ begin
404
+ # List Network Load Balancer Flow Logs
405
+ result = api_instance.datacenters_networkloadbalancers_flowlogs_get(datacenter_id, network_load_balancer_id, opts)
406
+ p result
407
+ rescue Ionoscloud::ApiError => e
408
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_flowlogs_get: #{e}"
409
+ end
410
+ ```
411
+
412
+ #### Using the datacenters_networkloadbalancers_flowlogs_get_with_http_info variant
413
+
414
+ This returns an Array which contains the response data, status code and headers.
415
+
416
+ > <Array(<FlowLogs>, Integer, Hash)> datacenters_networkloadbalancers_flowlogs_get_with_http_info(datacenter_id, network_load_balancer_id, opts)
417
+
418
+ ```ruby
419
+ begin
420
+ # List Network Load Balancer Flow Logs
421
+ data, status_code, headers = api_instance.datacenters_networkloadbalancers_flowlogs_get_with_http_info(datacenter_id, network_load_balancer_id, opts)
422
+ p status_code # => 2xx
423
+ p headers # => { ... }
424
+ p data # => <FlowLogs>
425
+ rescue Ionoscloud::ApiError => e
426
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_flowlogs_get_with_http_info: #{e}"
427
+ end
428
+ ```
429
+
430
+ ### Parameters
431
+
432
+ | Name | Type | Description | Notes |
433
+ | ---- | ---- | ----------- | ----- |
434
+ | **datacenter_id** | **String** | The unique ID of the datacenter | |
435
+ | **network_load_balancer_id** | **String** | The unique ID of the Network Load Balancer | |
436
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
437
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
438
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
439
+
440
+ ### Return type
441
+
442
+ [**FlowLogs**](FlowLogs.md)
443
+
444
+ ### Authorization
445
+
446
+ Basic Authentication, Token Authentication
447
+
448
+ ### HTTP request headers
449
+
450
+ - **Content-Type**: Not defined
451
+ - **Accept**: application/json
452
+
453
+
454
+ ## datacenters_networkloadbalancers_flowlogs_patch
455
+
456
+ > <FlowLog> datacenters_networkloadbalancers_flowlogs_patch(datacenter_id, network_load_balancer_id, flow_log_id, network_load_balancer_flow_log_properties, opts)
457
+
458
+ Partially modify a Flow Log of the Network Load Balancer
459
+
460
+ You can use to partially update a Flow Log of a Network Load Balancer.
461
+
462
+ ### Examples
463
+
464
+ ```ruby
465
+ require 'time'
466
+ require 'ionoscloud'
467
+ # setup authorization
468
+ Ionoscloud.configure do |config|
469
+ # Configure HTTP basic authorization: Basic Authentication
470
+ config.username = 'YOUR USERNAME'
471
+ config.password = 'YOUR PASSWORD'
472
+
473
+ # Configure API key authorization: Token Authentication
474
+ config.api_key['Authorization'] = 'YOUR API KEY'
475
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
476
+ # config.api_key_prefix['Authorization'] = 'Bearer'
477
+ end
478
+
479
+ api_instance = Ionoscloud::NetworkLoadBalancersApi.new
480
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
481
+ network_load_balancer_id = 'network_load_balancer_id_example' # String | The unique ID of the Network Load Balancer
482
+ flow_log_id = 'flow_log_id_example' # String | The unique ID of the Flow Log
483
+ network_load_balancer_flow_log_properties = Ionoscloud::FlowLogProperties.new({name: 'My resource', action: 'ACCEPTED', direction: 'INGRESS', bucket: 'bucketName/key'}) # FlowLogProperties | Properties of a Flow Log to be updated
484
+ opts = {
485
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
486
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
487
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
488
+ }
489
+
490
+ begin
491
+ # Partially modify a Flow Log of the Network Load Balancer
492
+ result = api_instance.datacenters_networkloadbalancers_flowlogs_patch(datacenter_id, network_load_balancer_id, flow_log_id, network_load_balancer_flow_log_properties, opts)
493
+ p result
494
+ rescue Ionoscloud::ApiError => e
495
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_flowlogs_patch: #{e}"
496
+ end
497
+ ```
498
+
499
+ #### Using the datacenters_networkloadbalancers_flowlogs_patch_with_http_info variant
500
+
501
+ This returns an Array which contains the response data, status code and headers.
502
+
503
+ > <Array(<FlowLog>, Integer, Hash)> datacenters_networkloadbalancers_flowlogs_patch_with_http_info(datacenter_id, network_load_balancer_id, flow_log_id, network_load_balancer_flow_log_properties, opts)
504
+
505
+ ```ruby
506
+ begin
507
+ # Partially modify a Flow Log of the Network Load Balancer
508
+ data, status_code, headers = api_instance.datacenters_networkloadbalancers_flowlogs_patch_with_http_info(datacenter_id, network_load_balancer_id, flow_log_id, network_load_balancer_flow_log_properties, opts)
509
+ p status_code # => 2xx
510
+ p headers # => { ... }
511
+ p data # => <FlowLog>
512
+ rescue Ionoscloud::ApiError => e
513
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_flowlogs_patch_with_http_info: #{e}"
514
+ end
515
+ ```
516
+
517
+ ### Parameters
518
+
519
+ | Name | Type | Description | Notes |
520
+ | ---- | ---- | ----------- | ----- |
521
+ | **datacenter_id** | **String** | The unique ID of the datacenter | |
522
+ | **network_load_balancer_id** | **String** | The unique ID of the Network Load Balancer | |
523
+ | **flow_log_id** | **String** | The unique ID of the Flow Log | |
524
+ | **network_load_balancer_flow_log_properties** | [**FlowLogProperties**](FlowLogProperties.md) | Properties of a Flow Log to be updated | |
525
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
526
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
527
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
528
+
529
+ ### Return type
530
+
531
+ [**FlowLog**](FlowLog.md)
532
+
533
+ ### Authorization
534
+
535
+ Basic Authentication, Token Authentication
536
+
537
+ ### HTTP request headers
538
+
539
+ - **Content-Type**: Not defined
540
+ - **Accept**: application/json
541
+
542
+
543
+ ## datacenters_networkloadbalancers_flowlogs_post
544
+
545
+ > <FlowLog> datacenters_networkloadbalancers_flowlogs_post(datacenter_id, network_load_balancer_id, network_load_balancer_flow_log, opts)
546
+
547
+ Add a Network Load Balancer Flow Log
548
+
549
+ This will add a new Flow Log to the Network Load Balancer.
550
+
551
+ ### Examples
552
+
553
+ ```ruby
554
+ require 'time'
555
+ require 'ionoscloud'
556
+ # setup authorization
557
+ Ionoscloud.configure do |config|
558
+ # Configure HTTP basic authorization: Basic Authentication
559
+ config.username = 'YOUR USERNAME'
560
+ config.password = 'YOUR PASSWORD'
561
+
562
+ # Configure API key authorization: Token Authentication
563
+ config.api_key['Authorization'] = 'YOUR API KEY'
564
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
565
+ # config.api_key_prefix['Authorization'] = 'Bearer'
566
+ end
567
+
568
+ api_instance = Ionoscloud::NetworkLoadBalancersApi.new
569
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
570
+ network_load_balancer_id = 'network_load_balancer_id_example' # String | The unique ID of the Network Load Balancer
571
+ network_load_balancer_flow_log = Ionoscloud::FlowLog.new({properties: Ionoscloud::FlowLogProperties.new({name: 'My resource', action: 'ACCEPTED', direction: 'INGRESS', bucket: 'bucketName/key'})}) # FlowLog | Flow Log to add
572
+ opts = {
573
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
574
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
575
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
576
+ }
577
+
578
+ begin
579
+ # Add a Network Load Balancer Flow Log
580
+ result = api_instance.datacenters_networkloadbalancers_flowlogs_post(datacenter_id, network_load_balancer_id, network_load_balancer_flow_log, opts)
581
+ p result
582
+ rescue Ionoscloud::ApiError => e
583
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_flowlogs_post: #{e}"
584
+ end
585
+ ```
586
+
587
+ #### Using the datacenters_networkloadbalancers_flowlogs_post_with_http_info variant
588
+
589
+ This returns an Array which contains the response data, status code and headers.
590
+
591
+ > <Array(<FlowLog>, Integer, Hash)> datacenters_networkloadbalancers_flowlogs_post_with_http_info(datacenter_id, network_load_balancer_id, network_load_balancer_flow_log, opts)
592
+
593
+ ```ruby
594
+ begin
595
+ # Add a Network Load Balancer Flow Log
596
+ data, status_code, headers = api_instance.datacenters_networkloadbalancers_flowlogs_post_with_http_info(datacenter_id, network_load_balancer_id, network_load_balancer_flow_log, opts)
597
+ p status_code # => 2xx
598
+ p headers # => { ... }
599
+ p data # => <FlowLog>
600
+ rescue Ionoscloud::ApiError => e
601
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_flowlogs_post_with_http_info: #{e}"
602
+ end
603
+ ```
604
+
605
+ ### Parameters
606
+
607
+ | Name | Type | Description | Notes |
608
+ | ---- | ---- | ----------- | ----- |
609
+ | **datacenter_id** | **String** | The unique ID of the datacenter | |
610
+ | **network_load_balancer_id** | **String** | The unique ID of the Network Load Balancer | |
611
+ | **network_load_balancer_flow_log** | [**FlowLog**](FlowLog.md) | Flow Log to add | |
612
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
613
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
614
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
615
+
616
+ ### Return type
617
+
618
+ [**FlowLog**](FlowLog.md)
619
+
620
+ ### Authorization
621
+
622
+ Basic Authentication, Token Authentication
623
+
624
+ ### HTTP request headers
625
+
626
+ - **Content-Type**: application/json
627
+ - **Accept**: application/json
628
+
629
+
630
+ ## datacenters_networkloadbalancers_flowlogs_put
631
+
632
+ > <FlowLog> datacenters_networkloadbalancers_flowlogs_put(datacenter_id, network_load_balancer_id, flow_log_id, network_load_balancer_flow_log, opts)
633
+
634
+ Modify a Flow Log of the Network Load Balancer
635
+
636
+ You can use to update a Flow Log of the Network Load Balancer.
637
+
638
+ ### Examples
639
+
640
+ ```ruby
641
+ require 'time'
642
+ require 'ionoscloud'
643
+ # setup authorization
644
+ Ionoscloud.configure do |config|
645
+ # Configure HTTP basic authorization: Basic Authentication
646
+ config.username = 'YOUR USERNAME'
647
+ config.password = 'YOUR PASSWORD'
648
+
649
+ # Configure API key authorization: Token Authentication
650
+ config.api_key['Authorization'] = 'YOUR API KEY'
651
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
652
+ # config.api_key_prefix['Authorization'] = 'Bearer'
653
+ end
654
+
655
+ api_instance = Ionoscloud::NetworkLoadBalancersApi.new
656
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
657
+ network_load_balancer_id = 'network_load_balancer_id_example' # String | The unique ID of the Network Load Balancer
658
+ flow_log_id = 'flow_log_id_example' # String | The unique ID of the Flow Log
659
+ network_load_balancer_flow_log = Ionoscloud::FlowLogPut.new({properties: Ionoscloud::FlowLogProperties.new({name: 'My resource', action: 'ACCEPTED', direction: 'INGRESS', bucket: 'bucketName/key'})}) # FlowLogPut | Modified Network Load Balancer Flow Log
660
+ opts = {
661
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
662
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
663
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
664
+ }
665
+
666
+ begin
667
+ # Modify a Flow Log of the Network Load Balancer
668
+ result = api_instance.datacenters_networkloadbalancers_flowlogs_put(datacenter_id, network_load_balancer_id, flow_log_id, network_load_balancer_flow_log, opts)
669
+ p result
670
+ rescue Ionoscloud::ApiError => e
671
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_flowlogs_put: #{e}"
672
+ end
673
+ ```
674
+
675
+ #### Using the datacenters_networkloadbalancers_flowlogs_put_with_http_info variant
676
+
677
+ This returns an Array which contains the response data, status code and headers.
678
+
679
+ > <Array(<FlowLog>, Integer, Hash)> datacenters_networkloadbalancers_flowlogs_put_with_http_info(datacenter_id, network_load_balancer_id, flow_log_id, network_load_balancer_flow_log, opts)
680
+
681
+ ```ruby
682
+ begin
683
+ # Modify a Flow Log of the Network Load Balancer
684
+ data, status_code, headers = api_instance.datacenters_networkloadbalancers_flowlogs_put_with_http_info(datacenter_id, network_load_balancer_id, flow_log_id, network_load_balancer_flow_log, opts)
685
+ p status_code # => 2xx
686
+ p headers # => { ... }
687
+ p data # => <FlowLog>
688
+ rescue Ionoscloud::ApiError => e
689
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_flowlogs_put_with_http_info: #{e}"
690
+ end
691
+ ```
692
+
693
+ ### Parameters
694
+
695
+ | Name | Type | Description | Notes |
696
+ | ---- | ---- | ----------- | ----- |
697
+ | **datacenter_id** | **String** | The unique ID of the datacenter | |
698
+ | **network_load_balancer_id** | **String** | The unique ID of the Network Load Balancer | |
699
+ | **flow_log_id** | **String** | The unique ID of the Flow Log | |
700
+ | **network_load_balancer_flow_log** | [**FlowLogPut**](FlowLogPut.md) | Modified Network Load Balancer Flow Log | |
701
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
702
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
703
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
704
+
705
+ ### Return type
706
+
707
+ [**FlowLog**](FlowLog.md)
708
+
709
+ ### Authorization
710
+
711
+ Basic Authentication, Token Authentication
712
+
713
+ ### HTTP request headers
714
+
715
+ - **Content-Type**: application/json
716
+ - **Accept**: application/json
717
+
718
+
719
+ ## datacenters_networkloadbalancers_forwardingrules_delete
720
+
721
+ > datacenters_networkloadbalancers_forwardingrules_delete(datacenter_id, network_load_balancer_id, forwarding_rule_id, opts)
722
+
723
+ Remove Forwarding Rule from Network Load Balancer
724
+
725
+ This will remove a forwarding rule from the Network Load Balancer.
726
+
727
+ ### Examples
728
+
729
+ ```ruby
730
+ require 'time'
731
+ require 'ionoscloud'
732
+ # setup authorization
733
+ Ionoscloud.configure do |config|
734
+ # Configure HTTP basic authorization: Basic Authentication
735
+ config.username = 'YOUR USERNAME'
736
+ config.password = 'YOUR PASSWORD'
737
+
738
+ # Configure API key authorization: Token Authentication
739
+ config.api_key['Authorization'] = 'YOUR API KEY'
740
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
741
+ # config.api_key_prefix['Authorization'] = 'Bearer'
742
+ end
743
+
744
+ api_instance = Ionoscloud::NetworkLoadBalancersApi.new
745
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
746
+ network_load_balancer_id = 'network_load_balancer_id_example' # String | The unique ID of the Network Load Balancer
747
+ forwarding_rule_id = 'forwarding_rule_id_example' # String | The unique ID of the forwarding rule
748
+ opts = {
749
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
750
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
751
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
752
+ }
753
+
754
+ begin
755
+ # Remove Forwarding Rule from Network Load Balancer
756
+ api_instance.datacenters_networkloadbalancers_forwardingrules_delete(datacenter_id, network_load_balancer_id, forwarding_rule_id, opts)
757
+ rescue Ionoscloud::ApiError => e
758
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_forwardingrules_delete: #{e}"
759
+ end
760
+ ```
761
+
762
+ #### Using the datacenters_networkloadbalancers_forwardingrules_delete_with_http_info variant
763
+
764
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
765
+
766
+ > <Array(nil, Integer, Hash)> datacenters_networkloadbalancers_forwardingrules_delete_with_http_info(datacenter_id, network_load_balancer_id, forwarding_rule_id, opts)
767
+
768
+ ```ruby
769
+ begin
770
+ # Remove Forwarding Rule from Network Load Balancer
771
+ data, status_code, headers = api_instance.datacenters_networkloadbalancers_forwardingrules_delete_with_http_info(datacenter_id, network_load_balancer_id, forwarding_rule_id, opts)
772
+ p status_code # => 2xx
773
+ p headers # => { ... }
774
+ p data # => nil
775
+ rescue Ionoscloud::ApiError => e
776
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_forwardingrules_delete_with_http_info: #{e}"
777
+ end
778
+ ```
779
+
780
+ ### Parameters
781
+
782
+ | Name | Type | Description | Notes |
783
+ | ---- | ---- | ----------- | ----- |
784
+ | **datacenter_id** | **String** | The unique ID of the datacenter | |
785
+ | **network_load_balancer_id** | **String** | The unique ID of the Network Load Balancer | |
786
+ | **forwarding_rule_id** | **String** | The unique ID of the forwarding rule | |
787
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
788
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
789
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
790
+
791
+ ### Return type
792
+
793
+ nil (empty response body)
794
+
795
+ ### Authorization
796
+
797
+ Basic Authentication, Token Authentication
798
+
799
+ ### HTTP request headers
800
+
801
+ - **Content-Type**: Not defined
802
+ - **Accept**: application/json
803
+
804
+
805
+ ## datacenters_networkloadbalancers_forwardingrules_find_by_forwarding_rule_id
806
+
807
+ > <NetworkLoadBalancerForwardingRule> datacenters_networkloadbalancers_forwardingrules_find_by_forwarding_rule_id(datacenter_id, network_load_balancer_id, forwarding_rule_id, opts)
808
+
809
+ Retrieve a Forwarding Rule of the Network Load Balancer
810
+
811
+ This will a forwarding rule of the Network Load Balancer.
812
+
813
+ ### Examples
814
+
815
+ ```ruby
816
+ require 'time'
817
+ require 'ionoscloud'
818
+ # setup authorization
819
+ Ionoscloud.configure do |config|
820
+ # Configure HTTP basic authorization: Basic Authentication
821
+ config.username = 'YOUR USERNAME'
822
+ config.password = 'YOUR PASSWORD'
823
+
824
+ # Configure API key authorization: Token Authentication
825
+ config.api_key['Authorization'] = 'YOUR API KEY'
826
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
827
+ # config.api_key_prefix['Authorization'] = 'Bearer'
828
+ end
829
+
830
+ api_instance = Ionoscloud::NetworkLoadBalancersApi.new
831
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
832
+ network_load_balancer_id = 'network_load_balancer_id_example' # String | The unique ID of the Network Load Balancer
833
+ forwarding_rule_id = 'forwarding_rule_id_example' # String | The unique ID of the forwarding rule
834
+ opts = {
835
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
836
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
837
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
838
+ }
839
+
840
+ begin
841
+ # Retrieve a Forwarding Rule of the Network Load Balancer
842
+ result = api_instance.datacenters_networkloadbalancers_forwardingrules_find_by_forwarding_rule_id(datacenter_id, network_load_balancer_id, forwarding_rule_id, opts)
843
+ p result
844
+ rescue Ionoscloud::ApiError => e
845
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_forwardingrules_find_by_forwarding_rule_id: #{e}"
846
+ end
847
+ ```
848
+
849
+ #### Using the datacenters_networkloadbalancers_forwardingrules_find_by_forwarding_rule_id_with_http_info variant
850
+
851
+ This returns an Array which contains the response data, status code and headers.
852
+
853
+ > <Array(<NetworkLoadBalancerForwardingRule>, Integer, Hash)> datacenters_networkloadbalancers_forwardingrules_find_by_forwarding_rule_id_with_http_info(datacenter_id, network_load_balancer_id, forwarding_rule_id, opts)
854
+
855
+ ```ruby
856
+ begin
857
+ # Retrieve a Forwarding Rule of the Network Load Balancer
858
+ data, status_code, headers = api_instance.datacenters_networkloadbalancers_forwardingrules_find_by_forwarding_rule_id_with_http_info(datacenter_id, network_load_balancer_id, forwarding_rule_id, opts)
859
+ p status_code # => 2xx
860
+ p headers # => { ... }
861
+ p data # => <NetworkLoadBalancerForwardingRule>
862
+ rescue Ionoscloud::ApiError => e
863
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_forwardingrules_find_by_forwarding_rule_id_with_http_info: #{e}"
864
+ end
865
+ ```
866
+
867
+ ### Parameters
868
+
869
+ | Name | Type | Description | Notes |
870
+ | ---- | ---- | ----------- | ----- |
871
+ | **datacenter_id** | **String** | The unique ID of the datacenter | |
872
+ | **network_load_balancer_id** | **String** | The unique ID of the Network Load Balancer | |
873
+ | **forwarding_rule_id** | **String** | The unique ID of the forwarding rule | |
874
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
875
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
876
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
877
+
878
+ ### Return type
879
+
880
+ [**NetworkLoadBalancerForwardingRule**](NetworkLoadBalancerForwardingRule.md)
881
+
882
+ ### Authorization
883
+
884
+ Basic Authentication, Token Authentication
885
+
886
+ ### HTTP request headers
887
+
888
+ - **Content-Type**: Not defined
889
+ - **Accept**: application/json
890
+
891
+
892
+ ## datacenters_networkloadbalancers_forwardingrules_get
893
+
894
+ > <NetworkLoadBalancerForwardingRules> datacenters_networkloadbalancers_forwardingrules_get(datacenter_id, network_load_balancer_id, opts)
895
+
896
+ List Network Load Balancer Forwarding Rules
897
+
898
+ You can retrieve a list of forwarding rules of the Network Load Balancer.
899
+
900
+ ### Examples
901
+
902
+ ```ruby
903
+ require 'time'
904
+ require 'ionoscloud'
905
+ # setup authorization
906
+ Ionoscloud.configure do |config|
907
+ # Configure HTTP basic authorization: Basic Authentication
908
+ config.username = 'YOUR USERNAME'
909
+ config.password = 'YOUR PASSWORD'
910
+
911
+ # Configure API key authorization: Token Authentication
912
+ config.api_key['Authorization'] = 'YOUR API KEY'
913
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
914
+ # config.api_key_prefix['Authorization'] = 'Bearer'
915
+ end
916
+
917
+ api_instance = Ionoscloud::NetworkLoadBalancersApi.new
918
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
919
+ network_load_balancer_id = 'network_load_balancer_id_example' # String | The unique ID of the Network Load Balancer
920
+ opts = {
921
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
922
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
923
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
924
+ }
925
+
926
+ begin
927
+ # List Network Load Balancer Forwarding Rules
928
+ result = api_instance.datacenters_networkloadbalancers_forwardingrules_get(datacenter_id, network_load_balancer_id, opts)
929
+ p result
930
+ rescue Ionoscloud::ApiError => e
931
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_forwardingrules_get: #{e}"
932
+ end
933
+ ```
934
+
935
+ #### Using the datacenters_networkloadbalancers_forwardingrules_get_with_http_info variant
936
+
937
+ This returns an Array which contains the response data, status code and headers.
938
+
939
+ > <Array(<NetworkLoadBalancerForwardingRules>, Integer, Hash)> datacenters_networkloadbalancers_forwardingrules_get_with_http_info(datacenter_id, network_load_balancer_id, opts)
940
+
941
+ ```ruby
942
+ begin
943
+ # List Network Load Balancer Forwarding Rules
944
+ data, status_code, headers = api_instance.datacenters_networkloadbalancers_forwardingrules_get_with_http_info(datacenter_id, network_load_balancer_id, opts)
945
+ p status_code # => 2xx
946
+ p headers # => { ... }
947
+ p data # => <NetworkLoadBalancerForwardingRules>
948
+ rescue Ionoscloud::ApiError => e
949
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_forwardingrules_get_with_http_info: #{e}"
950
+ end
951
+ ```
952
+
953
+ ### Parameters
954
+
955
+ | Name | Type | Description | Notes |
956
+ | ---- | ---- | ----------- | ----- |
957
+ | **datacenter_id** | **String** | The unique ID of the datacenter | |
958
+ | **network_load_balancer_id** | **String** | The unique ID of the Network Load Balancer | |
959
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
960
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
961
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
962
+
963
+ ### Return type
964
+
965
+ [**NetworkLoadBalancerForwardingRules**](NetworkLoadBalancerForwardingRules.md)
966
+
967
+ ### Authorization
968
+
969
+ Basic Authentication, Token Authentication
970
+
971
+ ### HTTP request headers
972
+
973
+ - **Content-Type**: Not defined
974
+ - **Accept**: application/json
975
+
976
+
977
+ ## datacenters_networkloadbalancers_forwardingrules_patch
978
+
979
+ > <NetworkLoadBalancerForwardingRule> datacenters_networkloadbalancers_forwardingrules_patch(datacenter_id, network_load_balancer_id, forwarding_rule_id, network_load_balancer_forwarding_rule_properties, opts)
980
+
981
+ Partially modify a forwarding rule of the Network Load Balancer
982
+
983
+ You can use to partially update a forwarding rule of a Network Load Balancer.
984
+
985
+ ### Examples
986
+
987
+ ```ruby
988
+ require 'time'
989
+ require 'ionoscloud'
990
+ # setup authorization
991
+ Ionoscloud.configure do |config|
992
+ # Configure HTTP basic authorization: Basic Authentication
993
+ config.username = 'YOUR USERNAME'
994
+ config.password = 'YOUR PASSWORD'
995
+
996
+ # Configure API key authorization: Token Authentication
997
+ config.api_key['Authorization'] = 'YOUR API KEY'
998
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
999
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1000
+ end
1001
+
1002
+ api_instance = Ionoscloud::NetworkLoadBalancersApi.new
1003
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
1004
+ network_load_balancer_id = 'network_load_balancer_id_example' # String | The unique ID of the Network Load Balancer
1005
+ forwarding_rule_id = 'forwarding_rule_id_example' # String | The unique ID of the forwarding rule
1006
+ network_load_balancer_forwarding_rule_properties = Ionoscloud::NetworkLoadBalancerForwardingRuleProperties.new({name: 'My Network Load Balancer forwarding rule', algorithm: 'ROUND_ROBIN', protocol: 'TCP', listener_ip: '81.173.1.2', listener_port: 8080, targets: [Ionoscloud::NetworkLoadBalancerForwardingRuleTarget.new({ip: '22.231.2.2', port: 8080, weight: 123})]}) # NetworkLoadBalancerForwardingRuleProperties | Properties of a forwarding rule to be updated
1007
+ opts = {
1008
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1009
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1010
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1011
+ }
1012
+
1013
+ begin
1014
+ # Partially modify a forwarding rule of the Network Load Balancer
1015
+ result = api_instance.datacenters_networkloadbalancers_forwardingrules_patch(datacenter_id, network_load_balancer_id, forwarding_rule_id, network_load_balancer_forwarding_rule_properties, opts)
1016
+ p result
1017
+ rescue Ionoscloud::ApiError => e
1018
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_forwardingrules_patch: #{e}"
1019
+ end
1020
+ ```
1021
+
1022
+ #### Using the datacenters_networkloadbalancers_forwardingrules_patch_with_http_info variant
1023
+
1024
+ This returns an Array which contains the response data, status code and headers.
1025
+
1026
+ > <Array(<NetworkLoadBalancerForwardingRule>, Integer, Hash)> datacenters_networkloadbalancers_forwardingrules_patch_with_http_info(datacenter_id, network_load_balancer_id, forwarding_rule_id, network_load_balancer_forwarding_rule_properties, opts)
1027
+
1028
+ ```ruby
1029
+ begin
1030
+ # Partially modify a forwarding rule of the Network Load Balancer
1031
+ data, status_code, headers = api_instance.datacenters_networkloadbalancers_forwardingrules_patch_with_http_info(datacenter_id, network_load_balancer_id, forwarding_rule_id, network_load_balancer_forwarding_rule_properties, opts)
1032
+ p status_code # => 2xx
1033
+ p headers # => { ... }
1034
+ p data # => <NetworkLoadBalancerForwardingRule>
1035
+ rescue Ionoscloud::ApiError => e
1036
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_forwardingrules_patch_with_http_info: #{e}"
1037
+ end
1038
+ ```
1039
+
1040
+ ### Parameters
1041
+
1042
+ | Name | Type | Description | Notes |
1043
+ | ---- | ---- | ----------- | ----- |
1044
+ | **datacenter_id** | **String** | The unique ID of the datacenter | |
1045
+ | **network_load_balancer_id** | **String** | The unique ID of the Network Load Balancer | |
1046
+ | **forwarding_rule_id** | **String** | The unique ID of the forwarding rule | |
1047
+ | **network_load_balancer_forwarding_rule_properties** | [**NetworkLoadBalancerForwardingRuleProperties**](NetworkLoadBalancerForwardingRuleProperties.md) | Properties of a forwarding rule to be updated | |
1048
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1049
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
1050
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1051
+
1052
+ ### Return type
1053
+
1054
+ [**NetworkLoadBalancerForwardingRule**](NetworkLoadBalancerForwardingRule.md)
1055
+
1056
+ ### Authorization
1057
+
1058
+ Basic Authentication, Token Authentication
1059
+
1060
+ ### HTTP request headers
1061
+
1062
+ - **Content-Type**: Not defined
1063
+ - **Accept**: application/json
1064
+
1065
+
1066
+ ## datacenters_networkloadbalancers_forwardingrules_post
1067
+
1068
+ > <NetworkLoadBalancerForwardingRule> datacenters_networkloadbalancers_forwardingrules_post(datacenter_id, network_load_balancer_id, network_load_balancer_forwarding_rule, opts)
1069
+
1070
+ Add a Network Load Balancer Forwarding Rule
1071
+
1072
+ This will add a new forwarding rule to the Network Load Balancer.
1073
+
1074
+ ### Examples
1075
+
1076
+ ```ruby
1077
+ require 'time'
1078
+ require 'ionoscloud'
1079
+ # setup authorization
1080
+ Ionoscloud.configure do |config|
1081
+ # Configure HTTP basic authorization: Basic Authentication
1082
+ config.username = 'YOUR USERNAME'
1083
+ config.password = 'YOUR PASSWORD'
1084
+
1085
+ # Configure API key authorization: Token Authentication
1086
+ config.api_key['Authorization'] = 'YOUR API KEY'
1087
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1088
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1089
+ end
1090
+
1091
+ api_instance = Ionoscloud::NetworkLoadBalancersApi.new
1092
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
1093
+ network_load_balancer_id = 'network_load_balancer_id_example' # String | The unique ID of the Network Load Balancer
1094
+ network_load_balancer_forwarding_rule = Ionoscloud::NetworkLoadBalancerForwardingRule.new({properties: Ionoscloud::NetworkLoadBalancerForwardingRuleProperties.new({name: 'My Network Load Balancer forwarding rule', algorithm: 'ROUND_ROBIN', protocol: 'TCP', listener_ip: '81.173.1.2', listener_port: 8080, targets: [Ionoscloud::NetworkLoadBalancerForwardingRuleTarget.new({ip: '22.231.2.2', port: 8080, weight: 123})]})}) # NetworkLoadBalancerForwardingRule | forwarding rule to add
1095
+ opts = {
1096
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1097
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1098
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1099
+ }
1100
+
1101
+ begin
1102
+ # Add a Network Load Balancer Forwarding Rule
1103
+ result = api_instance.datacenters_networkloadbalancers_forwardingrules_post(datacenter_id, network_load_balancer_id, network_load_balancer_forwarding_rule, opts)
1104
+ p result
1105
+ rescue Ionoscloud::ApiError => e
1106
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_forwardingrules_post: #{e}"
1107
+ end
1108
+ ```
1109
+
1110
+ #### Using the datacenters_networkloadbalancers_forwardingrules_post_with_http_info variant
1111
+
1112
+ This returns an Array which contains the response data, status code and headers.
1113
+
1114
+ > <Array(<NetworkLoadBalancerForwardingRule>, Integer, Hash)> datacenters_networkloadbalancers_forwardingrules_post_with_http_info(datacenter_id, network_load_balancer_id, network_load_balancer_forwarding_rule, opts)
1115
+
1116
+ ```ruby
1117
+ begin
1118
+ # Add a Network Load Balancer Forwarding Rule
1119
+ data, status_code, headers = api_instance.datacenters_networkloadbalancers_forwardingrules_post_with_http_info(datacenter_id, network_load_balancer_id, network_load_balancer_forwarding_rule, opts)
1120
+ p status_code # => 2xx
1121
+ p headers # => { ... }
1122
+ p data # => <NetworkLoadBalancerForwardingRule>
1123
+ rescue Ionoscloud::ApiError => e
1124
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_forwardingrules_post_with_http_info: #{e}"
1125
+ end
1126
+ ```
1127
+
1128
+ ### Parameters
1129
+
1130
+ | Name | Type | Description | Notes |
1131
+ | ---- | ---- | ----------- | ----- |
1132
+ | **datacenter_id** | **String** | The unique ID of the datacenter | |
1133
+ | **network_load_balancer_id** | **String** | The unique ID of the Network Load Balancer | |
1134
+ | **network_load_balancer_forwarding_rule** | [**NetworkLoadBalancerForwardingRule**](NetworkLoadBalancerForwardingRule.md) | forwarding rule to add | |
1135
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1136
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
1137
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1138
+
1139
+ ### Return type
1140
+
1141
+ [**NetworkLoadBalancerForwardingRule**](NetworkLoadBalancerForwardingRule.md)
1142
+
1143
+ ### Authorization
1144
+
1145
+ Basic Authentication, Token Authentication
1146
+
1147
+ ### HTTP request headers
1148
+
1149
+ - **Content-Type**: application/json
1150
+ - **Accept**: application/json
1151
+
1152
+
1153
+ ## datacenters_networkloadbalancers_forwardingrules_put
1154
+
1155
+ > <NetworkLoadBalancerForwardingRule> datacenters_networkloadbalancers_forwardingrules_put(datacenter_id, network_load_balancer_id, forwarding_rule_id, network_load_balancer_forwarding_rule, opts)
1156
+
1157
+ Modify a forwarding rule of the Network Load Balancer
1158
+
1159
+ You can use to update a forwarding rule of the Network Load Balancer.
1160
+
1161
+ ### Examples
1162
+
1163
+ ```ruby
1164
+ require 'time'
1165
+ require 'ionoscloud'
1166
+ # setup authorization
1167
+ Ionoscloud.configure do |config|
1168
+ # Configure HTTP basic authorization: Basic Authentication
1169
+ config.username = 'YOUR USERNAME'
1170
+ config.password = 'YOUR PASSWORD'
1171
+
1172
+ # Configure API key authorization: Token Authentication
1173
+ config.api_key['Authorization'] = 'YOUR API KEY'
1174
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1175
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1176
+ end
1177
+
1178
+ api_instance = Ionoscloud::NetworkLoadBalancersApi.new
1179
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
1180
+ network_load_balancer_id = 'network_load_balancer_id_example' # String | The unique ID of the Network Load Balancer
1181
+ forwarding_rule_id = 'forwarding_rule_id_example' # String | The unique ID of the forwarding rule
1182
+ network_load_balancer_forwarding_rule = Ionoscloud::NetworkLoadBalancerForwardingRulePut.new({properties: Ionoscloud::NetworkLoadBalancerForwardingRuleProperties.new({name: 'My Network Load Balancer forwarding rule', algorithm: 'ROUND_ROBIN', protocol: 'TCP', listener_ip: '81.173.1.2', listener_port: 8080, targets: [Ionoscloud::NetworkLoadBalancerForwardingRuleTarget.new({ip: '22.231.2.2', port: 8080, weight: 123})]})}) # NetworkLoadBalancerForwardingRulePut | Modified Network Load Balancer Forwarding Rule
1183
+ opts = {
1184
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1185
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1186
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1187
+ }
1188
+
1189
+ begin
1190
+ # Modify a forwarding rule of the Network Load Balancer
1191
+ result = api_instance.datacenters_networkloadbalancers_forwardingrules_put(datacenter_id, network_load_balancer_id, forwarding_rule_id, network_load_balancer_forwarding_rule, opts)
1192
+ p result
1193
+ rescue Ionoscloud::ApiError => e
1194
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_forwardingrules_put: #{e}"
1195
+ end
1196
+ ```
1197
+
1198
+ #### Using the datacenters_networkloadbalancers_forwardingrules_put_with_http_info variant
1199
+
1200
+ This returns an Array which contains the response data, status code and headers.
1201
+
1202
+ > <Array(<NetworkLoadBalancerForwardingRule>, Integer, Hash)> datacenters_networkloadbalancers_forwardingrules_put_with_http_info(datacenter_id, network_load_balancer_id, forwarding_rule_id, network_load_balancer_forwarding_rule, opts)
1203
+
1204
+ ```ruby
1205
+ begin
1206
+ # Modify a forwarding rule of the Network Load Balancer
1207
+ data, status_code, headers = api_instance.datacenters_networkloadbalancers_forwardingrules_put_with_http_info(datacenter_id, network_load_balancer_id, forwarding_rule_id, network_load_balancer_forwarding_rule, opts)
1208
+ p status_code # => 2xx
1209
+ p headers # => { ... }
1210
+ p data # => <NetworkLoadBalancerForwardingRule>
1211
+ rescue Ionoscloud::ApiError => e
1212
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_forwardingrules_put_with_http_info: #{e}"
1213
+ end
1214
+ ```
1215
+
1216
+ ### Parameters
1217
+
1218
+ | Name | Type | Description | Notes |
1219
+ | ---- | ---- | ----------- | ----- |
1220
+ | **datacenter_id** | **String** | The unique ID of the datacenter | |
1221
+ | **network_load_balancer_id** | **String** | The unique ID of the Network Load Balancer | |
1222
+ | **forwarding_rule_id** | **String** | The unique ID of the forwarding rule | |
1223
+ | **network_load_balancer_forwarding_rule** | [**NetworkLoadBalancerForwardingRulePut**](NetworkLoadBalancerForwardingRulePut.md) | Modified Network Load Balancer Forwarding Rule | |
1224
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1225
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
1226
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1227
+
1228
+ ### Return type
1229
+
1230
+ [**NetworkLoadBalancerForwardingRule**](NetworkLoadBalancerForwardingRule.md)
1231
+
1232
+ ### Authorization
1233
+
1234
+ Basic Authentication, Token Authentication
1235
+
1236
+ ### HTTP request headers
1237
+
1238
+ - **Content-Type**: application/json
1239
+ - **Accept**: application/json
1240
+
1241
+
1242
+ ## datacenters_networkloadbalancers_get
1243
+
1244
+ > <NetworkLoadBalancers> datacenters_networkloadbalancers_get(datacenter_id, opts)
1245
+
1246
+ List Network Load Balancers
1247
+
1248
+ Retrieve a list of Network Load Balancers within the datacenter.
1249
+
1250
+ ### Examples
1251
+
1252
+ ```ruby
1253
+ require 'time'
1254
+ require 'ionoscloud'
1255
+ # setup authorization
1256
+ Ionoscloud.configure do |config|
1257
+ # Configure HTTP basic authorization: Basic Authentication
1258
+ config.username = 'YOUR USERNAME'
1259
+ config.password = 'YOUR PASSWORD'
1260
+
1261
+ # Configure API key authorization: Token Authentication
1262
+ config.api_key['Authorization'] = 'YOUR API KEY'
1263
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1264
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1265
+ end
1266
+
1267
+ api_instance = Ionoscloud::NetworkLoadBalancersApi.new
1268
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
1269
+ opts = {
1270
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1271
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1272
+ x_contract_number: 56, # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1273
+ offset: 56, # Integer | the first element (of the total list of elements) to include in the response (use together with limit for pagination)
1274
+ limit: 56 # Integer | the maximum number of elements to return (use together with offset for pagination)
1275
+ }
1276
+
1277
+ begin
1278
+ # List Network Load Balancers
1279
+ result = api_instance.datacenters_networkloadbalancers_get(datacenter_id, opts)
1280
+ p result
1281
+ rescue Ionoscloud::ApiError => e
1282
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_get: #{e}"
1283
+ end
1284
+ ```
1285
+
1286
+ #### Using the datacenters_networkloadbalancers_get_with_http_info variant
1287
+
1288
+ This returns an Array which contains the response data, status code and headers.
1289
+
1290
+ > <Array(<NetworkLoadBalancers>, Integer, Hash)> datacenters_networkloadbalancers_get_with_http_info(datacenter_id, opts)
1291
+
1292
+ ```ruby
1293
+ begin
1294
+ # List Network Load Balancers
1295
+ data, status_code, headers = api_instance.datacenters_networkloadbalancers_get_with_http_info(datacenter_id, opts)
1296
+ p status_code # => 2xx
1297
+ p headers # => { ... }
1298
+ p data # => <NetworkLoadBalancers>
1299
+ rescue Ionoscloud::ApiError => e
1300
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_get_with_http_info: #{e}"
1301
+ end
1302
+ ```
1303
+
1304
+ ### Parameters
1305
+
1306
+ | Name | Type | Description | Notes |
1307
+ | ---- | ---- | ----------- | ----- |
1308
+ | **datacenter_id** | **String** | The unique ID of the datacenter | |
1309
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1310
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
1311
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1312
+ | **offset** | **Integer** | the first element (of the total list of elements) to include in the response (use together with limit for pagination) | [optional][default to 0] |
1313
+ | **limit** | **Integer** | the maximum number of elements to return (use together with offset for pagination) | [optional][default to 1000] |
1314
+
1315
+ ### Return type
1316
+
1317
+ [**NetworkLoadBalancers**](NetworkLoadBalancers.md)
1318
+
1319
+ ### Authorization
1320
+
1321
+ Basic Authentication, Token Authentication
1322
+
1323
+ ### HTTP request headers
1324
+
1325
+ - **Content-Type**: Not defined
1326
+ - **Accept**: application/json
1327
+
1328
+
1329
+ ## datacenters_networkloadbalancers_patch
1330
+
1331
+ > <NetworkLoadBalancer> datacenters_networkloadbalancers_patch(datacenter_id, network_load_balancer_id, network_load_balancer_properties, opts)
1332
+
1333
+ Partially update an Network Load Balancer
1334
+
1335
+ Partially update the attributes of a given Network Load Balancer
1336
+
1337
+ ### Examples
1338
+
1339
+ ```ruby
1340
+ require 'time'
1341
+ require 'ionoscloud'
1342
+ # setup authorization
1343
+ Ionoscloud.configure do |config|
1344
+ # Configure HTTP basic authorization: Basic Authentication
1345
+ config.username = 'YOUR USERNAME'
1346
+ config.password = 'YOUR PASSWORD'
1347
+
1348
+ # Configure API key authorization: Token Authentication
1349
+ config.api_key['Authorization'] = 'YOUR API KEY'
1350
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1351
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1352
+ end
1353
+
1354
+ api_instance = Ionoscloud::NetworkLoadBalancersApi.new
1355
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
1356
+ network_load_balancer_id = 'network_load_balancer_id_example' # String | The unique ID of the Network Load Balancer
1357
+ network_load_balancer_properties = Ionoscloud::NetworkLoadBalancerProperties.new({name: 'My Network Load Balancer', listener_lan: 1, target_lan: 2}) # NetworkLoadBalancerProperties | Network Load Balancer properties to be updated
1358
+ opts = {
1359
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1360
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1361
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1362
+ }
1363
+
1364
+ begin
1365
+ # Partially update an Network Load Balancer
1366
+ result = api_instance.datacenters_networkloadbalancers_patch(datacenter_id, network_load_balancer_id, network_load_balancer_properties, opts)
1367
+ p result
1368
+ rescue Ionoscloud::ApiError => e
1369
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_patch: #{e}"
1370
+ end
1371
+ ```
1372
+
1373
+ #### Using the datacenters_networkloadbalancers_patch_with_http_info variant
1374
+
1375
+ This returns an Array which contains the response data, status code and headers.
1376
+
1377
+ > <Array(<NetworkLoadBalancer>, Integer, Hash)> datacenters_networkloadbalancers_patch_with_http_info(datacenter_id, network_load_balancer_id, network_load_balancer_properties, opts)
1378
+
1379
+ ```ruby
1380
+ begin
1381
+ # Partially update an Network Load Balancer
1382
+ data, status_code, headers = api_instance.datacenters_networkloadbalancers_patch_with_http_info(datacenter_id, network_load_balancer_id, network_load_balancer_properties, opts)
1383
+ p status_code # => 2xx
1384
+ p headers # => { ... }
1385
+ p data # => <NetworkLoadBalancer>
1386
+ rescue Ionoscloud::ApiError => e
1387
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_patch_with_http_info: #{e}"
1388
+ end
1389
+ ```
1390
+
1391
+ ### Parameters
1392
+
1393
+ | Name | Type | Description | Notes |
1394
+ | ---- | ---- | ----------- | ----- |
1395
+ | **datacenter_id** | **String** | The unique ID of the datacenter | |
1396
+ | **network_load_balancer_id** | **String** | The unique ID of the Network Load Balancer | |
1397
+ | **network_load_balancer_properties** | [**NetworkLoadBalancerProperties**](NetworkLoadBalancerProperties.md) | Network Load Balancer properties to be updated | |
1398
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1399
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
1400
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1401
+
1402
+ ### Return type
1403
+
1404
+ [**NetworkLoadBalancer**](NetworkLoadBalancer.md)
1405
+
1406
+ ### Authorization
1407
+
1408
+ Basic Authentication, Token Authentication
1409
+
1410
+ ### HTTP request headers
1411
+
1412
+ - **Content-Type**: Not defined
1413
+ - **Accept**: application/json
1414
+
1415
+
1416
+ ## datacenters_networkloadbalancers_post
1417
+
1418
+ > <NetworkLoadBalancer> datacenters_networkloadbalancers_post(datacenter_id, network_load_balancer, opts)
1419
+
1420
+ Create an Network Load Balancer
1421
+
1422
+ Creates an Network Load Balancer within the datacenter.
1423
+
1424
+ ### Examples
1425
+
1426
+ ```ruby
1427
+ require 'time'
1428
+ require 'ionoscloud'
1429
+ # setup authorization
1430
+ Ionoscloud.configure do |config|
1431
+ # Configure HTTP basic authorization: Basic Authentication
1432
+ config.username = 'YOUR USERNAME'
1433
+ config.password = 'YOUR PASSWORD'
1434
+
1435
+ # Configure API key authorization: Token Authentication
1436
+ config.api_key['Authorization'] = 'YOUR API KEY'
1437
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1438
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1439
+ end
1440
+
1441
+ api_instance = Ionoscloud::NetworkLoadBalancersApi.new
1442
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
1443
+ network_load_balancer = Ionoscloud::NetworkLoadBalancer.new({properties: Ionoscloud::NetworkLoadBalancerProperties.new({name: 'My Network Load Balancer', listener_lan: 1, target_lan: 2})}) # NetworkLoadBalancer | Network Load Balancer to be created
1444
+ opts = {
1445
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1446
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1447
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1448
+ }
1449
+
1450
+ begin
1451
+ # Create an Network Load Balancer
1452
+ result = api_instance.datacenters_networkloadbalancers_post(datacenter_id, network_load_balancer, opts)
1453
+ p result
1454
+ rescue Ionoscloud::ApiError => e
1455
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_post: #{e}"
1456
+ end
1457
+ ```
1458
+
1459
+ #### Using the datacenters_networkloadbalancers_post_with_http_info variant
1460
+
1461
+ This returns an Array which contains the response data, status code and headers.
1462
+
1463
+ > <Array(<NetworkLoadBalancer>, Integer, Hash)> datacenters_networkloadbalancers_post_with_http_info(datacenter_id, network_load_balancer, opts)
1464
+
1465
+ ```ruby
1466
+ begin
1467
+ # Create an Network Load Balancer
1468
+ data, status_code, headers = api_instance.datacenters_networkloadbalancers_post_with_http_info(datacenter_id, network_load_balancer, opts)
1469
+ p status_code # => 2xx
1470
+ p headers # => { ... }
1471
+ p data # => <NetworkLoadBalancer>
1472
+ rescue Ionoscloud::ApiError => e
1473
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_post_with_http_info: #{e}"
1474
+ end
1475
+ ```
1476
+
1477
+ ### Parameters
1478
+
1479
+ | Name | Type | Description | Notes |
1480
+ | ---- | ---- | ----------- | ----- |
1481
+ | **datacenter_id** | **String** | The unique ID of the datacenter | |
1482
+ | **network_load_balancer** | [**NetworkLoadBalancer**](NetworkLoadBalancer.md) | Network Load Balancer to be created | |
1483
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1484
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
1485
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1486
+
1487
+ ### Return type
1488
+
1489
+ [**NetworkLoadBalancer**](NetworkLoadBalancer.md)
1490
+
1491
+ ### Authorization
1492
+
1493
+ Basic Authentication, Token Authentication
1494
+
1495
+ ### HTTP request headers
1496
+
1497
+ - **Content-Type**: application/json
1498
+ - **Accept**: application/json
1499
+
1500
+
1501
+ ## datacenters_networkloadbalancers_put
1502
+
1503
+ > <NetworkLoadBalancer> datacenters_networkloadbalancers_put(datacenter_id, network_load_balancer_id, network_load_balancer, opts)
1504
+
1505
+ Update an Network Load Balancer
1506
+
1507
+ Update the attributes of a given Network Load Balancer
1508
+
1509
+ ### Examples
1510
+
1511
+ ```ruby
1512
+ require 'time'
1513
+ require 'ionoscloud'
1514
+ # setup authorization
1515
+ Ionoscloud.configure do |config|
1516
+ # Configure HTTP basic authorization: Basic Authentication
1517
+ config.username = 'YOUR USERNAME'
1518
+ config.password = 'YOUR PASSWORD'
1519
+
1520
+ # Configure API key authorization: Token Authentication
1521
+ config.api_key['Authorization'] = 'YOUR API KEY'
1522
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1523
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1524
+ end
1525
+
1526
+ api_instance = Ionoscloud::NetworkLoadBalancersApi.new
1527
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
1528
+ network_load_balancer_id = 'network_load_balancer_id_example' # String | The unique ID of the Network Load Balancer
1529
+ network_load_balancer = Ionoscloud::NetworkLoadBalancerPut.new({properties: Ionoscloud::NetworkLoadBalancerProperties.new({name: 'My Network Load Balancer', listener_lan: 1, target_lan: 2})}) # NetworkLoadBalancerPut | Modified Network Load Balancer
1530
+ opts = {
1531
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1532
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1533
+ x_contract_number: 56, # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1534
+ offset: 56, # Integer | the first element (of the total list of elements) to include in the response (use together with limit for pagination)
1535
+ limit: 56 # Integer | the maximum number of elements to return (use together with offset for pagination)
1536
+ }
1537
+
1538
+ begin
1539
+ # Update an Network Load Balancer
1540
+ result = api_instance.datacenters_networkloadbalancers_put(datacenter_id, network_load_balancer_id, network_load_balancer, opts)
1541
+ p result
1542
+ rescue Ionoscloud::ApiError => e
1543
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_put: #{e}"
1544
+ end
1545
+ ```
1546
+
1547
+ #### Using the datacenters_networkloadbalancers_put_with_http_info variant
1548
+
1549
+ This returns an Array which contains the response data, status code and headers.
1550
+
1551
+ > <Array(<NetworkLoadBalancer>, Integer, Hash)> datacenters_networkloadbalancers_put_with_http_info(datacenter_id, network_load_balancer_id, network_load_balancer, opts)
1552
+
1553
+ ```ruby
1554
+ begin
1555
+ # Update an Network Load Balancer
1556
+ data, status_code, headers = api_instance.datacenters_networkloadbalancers_put_with_http_info(datacenter_id, network_load_balancer_id, network_load_balancer, opts)
1557
+ p status_code # => 2xx
1558
+ p headers # => { ... }
1559
+ p data # => <NetworkLoadBalancer>
1560
+ rescue Ionoscloud::ApiError => e
1561
+ puts "Error when calling NetworkLoadBalancersApi->datacenters_networkloadbalancers_put_with_http_info: #{e}"
1562
+ end
1563
+ ```
1564
+
1565
+ ### Parameters
1566
+
1567
+ | Name | Type | Description | Notes |
1568
+ | ---- | ---- | ----------- | ----- |
1569
+ | **datacenter_id** | **String** | The unique ID of the datacenter | |
1570
+ | **network_load_balancer_id** | **String** | The unique ID of the Network Load Balancer | |
1571
+ | **network_load_balancer** | [**NetworkLoadBalancerPut**](NetworkLoadBalancerPut.md) | Modified Network Load Balancer | |
1572
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1573
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
1574
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1575
+ | **offset** | **Integer** | the first element (of the total list of elements) to include in the response (use together with limit for pagination) | [optional][default to 0] |
1576
+ | **limit** | **Integer** | the maximum number of elements to return (use together with offset for pagination) | [optional][default to 1000] |
1577
+
1578
+ ### Return type
1579
+
1580
+ [**NetworkLoadBalancer**](NetworkLoadBalancer.md)
1581
+
1582
+ ### Authorization
1583
+
1584
+ Basic Authentication, Token Authentication
1585
+
1586
+ ### HTTP request headers
1587
+
1588
+ - **Content-Type**: application/json
1589
+ - **Accept**: application/json
1590
+