API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Prebuilds

PrebuildService manages prebuilds for projects to enable faster environment startup times. Prebuilds create snapshots of environments that can be used to provision new environments quickly.

CancelPrebuild

client.Prebuilds.Cancel(ctx, body) (*PrebuildCancelResponse, error)

POST/gitpod.v1.PrebuildService/CancelPrebuild

CreatePrebuild

client.Prebuilds.New(ctx, body) (*PrebuildNewResponse, error)

POST/gitpod.v1.PrebuildService/CreatePrebuild

CreatePrebuildLogsToken

client.Prebuilds.NewLogsToken(ctx, body) (*PrebuildNewLogsTokenResponse, error)

POST/gitpod.v1.PrebuildService/CreatePrebuildLogsToken

CreateWarmPool

client.Prebuilds.NewWarmPool(ctx, body) (*PrebuildNewWarmPoolResponse, error)

POST/gitpod.v1.PrebuildService/CreateWarmPool

DeletePrebuild

client.Prebuilds.Delete(ctx, body) (*PrebuildDeleteResponse, error)

POST/gitpod.v1.PrebuildService/DeletePrebuild

DeleteWarmPool

client.Prebuilds.DeleteWarmPool(ctx, body) (*PrebuildDeleteWarmPoolResponse, error)

POST/gitpod.v1.PrebuildService/DeleteWarmPool

ListPrebuilds

client.Prebuilds.List(ctx, params) (*PrebuildsPage[Prebuild], error)

POST/gitpod.v1.PrebuildService/ListPrebuilds

ListWarmPools

client.Prebuilds.ListWarmPools(ctx, params) (*WarmPoolsPage[WarmPool], error)

POST/gitpod.v1.PrebuildService/ListWarmPools

GetPrebuild

client.Prebuilds.Get(ctx, body) (*PrebuildGetResponse, error)

POST/gitpod.v1.PrebuildService/GetPrebuild

GetWarmPool

client.Prebuilds.GetWarmPool(ctx, body) (*PrebuildGetWarmPoolResponse, error)

POST/gitpod.v1.PrebuildService/GetWarmPool

UpdateWarmPool

client.Prebuilds.UpdateWarmPool(ctx, body) (*PrebuildUpdateWarmPoolResponse, error)

POST/gitpod.v1.PrebuildService/UpdateWarmPool

ModelsExpand Collapse

type Prebuild struct{…}

Prebuild represents a prebuild for a project that creates a snapshot for faster environment startup times.

Metadata PrebuildMetadata

metadata contains organizational and ownership information

CreatedAt Time

created_at is when the prebuild was created

formatdate-time

Creator Subject

creator is the identity of who created the prebuild. For manual prebuilds, this is the user who triggered it. For scheduled prebuilds, this is the configured executor.

ID stringOptional

id is the UUID of the subject

formatuuid

Principal PrincipalOptional

Principal is the principal of the subject

One of the following:

const PrincipalUnspecified Principal = "PRINCIPAL_UNSPECIFIED"

const PrincipalAccount Principal = "PRINCIPAL_ACCOUNT"

const PrincipalUser Principal = "PRINCIPAL_USER"

const PrincipalRunner Principal = "PRINCIPAL_RUNNER"

const PrincipalEnvironment Principal = "PRINCIPAL_ENVIRONMENT"

const PrincipalServiceAccount Principal = "PRINCIPAL_SERVICE_ACCOUNT"

const PrincipalRunnerManager Principal = "PRINCIPAL_RUNNER_MANAGER"

UpdatedAt Time

updated_at is when the prebuild was last updated

formatdate-time

EnvironmentClassID stringOptional

environment_class_id is the environment class used to create this prebuild. While the prebuild is created with a specific environment class, environments with different classes (e.g., smaller or larger instance sizes) can be created from the same prebuild, as long as they run on the same runner. If not specified in create requests, uses the project’s default environment class.

formatuuid

Executor SubjectOptional

executor is the identity used to run the prebuild. The executor’s SCM credentials are used to clone the repository. If not set, the creator’s identity is used.

ID stringOptional

id is the UUID of the subject

formatuuid

Principal PrincipalOptional

Principal is the principal of the subject

One of the following:

const PrincipalUnspecified Principal = "PRINCIPAL_UNSPECIFIED"

const PrincipalAccount Principal = "PRINCIPAL_ACCOUNT"

const PrincipalUser Principal = "PRINCIPAL_USER"

const PrincipalRunner Principal = "PRINCIPAL_RUNNER"

const PrincipalEnvironment Principal = "PRINCIPAL_ENVIRONMENT"

const PrincipalServiceAccount Principal = "PRINCIPAL_SERVICE_ACCOUNT"

const PrincipalRunnerManager Principal = "PRINCIPAL_RUNNER_MANAGER"

OrganizationID stringOptional

organization_id is the ID of the organization that owns the prebuild

formatuuid

ProjectID stringOptional

project_id is the ID of the project this prebuild was created for

formatuuid

TriggeredBy PrebuildTriggerOptional

trigger describes the trigger that created this prebuild.

One of the following:

const PrebuildTriggerUnspecified PrebuildTrigger = "PREBUILD_TRIGGER_UNSPECIFIED"

const PrebuildTriggerManual PrebuildTrigger = "PREBUILD_TRIGGER_MANUAL"

const PrebuildTriggerScheduled PrebuildTrigger = "PREBUILD_TRIGGER_SCHEDULED"

Spec PrebuildSpec

spec contains the configuration used to create this prebuild

DesiredPhase PrebuildPhaseOptional

desired_phase is the desired phase of the prebuild. Used to signal cancellation or other state changes. This field is managed by the API and reconciler.

One of the following:

const PrebuildPhaseUnspecified PrebuildPhase = "PREBUILD_PHASE_UNSPECIFIED"

const PrebuildPhasePending PrebuildPhase = "PREBUILD_PHASE_PENDING"

const PrebuildPhaseStarting PrebuildPhase = "PREBUILD_PHASE_STARTING"

const PrebuildPhaseRunning PrebuildPhase = "PREBUILD_PHASE_RUNNING"

const PrebuildPhaseStopping PrebuildPhase = "PREBUILD_PHASE_STOPPING"

const PrebuildPhaseSnapshotting PrebuildPhase = "PREBUILD_PHASE_SNAPSHOTTING"

const PrebuildPhaseCompleted PrebuildPhase = "PREBUILD_PHASE_COMPLETED"

const PrebuildPhaseFailed PrebuildPhase = "PREBUILD_PHASE_FAILED"

const PrebuildPhaseCancelling PrebuildPhase = "PREBUILD_PHASE_CANCELLING"

const PrebuildPhaseCancelled PrebuildPhase = "PREBUILD_PHASE_CANCELLED"

const PrebuildPhaseDeleting PrebuildPhase = "PREBUILD_PHASE_DELETING"

const PrebuildPhaseDeleted PrebuildPhase = "PREBUILD_PHASE_DELETED"

SpecVersion stringOptional

spec_version is incremented each time the spec is updated. Used for optimistic concurrency control.

Timeout stringOptional

timeout is the maximum time allowed for the prebuild to complete. Defaults to 60 minutes if not specified. Maximum allowed timeout is 2 hours.

formatregex

Status PrebuildStatus

status contains the current status and progress of the prebuild

Phase PrebuildPhase

phase is the current phase of the prebuild lifecycle

One of the following:

const PrebuildPhaseUnspecified PrebuildPhase = "PREBUILD_PHASE_UNSPECIFIED"

const PrebuildPhasePending PrebuildPhase = "PREBUILD_PHASE_PENDING"

const PrebuildPhaseStarting PrebuildPhase = "PREBUILD_PHASE_STARTING"

const PrebuildPhaseRunning PrebuildPhase = "PREBUILD_PHASE_RUNNING"

const PrebuildPhaseStopping PrebuildPhase = "PREBUILD_PHASE_STOPPING"

const PrebuildPhaseSnapshotting PrebuildPhase = "PREBUILD_PHASE_SNAPSHOTTING"

const PrebuildPhaseCompleted PrebuildPhase = "PREBUILD_PHASE_COMPLETED"

const PrebuildPhaseFailed PrebuildPhase = "PREBUILD_PHASE_FAILED"

const PrebuildPhaseCancelling PrebuildPhase = "PREBUILD_PHASE_CANCELLING"

const PrebuildPhaseCancelled PrebuildPhase = "PREBUILD_PHASE_CANCELLED"

const PrebuildPhaseDeleting PrebuildPhase = "PREBUILD_PHASE_DELETING"

const PrebuildPhaseDeleted PrebuildPhase = "PREBUILD_PHASE_DELETED"

CompletionTime TimeOptional

completion_time is when the prebuild completed (successfully or with failure)

formatdate-time

EnvironmentID stringOptional

environment_id is the ID of the environment used to create this prebuild. This field is set when the prebuild environment is created.

formatuuid

FailureMessage stringOptional

failure_message contains details about why the prebuild failed

LogURL stringOptional

log_url provides access to prebuild logs. During prebuild execution, this references the environment logs. After completion, this may reference archived logs.

formaturi

SnapshotCompletionPercentage int64Optional

snapshot_completion_percentage is the progress of snapshot creation (0-100). Only populated when phase is SNAPSHOTTING and progress is available from the cloud provider. This value may update infrequently or remain at 0 depending on the provider.

formatint32

maximum100

SnapshotSizeBytes stringOptional

snapshot_size_bytes is the size of the snapshot in bytes. Only populated when the snapshot is available (phase is COMPLETED).

StatusVersion stringOptional

status_version is incremented each time the status is updated. Used for optimistic concurrency control.

WarningMessage stringOptional

warning_message contains warnings from the prebuild environment that indicate something went wrong but the prebuild could still complete. For example, the devcontainer failed to build but the environment is still usable. These warnings will likely affect any environment started from this prebuild.

ID stringOptional

id is the unique identifier for the prebuild

formatuuid

type PrebuildMetadata struct{…}

PrebuildMetadata contains metadata about the prebuild

CreatedAt Time

created_at is when the prebuild was created

formatdate-time

Creator Subject

creator is the identity of who created the prebuild. For manual prebuilds, this is the user who triggered it. For scheduled prebuilds, this is the configured executor.

ID stringOptional

id is the UUID of the subject

formatuuid

Principal PrincipalOptional

Principal is the principal of the subject

One of the following:

const PrincipalUnspecified Principal = "PRINCIPAL_UNSPECIFIED"

const PrincipalAccount Principal = "PRINCIPAL_ACCOUNT"

const PrincipalUser Principal = "PRINCIPAL_USER"

const PrincipalRunner Principal = "PRINCIPAL_RUNNER"

const PrincipalEnvironment Principal = "PRINCIPAL_ENVIRONMENT"

const PrincipalServiceAccount Principal = "PRINCIPAL_SERVICE_ACCOUNT"

const PrincipalRunnerManager Principal = "PRINCIPAL_RUNNER_MANAGER"

UpdatedAt Time

updated_at is when the prebuild was last updated

formatdate-time

EnvironmentClassID stringOptional

environment_class_id is the environment class used to create this prebuild. While the prebuild is created with a specific environment class, environments with different classes (e.g., smaller or larger instance sizes) can be created from the same prebuild, as long as they run on the same runner. If not specified in create requests, uses the project’s default environment class.

formatuuid

Executor SubjectOptional

executor is the identity used to run the prebuild. The executor’s SCM credentials are used to clone the repository. If not set, the creator’s identity is used.

ID stringOptional

id is the UUID of the subject

formatuuid

Principal PrincipalOptional

Principal is the principal of the subject

One of the following:

const PrincipalUnspecified Principal = "PRINCIPAL_UNSPECIFIED"

const PrincipalAccount Principal = "PRINCIPAL_ACCOUNT"

const PrincipalUser Principal = "PRINCIPAL_USER"

const PrincipalRunner Principal = "PRINCIPAL_RUNNER"

const PrincipalEnvironment Principal = "PRINCIPAL_ENVIRONMENT"

const PrincipalServiceAccount Principal = "PRINCIPAL_SERVICE_ACCOUNT"

const PrincipalRunnerManager Principal = "PRINCIPAL_RUNNER_MANAGER"

OrganizationID stringOptional

organization_id is the ID of the organization that owns the prebuild

formatuuid

ProjectID stringOptional

project_id is the ID of the project this prebuild was created for

formatuuid

TriggeredBy PrebuildTriggerOptional

trigger describes the trigger that created this prebuild.

One of the following:

const PrebuildTriggerUnspecified PrebuildTrigger = "PREBUILD_TRIGGER_UNSPECIFIED"

const PrebuildTriggerManual PrebuildTrigger = "PREBUILD_TRIGGER_MANUAL"

const PrebuildTriggerScheduled PrebuildTrigger = "PREBUILD_TRIGGER_SCHEDULED"

type PrebuildPhase string

PrebuildPhase represents the lifecycle phase of a prebuild

One of the following:

const PrebuildPhaseUnspecified PrebuildPhase = "PREBUILD_PHASE_UNSPECIFIED"

const PrebuildPhasePending PrebuildPhase = "PREBUILD_PHASE_PENDING"

const PrebuildPhaseStarting PrebuildPhase = "PREBUILD_PHASE_STARTING"

const PrebuildPhaseRunning PrebuildPhase = "PREBUILD_PHASE_RUNNING"

const PrebuildPhaseStopping PrebuildPhase = "PREBUILD_PHASE_STOPPING"

const PrebuildPhaseSnapshotting PrebuildPhase = "PREBUILD_PHASE_SNAPSHOTTING"

const PrebuildPhaseCompleted PrebuildPhase = "PREBUILD_PHASE_COMPLETED"

const PrebuildPhaseFailed PrebuildPhase = "PREBUILD_PHASE_FAILED"

const PrebuildPhaseCancelling PrebuildPhase = "PREBUILD_PHASE_CANCELLING"

const PrebuildPhaseCancelled PrebuildPhase = "PREBUILD_PHASE_CANCELLED"

const PrebuildPhaseDeleting PrebuildPhase = "PREBUILD_PHASE_DELETING"

const PrebuildPhaseDeleted PrebuildPhase = "PREBUILD_PHASE_DELETED"

type PrebuildSpec struct{…}

PrebuildSpec contains the configuration used to create a prebuild

DesiredPhase PrebuildPhaseOptional

desired_phase is the desired phase of the prebuild. Used to signal cancellation or other state changes. This field is managed by the API and reconciler.

One of the following:

const PrebuildPhaseUnspecified PrebuildPhase = "PREBUILD_PHASE_UNSPECIFIED"

const PrebuildPhasePending PrebuildPhase = "PREBUILD_PHASE_PENDING"

const PrebuildPhaseStarting PrebuildPhase = "PREBUILD_PHASE_STARTING"

const PrebuildPhaseRunning PrebuildPhase = "PREBUILD_PHASE_RUNNING"

const PrebuildPhaseStopping PrebuildPhase = "PREBUILD_PHASE_STOPPING"

const PrebuildPhaseSnapshotting PrebuildPhase = "PREBUILD_PHASE_SNAPSHOTTING"

const PrebuildPhaseCompleted PrebuildPhase = "PREBUILD_PHASE_COMPLETED"

const PrebuildPhaseFailed PrebuildPhase = "PREBUILD_PHASE_FAILED"

const PrebuildPhaseCancelling PrebuildPhase = "PREBUILD_PHASE_CANCELLING"

const PrebuildPhaseCancelled PrebuildPhase = "PREBUILD_PHASE_CANCELLED"

const PrebuildPhaseDeleting PrebuildPhase = "PREBUILD_PHASE_DELETING"

const PrebuildPhaseDeleted PrebuildPhase = "PREBUILD_PHASE_DELETED"

SpecVersion stringOptional

spec_version is incremented each time the spec is updated. Used for optimistic concurrency control.

Timeout stringOptional

timeout is the maximum time allowed for the prebuild to complete. Defaults to 60 minutes if not specified. Maximum allowed timeout is 2 hours.

formatregex

type PrebuildStatus struct{…}

PrebuildStatus contains the current status and progress of a prebuild

Phase PrebuildPhase

phase is the current phase of the prebuild lifecycle

One of the following:

const PrebuildPhaseUnspecified PrebuildPhase = "PREBUILD_PHASE_UNSPECIFIED"

const PrebuildPhasePending PrebuildPhase = "PREBUILD_PHASE_PENDING"

const PrebuildPhaseStarting PrebuildPhase = "PREBUILD_PHASE_STARTING"

const PrebuildPhaseRunning PrebuildPhase = "PREBUILD_PHASE_RUNNING"

const PrebuildPhaseStopping PrebuildPhase = "PREBUILD_PHASE_STOPPING"

const PrebuildPhaseSnapshotting PrebuildPhase = "PREBUILD_PHASE_SNAPSHOTTING"

const PrebuildPhaseCompleted PrebuildPhase = "PREBUILD_PHASE_COMPLETED"

const PrebuildPhaseFailed PrebuildPhase = "PREBUILD_PHASE_FAILED"

const PrebuildPhaseCancelling PrebuildPhase = "PREBUILD_PHASE_CANCELLING"

const PrebuildPhaseCancelled PrebuildPhase = "PREBUILD_PHASE_CANCELLED"

const PrebuildPhaseDeleting PrebuildPhase = "PREBUILD_PHASE_DELETING"

const PrebuildPhaseDeleted PrebuildPhase = "PREBUILD_PHASE_DELETED"

CompletionTime TimeOptional

completion_time is when the prebuild completed (successfully or with failure)

formatdate-time

EnvironmentID stringOptional

environment_id is the ID of the environment used to create this prebuild. This field is set when the prebuild environment is created.

formatuuid

FailureMessage stringOptional

failure_message contains details about why the prebuild failed

LogURL stringOptional

log_url provides access to prebuild logs. During prebuild execution, this references the environment logs. After completion, this may reference archived logs.

formaturi

SnapshotCompletionPercentage int64Optional

snapshot_completion_percentage is the progress of snapshot creation (0-100). Only populated when phase is SNAPSHOTTING and progress is available from the cloud provider. This value may update infrequently or remain at 0 depending on the provider.

formatint32

maximum100

SnapshotSizeBytes stringOptional

snapshot_size_bytes is the size of the snapshot in bytes. Only populated when the snapshot is available (phase is COMPLETED).

StatusVersion stringOptional

status_version is incremented each time the status is updated. Used for optimistic concurrency control.

WarningMessage stringOptional

warning_message contains warnings from the prebuild environment that indicate something went wrong but the prebuild could still complete. For example, the devcontainer failed to build but the environment is still usable. These warnings will likely affect any environment started from this prebuild.

type PrebuildTrigger string

PrebuildTrigger indicates how the prebuild was triggered

One of the following:

const PrebuildTriggerUnspecified PrebuildTrigger = "PREBUILD_TRIGGER_UNSPECIFIED"

const PrebuildTriggerManual PrebuildTrigger = "PREBUILD_TRIGGER_MANUAL"

const PrebuildTriggerScheduled PrebuildTrigger = "PREBUILD_TRIGGER_SCHEDULED"

type WarmPool struct{…}

WarmPool maintains pre-created environment instances from a prebuild snapshot for near-instant environment startup. One warm pool exists per <project, environment_class> pair.

Metadata WarmPoolMetadata

metadata contains organizational and ownership information

CreatedAt Time

created_at is when the warm pool was created

formatdate-time

UpdatedAt Time

updated_at is when the warm pool was last updated

formatdate-time

EnvironmentClassID stringOptional

environment_class_id is the environment class whose instances are warmed

formatuuid

OrganizationID stringOptional

organization_id is the ID of the organization that owns the warm pool

formatuuid

ProjectID stringOptional

project_id is the ID of the project this warm pool belongs to

formatuuid

RunnerID stringOptional

runner_id is the runner that manages this warm pool. Derived from the environment class.

formatuuid

Spec WarmPoolSpec

spec contains the desired configuration for this warm pool

DesiredPhase WarmPoolPhaseOptional

desired_phase is the intended lifecycle phase for this warm pool. Managed by the API and reconciler.

One of the following:

const WarmPoolPhaseUnspecified WarmPoolPhase = "WARM_POOL_PHASE_UNSPECIFIED"

const WarmPoolPhasePending WarmPoolPhase = "WARM_POOL_PHASE_PENDING"

const WarmPoolPhaseReady WarmPoolPhase = "WARM_POOL_PHASE_READY"

const WarmPoolPhaseDegraded WarmPoolPhase = "WARM_POOL_PHASE_DEGRADED"

const WarmPoolPhaseDeleting WarmPoolPhase = "WARM_POOL_PHASE_DELETING"

const WarmPoolPhaseDeleted WarmPoolPhase = "WARM_POOL_PHASE_DELETED"

DeprecatedDesiredSize int64Optional

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.

formatint32

maximum20

minimum1

MaxSize int64Optional

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.

formatint32

maximum20

minimum1

MinSize int64Optional

min_size is the minimum number of warm instances to maintain. The pool will never scale below this value. Must be >= 0 and <= max_size. Set to 0 to allow full scale-down.

formatint32

maximum20

SnapshotID stringOptional

snapshot_id is the prebuild snapshot to warm up in the pool. Updated by the reconciler when a new prebuild completes for this project and environment class. Empty when no completed prebuild exists yet.

formatuuid

SpecVersion stringOptional

spec_version is incremented each time the spec is updated. Used for optimistic concurrency control.

Status WarmPoolStatus

status contains the current status reported by the runner

Phase WarmPoolPhase

phase is the current phase of the warm pool lifecycle

One of the following:

const WarmPoolPhaseUnspecified WarmPoolPhase = "WARM_POOL_PHASE_UNSPECIFIED"

const WarmPoolPhasePending WarmPoolPhase = "WARM_POOL_PHASE_PENDING"

const WarmPoolPhaseReady WarmPoolPhase = "WARM_POOL_PHASE_READY"

const WarmPoolPhaseDegraded WarmPoolPhase = "WARM_POOL_PHASE_DEGRADED"

const WarmPoolPhaseDeleting WarmPoolPhase = "WARM_POOL_PHASE_DELETING"

const WarmPoolPhaseDeleted WarmPoolPhase = "WARM_POOL_PHASE_DELETED"

DesiredSize int64Optional

desired_size is the current target number of instances the autoscaler has decided on. Unlike running_instances, this value is stable and does not fluctuate as instances are claimed and backfilled.

formatint32

FailureMessage stringOptional

failure_message contains details about why the warm pool is degraded or failed

RunningInstances int64Optional

running_instances is the number of running warm instances in the pool, ready to be claimed for near-instant environment startup.

formatint32

StatusVersion stringOptional

status_version is incremented each time the status is updated. Used for optimistic concurrency control.

StoppedInstances int64Optional

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.

formatint32

ID stringOptional

id is the unique identifier for the warm pool

formatuuid

type WarmPoolMetadata struct{…}

WarmPoolMetadata contains metadata about the warm pool

CreatedAt Time

created_at is when the warm pool was created

formatdate-time

UpdatedAt Time

updated_at is when the warm pool was last updated

formatdate-time

EnvironmentClassID stringOptional

environment_class_id is the environment class whose instances are warmed

formatuuid

OrganizationID stringOptional

organization_id is the ID of the organization that owns the warm pool

formatuuid

ProjectID stringOptional

project_id is the ID of the project this warm pool belongs to

formatuuid

RunnerID stringOptional

runner_id is the runner that manages this warm pool. Derived from the environment class.

formatuuid

type WarmPoolPhase string

WarmPoolPhase represents the lifecycle phase of a warm pool

One of the following:

const WarmPoolPhaseUnspecified WarmPoolPhase = "WARM_POOL_PHASE_UNSPECIFIED"

const WarmPoolPhasePending WarmPoolPhase = "WARM_POOL_PHASE_PENDING"

const WarmPoolPhaseReady WarmPoolPhase = "WARM_POOL_PHASE_READY"

const WarmPoolPhaseDegraded WarmPoolPhase = "WARM_POOL_PHASE_DEGRADED"

const WarmPoolPhaseDeleting WarmPoolPhase = "WARM_POOL_PHASE_DELETING"

const WarmPoolPhaseDeleted WarmPoolPhase = "WARM_POOL_PHASE_DELETED"

type WarmPoolSpec struct{…}

WarmPoolSpec contains the desired configuration for a warm pool

DesiredPhase WarmPoolPhaseOptional

desired_phase is the intended lifecycle phase for this warm pool. Managed by the API and reconciler.

One of the following:

const WarmPoolPhaseUnspecified WarmPoolPhase = "WARM_POOL_PHASE_UNSPECIFIED"

const WarmPoolPhasePending WarmPoolPhase = "WARM_POOL_PHASE_PENDING"

const WarmPoolPhaseReady WarmPoolPhase = "WARM_POOL_PHASE_READY"

const WarmPoolPhaseDegraded WarmPoolPhase = "WARM_POOL_PHASE_DEGRADED"

const WarmPoolPhaseDeleting WarmPoolPhase = "WARM_POOL_PHASE_DELETING"

const WarmPoolPhaseDeleted WarmPoolPhase = "WARM_POOL_PHASE_DELETED"

DeprecatedDesiredSize int64Optional

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.

formatint32

maximum20

minimum1

MaxSize int64Optional

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.

formatint32

maximum20

minimum1

MinSize int64Optional

min_size is the minimum number of warm instances to maintain. The pool will never scale below this value. Must be >= 0 and <= max_size. Set to 0 to allow full scale-down.

formatint32

maximum20

SnapshotID stringOptional

snapshot_id is the prebuild snapshot to warm up in the pool. Updated by the reconciler when a new prebuild completes for this project and environment class. Empty when no completed prebuild exists yet.

formatuuid

SpecVersion stringOptional

spec_version is incremented each time the spec is updated. Used for optimistic concurrency control.

type WarmPoolStatus struct{…}

WarmPoolStatus contains the current status of a warm pool as reported by the runner

Phase WarmPoolPhase

phase is the current phase of the warm pool lifecycle

One of the following:

const WarmPoolPhaseUnspecified WarmPoolPhase = "WARM_POOL_PHASE_UNSPECIFIED"

const WarmPoolPhasePending WarmPoolPhase = "WARM_POOL_PHASE_PENDING"

const WarmPoolPhaseReady WarmPoolPhase = "WARM_POOL_PHASE_READY"

const WarmPoolPhaseDegraded WarmPoolPhase = "WARM_POOL_PHASE_DEGRADED"

const WarmPoolPhaseDeleting WarmPoolPhase = "WARM_POOL_PHASE_DELETING"

const WarmPoolPhaseDeleted WarmPoolPhase = "WARM_POOL_PHASE_DELETED"

DesiredSize int64Optional

desired_size is the current target number of instances the autoscaler has decided on. Unlike running_instances, this value is stable and does not fluctuate as instances are claimed and backfilled.

formatint32

FailureMessage stringOptional

failure_message contains details about why the warm pool is degraded or failed

RunningInstances int64Optional

running_instances is the number of running warm instances in the pool, ready to be claimed for near-instant environment startup.

formatint32

StatusVersion stringOptional

status_version is incremented each time the status is updated. Used for optimistic concurrency control.

StoppedInstances int64Optional

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.

formatint32