stackit-postgresflex 0.0.1a0__tar.gz → 0.2.0__tar.gz

{stackit_postgresflex-0.0.1a0 → stackit_postgresflex-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: stackit-postgresflex
-Version: 0.0.1a0
+Version: 0.2.0
 Summary: STACKIT PostgreSQL Flex API
 Author: STACKIT Developer Tools
 Author-email: developer-tools@stackit.cloud

{stackit_postgresflex-0.0.1a0 → stackit_postgresflex-0.2.0}/pyproject.toml

@@ -1,6 +1,9 @@
+[project]
+name = "stackit-postgresflex"
+
 [tool.poetry]
 name = "stackit-postgresflex"
-version = "v0.0.1a"
+version = "v0.2.0"
 authors = [
     "STACKIT Developer Tools <developer-tools@stackit.cloud>",
 ]

{stackit_postgresflex-0.0.1a0 → stackit_postgresflex-0.2.0}/src/stackit/postgresflex/api/default_api.py

@@ -4438,7 +4438,7 @@ class DefaultApi:
         metric: Annotated[
             StrictStr,
             Field(
-                description="The name of the metric. Valid metrics are 'cpu', 'memory', 'max-connections', 'connections' and 'disk-use'."
+                description="The name of the metric. Valid metrics are 'cpu', 'memory', 'disk-use', 'disk-size' and 'connections'."
             ),
         ],
         granularity: Annotated[StrictStr, Field(description="The granularity in ISO8601 e.g. 5 minutes are 'PT5M'.")],
@@ -4472,13 +4472,13 @@ class DefaultApi:
     ) -> InstanceMetricsResponse:
         """Get Metric
 
-        Returns a metric for an instance. The metric will only be for the master pod if needed. Granularity parameter is always needed. If start and end time is provided, period is not considered in max-connections and disk-use. If you provide start time, you have to provide end time as well and vice versa.
+        Returns a metric for an instance. The metric will only be for the master pod if needed. Granularity parameter is always needed. If start and end time is provided, period is not considered in connections and disk-use. If you provide start time, you have to provide end time as well and vice versa.
 
         :param project_id: The UUID of the project. (required)
         :type project_id: str
         :param instance_id: The UUID of the instance. (required)
         :type instance_id: str
-        :param metric: The name of the metric. Valid metrics are 'cpu', 'memory', 'max-connections', 'connections' and 'disk-use'. (required)
+        :param metric: The name of the metric. Valid metrics are 'cpu', 'memory', 'disk-use', 'disk-size' and 'connections'. (required)
         :type metric: str
         :param granularity: The granularity in ISO8601 e.g. 5 minutes are 'PT5M'. (required)
         :type granularity: str
@@ -4545,7 +4545,7 @@ class DefaultApi:
         metric: Annotated[
             StrictStr,
             Field(
-                description="The name of the metric. Valid metrics are 'cpu', 'memory', 'max-connections', 'connections' and 'disk-use'."
+                description="The name of the metric. Valid metrics are 'cpu', 'memory', 'disk-use', 'disk-size' and 'connections'."
             ),
         ],
         granularity: Annotated[StrictStr, Field(description="The granularity in ISO8601 e.g. 5 minutes are 'PT5M'.")],
@@ -4579,13 +4579,13 @@ class DefaultApi:
     ) -> ApiResponse[InstanceMetricsResponse]:
         """Get Metric
 
-        Returns a metric for an instance. The metric will only be for the master pod if needed. Granularity parameter is always needed. If start and end time is provided, period is not considered in max-connections and disk-use. If you provide start time, you have to provide end time as well and vice versa.
+        Returns a metric for an instance. The metric will only be for the master pod if needed. Granularity parameter is always needed. If start and end time is provided, period is not considered in connections and disk-use. If you provide start time, you have to provide end time as well and vice versa.
 
         :param project_id: The UUID of the project. (required)
         :type project_id: str
         :param instance_id: The UUID of the instance. (required)
         :type instance_id: str
-        :param metric: The name of the metric. Valid metrics are 'cpu', 'memory', 'max-connections', 'connections' and 'disk-use'. (required)
+        :param metric: The name of the metric. Valid metrics are 'cpu', 'memory', 'disk-use', 'disk-size' and 'connections'. (required)
         :type metric: str
         :param granularity: The granularity in ISO8601 e.g. 5 minutes are 'PT5M'. (required)
         :type granularity: str
@@ -4652,7 +4652,7 @@ class DefaultApi:
         metric: Annotated[
             StrictStr,
             Field(
-                description="The name of the metric. Valid metrics are 'cpu', 'memory', 'max-connections', 'connections' and 'disk-use'."
+                description="The name of the metric. Valid metrics are 'cpu', 'memory', 'disk-use', 'disk-size' and 'connections'."
             ),
         ],
         granularity: Annotated[StrictStr, Field(description="The granularity in ISO8601 e.g. 5 minutes are 'PT5M'.")],
@@ -4686,13 +4686,13 @@ class DefaultApi:
     ) -> RESTResponseType:
         """Get Metric
 
-        Returns a metric for an instance. The metric will only be for the master pod if needed. Granularity parameter is always needed. If start and end time is provided, period is not considered in max-connections and disk-use. If you provide start time, you have to provide end time as well and vice versa.
+        Returns a metric for an instance. The metric will only be for the master pod if needed. Granularity parameter is always needed. If start and end time is provided, period is not considered in connections and disk-use. If you provide start time, you have to provide end time as well and vice versa.
 
         :param project_id: The UUID of the project. (required)
         :type project_id: str
         :param instance_id: The UUID of the instance. (required)
         :type instance_id: str
-        :param metric: The name of the metric. Valid metrics are 'cpu', 'memory', 'max-connections', 'connections' and 'disk-use'. (required)
+        :param metric: The name of the metric. Valid metrics are 'cpu', 'memory', 'disk-use', 'disk-size' and 'connections'. (required)
         :type metric: str
         :param granularity: The granularity in ISO8601 e.g. 5 minutes are 'PT5M'. (required)
         :type granularity: str

{stackit_postgresflex-0.0.1a0 → stackit_postgresflex-0.2.0}/src/stackit/postgresflex/configuration.py

@@ -12,6 +12,8 @@
     Do not edit the class manually.
 """  # noqa: E501 docstring might be too long
 
+import os
+
 
 class HostConfiguration:
     def __init__(
@@ -23,7 +25,14 @@ class HostConfiguration:
         server_operation_variables=None,
         ignore_operation_servers=False,
     ) -> None:
-        """Constructor"""
+        print(
+            "WARNING: STACKIT will move to a new way of specifying regions, where the region is provided\n",
+            "as a function argument instead of being set in the client configuration.\n"
+            "Once all services have migrated, the methods to specify the region in the client configuration "
+            "will be removed.",
+        )
+        """Constructor
+        """
         self._base_path = "https://postgres-flex-service.api.eu01.stackit.cloud"
         """Default Base url
         """
@@ -65,6 +74,7 @@ class HostConfiguration:
         :param index: array index of the host settings
         :param variables: hash of variable and the corresponding value
         :param servers: an array of host settings or None
+        :error: if a region is given for a global url
         :return: URL based on host settings
         """
         if index is None:
@@ -83,8 +93,25 @@ class HostConfiguration:
 
         url = server["url"]
 
+        # check if environment variable was provided for region
+        # if nothing was set this is None
+        region_env = os.environ.get("STACKIT_REGION")
+
         # go through variables and replace placeholders
         for variable_name, variable in server.get("variables", {}).items():
+            # If a region is provided by the user for a global url
+            # return an error (except for providing via environment variable).
+            # The region is provided as a function argument instead of being set in the client configuration.
+            if (
+                variable_name == "region"
+                and (variable["default_value"] == "global" or variable["default_value"] == "")
+                and region_env is None
+                and variables.get(variable_name) is not None
+            ):
+                raise ValueError(
+                    "this API does not support setting a region in the the client configuration, "
+                    "please check if the region can be specified as a function parameter"
+                )
             used_value = variables.get(variable_name, variable["default_value"])
 
             if "enum_values" in variable and used_value not in variable["enum_values"]: