Expand description
Types used as operation parameters and responses.
Modules§
Structs§
- Acquire
Request AcquireRequest- Acquire
Response AcquireResponse- Acquired
Deployment Response AcquiredDeploymentResponse- Agent
Sync Request AgentSyncRequest- Agent
Sync Response AgentSyncResponse- Alien
Error - Canonical error container that provides a structured way to represent errors with rich metadata including error codes, human-readable messages, context, and chaining capabilities for error propagation.
- Alien
Error Code - A unique identifier for the type of error.
- Alien
Error Message - Human-readable error message.
- Artifact
Registry Heartbeat Status ArtifactRegistryHeartbeatStatus- AwsCode
Build Heartbeat Data AwsCodeBuildHeartbeatData- AwsCompute
Cluster Heartbeat Data AwsComputeClusterHeartbeatData- AwsCustom
Certificate Config AwsCustomCertificateConfig- AwsDaemon
Heartbeat Data AwsDaemonHeartbeatData- AwsDynamo
DbKey Schema Element AwsDynamoDbKeySchemaElement- AwsDynamo
DbKv Heartbeat Data AwsDynamoDbKvHeartbeatData- AwsEcr
Artifact Registry Heartbeat Data AwsEcrArtifactRegistryHeartbeatData- AwsEcr
Repository Heartbeat Data AwsEcrRepositoryHeartbeatData- AwsIam
Role Service Account Heartbeat Data AwsIamRoleServiceAccountHeartbeatData- AwsLambda
Worker Heartbeat Data AwsLambdaWorkerHeartbeatData- AwsManagement
Config - AWS management configuration extracted from stack settings
- AwsParameter
Store Vault Heartbeat Data AwsParameterStoreVaultHeartbeatData- AwsRemote
Stack Management Heartbeat Data AwsRemoteStackManagementHeartbeatData- AwsS3
Storage Heartbeat Data AwsS3StorageHeartbeatData- AwsSqs
Queue Heartbeat Data AwsSqsQueueHeartbeatData- AwsVpc
Network Heartbeat Data AwsVpcNetworkHeartbeatData- Azure
Blob Storage Heartbeat Data AzureBlobStorageHeartbeatData- Azure
Compute Cluster Heartbeat Data AzureComputeClusterHeartbeatData- Azure
Container Apps Build Heartbeat Data AzureContainerAppsBuildHeartbeatData- Azure
Container Apps Environment Heartbeat Data AzureContainerAppsEnvironmentHeartbeatData- Azure
Container Apps Environment Heartbeat Status AzureContainerAppsEnvironmentHeartbeatStatus- Azure
Container Apps Environment Workload Profile AzureContainerAppsEnvironmentWorkloadProfile- Azure
Container Apps Worker Heartbeat Data AzureContainerAppsWorkerHeartbeatData- Azure
Container Registry Heartbeat Data AzureContainerRegistryHeartbeatData- Azure
Custom Certificate Config AzureCustomCertificateConfig- Azure
Daemon Heartbeat Data AzureDaemonHeartbeatData- Azure
KeyVault Heartbeat Data AzureKeyVaultHeartbeatData- Azure
Managed Identity Service Account Heartbeat Data AzureManagedIdentityServiceAccountHeartbeatData- Azure
Management Config - Azure management configuration extracted from stack settings
- Azure
Remote Stack Management Heartbeat Data AzureRemoteStackManagementHeartbeatData- Azure
Resource Group Heartbeat Data AzureResourceGroupHeartbeatData- Azure
Resource Group Heartbeat Status AzureResourceGroupHeartbeatStatus- Azure
Resource Provider Activation Heartbeat Data AzureResourceProviderActivationHeartbeatData- Azure
Service BusNamespace Heartbeat Data AzureServiceBusNamespaceHeartbeatData- Azure
Service BusQueue Heartbeat Data AzureServiceBusQueueHeartbeatData- Azure
Storage Account Endpoints AzureStorageAccountEndpoints- Azure
Storage Account Heartbeat Data AzureStorageAccountHeartbeatData- Azure
Table KvHeartbeat Data AzureTableKvHeartbeatData- Azure
Vnet Network Heartbeat Data AzureVnetNetworkHeartbeatData- Base
Resource - Resource that can hold any resource type in the Alien system. All resources share common ‘type’ and ‘id’ fields with additional type-specific properties.
- Base
Resource Outputs - Resource outputs that can hold output data for any resource type in the Alien system. All resource outputs share a common ‘type’ field with additional type-specific output properties.
- Build
Heartbeat Status BuildHeartbeatStatus- Command
Payload Response - Payload response containing params and response data from KV
- Command
Status Response - Response to status queries
- Commands
Info CommandsInfo- Compute
Capacity Blocker ComputeCapacityBlocker- Compute
Capacity Group Status ComputeCapacityGroupStatus- Compute
Capacity Recommendation ComputeCapacityRecommendation- Compute
Cluster Heartbeat Status ComputeClusterHeartbeatStatus- Create
Command Request - Request to create a new command
- Create
Command Response - Response to command creation
- Create
Deployment Group Request CreateDeploymentGroupRequest- Create
Deployment Request CreateDeploymentRequest- Create
Deployment Response CreateDeploymentResponse- Create
Release Request CreateReleaseRequest- Create
Token Response CreateTokenResponse- Custom
Certificate Config - Platform-specific certificate references for custom domains.
- Custom
Domain Config - Custom domain configuration for a single resource.
- Delete
Deployment Request DeleteDeploymentRequest- Deployment
Group Minimal DeploymentGroupMinimal- Deployment
Group Response DeploymentGroupResponse- Deployment
Info Response DeploymentInfoResponse- Deployment
Response DeploymentResponse- Domain
Settings - Domain configuration for the stack.
- Envelope
- Commands envelope sent to deployments
- Environment
Variable - Environment variable for deployment
- Error
Response - Error response wrapper for API endpoints
- GcpArtifact
Registry Heartbeat Data GcpArtifactRegistryHeartbeatData- GcpCloud
Build Heartbeat Data GcpCloudBuildHeartbeatData- GcpCloud
RunWorker Heartbeat Data GcpCloudRunWorkerHeartbeatData- GcpCloud
Storage Heartbeat Data GcpCloudStorageHeartbeatData- GcpCompute
Cluster Heartbeat Data GcpComputeClusterHeartbeatData- GcpCustom
Certificate Config GcpCustomCertificateConfig- GcpDaemon
Heartbeat Data GcpDaemonHeartbeatData- GcpFirestore
KvHeartbeat Data GcpFirestoreKvHeartbeatData- GcpManagement
Config - GCP management configuration extracted from stack settings
- GcpPub
SubQueue Heartbeat Data GcpPubSubQueueHeartbeatData- GcpRemote
Stack Management Heartbeat Data GcpRemoteStackManagementHeartbeatData- GcpSecret
Manager Vault Heartbeat Data GcpSecretManagerVaultHeartbeatData- GcpService
Account Heartbeat Data GcpServiceAccountHeartbeatData- GcpService
Usage Activation Heartbeat Data GcpServiceUsageActivationHeartbeatData- GcpVpc
Network Heartbeat Data GcpVpcNetworkHeartbeatData- GitMetadata
GitMetadata- GitMetadata
Response GitMetadataResponse- Health
Response HealthResponse- Heartbeat
Collection Issue HeartbeatCollectionIssue- Horizon
Container Heartbeat Data HorizonContainerHeartbeatData- Imported
Resource - One resolved resource import payload.
- Initialize
Request InitializeRequest- Initialize
Response InitializeResponse- Kubernetes
Build Heartbeat Data KubernetesBuildHeartbeatData- Kubernetes
Cloud Reference - Optional provider-specific identity for a cloud-backed Kubernetes cluster.
- Kubernetes
Cluster Heartbeat Data KubernetesClusterHeartbeatData- Kubernetes
Cluster Node Status KubernetesClusterNodeStatus- Kubernetes
Cluster Settings - Kubernetes cluster setup settings.
- Kubernetes
Container Heartbeat Data KubernetesContainerHeartbeatData- Kubernetes
Custom Certificate Config KubernetesCustomCertificateConfig- Kubernetes
Daemon Heartbeat Data KubernetesDaemonHeartbeatData- Kubernetes
Event Involved Object KubernetesEventInvolvedObject- Kubernetes
Event Snapshot KubernetesEventSnapshot- Kubernetes
Event Source KubernetesEventSource- Kubernetes
Gateway Route Profile - Shared Gateway API route profile values.
- Kubernetes
Ingress Route Profile - Shared Ingress route profile values.
- Kubernetes
Node Condition Status KubernetesNodeConditionStatus- Kubernetes
Node Resources KubernetesNodeResources- Kubernetes
Node Usage KubernetesNodeUsage- Kubernetes
Owner Reference KubernetesOwnerReference- Kubernetes
PodRuntime Unit Status KubernetesPodRuntimeUnitStatus- Kubernetes
Secret Vault Heartbeat Data KubernetesSecretVaultHeartbeatData- Kubernetes
Settings - Kubernetes runtime substrate configuration.
- Kubernetes
TlsSecret Ref - Namespace-scoped Kubernetes TLS Secret reference.
- Kubernetes
Worker Heartbeat Data KubernetesWorkerHeartbeatData- Kubernetes
Workload Condition KubernetesWorkloadCondition- Kubernetes
Workload Status KubernetesWorkloadStatus- KvHeartbeat
Status KvHeartbeatStatus- Lease
Info - Lease information
- Lease
Request - Request for acquiring leases
- Lease
Response - Response to lease acquisition
- List
Deployment Groups Response ListDeploymentGroupsResponse- List
Deployments Response ListDeploymentsResponse- List
Releases Response ListReleasesResponse- Local
Artifact Registry Heartbeat Data LocalArtifactRegistryHeartbeatData- Local
Compute Cluster Heartbeat Data LocalComputeClusterHeartbeatData- Local
Container Heartbeat Data LocalContainerHeartbeatData- Local
Daemon Heartbeat Data LocalDaemonHeartbeatData- Local
KvHeartbeat Data LocalKvHeartbeatData- Local
Queue Heartbeat Data LocalQueueHeartbeatData- Local
Runtime Event Snapshot LocalRuntimeEventSnapshot- Local
Runtime Event Subject LocalRuntimeEventSubject- Local
Runtime Unit Status LocalRuntimeUnitStatus- Local
Service Account Heartbeat Data LocalServiceAccountHeartbeatData- Local
Storage Heartbeat Data LocalStorageHeartbeatData- Local
Vault Heartbeat Data LocalVaultHeartbeatData- Local
Worker Heartbeat Data LocalWorkerHeartbeatData- Managed
Runtime Event Involved Object ManagedRuntimeEventInvolvedObject- Managed
Runtime Event Snapshot ManagedRuntimeEventSnapshot- Managed
Runtime Event Source ManagedRuntimeEventSource- Managed
Runtime Unit Status ManagedRuntimeUnitStatus- Metric
Sample MetricSample- Network
Heartbeat Status NetworkHeartbeatStatus- Observed
Counts ObservedCounts- Presigned
Request - A presigned request that can be serialized, stored, and executed later. Hides implementation details for different storage backends.
- Provider
Fleet Status ProviderFleetStatus- Queue
Heartbeat Status QueueHeartbeatStatus- RawHeartbeat
Snippet RawHeartbeatSnippet- Reconcile
Request ReconcileRequest- Reconcile
Response ReconcileResponse- Release
Request ReleaseRequest- Release
Response ReleaseResponse- Remote
Stack Management Heartbeat Status RemoteStackManagementHeartbeatStatus- Resolve
Credentials Request ResolveCredentialsRequest- Resolve
Credentials Response ResolveCredentialsResponse- Resource
Entry ResourceEntry- Resource
Heartbeat ResourceHeartbeat- Resource
Ref - New ResourceRef that works with any resource type. This can eventually replace the enum-based ResourceRef for full extensibility.
- Resource
Type - Resource type identifier that determines the specific kind of resource. This field is used for polymorphic deserialization and resource-specific behavior.
- Response
Handling - Response handling configuration for deployments
- Scope
Info ScopeInfo- Service
Account Heartbeat Status ServiceAccountHeartbeatStatus- Service
Activation Heartbeat Status ServiceActivationHeartbeatStatus- Stack
ByPlatform - The release API accepts stacks keyed by platform. Only one platform stack needs to be present.
- Stack
Import Request - Request body for manager-side stack import.
- Stack
Import Response - Response body returned after a stack import.
- Stack
Resource State - Represents the state of a single resource within the stack for a specific platform.
- Stack
Settings - User-customizable deployment settings specified at deploy time.
- Stack
State - Represents the collective state of all resources in a stack, including platform and pending actions.
- Storage
Heartbeat Status StorageHeartbeatStatus- Storage
Upload - Storage upload information
- Store
Payload Request - Request to store payload data directly in KV by command_id.
- Submit
Response Request - Request to submit a command response (from deployment)
- Upload
Complete Request - Request to mark upload as complete
- Upload
Complete Response - Response to upload completion
- Value
Value- Vault
Heartbeat Status VaultHeartbeatStatus- Whoami
Response WhoamiResponse- Workload
Heartbeat Status WorkloadHeartbeatStatus- Workload
Replica Status WorkloadReplicaStatus
Enums§
- Artifact
Registry Heartbeat Data ArtifactRegistryHeartbeatData- Artifact
Registry Heartbeat Data Variant0 Backend ArtifactRegistryHeartbeatDataVariant0Backend- Artifact
Registry Heartbeat Data Variant1 Backend ArtifactRegistryHeartbeatDataVariant1Backend- Artifact
Registry Heartbeat Data Variant2 Backend ArtifactRegistryHeartbeatDataVariant2Backend- Artifact
Registry Heartbeat Data Variant3 Backend ArtifactRegistryHeartbeatDataVariant3Backend- Body
Spec - Body specification supporting inline and storage modes
- Build
Heartbeat Data BuildHeartbeatData- Build
Heartbeat Data Variant0 Backend BuildHeartbeatDataVariant0Backend- Build
Heartbeat Data Variant1 Backend BuildHeartbeatDataVariant1Backend- Build
Heartbeat Data Variant2 Backend BuildHeartbeatDataVariant2Backend- Build
Heartbeat Data Variant3 Backend BuildHeartbeatDataVariant3Backend- Command
Response - Command response from deployment
- Command
State - Command states in the Commands protocol lifecycle
- Compute
Capacity Blocker Category ComputeCapacityBlockerCategory- Compute
Cluster Heartbeat Data ComputeClusterHeartbeatData- Compute
Cluster Heartbeat Data Variant0 Backend ComputeClusterHeartbeatDataVariant0Backend- Compute
Cluster Heartbeat Data Variant1 Backend ComputeClusterHeartbeatDataVariant1Backend- Compute
Cluster Heartbeat Data Variant2 Backend ComputeClusterHeartbeatDataVariant2Backend- Compute
Cluster Heartbeat Data Variant3 Backend ComputeClusterHeartbeatDataVariant3Backend- Container
Heartbeat Data ContainerHeartbeatData- Container
Heartbeat Data Variant0 Backend ContainerHeartbeatDataVariant0Backend- Container
Heartbeat Data Variant1 Backend ContainerHeartbeatDataVariant1Backend- Container
Heartbeat Data Variant2 Backend ContainerHeartbeatDataVariant2Backend- Daemon
Heartbeat Data DaemonHeartbeatData- Daemon
Heartbeat Data Variant0 Backend DaemonHeartbeatDataVariant0Backend- Daemon
Heartbeat Data Variant1 Backend DaemonHeartbeatDataVariant1Backend- Daemon
Heartbeat Data Variant2 Backend DaemonHeartbeatDataVariant2Backend- Daemon
Heartbeat Data Variant3 Backend DaemonHeartbeatDataVariant3Backend- Daemon
Heartbeat Data Variant4 Backend DaemonHeartbeatDataVariant4Backend- Delete
Deployment Action DeleteDeploymentAction- Deployment
Model - Deployment model: how updates are delivered to the remote environment.
- Environment
Variable Type - Type of environment variable
- Heartbeat
Backend HeartbeatBackend- Heartbeat
Collection Issue Reason HeartbeatCollectionIssueReason- Heartbeat
Issue Severity HeartbeatIssueSeverity- Heartbeats
Mode - How heartbeat health checks are handled.
- Horizon
Workload Scheduling Mode HorizonWorkloadSchedulingMode- Import
Source Kind - Package source that produced an import request. Observability label only — the manager does not branch on this value, and any new deployment pathway can omit it without affecting import behavior.
- Kubernetes
Certificate Mode - Certificate publication or reference mode for Kubernetes public endpoints.
- Kubernetes
Certificate Mode Variant0 Mode KubernetesCertificateModeVariant0Mode- Kubernetes
Certificate Mode Variant1 Mode KubernetesCertificateModeVariant1Mode- Kubernetes
Certificate Mode Variant2 Mode KubernetesCertificateModeVariant2Mode- Kubernetes
Certificate Mode Variant3 Mode KubernetesCertificateModeVariant3Mode- Kubernetes
Certificate Mode Variant4 Mode KubernetesCertificateModeVariant4Mode- Kubernetes
Cluster Ownership - Ownership model for the Kubernetes cluster.
- Kubernetes
Exposure Settings - Kubernetes public HTTPS exposure mode.
- Kubernetes
Route Profile - Kubernetes route API selected for public endpoints.
- Kubernetes
Route Profile Variant0 Route Api KubernetesRouteProfileVariant0RouteApi- Kubernetes
Route Profile Variant1 Route Api KubernetesRouteProfileVariant1RouteApi- Kubernetes
Route Provider Options - Provider-specific route options required by supported managed profiles.
- Kubernetes
Workload Kind KubernetesWorkloadKind- KvHeartbeat
Data KvHeartbeatData- KvHeartbeat
Data Variant0 Backend KvHeartbeatDataVariant0Backend- KvHeartbeat
Data Variant1 Backend KvHeartbeatDataVariant1Backend- KvHeartbeat
Data Variant2 Backend KvHeartbeatDataVariant2Backend- KvHeartbeat
Data Variant3 Backend KvHeartbeatDataVariant3Backend- Local
Operation - Local filesystem operations
- Local
Runtime Unit Kind LocalRuntimeUnitKind- Management
Config - Management configuration for different cloud platforms.
- Management
Config Variant0 Platform ManagementConfigVariant0Platform- Management
Config Variant1 Platform ManagementConfigVariant1Platform- Management
Config Variant2 Platform ManagementConfigVariant2Platform- Management
Config Variant3 Platform ManagementConfigVariant3Platform- Metric
Unit MetricUnit- Network
Heartbeat Data NetworkHeartbeatData- Network
Heartbeat Data Variant0 Backend NetworkHeartbeatDataVariant0Backend- Network
Heartbeat Data Variant1 Backend NetworkHeartbeatDataVariant1Backend- Network
Heartbeat Data Variant2 Backend NetworkHeartbeatDataVariant2Backend- Network
Settings - Network configuration for the stack.
- Observed
Health ObservedHealth- Platform
- Represents the target cloud platform.
- Presigned
Operation - The type of operation a presigned request performs
- Presigned
Request Backend - Storage backend representation for different presigned request types
- Provider
Lifecycle State ProviderLifecycleState- Queue
Heartbeat Data QueueHeartbeatData- Queue
Heartbeat Data Variant0 Backend QueueHeartbeatDataVariant0Backend- Queue
Heartbeat Data Variant1 Backend QueueHeartbeatDataVariant1Backend- Queue
Heartbeat Data Variant2 Backend QueueHeartbeatDataVariant2Backend- Queue
Heartbeat Data Variant3 Backend QueueHeartbeatDataVariant3Backend- RawHeartbeat
Snippet Format RawHeartbeatSnippetFormat- Remote
Stack Management Heartbeat Data RemoteStackManagementHeartbeatData- Remote
Stack Management Heartbeat Data Variant0 Backend RemoteStackManagementHeartbeatDataVariant0Backend- Remote
Stack Management Heartbeat Data Variant1 Backend RemoteStackManagementHeartbeatDataVariant1Backend- Remote
Stack Management Heartbeat Data Variant2 Backend RemoteStackManagementHeartbeatDataVariant2Backend- Resource
Heartbeat Data ResourceHeartbeatData- Resource
Lifecycle - Describes the lifecycle of a resource within a stack, determining how it’s managed and deployed.
- Resource
Status - Represents the high-level status of a resource during its lifecycle.
- Service
Account Heartbeat Data ServiceAccountHeartbeatData- Service
Account Heartbeat Data Variant0 Backend ServiceAccountHeartbeatDataVariant0Backend- Service
Account Heartbeat Data Variant1 Backend ServiceAccountHeartbeatDataVariant1Backend- Service
Account Heartbeat Data Variant2 Backend ServiceAccountHeartbeatDataVariant2Backend- Service
Account Heartbeat Data Variant3 Backend ServiceAccountHeartbeatDataVariant3Backend- Service
Activation Heartbeat Data ServiceActivationHeartbeatData- Service
Activation Heartbeat Data Variant0 Backend ServiceActivationHeartbeatDataVariant0Backend- Service
Activation Heartbeat Data Variant1 Backend ServiceActivationHeartbeatDataVariant1Backend- Storage
Heartbeat Data StorageHeartbeatData- Storage
Heartbeat Data Variant0 Backend StorageHeartbeatDataVariant0Backend- Storage
Heartbeat Data Variant1 Backend StorageHeartbeatDataVariant1Backend- Storage
Heartbeat Data Variant2 Backend StorageHeartbeatDataVariant2Backend- Storage
Heartbeat Data Variant3 Backend StorageHeartbeatDataVariant3Backend- Telemetry
Mode - How telemetry (logs, metrics, traces) is handled.
- Updates
Mode - How updates are delivered to the deployment.
- Vault
Heartbeat Data VaultHeartbeatData- Vault
Heartbeat Data Variant0 Backend VaultHeartbeatDataVariant0Backend- Vault
Heartbeat Data Variant1 Backend VaultHeartbeatDataVariant1Backend- Vault
Heartbeat Data Variant2 Backend VaultHeartbeatDataVariant2Backend- Vault
Heartbeat Data Variant3 Backend VaultHeartbeatDataVariant3Backend- Vault
Heartbeat Data Variant4 Backend VaultHeartbeatDataVariant4Backend- Worker
Heartbeat Data WorkerHeartbeatData- Worker
Heartbeat Data Variant0 Backend WorkerHeartbeatDataVariant0Backend- Worker
Heartbeat Data Variant1 Backend WorkerHeartbeatDataVariant1Backend- Worker
Heartbeat Data Variant2 Backend WorkerHeartbeatDataVariant2Backend- Worker
Heartbeat Data Variant3 Backend WorkerHeartbeatDataVariant3Backend- Worker
Heartbeat Data Variant4 Backend WorkerHeartbeatDataVariant4Backend