feat(api): add managed_metrics_enabled field to metrics configuration

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 193
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-2110902e48daa64a96807838ec3cb8461618762cca4ed69116960195481b07df.yml
-openapi_spec_hash: 3fb674220196e951da8e3d45eba67ec7
-config_hash: 719d606666b99e520b83306733eee5d5
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-46b2bdeb8322ab3291dc87f9ac5d2e899a8ea34f79b2c2b1beadc551a1700fcf.yml
+openapi_spec_hash: 1a1032b0d0f6ce441d13430b58abb3a0
+config_hash: de54bcc58fea1260a6792f8fd013439b

src/gitpod/resources/prebuilds.py

@@ -418,6 +418,8 @@ def create_warm_pool(
         environment_class_id: str,
         project_id: str,
         desired_size: int | Omit = omit,
+        max_size: Optional[int] | Omit = omit,
+        min_size: Optional[int] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -457,7 +459,14 @@ def create_warm_pool(
           project_id: project_id specifies the project this warm pool belongs to. The project must
               have prebuilds enabled.
 
-          desired_size: desired_size is the number of warm instances to maintain.
+          desired_size: desired_size is the number of warm instances to maintain. Deprecated: Use
+              min_size and max_size instead for dynamic scaling.
+
+          max_size: max_size is the maximum number of warm instances to maintain. The pool will
+              never scale above this value. Must be >= min_size and <= 20.
+
+          min_size: min_size is the minimum number of warm instances to maintain. The pool will
+              never scale below this value. Must be >= 1 and <= max_size.
 
           extra_headers: Send extra headers
 
@@ -474,6 +483,8 @@ def create_warm_pool(
                     "environment_class_id": environment_class_id,
                     "project_id": project_id,
                     "desired_size": desired_size,
+                    "max_size": max_size,
+                    "min_size": min_size,
                 },
                 prebuild_create_warm_pool_params.PrebuildCreateWarmPoolParams,
             ),
@@ -660,6 +671,8 @@ def update_warm_pool(
         *,
         warm_pool_id: str,
         desired_size: Optional[int] | Omit = omit,
+        max_size: Optional[int] | Omit = omit,
+        min_size: Optional[int] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -684,7 +697,14 @@ def update_warm_pool(
         Args:
           warm_pool_id: warm_pool_id specifies the warm pool to update
 
-          desired_size: desired_size updates the number of warm instances to maintain.
+          desired_size: desired_size updates the number of warm instances to maintain. Deprecated: Use
+              min_size and max_size instead for dynamic scaling.
+
+          max_size: max_size updates the maximum number of warm instances to maintain. The pool will
+              never scale above this value. Must be >= min_size and <= 20.
+
+          min_size: min_size updates the minimum number of warm instances to maintain. The pool will
+              never scale below this value. Must be >= 1 and <= max_size.
 
           extra_headers: Send extra headers
 
@@ -700,6 +720,8 @@ def update_warm_pool(
                 {
                     "warm_pool_id": warm_pool_id,
                     "desired_size": desired_size,
+                    "max_size": max_size,
+                    "min_size": min_size,
                 },
                 prebuild_update_warm_pool_params.PrebuildUpdateWarmPoolParams,
             ),
@@ -1085,6 +1107,8 @@ async def create_warm_pool(
         environment_class_id: str,
         project_id: str,
         desired_size: int | Omit = omit,
+        max_size: Optional[int] | Omit = omit,
+        min_size: Optional[int] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -1124,7 +1148,14 @@ async def create_warm_pool(
           project_id: project_id specifies the project this warm pool belongs to. The project must
               have prebuilds enabled.
 
-          desired_size: desired_size is the number of warm instances to maintain.
+          desired_size: desired_size is the number of warm instances to maintain. Deprecated: Use
+              min_size and max_size instead for dynamic scaling.
+
+          max_size: max_size is the maximum number of warm instances to maintain. The pool will
+              never scale above this value. Must be >= min_size and <= 20.
+
+          min_size: min_size is the minimum number of warm instances to maintain. The pool will
+              never scale below this value. Must be >= 1 and <= max_size.
 
           extra_headers: Send extra headers
 
@@ -1141,6 +1172,8 @@ async def create_warm_pool(
                     "environment_class_id": environment_class_id,
                     "project_id": project_id,
                     "desired_size": desired_size,
+                    "max_size": max_size,
+                    "min_size": min_size,
                 },
                 prebuild_create_warm_pool_params.PrebuildCreateWarmPoolParams,
             ),
@@ -1327,6 +1360,8 @@ async def update_warm_pool(
         *,
         warm_pool_id: str,
         desired_size: Optional[int] | Omit = omit,
+        max_size: Optional[int] | Omit = omit,
+        min_size: Optional[int] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -1351,7 +1386,14 @@ async def update_warm_pool(
         Args:
           warm_pool_id: warm_pool_id specifies the warm pool to update
 
-          desired_size: desired_size updates the number of warm instances to maintain.
+          desired_size: desired_size updates the number of warm instances to maintain. Deprecated: Use
+              min_size and max_size instead for dynamic scaling.
+
+          max_size: max_size updates the maximum number of warm instances to maintain. The pool will
+              never scale above this value. Must be >= min_size and <= 20.
+
+          min_size: min_size updates the minimum number of warm instances to maintain. The pool will
+              never scale below this value. Must be >= 1 and <= max_size.
 
           extra_headers: Send extra headers
 
@@ -1367,6 +1409,8 @@ async def update_warm_pool(
                 {
                     "warm_pool_id": warm_pool_id,
                     "desired_size": desired_size,
+                    "max_size": max_size,
+                    "min_size": min_size,
                 },
                 prebuild_update_warm_pool_params.PrebuildUpdateWarmPoolParams,
             ),

src/gitpod/types/metrics_configuration.py

@@ -2,6 +2,8 @@
 
 from typing import Optional
 
+from pydantic import Field as FieldInfo
+
 from .._models import BaseModel
 
 __all__ = ["MetricsConfiguration"]
@@ -11,6 +13,12 @@ class MetricsConfiguration(BaseModel):
     enabled: Optional[bool] = None
     """enabled indicates whether the runner should collect metrics"""
 
+    managed_metrics_enabled: Optional[bool] = FieldInfo(alias="managedMetricsEnabled", default=None)
+    """
+    When true, the runner pushes metrics to the management plane via
+    ReportRunnerMetrics instead of directly to the remote_write endpoint.
+    """
+
     password: Optional[str] = None
     """password is the password to use for the metrics collector"""
 

src/gitpod/types/metrics_configuration_param.py

@@ -2,7 +2,9 @@
 
 from __future__ import annotations
 
-from typing_extensions import TypedDict
+from typing_extensions import Annotated, TypedDict
+
+from .._utils import PropertyInfo
 
 __all__ = ["MetricsConfigurationParam"]
 
@@ -11,6 +13,12 @@ class MetricsConfigurationParam(TypedDict, total=False):
     enabled: bool
     """enabled indicates whether the runner should collect metrics"""
 
+    managed_metrics_enabled: Annotated[bool, PropertyInfo(alias="managedMetricsEnabled")]
+    """
+    When true, the runner pushes metrics to the management plane via
+    ReportRunnerMetrics instead of directly to the remote_write endpoint.
+    """
+
     password: str
     """password is the password to use for the metrics collector"""
 

src/gitpod/types/prebuild_create_warm_pool_params.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from typing import Optional
 from typing_extensions import Required, Annotated, TypedDict
 
 from .._utils import PropertyInfo
@@ -23,4 +24,19 @@ class PrebuildCreateWarmPoolParams(TypedDict, total=False):
     """
 
     desired_size: Annotated[int, PropertyInfo(alias="desiredSize")]
-    """desired_size is the number of warm instances to maintain."""
+    """
+    desired_size is the number of warm instances to maintain. Deprecated: Use
+    min_size and max_size instead for dynamic scaling.
+    """
+
+    max_size: Annotated[Optional[int], PropertyInfo(alias="maxSize")]
+    """
+    max_size is the maximum number of warm instances to maintain. The pool will
+    never scale above this value. Must be >= min_size and <= 20.
+    """
+
+    min_size: Annotated[Optional[int], PropertyInfo(alias="minSize")]
+    """
+    min_size is the minimum number of warm instances to maintain. The pool will
+    never scale below this value. Must be >= 1 and <= max_size.
+    """

src/gitpod/types/prebuild_update_warm_pool_params.py

@@ -15,4 +15,19 @@ class PrebuildUpdateWarmPoolParams(TypedDict, total=False):
     """warm_pool_id specifies the warm pool to update"""
 
     desired_size: Annotated[Optional[int], PropertyInfo(alias="desiredSize")]
-    """desired_size updates the number of warm instances to maintain."""
+    """
+    desired_size updates the number of warm instances to maintain. Deprecated: Use
+    min_size and max_size instead for dynamic scaling.
+    """
+
+    max_size: Annotated[Optional[int], PropertyInfo(alias="maxSize")]
+    """
+    max_size updates the maximum number of warm instances to maintain. The pool will
+    never scale above this value. Must be >= min_size and <= 20.
+    """
+
+    min_size: Annotated[Optional[int], PropertyInfo(alias="minSize")]
+    """
+    min_size updates the minimum number of warm instances to maintain. The pool will
+    never scale below this value. Must be >= 1 and <= max_size.
+    """

src/gitpod/types/runner_update_params.py

@@ -33,6 +33,12 @@ class SpecConfigurationMetrics(TypedDict, total=False):
     enabled: Optional[bool]
     """enabled indicates whether the runner should collect metrics"""
 
+    managed_metrics_enabled: Annotated[Optional[bool], PropertyInfo(alias="managedMetricsEnabled")]
+    """
+    When true, the runner pushes metrics to the management plane via
+    ReportRunnerMetrics instead of directly to the remote_write endpoint.
+    """
+
     password: Optional[str]
     """password is the password to use for the metrics collector"""
 

src/gitpod/types/warm_pool_spec.py

@@ -20,7 +20,23 @@ class WarmPoolSpec(BaseModel):
     """
 
     desired_size: Optional[int] = FieldInfo(alias="desiredSize", default=None)
-    """desired_size is the number of warm instances to maintain."""
+    """
+    desired_size is the number of warm instances to maintain. Deprecated: Use
+    min_size and max_size instead for dynamic scaling. Existing pools will be
+    migrated to min_size=max_size=desired_size.
+    """
+
+    max_size: Optional[int] = FieldInfo(alias="maxSize", default=None)
+    """
+    max_size is the maximum number of warm instances to maintain. The pool will
+    never scale above this value. Must be >= min_size and <= 20.
+    """
+
+    min_size: Optional[int] = FieldInfo(alias="minSize", default=None)
+    """
+    min_size is the minimum number of warm instances to maintain. The pool will
+    never scale below this value. Must be >= 1 and <= max_size.
+    """
 
     snapshot_id: Optional[str] = FieldInfo(alias="snapshotId", default=None)
     """

src/gitpod/types/warm_pool_status.py

@@ -21,8 +21,23 @@ class WarmPoolStatus(BaseModel):
     failure_message: Optional[str] = FieldInfo(alias="failureMessage", default=None)
     """failure_message contains details about why the warm pool is degraded or failed"""
 
+    running_instances: Optional[int] = FieldInfo(alias="runningInstances", default=None)
+    """
+    running_instances is the number of running warm instances in the pool, ready to
+    be claimed for near-instant environment startup.
+    """
+
     status_version: Optional[str] = FieldInfo(alias="statusVersion", default=None)
     """
     status_version is incremented each time the status is updated. Used for
     optimistic concurrency control.
     """
+
+    stopped_instances: Optional[int] = FieldInfo(alias="stoppedInstances", default=None)
+    """
+    stopped_instances is the number of pre-provisioned but stopped instances in the
+    pool. When a running instance is claimed, stopped instances are used to backfill
+    the running pool faster than provisioning from scratch. Stopped instances only
+    incur storage costs, allowing a larger total pool at lower cost than keeping all
+    instances running.
+    """

tests/api_resources/test_prebuilds.py

@@ -279,6 +279,8 @@ def test_method_create_warm_pool_with_all_params(self, client: Gitpod) -> None:
             environment_class_id="d2c94c27-3b76-4a42-b88c-95a85e392c68",
             project_id="b0e12f6c-4c67-429d-a4a6-d9838b5da047",
             desired_size=2,
+            max_size=1,
+            min_size=1,
         )
         assert_matches_type(PrebuildCreateWarmPoolResponse, prebuild, path=["response"])
 
@@ -437,6 +439,8 @@ def test_method_update_warm_pool_with_all_params(self, client: Gitpod) -> None:
         prebuild = client.prebuilds.update_warm_pool(
             warm_pool_id="a1b2c3d4-5678-9abc-def0-1234567890ab",
             desired_size=5,
+            max_size=1,
+            min_size=1,
         )
         assert_matches_type(PrebuildUpdateWarmPoolResponse, prebuild, path=["response"])
 
@@ -723,6 +727,8 @@ async def test_method_create_warm_pool_with_all_params(self, async_client: Async
             environment_class_id="d2c94c27-3b76-4a42-b88c-95a85e392c68",
             project_id="b0e12f6c-4c67-429d-a4a6-d9838b5da047",
             desired_size=2,
+            max_size=1,
+            min_size=1,
         )
         assert_matches_type(PrebuildCreateWarmPoolResponse, prebuild, path=["response"])
 
@@ -881,6 +887,8 @@ async def test_method_update_warm_pool_with_all_params(self, async_client: Async
         prebuild = await async_client.prebuilds.update_warm_pool(
             warm_pool_id="a1b2c3d4-5678-9abc-def0-1234567890ab",
             desired_size=5,
+            max_size=1,
+            min_size=1,
         )
         assert_matches_type(PrebuildUpdateWarmPoolResponse, prebuild, path=["response"])