ionoscloud 6.0.2 → 6.1.0

data/docs/models/ApplicationLoadBalancerHttpRule.md

@@ -0,0 +1,34 @@
+# ApplicationLoadBalancerHttpRule
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The unique name of the Application Load Balancer HTTP rule. |  |
+| **type** | **String** | Type of the HTTP rule. |  |
+| **target_group** | **String** | The ID of the target group; mandatory and only valid for FORWARD actions. | [optional] |
+| **drop_query** | **Boolean** | Default is false; valid only for REDIRECT actions. | [optional] |
+| **location** | **String** | The location for redirecting; mandatory and valid only for REDIRECT actions. | [optional] |
+| **status_code** | **Integer** | Valid only for REDIRECT and STATIC actions. For REDIRECT actions, default is 301 and possible values are 301, 302, 303, 307, and 308. For STATIC actions, default is 503 and valid range is 200 to 599. | [optional] |
+| **response_message** | **String** | The response message of the request; mandatory for STATIC actions. | [optional] |
+| **content_type** | **String** | Valid only for STATIC actions. | [optional] |
+| **conditions** | [**Array<ApplicationLoadBalancerHttpRuleCondition>**](ApplicationLoadBalancerHttpRuleCondition.md) | An array of items in the collection.The action is only performed if each and every condition is met; if no conditions are set, the rule will always be performed. | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::ApplicationLoadBalancerHttpRule.new(
+  name: My Application Load Balancer HTTP rule,
+  type: FORWARD,
+  target_group: 96e514d0-73e4-4abd-8fbc-c0f53b79bfae,
+  drop_query: true,
+  location: www.ionos.com,
+  status_code: 301,
+  response_message: Application Down,
+  content_type: text/html,
+  conditions: null
+)
+```
+

data/docs/models/ApplicationLoadBalancerHttpRuleCondition.md

@@ -0,0 +1,26 @@
+# ApplicationLoadBalancerHttpRuleCondition
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Type of the HTTP rule condition. |  |
+| **condition** | **String** | Matching rule for the HTTP rule condition attribute; mandatory for HEADER, PATH, QUERY, METHOD, HOST, and COOKIE types; must be null when type is SOURCE_IP. |  |
+| **negate** | **Boolean** | Specifies whether the condition is negated or not; the default is False. | [optional] |
+| **key** | **String** | Must be null when type is PATH, METHOD, HOST, or SOURCE_IP. Key can only be set when type is COOKIES, HEADER, or QUERY. | [optional] |
+| **value** | **String** | Mandatory for conditions CONTAINS, EQUALS, MATCHES, STARTS_WITH, ENDS_WITH; must be null when condition is EXISTS; should be a valid CIDR if provided and if type is SOURCE_IP. | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::ApplicationLoadBalancerHttpRuleCondition.new(
+  type: HEADER,
+  condition: STARTS_WITH,
+  negate: false,
+  key: forward-at,
+  value: Friday
+)
+```
+

data/docs/models/ApplicationLoadBalancerProperties.md

@@ -0,0 +1,26 @@
+# ApplicationLoadBalancerProperties
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the Application Load Balancer. |  |
+| **listener_lan** | **Integer** | ID of the listening (inbound) LAN. |  |
+| **ips** | **Array<String>** | Collection of the Application Load Balancer IP addresses. (Inbound and outbound) IPs of the listenerLan are customer-reserved public IPs for the public Load Balancers, and private IPs for the private Load Balancers. | [optional] |
+| **target_lan** | **Integer** | ID of the balanced private target LAN (outbound). |  |
+| **lb_private_ips** | **Array<String>** | Collection of private IP addresses with the subnet mask of the Application Load Balancer. IPs must contain valid a subnet mask. If no IP is provided, the system will generate an IP with /24 subnet. | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::ApplicationLoadBalancerProperties.new(
+  name: My Application Load Balancer,
+  listener_lan: 1,
+  ips: [81.173.1.2, 22.231.2.2, 22.231.2.3],
+  target_lan: 2,
+  lb_private_ips: [81.173.1.5/24, 22.231.2.5/24]
+)
+```
+

data/docs/models/ApplicationLoadBalancerPut.md

@@ -0,0 +1,24 @@
+# ApplicationLoadBalancerPut
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier. | [optional][readonly] |
+| **type** | [**Type**](Type.md) | The type of object that has been created. | [optional] |
+| **href** | **String** | URL to the object representation (absolute path). | [optional][readonly] |
+| **properties** | [**ApplicationLoadBalancerProperties**](ApplicationLoadBalancerProperties.md) |  |  |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::ApplicationLoadBalancerPut.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "applicationloadbalancer",
+  href: <RESOURCE-URI>,
+  properties: null
+)
+```
+

data/docs/models/ApplicationLoadBalancers.md

@@ -0,0 +1,30 @@
+# ApplicationLoadBalancers
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier. | [optional][readonly] |
+| **type** | [**Type**](Type.md) | The type of object that has been created. | [optional] |
+| **href** | **String** | URL to the object representation (absolute path). | [optional][readonly] |
+| **items** | [**Array<ApplicationLoadBalancer>**](ApplicationLoadBalancer.md) | Array of items in the collection. | [optional][readonly] |
+| **offset** | **Float** | The offset (if specified in the request). | [optional] |
+| **limit** | **Float** | The limit (if specified in the request). | [optional] |
+| **_links** | [**PaginationLinks**](PaginationLinks.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::ApplicationLoadBalancers.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "collection",
+  href: <RESOURCE-URI>,
+  items: null,
+  offset: 0,
+  limit: 1000,
+  _links: null
+)
+```
+

data/docs/models/TargetGroup.md

@@ -0,0 +1,26 @@
+# TargetGroup
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier. | [optional][readonly] |
+| **type** | [**Type**](Type.md) | The type of object that has been created. | [optional] |
+| **href** | **String** | URL to the object representation (absolute path). | [optional][readonly] |
+| **metadata** | [**DatacenterElementMetadata**](DatacenterElementMetadata.md) |  | [optional] |
+| **properties** | [**TargetGroupProperties**](TargetGroupProperties.md) |  |  |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::TargetGroup.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "target-group",
+  href: <RESOURCE-URI>,
+  metadata: null,
+  properties: null
+)
+```
+

data/docs/models/TargetGroupHealthCheck.md

@@ -0,0 +1,22 @@
+# TargetGroupHealthCheck
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **check_timeout** | **Integer** | The maximum time in milliseconds to wait for a target to respond to a check. For target VMs with 'Check Interval' set, the lesser of the two  values is used once the TCP connection is established. | [optional] |
+| **check_interval** | **Integer** | The interval in milliseconds between consecutive health checks; default is 2000. | [optional] |
+| **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] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::TargetGroupHealthCheck.new(
+  check_timeout: 2000,
+  check_interval: 2000,
+  retries: 3
+)
+```
+

data/docs/models/TargetGroupHttpHealthCheck.md

@@ -0,0 +1,28 @@
+# TargetGroupHttpHealthCheck
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **path** | **String** | The path (destination URL) for the HTTP health check request; the default is /. | [optional] |
+| **method** | **String** | The method for the HTTP health check. | [optional] |
+| **match_type** | **String** |  |  |
+| **response** | **String** | The response returned by the request, depending on the match type. |  |
+| **regex** | **Boolean** |  | [optional] |
+| **negate** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::TargetGroupHttpHealthCheck.new(
+  path: /monitoring,
+  method: GET,
+  match_type: STATUS_CODE,
+  response: 200,
+  regex: false,
+  negate: false
+)
+```
+

data/docs/models/TargetGroupProperties.md

@@ -0,0 +1,28 @@
+# TargetGroupProperties
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the target group. |  |
+| **algorithm** | **String** | Balancing algorithm |  |
+| **protocol** | **String** | Balancing protocol |  |
+| **targets** | [**Array<TargetGroupTarget>**](TargetGroupTarget.md) | Array of items in the collection. | [optional] |
+| **health_check** | [**TargetGroupHealthCheck**](TargetGroupHealthCheck.md) |  | [optional] |
+| **http_health_check** | [**TargetGroupHttpHealthCheck**](TargetGroupHttpHealthCheck.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::TargetGroupProperties.new(
+  name: My target group,
+  algorithm: ROUND_ROBIN,
+  protocol: HTTP,
+  targets: null,
+  health_check: null,
+  http_health_check: null
+)
+```
+

data/docs/models/TargetGroupPut.md

@@ -0,0 +1,24 @@
+# TargetGroupPut
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier. | [optional][readonly] |
+| **type** | [**Type**](Type.md) | The type of object that has been created. | [optional] |
+| **href** | **String** | URL to the object representation (absolute path). | [optional][readonly] |
+| **properties** | [**TargetGroupProperties**](TargetGroupProperties.md) |  |  |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::TargetGroupPut.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "applicationloadbalancer",
+  href: <RESOURCE-URI>,
+  properties: null
+)
+```
+

data/docs/models/TargetGroupTarget.md

@@ -0,0 +1,26 @@
+# TargetGroupTarget
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ip** | **String** | The IP of the balanced target VM. |  |
+| **port** | **Integer** | The port of the balanced target service; valid range is 1 to 65535. |  |
+| **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. |  |
+| **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's address and port. The default value is 'TRUE'. | [optional] |
+| **maintenance_enabled** | **Boolean** | When the maintenance mode is enabled, the target is prevented from receiving traffic; the default value is 'FALSE'. | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::TargetGroupTarget.new(
+  ip: 22.231.2.2,
+  port: 8080,
+  weight: 123,
+  health_check_enabled: null,
+  maintenance_enabled: null
+)
+```
+

data/docs/models/TargetGroups.md

@@ -0,0 +1,30 @@
+# TargetGroups
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier. | [optional][readonly] |
+| **type** | [**Type**](Type.md) | The type of object that has been created. | [optional] |
+| **href** | **String** | URL to the object representation (absolute path). | [optional][readonly] |
+| **items** | [**Array<TargetGroup>**](TargetGroup.md) | Array of items in the collection. | [optional][readonly] |
+| **offset** | **Float** | The offset, specified in the request (if not is specified, 0 is used by default). | [optional] |
+| **limit** | **Float** | The limit, specified in the request (if not specified, the endpoint's default pagination limit is used). | [optional] |
+| **_links** | [**PaginationLinks**](PaginationLinks.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::TargetGroups.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "collection",
+  href: <RESOURCE-URI>,
+  items: null,
+  offset: 0,
+  limit: 1000,
+  _links: null
+)
+```
+