-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
834d321
commit 348af99
Showing
45 changed files
with
10,644 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# ApplicationLoadBalancer | ||
|
||
## 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** | [**ApplicationLoadBalancerProperties**](ApplicationLoadBalancerProperties.md) | | | | ||
| **entities** | [**ApplicationLoadBalancerEntities**](ApplicationLoadBalancerEntities.md) | | [optional] | | ||
|
||
## Example | ||
|
||
```ruby | ||
require 'ionoscloud' | ||
|
||
instance = Ionoscloud::ApplicationLoadBalancer.new( | ||
id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c, | ||
type: "applicationloadbalancer", | ||
href: <RESOURCE-URI>, | ||
metadata: null, | ||
properties: null, | ||
entities: null | ||
) | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# ApplicationLoadBalancerEntities | ||
|
||
## Properties | ||
|
||
| Name | Type | Description | Notes | | ||
| ---- | ---- | ----------- | ----- | | ||
| **forwardingrules** | [**ApplicationLoadBalancerForwardingRules**](ApplicationLoadBalancerForwardingRules.md) | | [optional] | | ||
|
||
## Example | ||
|
||
```ruby | ||
require 'ionoscloud' | ||
|
||
instance = Ionoscloud::ApplicationLoadBalancerEntities.new( | ||
forwardingrules: null | ||
) | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# ApplicationLoadBalancerForwardingRule | ||
|
||
## 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** | [**ApplicationLoadBalancerForwardingRuleProperties**](ApplicationLoadBalancerForwardingRuleProperties.md) | | | | ||
|
||
## Example | ||
|
||
```ruby | ||
require 'ionoscloud' | ||
|
||
instance = Ionoscloud::ApplicationLoadBalancerForwardingRule.new( | ||
id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c, | ||
type: "forwarding-rule", | ||
href: <RESOURCE-URI>, | ||
metadata: null, | ||
properties: null | ||
) | ||
``` | ||
|
30 changes: 30 additions & 0 deletions
30
docs/models/ApplicationLoadBalancerForwardingRuleProperties.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# ApplicationLoadBalancerForwardingRuleProperties | ||
|
||
## Properties | ||
|
||
| Name | Type | Description | Notes | | ||
| ---- | ---- | ----------- | ----- | | ||
| **name** | **String** | The name of the Application Load Balancer forwarding rule. | | | ||
| **protocol** | **String** | Balancing protocol | | | ||
| **listener_ip** | **String** | Listening (inbound) IP | | | ||
| **listener_port** | **Integer** | Listening (inbound) port number; valid range is 1 to 65535. | | | ||
| **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] | | ||
| **server_certificates** | **Array<String>** | Array of items in the collection. | [optional] | | ||
| **http_rules** | [**Array<ApplicationLoadBalancerHttpRule>**](ApplicationLoadBalancerHttpRule.md) | An array of items in the collection. The original order of rules is perserved during processing, except for Forward-type rules are processed after the rules with other action defined. The relative order of Forward-type rules is also preserved during the processing. | [optional] | | ||
|
||
## Example | ||
|
||
```ruby | ||
require 'ionoscloud' | ||
|
||
instance = Ionoscloud::ApplicationLoadBalancerForwardingRuleProperties.new( | ||
name: My Application Load Balancer forwarding rule, | ||
protocol: HTTP, | ||
listener_ip: 81.173.1.2, | ||
listener_port: 8080, | ||
client_timeout: 50, | ||
server_certificates: [3839d24f-57bd-408e-96ee-8da3d2db5a03, a6b4f7d5-b23a-4f53-b83e-8a6528ab4612], | ||
http_rules: null | ||
) | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# ApplicationLoadBalancerForwardingRulePut | ||
|
||
## 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** | [**ApplicationLoadBalancerForwardingRuleProperties**](ApplicationLoadBalancerForwardingRuleProperties.md) | | | | ||
|
||
## Example | ||
|
||
```ruby | ||
require 'ionoscloud' | ||
|
||
instance = Ionoscloud::ApplicationLoadBalancerForwardingRulePut.new( | ||
id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c, | ||
type: "forwarding-rule", | ||
href: <RESOURCE-URI>, | ||
properties: null | ||
) | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# ApplicationLoadBalancerForwardingRules | ||
|
||
## 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<ApplicationLoadBalancerForwardingRule>**](ApplicationLoadBalancerForwardingRule.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::ApplicationLoadBalancerForwardingRules.new( | ||
id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c, | ||
type: "collection", | ||
href: <RESOURCE-URI>, | ||
items: null, | ||
offset: 0, | ||
limit: 1000, | ||
_links: null | ||
) | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
) | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
) | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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] | ||
) | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
) | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
) | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
) | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
) | ||
``` | ||
|
Oops, something went wrong.