ionoscloud 6.0.0 → 6.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (210) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +70 -0
  3. data/README.md +10 -1
  4. data/docs/CHANGELOG.md +22 -0
  5. data/docs/README.md +2 -2
  6. data/docs/api/ApplicationLoadBalancersApi.md +1586 -0
  7. data/docs/api/BackupUnitsApi.md +14 -14
  8. data/docs/api/ContractResourcesApi.md +2 -2
  9. data/docs/api/DataCentersApi.md +15 -15
  10. data/docs/api/DefaultApi.md +2 -2
  11. data/docs/api/FirewallRulesApi.md +14 -14
  12. data/docs/api/FlowLogsApi.md +2 -2
  13. data/docs/api/IPBlocksApi.md +14 -14
  14. data/docs/api/ImagesApi.md +10 -10
  15. data/docs/api/KubernetesApi.md +30 -30
  16. data/docs/api/LANsApi.md +22 -22
  17. data/docs/api/LabelsApi.md +54 -54
  18. data/docs/api/LoadBalancersApi.md +22 -22
  19. data/docs/api/LocationsApi.md +6 -6
  20. data/docs/api/NATGatewaysApi.md +26 -26
  21. data/docs/api/NetworkInterfacesApi.md +14 -14
  22. data/docs/api/NetworkLoadBalancersApi.md +38 -38
  23. data/docs/api/PrivateCrossConnectsApi.md +10 -10
  24. data/docs/api/RequestsApi.md +8 -8
  25. data/docs/api/ServersApi.md +62 -52
  26. data/docs/api/SnapshotsApi.md +10 -10
  27. data/docs/api/TargetGroupsApi.md +516 -0
  28. data/docs/api/UserManagementApi.md +50 -50
  29. data/docs/api/UserS3KeysApi.md +12 -12
  30. data/docs/api/VolumesApi.md +18 -18
  31. data/docs/models/ApplicationLoadBalancer.md +28 -0
  32. data/docs/models/ApplicationLoadBalancerEntities.md +18 -0
  33. data/docs/models/ApplicationLoadBalancerForwardingRule.md +26 -0
  34. data/docs/models/ApplicationLoadBalancerForwardingRuleProperties.md +30 -0
  35. data/docs/models/ApplicationLoadBalancerForwardingRulePut.md +24 -0
  36. data/docs/models/ApplicationLoadBalancerForwardingRules.md +30 -0
  37. data/docs/models/ApplicationLoadBalancerHttpRule.md +34 -0
  38. data/docs/models/ApplicationLoadBalancerHttpRuleCondition.md +26 -0
  39. data/docs/models/ApplicationLoadBalancerProperties.md +26 -0
  40. data/docs/models/ApplicationLoadBalancerPut.md +24 -0
  41. data/docs/models/ApplicationLoadBalancers.md +30 -0
  42. data/docs/models/AttachedVolumes.md +1 -1
  43. data/docs/models/BackupUnits.md +1 -1
  44. data/docs/models/BalancedNics.md +1 -1
  45. data/docs/models/Cdroms.md +1 -1
  46. data/docs/models/Contracts.md +1 -1
  47. data/docs/models/Datacenters.md +1 -1
  48. data/docs/models/ErrorMessage.md +1 -1
  49. data/docs/models/FirewallRules.md +1 -1
  50. data/docs/models/FirewallruleProperties.md +1 -1
  51. data/docs/models/FlowLogs.md +1 -1
  52. data/docs/models/GroupMembers.md +1 -1
  53. data/docs/models/GroupShares.md +1 -1
  54. data/docs/models/GroupUsers.md +1 -1
  55. data/docs/models/Groups.md +1 -1
  56. data/docs/models/Images.md +1 -1
  57. data/docs/models/IpBlocks.md +3 -3
  58. data/docs/models/KubernetesClusterProperties.md +1 -1
  59. data/docs/models/KubernetesClusterPropertiesForPost.md +1 -1
  60. data/docs/models/KubernetesClusterPropertiesForPut.md +1 -1
  61. data/docs/models/KubernetesClusters.md +1 -1
  62. data/docs/models/KubernetesNodePoolProperties.md +1 -1
  63. data/docs/models/KubernetesNodePoolPropertiesForPost.md +1 -1
  64. data/docs/models/KubernetesNodePoolPropertiesForPut.md +1 -1
  65. data/docs/models/KubernetesNodePools.md +1 -1
  66. data/docs/models/KubernetesNodes.md +1 -1
  67. data/docs/models/LabelResources.md +1 -1
  68. data/docs/models/Labels.md +1 -1
  69. data/docs/models/LanNics.md +1 -1
  70. data/docs/models/Lans.md +1 -1
  71. data/docs/models/Loadbalancers.md +1 -1
  72. data/docs/models/Locations.md +1 -1
  73. data/docs/models/NatGatewayProperties.md +1 -1
  74. data/docs/models/NatGatewayRules.md +1 -1
  75. data/docs/models/NatGateways.md +1 -1
  76. data/docs/models/NetworkLoadBalancerForwardingRuleHealthCheck.md +4 -4
  77. data/docs/models/NetworkLoadBalancerForwardingRuleProperties.md +5 -5
  78. data/docs/models/NetworkLoadBalancerForwardingRuleTarget.md +3 -3
  79. data/docs/models/NetworkLoadBalancerForwardingRuleTargetHealthCheck.md +3 -3
  80. data/docs/models/NetworkLoadBalancerForwardingRules.md +1 -1
  81. data/docs/models/NetworkLoadBalancerProperties.md +2 -2
  82. data/docs/models/NetworkLoadBalancers.md +1 -1
  83. data/docs/models/NicProperties.md +3 -3
  84. data/docs/models/Nics.md +1 -1
  85. data/docs/models/PrivateCrossConnects.md +1 -1
  86. data/docs/models/Requests.md +3 -3
  87. data/docs/models/ResourceGroups.md +1 -1
  88. data/docs/models/Resources.md +1 -1
  89. data/docs/models/ResourcesUsers.md +1 -1
  90. data/docs/models/S3Keys.md +1 -1
  91. data/docs/models/Servers.md +1 -1
  92. data/docs/models/Snapshots.md +1 -1
  93. data/docs/models/TargetGroup.md +26 -0
  94. data/docs/models/TargetGroupHealthCheck.md +22 -0
  95. data/docs/models/TargetGroupHttpHealthCheck.md +28 -0
  96. data/docs/models/TargetGroupProperties.md +28 -0
  97. data/docs/models/TargetGroupPut.md +24 -0
  98. data/docs/models/TargetGroupTarget.md +26 -0
  99. data/docs/models/TargetGroups.md +30 -0
  100. data/docs/models/Templates.md +1 -1
  101. data/docs/models/Users.md +1 -1
  102. data/docs/models/VolumeProperties.md +4 -2
  103. data/docs/models/Volumes.md +1 -1
  104. data/git_push.sh +0 -3
  105. data/lib/ionoscloud/api/_api.rb +2 -2
  106. data/lib/ionoscloud/api/application_load_balancers_api.rb +1690 -0
  107. data/lib/ionoscloud/api/backup_units_api.rb +14 -14
  108. data/lib/ionoscloud/api/contract_resources_api.rb +2 -2
  109. data/lib/ionoscloud/api/data_centers_api.rb +16 -16
  110. data/lib/ionoscloud/api/firewall_rules_api.rb +14 -14
  111. data/lib/ionoscloud/api/flow_logs_api.rb +2 -2
  112. data/lib/ionoscloud/api/images_api.rb +10 -10
  113. data/lib/ionoscloud/api/ip_blocks_api.rb +14 -14
  114. data/lib/ionoscloud/api/kubernetes_api.rb +30 -30
  115. data/lib/ionoscloud/api/labels_api.rb +54 -54
  116. data/lib/ionoscloud/api/lans_api.rb +22 -22
  117. data/lib/ionoscloud/api/load_balancers_api.rb +22 -22
  118. data/lib/ionoscloud/api/locations_api.rb +6 -6
  119. data/lib/ionoscloud/api/nat_gateways_api.rb +26 -26
  120. data/lib/ionoscloud/api/network_interfaces_api.rb +14 -14
  121. data/lib/ionoscloud/api/network_load_balancers_api.rb +38 -38
  122. data/lib/ionoscloud/api/private_cross_connects_api.rb +10 -10
  123. data/lib/ionoscloud/api/requests_api.rb +8 -8
  124. data/lib/ionoscloud/api/servers_api.rb +52 -52
  125. data/lib/ionoscloud/api/snapshots_api.rb +10 -10
  126. data/lib/ionoscloud/api/target_groups_api.rb +530 -0
  127. data/lib/ionoscloud/api/user_management_api.rb +50 -50
  128. data/lib/ionoscloud/api/user_s3_keys_api.rb +12 -12
  129. data/lib/ionoscloud/api/volumes_api.rb +19 -19
  130. data/lib/ionoscloud/api_client.rb +1 -1
  131. data/lib/ionoscloud/configuration.rb +11 -26
  132. data/lib/ionoscloud/models/application_load_balancer.rb +319 -0
  133. data/lib/ionoscloud/models/application_load_balancer_entities.rb +226 -0
  134. data/lib/ionoscloud/models/application_load_balancer_forwarding_rule.rb +302 -0
  135. data/lib/ionoscloud/models/application_load_balancer_forwarding_rule_properties.rb +389 -0
  136. data/lib/ionoscloud/models/application_load_balancer_forwarding_rule_put.rb +285 -0
  137. data/lib/ionoscloud/models/application_load_balancer_forwarding_rules.rb +334 -0
  138. data/lib/ionoscloud/models/application_load_balancer_http_rule.rb +427 -0
  139. data/lib/ionoscloud/models/application_load_balancer_http_rule_condition.rb +355 -0
  140. data/lib/ionoscloud/models/application_load_balancer_properties.rb +314 -0
  141. data/lib/ionoscloud/models/application_load_balancer_put.rb +285 -0
  142. data/lib/ionoscloud/models/application_load_balancers.rb +334 -0
  143. data/lib/ionoscloud/models/attached_volumes.rb +1 -1
  144. data/lib/ionoscloud/models/backup_units.rb +1 -1
  145. data/lib/ionoscloud/models/balanced_nics.rb +1 -1
  146. data/lib/ionoscloud/models/cdroms.rb +1 -1
  147. data/lib/ionoscloud/models/contracts.rb +1 -1
  148. data/lib/ionoscloud/models/datacenters.rb +1 -1
  149. data/lib/ionoscloud/models/error_message.rb +1 -1
  150. data/lib/ionoscloud/models/firewall_rules.rb +1 -1
  151. data/lib/ionoscloud/models/firewallrule_properties.rb +6 -1
  152. data/lib/ionoscloud/models/flow_logs.rb +1 -1
  153. data/lib/ionoscloud/models/group_members.rb +1 -1
  154. data/lib/ionoscloud/models/group_shares.rb +1 -1
  155. data/lib/ionoscloud/models/group_users.rb +1 -1
  156. data/lib/ionoscloud/models/groups.rb +1 -1
  157. data/lib/ionoscloud/models/image_properties.rb +2 -2
  158. data/lib/ionoscloud/models/images.rb +1 -1
  159. data/lib/ionoscloud/models/ip_blocks.rb +3 -3
  160. data/lib/ionoscloud/models/kubernetes_cluster_properties.rb +1 -1
  161. data/lib/ionoscloud/models/kubernetes_cluster_properties_for_post.rb +1 -1
  162. data/lib/ionoscloud/models/kubernetes_cluster_properties_for_put.rb +1 -1
  163. data/lib/ionoscloud/models/kubernetes_clusters.rb +1 -1
  164. data/lib/ionoscloud/models/kubernetes_node_pool_properties.rb +1 -1
  165. data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_post.rb +1 -1
  166. data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_put.rb +1 -1
  167. data/lib/ionoscloud/models/kubernetes_node_pools.rb +1 -1
  168. data/lib/ionoscloud/models/kubernetes_nodes.rb +1 -1
  169. data/lib/ionoscloud/models/label_resources.rb +1 -1
  170. data/lib/ionoscloud/models/labels.rb +1 -1
  171. data/lib/ionoscloud/models/lan_nics.rb +1 -1
  172. data/lib/ionoscloud/models/lans.rb +1 -1
  173. data/lib/ionoscloud/models/loadbalancer_properties.rb +1 -0
  174. data/lib/ionoscloud/models/loadbalancers.rb +1 -1
  175. data/lib/ionoscloud/models/locations.rb +1 -1
  176. data/lib/ionoscloud/models/nat_gateway_properties.rb +1 -1
  177. data/lib/ionoscloud/models/nat_gateway_rules.rb +1 -1
  178. data/lib/ionoscloud/models/nat_gateways.rb +1 -1
  179. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_health_check.rb +4 -4
  180. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_properties.rb +5 -5
  181. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_target.rb +3 -3
  182. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_target_health_check.rb +3 -3
  183. data/lib/ionoscloud/models/network_load_balancer_forwarding_rules.rb +1 -1
  184. data/lib/ionoscloud/models/network_load_balancer_properties.rb +2 -2
  185. data/lib/ionoscloud/models/network_load_balancers.rb +1 -1
  186. data/lib/ionoscloud/models/nic_properties.rb +4 -3
  187. data/lib/ionoscloud/models/nics.rb +1 -1
  188. data/lib/ionoscloud/models/private_cross_connects.rb +1 -1
  189. data/lib/ionoscloud/models/requests.rb +3 -3
  190. data/lib/ionoscloud/models/resource_groups.rb +1 -1
  191. data/lib/ionoscloud/models/resources.rb +1 -1
  192. data/lib/ionoscloud/models/resources_users.rb +1 -1
  193. data/lib/ionoscloud/models/s3_keys.rb +1 -1
  194. data/lib/ionoscloud/models/servers.rb +1 -1
  195. data/lib/ionoscloud/models/snapshot_properties.rb +2 -2
  196. data/lib/ionoscloud/models/snapshots.rb +1 -1
  197. data/lib/ionoscloud/models/target_group.rb +302 -0
  198. data/lib/ionoscloud/models/target_group_health_check.rb +263 -0
  199. data/lib/ionoscloud/models/target_group_http_health_check.rb +373 -0
  200. data/lib/ionoscloud/models/target_group_properties.rb +376 -0
  201. data/lib/ionoscloud/models/target_group_put.rb +285 -0
  202. data/lib/ionoscloud/models/target_group_target.rb +314 -0
  203. data/lib/ionoscloud/models/target_groups.rb +334 -0
  204. data/lib/ionoscloud/models/templates.rb +1 -1
  205. data/lib/ionoscloud/models/users.rb +1 -1
  206. data/lib/ionoscloud/models/volume_properties.rb +25 -7
  207. data/lib/ionoscloud/models/volumes.rb +1 -1
  208. data/lib/ionoscloud/version.rb +1 -1
  209. data/lib/ionoscloud.rb +20 -0
  210. metadata +46 -5
@@ -7,9 +7,9 @@
7
7
  | **id** | **String** | The resource's unique identifier. | [optional][readonly] |
8
8
  | **type** | [**Type**](Type.md) | The type of object that has been created. | [optional] |
9
9
  | **href** | **String** | URL to the object representation (absolute path). | [optional][readonly] |
10
- | **items** | [**Array<IpBlock>**](IpBlock.md) | Array of items in that collection | [optional][readonly] |
11
- | **offset** | **Float** | The offset specified in the request (or, if none was specified, the default offset of 0) | [optional] |
12
- | **limit** | **Float** | The limit specified in the request (if none was specified, use the endpoint's default pagination limit). | [optional] |
10
+ | **items** | [**Array<IpBlock>**](IpBlock.md) | Array of items in the collection. | [optional][readonly] |
11
+ | **offset** | **Float** | The offset, specified in the request (if not is specified, 0 is used by default). | [optional] |
12
+ | **limit** | **Float** | The limit, specified in the request (if not specified, the endpoint's default pagination limit is used). | [optional] |
13
13
  | **_links** | [**PaginationLinks**](PaginationLinks.md) | | [optional] |
14
14
 
15
15
  ## Example
@@ -9,7 +9,7 @@
9
9
  | **maintenance_window** | [**KubernetesMaintenanceWindow**](KubernetesMaintenanceWindow.md) | | [optional] |
10
10
  | **available_upgrade_versions** | **Array<String>** | List of available versions for upgrading the cluster | [optional] |
11
11
  | **viable_node_pool_versions** | **Array<String>** | List of versions that may be used for node pools under this cluster | [optional] |
12
- | **api_subnet_allow_list** | **Array<String>** | Access to the K8s API server is restricted to these CIDRs. Traffic, internal to the cluster, is not affected by this restriction. If no allowlist is specified, access is not restricted. If an IP without subnet mask is provided, the default value will be used: 32 for IPv4 and 128 for IPv6. | [optional] |
12
+ | **api_subnet_allow_list** | **Array<String>** | Access to the K8s API server is restricted to these CIDRs. Traffic, internal to the cluster, is not affected by this restriction. If no allowlist is specified, access is not restricted. If an IP without subnet mask is provided, the default value is used: 32 for IPv4 and 128 for IPv6. | [optional] |
13
13
  | **s3_buckets** | [**Array<S3Bucket>**](S3Bucket.md) | List of S3 bucket configured for K8s usage. For now it contains only an S3 bucket used to store K8s API audit logs | [optional] |
14
14
 
15
15
  ## Example
@@ -7,7 +7,7 @@
7
7
  | **name** | **String** | A Kubernetes cluster name. Valid Kubernetes cluster name must be 63 characters or less and must be empty or begin and end with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. | |
8
8
  | **k8s_version** | **String** | The Kubernetes version the cluster is running. This imposes restrictions on what Kubernetes versions can be run in a cluster's nodepools. Additionally, not all Kubernetes versions are viable upgrade targets for all prior versions. | [optional] |
9
9
  | **maintenance_window** | [**KubernetesMaintenanceWindow**](KubernetesMaintenanceWindow.md) | | [optional] |
10
- | **api_subnet_allow_list** | **Array<String>** | Access to the K8s API server is restricted to these CIDRs. Traffic, internal to the cluster, is not affected by this restriction. If no allowlist is specified, access is not restricted. If an IP without subnet mask is provided, the default value will be used: 32 for IPv4 and 128 for IPv6. | [optional] |
10
+ | **api_subnet_allow_list** | **Array<String>** | Access to the K8s API server is restricted to these CIDRs. Traffic, internal to the cluster, is not affected by this restriction. If no allowlist is specified, access is not restricted. If an IP without subnet mask is provided, the default value is used: 32 for IPv4 and 128 for IPv6. | [optional] |
11
11
  | **s3_buckets** | [**Array<S3Bucket>**](S3Bucket.md) | List of S3 bucket configured for K8s usage. For now it contains only an S3 bucket used to store K8s API audit logs | [optional] |
12
12
 
13
13
  ## Example
@@ -7,7 +7,7 @@
7
7
  | **name** | **String** | A Kubernetes cluster name. Valid Kubernetes cluster name must be 63 characters or less and must be empty or begin and end with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. | |
8
8
  | **k8s_version** | **String** | The Kubernetes version the cluster is running. This imposes restrictions on what Kubernetes versions can be run in a cluster's nodepools. Additionally, not all Kubernetes versions are viable upgrade targets for all prior versions. | [optional] |
9
9
  | **maintenance_window** | [**KubernetesMaintenanceWindow**](KubernetesMaintenanceWindow.md) | | [optional] |
10
- | **api_subnet_allow_list** | **Array<String>** | Access to the K8s API server is restricted to these CIDRs. Traffic, internal to the cluster, is not affected by this restriction. If no allowlist is specified, access is not restricted. If an IP without subnet mask is provided, the default value will be used: 32 for IPv4 and 128 for IPv6. | [optional] |
10
+ | **api_subnet_allow_list** | **Array<String>** | Access to the K8s API server is restricted to these CIDRs. Traffic, internal to the cluster, is not affected by this restriction. If no allowlist is specified, access is not restricted. If an IP without subnet mask is provided, the default value is used: 32 for IPv4 and 128 for IPv6. | [optional] |
11
11
  | **s3_buckets** | [**Array<S3Bucket>**](S3Bucket.md) | List of S3 bucket configured for K8s usage. For now it contains only an S3 bucket used to store K8s API audit logs | [optional] |
12
12
 
13
13
  ## Example
@@ -7,7 +7,7 @@
7
7
  | **id** | **String** | A unique representation of the Kubernetes cluster as a resource collection. | [optional][readonly] |
8
8
  | **type** | **String** | The type of resource within a collection. | [optional][readonly] |
9
9
  | **href** | **String** | URL to the collection representation (absolute path). | [optional][readonly] |
10
- | **items** | [**Array<KubernetesCluster>**](KubernetesCluster.md) | Array of items in that collection. | [optional][readonly] |
10
+ | **items** | [**Array<KubernetesCluster>**](KubernetesCluster.md) | Array of items in the collection. | [optional][readonly] |
11
11
 
12
12
  ## Example
13
13
 
@@ -19,7 +19,7 @@
19
19
  | **lans** | [**Array<KubernetesNodePoolLan>**](KubernetesNodePoolLan.md) | array of additional LANs attached to worker nodes | [optional] |
20
20
  | **labels** | **Hash<String, String>** | map of labels attached to node pool. | [optional] |
21
21
  | **annotations** | **Hash<String, String>** | map of annotations attached to node pool. | [optional] |
22
- | **public_ips** | **Array<String>** | Optional array of reserved public IP addresses to be used by the nodes. IPs must be from same location as the data center used for the node pool. The array must contain one extra IP than maximum number of nodes could be. (nodeCount+1 if fixed node amount or maxNodeCount+1 if auto scaling is used) The extra provided IP Will be used during rebuilding of nodes. | [optional] |
22
+ | **public_ips** | **Array<String>** | Optional array of reserved public IP addresses to be used by the nodes. IPs must be from same location as the data center used for the node pool. The array must contain one more IP than maximum number possible number of nodes (nodeCount+1 for fixed number of nodes or maxNodeCount+1 when auto scaling is used). The extra IP is used when the nodes are rebuilt. | [optional] |
23
23
  | **available_upgrade_versions** | **Array<String>** | List of available versions for upgrading the node pool. | [optional] |
24
24
 
25
25
  ## Example
@@ -19,7 +19,7 @@
19
19
  | **lans** | [**Array<KubernetesNodePoolLan>**](KubernetesNodePoolLan.md) | array of additional LANs attached to worker nodes | [optional] |
20
20
  | **labels** | **Hash<String, String>** | map of labels attached to node pool. | [optional] |
21
21
  | **annotations** | **Hash<String, String>** | map of annotations attached to node pool. | [optional] |
22
- | **public_ips** | **Array<String>** | Optional array of reserved public IP addresses to be used by the nodes. IPs must be from same location as the data center used for the node pool. The array must contain one extra IP than maximum number of nodes could be. (nodeCount+1 if fixed node amount or maxNodeCount+1 if auto scaling is used) The extra provided IP Will be used during rebuilding of nodes. | [optional] |
22
+ | **public_ips** | **Array<String>** | Optional array of reserved public IP addresses to be used by the nodes. IPs must be from same location as the data center used for the node pool. The array must contain one more IP than the maximum possible number of nodes (nodeCount+1 for fixed number of nodes or maxNodeCount+1 when auto scaling is used). The extra IP is used when the nodes are rebuilt. | [optional] |
23
23
 
24
24
  ## Example
25
25
 
@@ -12,7 +12,7 @@
12
12
  | **lans** | [**Array<KubernetesNodePoolLan>**](KubernetesNodePoolLan.md) | array of additional LANs attached to worker nodes | [optional] |
13
13
  | **labels** | **Hash<String, String>** | map of labels attached to node pool. | [optional] |
14
14
  | **annotations** | **Hash<String, String>** | map of annotations attached to node pool. | [optional] |
15
- | **public_ips** | **Array<String>** | Optional array of reserved public IP addresses to be used by the nodes. IPs must be from same location as the data center used for the node pool. The array must contain one extra IP than maximum number of nodes could be. (nodeCount+1 if fixed node amount or maxNodeCount+1 if auto scaling is used) The extra provided IP Will be used during rebuilding of nodes. | [optional] |
15
+ | **public_ips** | **Array<String>** | Optional array of reserved public IP addresses to be used by the nodes. IPs must be from same location as the data center used for the node pool. The array must contain one more IP than the maximum possible number of nodes (nodeCount+1 for fixed number of nodes or maxNodeCount+1 when auto scaling is used). The extra IP is used when the nodes are rebuilt. | [optional] |
16
16
 
17
17
  ## Example
18
18
 
@@ -7,7 +7,7 @@
7
7
  | **id** | **String** | A unique representation of the Kubernetes node pool as a resource collection. | [optional][readonly] |
8
8
  | **type** | **String** | The type of resource within a collection. | [optional][readonly] |
9
9
  | **href** | **String** | URL to the collection representation (absolute path). | [optional][readonly] |
10
- | **items** | [**Array<KubernetesNodePool>**](KubernetesNodePool.md) | Array of items in that collection. | [optional][readonly] |
10
+ | **items** | [**Array<KubernetesNodePool>**](KubernetesNodePool.md) | Array of items in the collection. | [optional][readonly] |
11
11
 
12
12
  ## Example
13
13
 
@@ -7,7 +7,7 @@
7
7
  | **id** | **String** | A unique representation of the Kubernetes node pool as a resource collection. | [optional][readonly] |
8
8
  | **type** | **String** | The type of resource within a collection. | [optional][readonly] |
9
9
  | **href** | **String** | URL to the collection representation (absolute path). | [optional][readonly] |
10
- | **items** | [**Array<KubernetesNode>**](KubernetesNode.md) | Array of items in that collection. | [optional][readonly] |
10
+ | **items** | [**Array<KubernetesNode>**](KubernetesNode.md) | Array of items in the collection. | [optional][readonly] |
11
11
 
12
12
  ## Example
13
13
 
@@ -7,7 +7,7 @@
7
7
  | **id** | **String** | A unique representation of the label as a resource collection. | [optional][readonly] |
8
8
  | **type** | **String** | The type of resource within a collection. | [optional][readonly] |
9
9
  | **href** | **String** | URL to the collection representation (absolute path). | [optional][readonly] |
10
- | **items** | [**Array<LabelResource>**](LabelResource.md) | Array of items in that collection. | [optional][readonly] |
10
+ | **items** | [**Array<LabelResource>**](LabelResource.md) | Array of items in the collection. | [optional][readonly] |
11
11
  | **offset** | **Float** | The offset (if specified in the request). | [optional] |
12
12
  | **limit** | **Float** | The limit (if specified in the request). | [optional] |
13
13
  | **_links** | [**PaginationLinks**](PaginationLinks.md) | | [optional] |
@@ -7,7 +7,7 @@
7
7
  | **id** | **String** | A unique representation of the label as a resource collection. | [optional][readonly] |
8
8
  | **type** | **String** | The type of resource within a collection. | [optional][readonly] |
9
9
  | **href** | **String** | URL to the collection representation (absolute path). | [optional][readonly] |
10
- | **items** | [**Array<Label>**](Label.md) | Array of items in that collection. | [optional][readonly] |
10
+ | **items** | [**Array<Label>**](Label.md) | Array of items in the collection. | [optional][readonly] |
11
11
 
12
12
  ## Example
13
13
 
@@ -7,7 +7,7 @@
7
7
  | **id** | **String** | The resource's unique identifier. | [optional][readonly] |
8
8
  | **type** | [**Type**](Type.md) | The type of object that has been created. | [optional] |
9
9
  | **href** | **String** | URL to the object representation (absolute path). | [optional][readonly] |
10
- | **items** | [**Array<Nic>**](Nic.md) | Array of items in that collection. | [optional][readonly] |
10
+ | **items** | [**Array<Nic>**](Nic.md) | Array of items in the collection. | [optional][readonly] |
11
11
  | **offset** | **Float** | The offset (if specified in the request). | [optional] |
12
12
  | **limit** | **Float** | The limit (if specified in the request). | [optional] |
13
13
  | **_links** | [**PaginationLinks**](PaginationLinks.md) | | [optional] |
data/docs/models/Lans.md CHANGED
@@ -7,7 +7,7 @@
7
7
  | **id** | **String** | The resource's unique identifier. | [optional][readonly] |
8
8
  | **type** | [**Type**](Type.md) | The type of object that has been created. | [optional] |
9
9
  | **href** | **String** | URL to the object representation (absolute path). | [optional][readonly] |
10
- | **items** | [**Array<Lan>**](Lan.md) | Array of items in that collection. | [optional][readonly] |
10
+ | **items** | [**Array<Lan>**](Lan.md) | Array of items in the collection. | [optional][readonly] |
11
11
  | **offset** | **Float** | The offset (if specified in the request). | [optional] |
12
12
  | **limit** | **Float** | The limit (if specified in the request). | [optional] |
13
13
  | **_links** | [**PaginationLinks**](PaginationLinks.md) | | [optional] |
@@ -7,7 +7,7 @@
7
7
  | **id** | **String** | The resource's unique identifier. | [optional][readonly] |
8
8
  | **type** | [**Type**](Type.md) | The type of object that has been created. | [optional] |
9
9
  | **href** | **String** | URL to the object representation (absolute path). | [optional][readonly] |
10
- | **items** | [**Array<Loadbalancer>**](Loadbalancer.md) | Array of items in that collection. | [optional][readonly] |
10
+ | **items** | [**Array<Loadbalancer>**](Loadbalancer.md) | Array of items in the collection. | [optional][readonly] |
11
11
  | **offset** | **Float** | The offset (if specified in the request). | [optional] |
12
12
  | **limit** | **Float** | The limit (if specified in the request). | [optional] |
13
13
  | **_links** | [**PaginationLinks**](PaginationLinks.md) | | [optional] |
@@ -7,7 +7,7 @@
7
7
  | **id** | **String** | The resource's unique identifier. | [optional][readonly] |
8
8
  | **type** | [**Type**](Type.md) | The type of object that has been created. | [optional] |
9
9
  | **href** | **String** | URL to the object representation (absolute path). | [optional][readonly] |
10
- | **items** | [**Array<Location>**](Location.md) | Array of items in that collection. | [optional][readonly] |
10
+ | **items** | [**Array<Location>**](Location.md) | Array of items in the collection. | [optional][readonly] |
11
11
 
12
12
  ## Example
13
13
 
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **name** | **String** | Name of the NAT Gateway. | |
8
8
  | **public_ips** | **Array<String>** | Collection of public IP addresses of the NAT Gateway. Should be customer reserved IP addresses in that location. | |
9
- | **lans** | [**Array<NatGatewayLanProperties>**](NatGatewayLanProperties.md) | Collection of LANs connected to the NAT Gateway. IPs must contain valid subnet mask. If user will not provide any IP then system will generate an IP with /24 subnet. | [optional] |
9
+ | **lans** | [**Array<NatGatewayLanProperties>**](NatGatewayLanProperties.md) | Collection of LANs connected to the NAT Gateway. IPs must contain a valid subnet mask. If no IP is provided, the system will generate an IP with /24 subnet. | [optional] |
10
10
 
11
11
  ## Example
12
12
 
@@ -7,7 +7,7 @@
7
7
  | **id** | **String** | The resource's unique identifier. | [optional][readonly] |
8
8
  | **type** | [**Type**](Type.md) | The type of object that has been created. | [optional] |
9
9
  | **href** | **String** | URL to the object representation (absolute path). | [optional][readonly] |
10
- | **items** | [**Array<NatGatewayRule>**](NatGatewayRule.md) | Array of items in that collection. | [optional][readonly] |
10
+ | **items** | [**Array<NatGatewayRule>**](NatGatewayRule.md) | Array of items in the collection. | [optional][readonly] |
11
11
 
12
12
  ## Example
13
13
 
@@ -7,7 +7,7 @@
7
7
  | **id** | **String** | The resource's unique identifier. | [optional][readonly] |
8
8
  | **type** | [**Type**](Type.md) | The type of object that has been created. | [optional] |
9
9
  | **href** | **String** | URL to the object representation (absolute path). | [optional][readonly] |
10
- | **items** | [**Array<NatGateway>**](NatGateway.md) | Array of items in that collection. | [optional][readonly] |
10
+ | **items** | [**Array<NatGateway>**](NatGateway.md) | Array of items in the collection. | [optional][readonly] |
11
11
  | **offset** | **Float** | The offset (if specified in the request). | [optional] |
12
12
  | **limit** | **Float** | The limit (if specified in the request). | [optional] |
13
13
  | **_links** | [**PaginationLinks**](PaginationLinks.md) | | [optional] |
@@ -4,10 +4,10 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
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
- | **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] |
9
- | **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] |
10
- | **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] |
7
+ | **client_timeout** | **Integer** | The maximum time in milliseconds to wait for the client to acknowledge or send data; default is 50,000 (50 seconds). | [optional] |
8
+ | **connect_timeout** | **Integer** | The maximum time in milliseconds to wait for a connection attempt to a target to succeed; default is 5000 (five seconds). | [optional] |
9
+ | **target_timeout** | **Integer** | The maximum time in milliseconds that a target can remain inactive; default is 50,000 (50 seconds). | [optional] |
10
+ | **retries** | **Integer** | The maximum number of attempts to reconnect to a target after a connection failure. Valid range is 0 to 65535 and default is three reconnection attempts. | [optional] |
11
11
 
12
12
  ## Example
13
13
 
@@ -5,12 +5,12 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **name** | **String** | The name of the 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) | |
8
+ | **algorithm** | **String** | Balancing algorithm | |
9
+ | **protocol** | **String** | Balancing protocol | |
10
+ | **listener_ip** | **String** | Listening (inbound) IP | |
11
+ | **listener_port** | **Integer** | Listening (inbound) port number; valid range is 1 to 65535. | |
12
12
  | **health_check** | [**NetworkLoadBalancerForwardingRuleHealthCheck**](NetworkLoadBalancerForwardingRuleHealthCheck.md) | | [optional] |
13
- | **targets** | [**Array<NetworkLoadBalancerForwardingRuleTarget>**](NetworkLoadBalancerForwardingRuleTarget.md) | Array of items in that collection. | |
13
+ | **targets** | [**Array<NetworkLoadBalancerForwardingRuleTarget>**](NetworkLoadBalancerForwardingRuleTarget.md) | Array of items in the collection. | |
14
14
 
15
15
  ## Example
16
16
 
@@ -4,9 +4,9 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
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'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'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. | |
7
+ | **ip** | **String** | The IP of the balanced target VM. | |
8
+ | **port** | **Integer** | The port of the balanced target service; valid range is 1 to 65535. | |
9
+ | **weight** | **Integer** | Traffic is distributed in proportion to target weight, relative to the combined weight of all targets. A target with higher weight receives a greater share of traffic. Valid range is 0 to 256 and default is 1. Targets with weight of 0 do not participate in load balancing but still accept persistent connections. It is best to assign weights in the middle of the range to leave room for later adjustments. | |
10
10
  | **health_check** | [**NetworkLoadBalancerForwardingRuleTargetHealthCheck**](NetworkLoadBalancerForwardingRuleTargetHealthCheck.md) | | [optional] |
11
11
 
12
12
  ## Example
@@ -4,9 +4,9 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **check** | **Boolean** | Check specifies whether the target VM'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] |
7
+ | **check** | **Boolean** | Makes the target available only if it accepts periodic health check TCP connection attempts; when turned off, the target is considered always available. The health check only consists of a connection attempt to the address and port of the target. | [optional] |
8
+ | **check_interval** | **Integer** | The interval in milliseconds between consecutive health checks; default is 2000. | [optional] |
9
+ | **maintenance** | **Boolean** | Maintenance mode prevents the target from receiving balanced traffic. | [optional] |
10
10
 
11
11
  ## Example
12
12
 
@@ -7,7 +7,7 @@
7
7
  | **id** | **String** | The resource's unique identifier. | [optional][readonly] |
8
8
  | **type** | [**Type**](Type.md) | The type of object that has been created. | [optional] |
9
9
  | **href** | **String** | URL to the object representation (absolute path). | [optional][readonly] |
10
- | **items** | [**Array<NetworkLoadBalancerForwardingRule>**](NetworkLoadBalancerForwardingRule.md) | Array of items in that collection. | [optional][readonly] |
10
+ | **items** | [**Array<NetworkLoadBalancerForwardingRule>**](NetworkLoadBalancerForwardingRule.md) | Array of items in the collection. | [optional][readonly] |
11
11
  | **offset** | **Float** | The offset (if specified in the request). | [optional] |
12
12
  | **limit** | **Float** | The limit (if specified in the request). | [optional] |
13
13
  | **_links** | [**PaginationLinks**](PaginationLinks.md) | | [optional] |
@@ -6,9 +6,9 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **name** | **String** | The name of the Network Load Balancer. | |
8
8
  | **listener_lan** | **Integer** | ID of the listening LAN (inbound). | |
9
- | **ips** | **Array<String>** | 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] |
9
+ | **ips** | **Array<String>** | Collection of the Network Load Balancer IP addresses. (Inbound and outbound) IPs of the listenerLan must be customer-reserved IPs for public Load Balancers, and private IPs for private Load Balancers. | [optional] |
10
10
  | **target_lan** | **Integer** | ID of the balanced private target LAN (outbound). | |
11
- | **lb_private_ips** | **Array<String>** | 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] |
11
+ | **lb_private_ips** | **Array<String>** | Collection of private IP addresses with subnet mask of the Network Load Balancer. IPs must contain a valid subnet mask. If no IP is provided, the system will generate an IP with /24 subnet. | [optional] |
12
12
 
13
13
  ## Example
14
14
 
@@ -7,7 +7,7 @@
7
7
  | **id** | **String** | The resource's unique identifier. | [optional][readonly] |
8
8
  | **type** | [**Type**](Type.md) | The type of object that has been created. | [optional] |
9
9
  | **href** | **String** | URL to the object representation (absolute path). | [optional][readonly] |
10
- | **items** | [**Array<NetworkLoadBalancer>**](NetworkLoadBalancer.md) | Array of items in that collection. | [optional][readonly] |
10
+ | **items** | [**Array<NetworkLoadBalancer>**](NetworkLoadBalancer.md) | Array of items in the collection. | [optional][readonly] |
11
11
  | **offset** | **Float** | The offset (if specified in the request). | [optional] |
12
12
  | **limit** | **Float** | The limit (if specified in the request). | [optional] |
13
13
  | **_links** | [**PaginationLinks**](PaginationLinks.md) | | [optional] |
@@ -10,9 +10,9 @@
10
10
  | **dhcp** | **Boolean** | Indicates if the NIC will reserve an IP using DHCP. | [optional] |
11
11
  | **lan** | **Integer** | The LAN ID the NIC will be on. If the LAN ID does not exist, it will be implicitly created. | |
12
12
  | **firewall_active** | **Boolean** | Activate or deactivate the firewall. By default, an active firewall without any defined rules will block all incoming network traffic except for the firewall rules that explicitly allows certain protocols, IP addresses and ports. | [optional] |
13
- | **firewall_type** | **String** | The type of firewall rules that will be allowed on the NIC. If not specified, the default INGRESS value is taken. | [optional] |
14
- | **device_number** | **Integer** | The Logical Unit Number (LUN) of the storage volume. Null if this NIC was create from CloudAPI and no DCD changes were done on the Datacenter. | [optional][readonly] |
15
- | **pci_slot** | **Integer** | The PCI slot number of the NIC. | [optional][readonly] |
13
+ | **firewall_type** | **String** | The type of firewall rules that will be allowed on the NIC. If not specified, the default INGRESS value is used. | [optional] |
14
+ | **device_number** | **Integer** | The Logical Unit Number (LUN) of the storage volume. Null if this NIC was created using Cloud API and no DCD changes were performed on the Datacenter. | [optional][readonly] |
15
+ | **pci_slot** | **Integer** | The PCI slot number for the NIC. | [optional][readonly] |
16
16
 
17
17
  ## Example
18
18
 
data/docs/models/Nics.md CHANGED
@@ -7,7 +7,7 @@
7
7
  | **id** | **String** | The resource's unique identifier. | [optional][readonly] |
8
8
  | **type** | [**Type**](Type.md) | The type of object that has been created. | [optional] |
9
9
  | **href** | **String** | URL to the object representation (absolute path). | [optional][readonly] |
10
- | **items** | [**Array<Nic>**](Nic.md) | Array of items in that collection. | [optional] |
10
+ | **items** | [**Array<Nic>**](Nic.md) | Array of items in the collection. | [optional] |
11
11
  | **offset** | **Float** | The offset (if specified in the request). | [optional] |
12
12
  | **limit** | **Float** | The limit (if specified in the request). | [optional] |
13
13
  | **_links** | [**PaginationLinks**](PaginationLinks.md) | | [optional] |
@@ -7,7 +7,7 @@
7
7
  | **id** | **String** | The resource's unique identifier. | [optional][readonly] |
8
8
  | **type** | [**Type**](Type.md) | The type of object that has been created. | [optional] |
9
9
  | **href** | **String** | URL to the object representation (absolute path). | [optional][readonly] |
10
- | **items** | [**Array<PrivateCrossConnect>**](PrivateCrossConnect.md) | Array of items in that collection. | [optional][readonly] |
10
+ | **items** | [**Array<PrivateCrossConnect>**](PrivateCrossConnect.md) | Array of items in the collection. | [optional][readonly] |
11
11
 
12
12
  ## Example
13
13
 
@@ -7,9 +7,9 @@
7
7
  | **id** | **String** | The resource's unique identifier. | [optional][readonly] |
8
8
  | **type** | [**Type**](Type.md) | The type of object that has been created. | [optional] |
9
9
  | **href** | **String** | URL to the object representation (absolute path). | [optional][readonly] |
10
- | **items** | [**Array<Request>**](Request.md) | Array of items in that collection. | [optional][readonly] |
11
- | **offset** | **Float** | The offset specified in the request (or, if none was specified, the default offset of 0) | |
12
- | **limit** | **Float** | The limit specified in the request (if none was specified, use the endpoint's default pagination limit). | |
10
+ | **items** | [**Array<Request>**](Request.md) | Array of items in the collection. | [optional][readonly] |
11
+ | **offset** | **Float** | The offset, specified in the request (if not is specified, 0 is used by default). | |
12
+ | **limit** | **Float** | The limit, specified in the request (if not specified, the endpoint's default pagination limit is used). | |
13
13
  | **_links** | [**PaginationLinks**](PaginationLinks.md) | | |
14
14
 
15
15
  ## Example
@@ -7,7 +7,7 @@
7
7
  | **id** | **String** | The resource's unique identifier. | [optional][readonly] |
8
8
  | **type** | [**Type**](Type.md) | The type of the resource. | [optional] |
9
9
  | **href** | **String** | URL to the object representation (absolute path). | [optional][readonly] |
10
- | **items** | [**Array<Resource>**](Resource.md) | Array of items in that collection. | [optional][readonly] |
10
+ | **items** | [**Array<Resource>**](Resource.md) | Array of items in the collection. | [optional][readonly] |
11
11
 
12
12
  ## Example
13
13
 
@@ -7,7 +7,7 @@
7
7
  | **id** | **String** | The resource's unique identifier. | [optional][readonly] |
8
8
  | **type** | [**Type**](Type.md) | The type of the resource. | [optional] |
9
9
  | **href** | **String** | URL to the object representation (absolute path). | [optional][readonly] |
10
- | **items** | [**Array<Resource>**](Resource.md) | Array of items in that collection. | [optional][readonly] |
10
+ | **items** | [**Array<Resource>**](Resource.md) | Array of items in the collection. | [optional][readonly] |
11
11
 
12
12
  ## Example
13
13
 
@@ -7,7 +7,7 @@
7
7
  | **id** | **String** | The resource's unique identifier. | [optional][readonly] |
8
8
  | **type** | [**Type**](Type.md) | The type of the resource. | [optional] |
9
9
  | **href** | **String** | URL to the object representation (absolute path). | [optional][readonly] |
10
- | **items** | [**Array<Resource>**](Resource.md) | Array of items in that collection. | [optional][readonly] |
10
+ | **items** | [**Array<Resource>**](Resource.md) | Array of items in the collection. | [optional][readonly] |
11
11
 
12
12
  ## Example
13
13
 
@@ -7,7 +7,7 @@
7
7
  | **id** | **String** | The resource's unique identifier. | [optional][readonly] |
8
8
  | **type** | [**Type**](Type.md) | The type of the resource. | [optional] |
9
9
  | **href** | **String** | URL to the object representation (absolute path). | [optional][readonly] |
10
- | **items** | [**Array<S3Key>**](S3Key.md) | Array of items in that collection. | [optional][readonly] |
10
+ | **items** | [**Array<S3Key>**](S3Key.md) | Array of items in the collection. | [optional][readonly] |
11
11
 
12
12
  ## Example
13
13
 
@@ -7,7 +7,7 @@
7
7
  | **id** | **String** | The resource's unique identifier. | [optional][readonly] |
8
8
  | **type** | [**Type**](Type.md) | The type of object that has been created. | [optional] |
9
9
  | **href** | **String** | URL to the object representation (absolute path). | [optional][readonly] |
10
- | **items** | [**Array<Server>**](Server.md) | Array of items in that collection. | [optional][readonly] |
10
+ | **items** | [**Array<Server>**](Server.md) | Array of items in the collection. | [optional][readonly] |
11
11
  | **offset** | **Float** | The offset (if specified in the request). | [optional] |
12
12
  | **limit** | **Float** | The limit (if specified in the request). | [optional] |
13
13
  | **_links** | [**PaginationLinks**](PaginationLinks.md) | | [optional] |
@@ -7,7 +7,7 @@
7
7
  | **id** | **String** | The resource's unique identifier. | [optional][readonly] |
8
8
  | **type** | [**Type**](Type.md) | The type of object that has been created. | [optional] |
9
9
  | **href** | **String** | URL to the object representation (absolute path). | [optional][readonly] |
10
- | **items** | [**Array<Snapshot>**](Snapshot.md) | Array of items in that collection. | [optional][readonly] |
10
+ | **items** | [**Array<Snapshot>**](Snapshot.md) | Array of items in the collection. | [optional][readonly] |
11
11
 
12
12
  ## Example
13
13
 
@@ -0,0 +1,26 @@
1
+ # TargetGroup
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** | [**TargetGroupProperties**](TargetGroupProperties.md) | | |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ionoscloud'
17
+
18
+ instance = Ionoscloud::TargetGroup.new(
19
+ id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
20
+ type: "target-group",
21
+ href: <RESOURCE-URI>,
22
+ metadata: null,
23
+ properties: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,22 @@
1
+ # TargetGroupHealthCheck
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **check_timeout** | **Integer** | The maximum time in milliseconds to wait for a target to respond to a check. For target VMs with &#39;Check Interval&#39; set, the lesser of the two values is used once the TCP connection is established. | [optional] |
8
+ | **check_interval** | **Integer** | The interval in milliseconds between consecutive health checks; default is 2000. | [optional] |
9
+ | **retries** | **Integer** | The maximum number of attempts to reconnect to a target after a connection failure. Valid range is 0 to 65535, and default is three reconnection attempts. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'ionoscloud'
15
+
16
+ instance = Ionoscloud::TargetGroupHealthCheck.new(
17
+ check_timeout: 2000,
18
+ check_interval: 2000,
19
+ retries: 3
20
+ )
21
+ ```
22
+
@@ -0,0 +1,28 @@
1
+ # TargetGroupHttpHealthCheck
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **path** | **String** | The path (destination URL) for the HTTP health check request; the default is /. | [optional] |
8
+ | **method** | **String** | The method for the HTTP health check. | [optional] |
9
+ | **match_type** | **String** | | |
10
+ | **response** | **String** | The response returned by the request, depending on the match type. | |
11
+ | **regex** | **Boolean** | | [optional] |
12
+ | **negate** | **Boolean** | | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'ionoscloud'
18
+
19
+ instance = Ionoscloud::TargetGroupHttpHealthCheck.new(
20
+ path: /monitoring,
21
+ method: GET,
22
+ match_type: STATUS_CODE,
23
+ response: 200,
24
+ regex: false,
25
+ negate: false
26
+ )
27
+ ```
28
+
@@ -0,0 +1,28 @@
1
+ # TargetGroupProperties
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | The name of the target group. | |
8
+ | **algorithm** | **String** | Balancing algorithm | |
9
+ | **protocol** | **String** | Balancing protocol | |
10
+ | **targets** | [**Array&lt;TargetGroupTarget&gt;**](TargetGroupTarget.md) | Array of items in the collection. | [optional] |
11
+ | **health_check** | [**TargetGroupHealthCheck**](TargetGroupHealthCheck.md) | | [optional] |
12
+ | **http_health_check** | [**TargetGroupHttpHealthCheck**](TargetGroupHttpHealthCheck.md) | | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'ionoscloud'
18
+
19
+ instance = Ionoscloud::TargetGroupProperties.new(
20
+ name: My target group,
21
+ algorithm: ROUND_ROBIN,
22
+ protocol: HTTP,
23
+ targets: null,
24
+ health_check: null,
25
+ http_health_check: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,24 @@
1
+ # TargetGroupPut
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** | [**TargetGroupProperties**](TargetGroupProperties.md) | | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ionoscloud'
16
+
17
+ instance = Ionoscloud::TargetGroupPut.new(
18
+ id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
19
+ type: "applicationloadbalancer",
20
+ href: <RESOURCE-URI>,
21
+ properties: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,26 @@
1
+ # TargetGroupTarget
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **ip** | **String** | The IP of the balanced target VM. | |
8
+ | **port** | **Integer** | The port of the balanced target service; valid range is 1 to 65535. | |
9
+ | **weight** | **Integer** | Traffic is distributed in proportion to target weight, relative to the combined weight of all targets. A target with higher weight receives a greater share of traffic. Valid range is 0 to 256 and default is 1; targets with weight of 0 do not participate in load balancing but still accept persistent connections. It is best use values in the middle of the range to leave room for later adjustments. | |
10
+ | **health_check_enabled** | **Boolean** | When the health check is enabled, the target is available only when it accepts regular TCP or HTTP connection attempts for state checking. The state check consists of one connection attempt with the target&#39;s address and port. The default value is &#39;TRUE&#39;. | [optional] |
11
+ | **maintenance_enabled** | **Boolean** | When the maintenance mode is enabled, the target is prevented from receiving traffic; the default value is &#39;FALSE&#39;. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ionoscloud'
17
+
18
+ instance = Ionoscloud::TargetGroupTarget.new(
19
+ ip: 22.231.2.2,
20
+ port: 8080,
21
+ weight: 123,
22
+ health_check_enabled: null,
23
+ maintenance_enabled: null
24
+ )
25
+ ```
26
+