stackit-loadbalancer 0.0.1a1__py3-none-any.whl

stackit/loadbalancer/models/load_balancer.py

@@ -0,0 +1,231 @@
+# coding: utf-8
+
+"""
+    Load Balancer API
+
+    This API offers an interface to provision and manage load balancing servers in your STACKIT project. It also has the possibility of pooling target servers for load balancing purposes.  For each load balancer provided, two VMs are deployed in your OpenStack project subject to a fee.
+
+    The version of the OpenAPI document: 1.7.2
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501 docstring might be too long
+
+from __future__ import annotations
+
+import json
+import pprint
+import re
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing_extensions import Annotated, Self
+
+from stackit.loadbalancer.models.listener import Listener
+from stackit.loadbalancer.models.load_balancer_error import LoadBalancerError
+from stackit.loadbalancer.models.load_balancer_options import LoadBalancerOptions
+from stackit.loadbalancer.models.network import Network
+from stackit.loadbalancer.models.target_pool import TargetPool
+
+
+class LoadBalancer(BaseModel):
+    """
+    LoadBalancer
+    """
+
+    errors: Optional[List[LoadBalancerError]] = Field(
+        default=None, description="Reports all errors a load balancer has."
+    )
+    external_address: Optional[StrictStr] = Field(
+        default=None,
+        description="External load balancer IP address where this load balancer is exposed. Not changeable after creation.",
+        alias="externalAddress",
+    )
+    listeners: Optional[List[Listener]] = Field(
+        default=None,
+        description="There is a maximum listener count of 20.  Port and protocol limitations:  - UDP listeners cannot have the same port. - TCP-derived listeners cannot have the same port. A TCP-derived listener is any listener that listens on a TCP port. As of now those are: TCP, TCP_PROXY, and PROTOCOL_TLS_PASSTHROUGH. The only exception is, if all listeners for the same port are PROTOCOL_TLS_PASSTHROUGH. - PROTOCOL_TLS_PASSTHROUGH listeners cannot have the same port and at least one common domain name. - PROTOCOL_TLS_PASSTHROUGH listeners can have the same domain name and different ports though (e.g. ports 443 and 8443 for domain example.com). - PROTOCOL_TLS_PASSTHROUGH listeners without a domain name serve as a default listener and you can have only one default listener. ",
+    )
+    name: Optional[Annotated[str, Field(strict=True)]] = Field(
+        default=None, description="Load balancer name. Not changeable after creation."
+    )
+    networks: Optional[List[Network]] = Field(
+        default=None,
+        description="List of networks that listeners and targets reside in. Currently limited to one. Not changeable after creation.",
+    )
+    options: Optional[LoadBalancerOptions] = None
+    plan_id: Optional[StrictStr] = Field(
+        default=None,
+        description="Service Plan configures the size of the Load Balancer. Currently supported plans are p10, p50, p250 and p750. This list can change in the future where plan ids will be removed and new plans by added. That is the reason this is not an enum.",
+        alias="planId",
+    )
+    private_address: Optional[StrictStr] = Field(
+        default=None,
+        description="Transient private load balancer IP address that can change any time.",
+        alias="privateAddress",
+    )
+    status: Optional[StrictStr] = None
+    target_pools: Optional[List[TargetPool]] = Field(
+        default=None,
+        description="List of all target pools which will be used in the load balancer. Limited to 20.",
+        alias="targetPools",
+    )
+    version: Optional[StrictStr] = Field(
+        default=None,
+        description="Load balancer resource version. Must be empty or unset for creating load balancers, non-empty for updating load balancers. Semantics: While retrieving load balancers, this is the current version of this load balancer resource that changes during updates of the load balancers. On updates this field specified the load balancer version you calculated your update for instead of the future version to enable concurrency safe updates. Update calls will then report the new version in their result as you would see with a load balancer retrieval call later. There exist no total order of the version, so you can only compare it for equality, but not for less/greater than another version. Since the creation of load balancer is always intended to create the first version of it, there should be no existing version. That's why this field must by empty of not present in that case.",
+    )
+    __properties: ClassVar[List[str]] = [
+        "errors",
+        "externalAddress",
+        "listeners",
+        "name",
+        "networks",
+        "options",
+        "planId",
+        "privateAddress",
+        "status",
+        "targetPools",
+        "version",
+    ]
+
+    @field_validator("name")
+    def name_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^[0-9a-z](?:(?:[0-9a-z]|-){0,61}[0-9a-z])?$", value):
+            raise ValueError(r"must validate the regular expression /^[0-9a-z](?:(?:[0-9a-z]|-){0,61}[0-9a-z])?$/")
+        return value
+
+    @field_validator("status")
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(
+            ["STATUS_UNSPECIFIED", "STATUS_PENDING", "STATUS_READY", "STATUS_ERROR", "STATUS_TERMINATING"]
+        ):
+            raise ValueError(
+                "must be one of enum values ('STATUS_UNSPECIFIED', 'STATUS_PENDING', 'STATUS_READY', 'STATUS_ERROR', 'STATUS_TERMINATING')"
+            )
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of LoadBalancer from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set(
+            [
+                "errors",
+                "private_address",
+                "status",
+            ]
+        )
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in errors (list)
+        _items = []
+        if self.errors:
+            for _item in self.errors:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict["errors"] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in listeners (list)
+        _items = []
+        if self.listeners:
+            for _item in self.listeners:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict["listeners"] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in networks (list)
+        _items = []
+        if self.networks:
+            for _item in self.networks:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict["networks"] = _items
+        # override the default output from pydantic by calling `to_dict()` of options
+        if self.options:
+            _dict["options"] = self.options.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in target_pools (list)
+        _items = []
+        if self.target_pools:
+            for _item in self.target_pools:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict["targetPools"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of LoadBalancer from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "errors": (
+                    [LoadBalancerError.from_dict(_item) for _item in obj["errors"]]
+                    if obj.get("errors") is not None
+                    else None
+                ),
+                "externalAddress": obj.get("externalAddress"),
+                "listeners": (
+                    [Listener.from_dict(_item) for _item in obj["listeners"]]
+                    if obj.get("listeners") is not None
+                    else None
+                ),
+                "name": obj.get("name"),
+                "networks": (
+                    [Network.from_dict(_item) for _item in obj["networks"]] if obj.get("networks") is not None else None
+                ),
+                "options": LoadBalancerOptions.from_dict(obj["options"]) if obj.get("options") is not None else None,
+                "planId": obj.get("planId"),
+                "privateAddress": obj.get("privateAddress"),
+                "status": obj.get("status"),
+                "targetPools": (
+                    [TargetPool.from_dict(_item) for _item in obj["targetPools"]]
+                    if obj.get("targetPools") is not None
+                    else None
+                ),
+                "version": obj.get("version"),
+            }
+        )
+        return _obj

stackit/loadbalancer/models/load_balancer_error.py

@@ -0,0 +1,113 @@
+# coding: utf-8
+
+"""
+    Load Balancer API
+
+    This API offers an interface to provision and manage load balancing servers in your STACKIT project. It also has the possibility of pooling target servers for load balancing purposes.  For each load balancer provided, two VMs are deployed in your OpenStack project subject to a fee.
+
+    The version of the OpenAPI document: 1.7.2
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501 docstring might be too long
+
+from __future__ import annotations
+
+import json
+import pprint
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing_extensions import Self
+
+
+class LoadBalancerError(BaseModel):
+    """
+    LoadBalancerError
+    """
+
+    description: Optional[StrictStr] = Field(
+        default=None,
+        description='The error description contains additional helpful user information to fix the error state of the load balancer. For example the IP 45.135.247.139 does not exist in the project, then the description will report: Floating IP "45.135.247.139" could not be found or if the IP was deleted then you will get a proper error message.',
+    )
+    type: Optional[StrictStr] = Field(
+        default=None,
+        description="The error type specifies which part of the load balancer encountered the error. I.e. the API will not check if a provided public IP is actually available in the project. Instead the load balancer with try to use the provided IP and if not available reports TYPE_FIP_NOT_CONFIGURED error or TYPE_FIP_NOT_FOUND if the IP was deleted.",
+    )
+    __properties: ClassVar[List[str]] = ["description", "type"]
+
+    @field_validator("type")
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(
+            [
+                "TYPE_UNSPECIFIED",
+                "TYPE_INTERNAL",
+                "TYPE_QUOTA_SECGROUP_EXCEEDED",
+                "TYPE_QUOTA_SECGROUPRULE_EXCEEDED",
+                "TYPE_PORT_NOT_CONFIGURED",
+                "TYPE_FIP_NOT_CONFIGURED",
+                "TYPE_TARGET_NOT_ACTIVE",
+                "TYPE_METRICS_MISCONFIGURED",
+                "TYPE_LOGS_MISCONFIGURED",
+                "TYPE_FIP_NOT_FOUND",
+            ]
+        ):
+            raise ValueError(
+                "must be one of enum values ('TYPE_UNSPECIFIED', 'TYPE_INTERNAL', 'TYPE_QUOTA_SECGROUP_EXCEEDED', 'TYPE_QUOTA_SECGROUPRULE_EXCEEDED', 'TYPE_PORT_NOT_CONFIGURED', 'TYPE_FIP_NOT_CONFIGURED', 'TYPE_TARGET_NOT_ACTIVE', 'TYPE_METRICS_MISCONFIGURED', 'TYPE_LOGS_MISCONFIGURED', 'TYPE_FIP_NOT_FOUND')"
+            )
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of LoadBalancerError from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of LoadBalancerError from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"description": obj.get("description"), "type": obj.get("type")})
+        return _obj

stackit/loadbalancer/models/load_balancer_options.py

@@ -0,0 +1,116 @@
+# coding: utf-8
+
+"""
+    Load Balancer API
+
+    This API offers an interface to provision and manage load balancing servers in your STACKIT project. It also has the possibility of pooling target servers for load balancing purposes.  For each load balancer provided, two VMs are deployed in your OpenStack project subject to a fee.
+
+    The version of the OpenAPI document: 1.7.2
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501 docstring might be too long
+
+from __future__ import annotations
+
+import json
+import pprint
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool
+from typing_extensions import Self
+
+from stackit.loadbalancer.models.loadbalancer_option_access_control import (
+    LoadbalancerOptionAccessControl,
+)
+from stackit.loadbalancer.models.loadbalancer_option_observability import (
+    LoadbalancerOptionObservability,
+)
+
+
+class LoadBalancerOptions(BaseModel):
+    """
+    Defines any optional functionality you want to have enabled on your load balancer.
+    """
+
+    access_control: Optional[LoadbalancerOptionAccessControl] = Field(default=None, alias="accessControl")
+    ephemeral_address: Optional[StrictBool] = Field(default=None, alias="ephemeralAddress")
+    observability: Optional[LoadbalancerOptionObservability] = None
+    private_network_only: Optional[StrictBool] = Field(
+        default=None,
+        description="Load Balancer is accessible only via a private network ip address. Not changeable after creation.",
+        alias="privateNetworkOnly",
+    )
+    __properties: ClassVar[List[str]] = ["accessControl", "ephemeralAddress", "observability", "privateNetworkOnly"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of LoadBalancerOptions from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of access_control
+        if self.access_control:
+            _dict["accessControl"] = self.access_control.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of observability
+        if self.observability:
+            _dict["observability"] = self.observability.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of LoadBalancerOptions from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "accessControl": (
+                    LoadbalancerOptionAccessControl.from_dict(obj["accessControl"])
+                    if obj.get("accessControl") is not None
+                    else None
+                ),
+                "ephemeralAddress": obj.get("ephemeralAddress"),
+                "observability": (
+                    LoadbalancerOptionObservability.from_dict(obj["observability"])
+                    if obj.get("observability") is not None
+                    else None
+                ),
+                "privateNetworkOnly": obj.get("privateNetworkOnly"),
+            }
+        )
+        return _obj

stackit/loadbalancer/models/loadbalancer_option_access_control.py

@@ -0,0 +1,85 @@
+# coding: utf-8
+
+"""
+    Load Balancer API
+
+    This API offers an interface to provision and manage load balancing servers in your STACKIT project. It also has the possibility of pooling target servers for load balancing purposes.  For each load balancer provided, two VMs are deployed in your OpenStack project subject to a fee.
+
+    The version of the OpenAPI document: 1.7.2
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501 docstring might be too long
+
+from __future__ import annotations
+
+import json
+import pprint
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing_extensions import Self
+
+
+class LoadbalancerOptionAccessControl(BaseModel):
+    """
+    Use this option to limit the IP ranges that can use the load balancer.
+    """
+
+    allowed_source_ranges: Optional[List[StrictStr]] = Field(
+        default=None,
+        description="Load Balancer is accessible only from an IP address in this range",
+        alias="allowedSourceRanges",
+    )
+    __properties: ClassVar[List[str]] = ["allowedSourceRanges"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of LoadbalancerOptionAccessControl from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of LoadbalancerOptionAccessControl from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"allowedSourceRanges": obj.get("allowedSourceRanges")})
+        return _obj

stackit/loadbalancer/models/loadbalancer_option_logs.py

@@ -0,0 +1,90 @@
+# coding: utf-8
+
+"""
+    Load Balancer API
+
+    This API offers an interface to provision and manage load balancing servers in your STACKIT project. It also has the possibility of pooling target servers for load balancing purposes.  For each load balancer provided, two VMs are deployed in your OpenStack project subject to a fee.
+
+    The version of the OpenAPI document: 1.7.2
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501 docstring might be too long
+
+from __future__ import annotations
+
+import json
+import pprint
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing_extensions import Self
+
+
+class LoadbalancerOptionLogs(BaseModel):
+    """
+    LoadbalancerOptionLogs
+    """
+
+    credentials_ref: Optional[StrictStr] = Field(
+        default=None,
+        description="Credentials reference for logging. This reference is created via the observability create endpoint and the credential needs to contain the basic auth username and password for the logging solution the push URL points to. Then this enables monitoring via remote write for the Load Balancer.",
+        alias="credentialsRef",
+    )
+    push_url: Optional[StrictStr] = Field(
+        default=None,
+        description="The ARGUS/Loki remote write Push URL you want the logs to be shipped to.",
+        alias="pushUrl",
+    )
+    __properties: ClassVar[List[str]] = ["credentialsRef", "pushUrl"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of LoadbalancerOptionLogs from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of LoadbalancerOptionLogs from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"credentialsRef": obj.get("credentialsRef"), "pushUrl": obj.get("pushUrl")})
+        return _obj