Statuses and Modes
Runtime, checkpoint, agent, and egress state values.
RuntimeStatus
Section titled “RuntimeStatus”Lifecycle state reported for a runtime.
RuntimeStatus declaration
Section titled “RuntimeStatus declaration”type RuntimeStatus = "running" | "paused" | "shutdown" | "creating" | "deleting" | "error" | "crashed" | "suspended"RuntimeStatus values
Section titled “RuntimeStatus values”| Name | Value |
|---|---|
"running" |
"running" |
"paused" |
"paused" |
"shutdown" |
"shutdown" |
"creating" |
"creating" |
"deleting" |
"deleting" |
"error" |
"error" |
"crashed" |
"crashed" |
"suspended" |
"suspended" |
CheckpointState
Section titled “CheckpointState”Creation state reported for a checkpoint.
CheckpointState declaration
Section titled “CheckpointState declaration”type CheckpointState = "creating" | "ready" | "failed"CheckpointState values
Section titled “CheckpointState values”| Name | Value |
|---|---|
"creating" |
"creating" |
"ready" |
"ready" |
"failed" |
"failed" |
RuntimeAgentStatus
Section titled “RuntimeAgentStatus”Execution state reported for a runtime agent.
RuntimeAgentStatus declaration
Section titled “RuntimeAgentStatus declaration”type RuntimeAgentStatus = "queued" | "running" | "succeeded" | "failed"RuntimeAgentStatus values
Section titled “RuntimeAgentStatus values”| Name | Value |
|---|---|
"queued" |
"queued" |
"running" |
"running" |
"succeeded" |
"succeeded" |
"failed" |
"failed" |
EgressMode
Section titled “EgressMode”Value type for an egress policy mode. Supported runtime egress policy modes.
EgressMode declaration
Section titled “EgressMode declaration”const EgressMode: { ALLOWLIST: "allowlist"; DENYLIST: "denylist" }type EgressMode = typeof EgressMode[keyof typeof EgressMode]EgressMode values
Section titled “EgressMode values”| Name | Value |
|---|---|
ALLOWLIST |
"allowlist" |
DENYLIST |
"denylist" |