contracts

package

Go to main page

Versions in this module

v0

v0.7.0

Aug 26, 2026

Changes in this version

type QuotaLimits

+ MaxVCPUCount int64

type QuotaUsage

+ VCPUCount int64

type ResourcePolicy

+ VCPUCount int64

type TenantQuota

+ MaxVCPUCount int64

type TenantQuotaUsage

+ VCPUCount int64

v0.6.0

Aug 26, 2026

Changes in this version

+ const AuthorityKindApplication

+ const AuthorityKindPlatform

+ const AuthorityKindTenantController

+ const AuthorityStateActive

+ const AuthorityStateExpired

+ const AuthorityStateRevoked

+ const SubjectCleanupStateFailed

+ const SubjectCleanupStateNone

+ const SubjectCleanupStatePending

+ const SubjectCleanupStateRunning

+ const SubjectCleanupStateSucceeded

+ const SubjectStateActive

+ const SubjectStateClosed

+ const SubjectStateClosing

+ const SubjectStateExpired

+ const TenantControllerGrantManagement

+ const TenantStateActive

+ const TenantStateExpired

+ const TenantStateSuspended

+ type ApplicationAuthority struct

+ CreatedAt time.Time

+ ExpiresAt *time.Time

+ ID string

+ Kind string

+ LookupID string

+ Metadata map[string]string

+ ProfileGrants []string

+ Revision int64

+ Scopes []string

+ State string

+ SubjectRef string

+ TenantRef string

+ UpdatedAt time.Time

+ type ApplicationAuthorityPage struct

+ Items []ApplicationAuthority

+ NextCursor *string

+ type ApplicationCredentialResponse struct

+ Authority ApplicationAuthority

+ BearerToken string

+ type CreateApplicationAuthorityRequest struct

+ ExpiresAt time.Time

+ Metadata map[string]string

+ ProfileGrants []string

+ Scopes []string

+ SubjectRef string

+ type CreateSubjectRequest struct

+ ExpiresAt *time.Time

+ Metadata map[string]string

+ Quota QuotaLimits

+ Ref string

+ type CreateTenantControllerAuthorityRequest struct

+ ExpiresAt time.Time

+ Metadata map[string]string

+ type CreateTenantRequest struct

+ AggregateQuota TenantQuota

+ AllowedApplicationScopes []string

+ AllowedProfileGrants []string

+ ExpiresAt *time.Time

+ ExpiryPolicy TenantExpiryPolicy

+ Metadata map[string]string

+ Ref string

+ type DeploymentUsage struct

+ NextCursor *string

+ ObservedAt time.Time

+ Tenants []TenantAggregateUsage

+ Usage TenantQuotaUsage

+ type Subject struct

+ CleanupState string

+ CreatedAt time.Time

+ ExpiresAt *time.Time

+ Metadata map[string]string

+ Quota QuotaLimits

+ Ref string

+ Revision int64

+ State string

+ TenantRef string

+ UpdatedAt time.Time

+ type SubjectPage struct

+ Items []Subject

+ NextCursor *string

+ type Tenant struct

+ AggregateQuota TenantQuota

+ AllowedApplicationScopes []string

+ AllowedProfileGrants []string

+ CreatedAt time.Time

+ ExpiresAt *time.Time

+ ExpiryPolicy TenantExpiryPolicy

+ Metadata map[string]string

+ Ref string

+ Revision int64

+ State string

+ UpdatedAt time.Time

+ type TenantAggregateUsage struct

+ Limits TenantQuota

+ TenantRef string

+ Usage TenantQuotaUsage

+ type TenantControllerAuthority struct

+ CreatedAt time.Time

+ ExpiresAt *time.Time

+ Grant string

+ ID string

+ Kind string

+ LookupID string

+ Metadata map[string]string

+ Revision int64

+ State string

+ TenantRef string

+ UpdatedAt time.Time

+ type TenantControllerAuthorityPage struct

+ Items []TenantControllerAuthority

+ NextCursor *string

+ type TenantControllerCredentialResponse struct

+ Authority TenantControllerAuthority

+ BearerToken string

+ type TenantExpiryPolicy struct

+ MaximumAuthorityLifetimeSeconds int64

+ MaximumSubjectLifetimeSeconds int64

+ type TenantPage struct

+ Items []Tenant

+ NextCursor *string

+ type TenantQuota struct

+ MaxActiveInstances int64

+ MaxActiveSubjects int64

+ MaxApplicationAuthorities int64

+ MaxCPUMillis int64

+ MaxConcurrentOperations int64

+ MaxMemoryBytes int64

+ MaxPortSessions int64

+ MaxSandboxes int64

+ MaxSnapshots int64

+ type TenantQuotaUsage struct

+ ActiveInstances int64

+ ActiveSubjects int64

+ ApplicationAuthorities int64

+ CPUMillis int64

+ ConcurrentOperations int64

+ MemoryBytes int64

+ PortSessions int64

+ Sandboxes int64

+ Snapshots int64

+ type TenantUsage struct

+ Limits TenantQuota

+ NextCursor *string

+ ObservedAt time.Time

+ Subjects []SubjectUsage

+ TenantRef string

+ Usage TenantQuotaUsage

+ type UpdateSubjectQuotaRequest struct

+ Quota QuotaLimits

v0.5.2

Aug 20, 2026

v0.5.1

Aug 10, 2026

v0.5.0

Aug 10, 2026

v0.4.7

Aug 9, 2026

v0.4.6

Aug 9, 2026

v0.4.5

Aug 9, 2026

v0.4.4

Aug 9, 2026

v0.4.3

Aug 8, 2026

v0.4.2

Aug 8, 2026

v0.4.1

Aug 8, 2026

v0.4.0

Aug 8, 2026

v0.3.1

Aug 7, 2026

v0.3.0

Aug 7, 2026

Changes in this version

+ const RunnerCapabilitySnapshotResume

+ const StartupModeColdBoot

+ const StartupModeSnapshotResume

type ProfileRevisionSpec

+ Startup StartupPolicy

+ type StartupPolicy struct

+ Mode string

v0.2.3

Aug 6, 2026

v0.2.2

Aug 6, 2026

v0.2.1

Aug 6, 2026

v0.2.0

Aug 5, 2026

Changes in this version

+ const PortTransportProxied

type MetricsSnapshot

+ LiveDataPlaneDroppedRouteNotFoundFrames uint64

v0.1.4

Aug 4, 2026

v0.1.3

Aug 4, 2026

v0.1.2

Aug 4, 2026

v0.1.1

Aug 4, 2026

v0.1.0

Aug 4, 2026

Changes in this version

+ const ActivitySessionKindExec

+ const ActivitySessionKindFile

+ const ActivitySessionKindPTY

+ const ActivitySessionKindPort

+ const ActivitySessionStateActive

+ const ActivitySessionStateClosed

+ const DataPlaneTransportDirect

+ const DataPlaneTransportProxied

+ const GuestLivenessLost

+ const GuestLivenessReady

+ const GuestLivenessStarting

+ const GuestLivenessStopped

+ const GuestLivenessUnknown

+ const LeaseStateActive

+ const LeaseStateExpired

+ const LeaseStateFenced

+ const LeaseStateReleased

+ const ObjectStateDeleted

+ const ObjectStateGarbageDeleting

+ const ObjectStateGarbagePending

+ const ObjectStateIntegrityFailed

+ const ObjectStatePublished

+ const ObjectStateQuotaFailed

+ const ObjectStateStaging

+ const ObjectStateVerified

+ const OperationStateCancelled

+ const OperationStateFailed

+ const OperationStatePending

+ const OperationStateRunning

+ const OperationStateSucceeded

+ const PortSessionStateClosed

+ const PortSessionStateClosing

+ const PortSessionStateExpired

+ const PortSessionStateFenced

+ const PortSessionStateOpen

+ const PortTransportDirect

+ const PortTransportRelay

+ const ProfileStateDisabled

+ const ProfileStateEnabled

+ const RunnerPoolStateDraining

+ const RunnerPoolStateOffline

+ const RunnerPoolStateReady

+ const SandboxDesiredStateDeleted

+ const SandboxDesiredStateRunning

+ const SandboxDesiredStateStopped

+ const SandboxIDPrefix

+ const SandboxNameMetadataKey

+ const SandboxStateCreating

+ const SandboxStateDeleted

+ const SandboxStateDeleting

+ const SandboxStateDraining

+ const SandboxStateFailed

+ const SandboxStateReady

+ const SandboxStateStarting

+ const SandboxStateStopped

+ const SandboxStateStopping

+ const TerminationReasonFenced

+ const TerminationReasonGuestAgentLost

+ const TerminationReasonGuestShutdown

+ const TerminationReasonIdleTimeout

+ const TerminationReasonInternalFailure

+ const TerminationReasonMaximumDuration

+ const TerminationReasonRequestedDrain

+ const TerminationReasonRequestedStop

+ const TerminationReasonResourceExhaustion

+ const TerminationReasonRunnerLost

+ const TerminationReasonStartupFailed

+ type AcquireLeaseRequest struct

+ DurationSeconds int64

+ ReplaceActive bool

+ type ActivitySession struct

+ ClosedAt *time.Time

+ CreatedAt time.Time

+ Generation int64

+ ID string

+ Kind string

+ LastActivityAt time.Time

+ LeaseID string

+ SandboxID string

+ State string

+ SubjectRef string

+ TenantRef string

+ type Artifact struct

+ CreatedAt time.Time

+ GarbageCollectedAt *time.Time

+ ID string

+ MediaType string

+ Metadata map[string]string

+ Name string

+ PublishedAt *time.Time

+ RetainUntil time.Time

+ SHA256 string

+ SandboxID string

+ SizeBytes int64

+ SourceGeneration int64

+ State string

+ SubjectRef string

+ TenantRef string

+ type ArtifactPage struct

+ Items []Artifact

+ NextCursor *string

+ type Assignment struct

+ CapabilitySnapshot map[string]string

+ ClaimExpiresAt time.Time

+ CreatedAt time.Time

+ FencingToken []byte

+ Generation int64

+ ID string

+ InstanceID string

+ ReleaseProof map[string]string

+ ResolvedArtifacts map[string]string

+ RunnerID string

+ SandboxID string

+ State string

+ UpdatedAt time.Time

+ type AuditEvent struct

+ Action string

+ ActorID string

+ ActorKind string

+ CreatedAt time.Time

+ Details map[string]string

+ ID string

+ Outcome string

+ RequestID string

+ ResourceID string

+ ResourceKind string

+ SubjectRef string

+ TenantRef string

+ type BootStageDurationMetric struct

+ Histogram MetricDurationHistogram

+ Stage string

+ type BootStageTiming struct

+ CumulativeMilliseconds float64

+ ElapsedMilliseconds float64

+ ObservedAt time.Time

+ ReceivedAt time.Time

+ Stage string

+ type BootStageTimingSummary struct

+ Duration DurationPercentiles

+ Stage string

+ type BootTiming struct

+ Completed bool

+ DurationMilliseconds float64

+ Generation int64

+ Stages []BootStageTiming

+ type BufferedExecRequest struct

+ Command ExecCommand

+ Cwd *string

+ DeadlineMilliseconds int64

+ Environment map[string]string

+ MaximumOutputBytes int64

+ StdinBase64 *string

+ type CreateDirectoryRequest struct

+ Path string

+ Recursive *bool

+ type CreatePortSessionRequest struct

+ DurationSeconds int64

+ Name string

+ type CreateProfileRequest struct

+ Name string

+ Spec ProfileRevisionSpec

+ type CreateRunnerPoolRequest struct

+ Architectures []string

+ Capabilities []string

+ CapacityPolicy map[string]int64

+ Name string

+ State string

+ type CreateSandboxRequest struct

+ Metadata map[string]string

+ Profile string

+ SourceSnapshotID string

+ type CreateSnapshotRequest struct

+ Metadata map[string]string

+ Name string

+ type CreateTerminalRequest struct

+ Columns int64

+ Command ExecCommand

+ Cwd *string

+ DeadlineMilliseconds int64

+ Detachable bool

+ Environment map[string]string

+ Rows int64

+ type DeploymentTimingSummary struct

+ API DurationPercentiles

+ APISeries []HTTPRouteTimingSummary

+ Boot DurationPercentiles

+ BootStages []BootStageTimingSummary

+ DominantBootStage *BootStageTimingSummary

+ Exec DurationPercentiles

+ ExecSeries []ExecTimingSummary

+ ObservedAt time.Time

+ Operations []OperationTimingSummary

+ WindowSeconds int64

+ type DirectoryListing struct

+ Entries []FileStat

+ Path string

+ type DurationPercentiles struct

+ Count int64

+ P50Milliseconds *float64

+ P95Milliseconds *float64

+ P99Milliseconds *float64

+ type ExecCancelled struct

+ Kind string

+ Output ExecOutput

+ type ExecCommand struct

+ Arguments []string

+ Command string

+ Executable string

+ Mode string

+ func (command *ExecCommand) UnmarshalJSON(data []byte) error

+ func (command ExecCommand) MarshalJSON() ([]byte, error)

+ type ExecDeadlineExceeded struct

+ ElapsedMilliseconds int64

+ Kind string

+ Output ExecOutput

+ type ExecDurationMetric struct

+ Histogram MetricDurationHistogram

+ Mode string

+ Outcome string

+ type ExecExited struct

+ ElapsedMilliseconds int64

+ ExitCode int32

+ Kind string

+ Output ExecOutput

+ Signal *int32

+ type ExecInfrastructureFailed struct

+ Kind string

+ Message string

+ Reason string

+ Retryable bool

+ type ExecOutput struct

+ StderrBase64 string

+ StdoutBase64 string

+ type ExecOutputExhausted struct

+ Kind string

+ LimitBytes int64

+ Output ExecOutput

+ type ExecSpawnFailed struct

+ Kind string

+ Message string

+ Reason string

+ type ExecStreamSession struct

+ ExpiresAt time.Time

+ Generation int64

+ ID string

+ SandboxID string

+ State string

+ Subprotocol string

+ WebsocketURL string

+ type ExecTiming struct

+ CompletedAt time.Time

+ CreatedAt time.Time

+ ElapsedMilliseconds int64

+ Mode string

+ Outcome string

+ SessionID string

+ type ExecTimingSummary struct

+ Duration DurationPercentiles

+ Mode string

+ Outcome string

+ type ExecutionPolicy struct

+ DataPlaneTransport string

+ MaximumBufferedOutputBytes int64

+ MaximumDeadlineMilliseconds int64

+ MaximumTransferBytes int64

+ StreamWindowBytes int64

+ TerminalDetachSeconds int64

+ type FileExistsResult struct

+ Exists bool

+ Path string

+ type FileStat struct

+ Kind string

+ ModifiedAt time.Time

+ Path string

+ SizeBytes int64

+ type FileWriteResult struct

+ Path string

+ SHA256 string

+ SizeBytes int64

+ type HTTPRouteTimingSummary struct

+ Duration DurationPercentiles

+ Route string

+ StatusClass string

+ type Instance struct

+ CreatedAt time.Time

+ Generation int64

+ GuestHeartbeatAt *time.Time

+ GuestLiveness string

+ ID string

+ ReadyAt *time.Time

+ SandboxID string

+ State string

+ StoppedAt *time.Time

+ TerminationReason string

+ UpdatedAt time.Time

+ type Lease struct

+ CreatedAt time.Time

+ ExpiresAt time.Time

+ Generation int64

+ ID string

+ Revision int64

+ SandboxID string

+ State string

+ SubjectRef string

+ TenantRef string

+ UpdatedAt time.Time

+ type LifecyclePolicy struct

+ DrainGraceSeconds int64

+ IdleSeconds int64

+ InitialState string

+ LeaseSeconds int64

+ MaximumDurationSeconds int64

+ type MetricDurationHistogram struct

+ BucketCounts []uint64

+ Count uint64

+ SumSeconds float64

+ type MetricsSnapshot struct

+ BootDuration MetricDurationHistogram

+ BootStageDurations []BootStageDurationMetric

+ ExecDurations []ExecDurationMetric

+ OperationDurations []OperationDurationMetric

+ OperationStates map[string]int64

+ SandboxStates map[string]int64

+ type NetworkDestination struct

+ CIDR string

+ Domain string

+ Port int64

+ Protocol string

+ type NetworkPolicy struct

+ Destinations []NetworkDestination

+ Mode string

+ type Operation struct

+ CompletedAt *time.Time

+ CreatedAt time.Time

+ Error *Problem

+ ID string

+ Kind string

+ RequestID string

+ RequestMetadata map[string]string

+ Sandbox *Sandbox

+ SandboxID string

+ Snapshot *Snapshot

+ StartedAt *time.Time

+ State string

+ SubjectRef string

+ TenantRef string

+ UpdatedAt time.Time

+ type OperationDurationMetric struct

+ Histogram MetricDurationHistogram

+ Kind string

+ TerminalState string

+ type OperationStageTiming struct

+ CumulativeMilliseconds float64

+ ElapsedMilliseconds float64

+ ObservedAt time.Time

+ Stage string

+ type OperationTiming struct

+ Boots []BootTiming

+ CompletedAt *time.Time

+ CreatedAt time.Time

+ ExecutionMilliseconds *int64

+ Kind string

+ OperationID string

+ Orchestration []OperationStageTiming

+ QueueMilliseconds *int64

+ SandboxID string

+ StartedAt *time.Time

+ State string

+ TotalMilliseconds *int64

+ type OperationTimingSummary struct

+ Execution DurationPercentiles

+ Kind string

+ Queue DurationPercentiles

+ State string

+ Total DurationPercentiles

+ type PingResult struct

+ Generation int64

+ Healthy bool

+ ObservedAt time.Time

+ SandboxID string

+ type PortPolicy struct

+ MaximumSessionSeconds int64

+ MaximumSessions int64

+ Name string

+ Port int64

+ Protocol string

+ type PortSession struct

+ CertificateSPKISHA256 string

+ CreatedAt time.Time

+ Endpoint string

+ ExpiresAt time.Time

+ Generation int64

+ ID string

+ Name string

+ Protocol string

+ SandboxID string

+ State string

+ Transport string

+ type Principal struct

+ ID string

+ Kind string

+ SubjectRef string

+ TenantRef string

+ type Problem struct

+ Code string

+ Details []ProblemDetail

+ RequestID string

+ RetryAfterMilliseconds *int64

+ Retryable bool

+ Status int

+ Title string

+ Type string

+ type ProblemDetail struct

+ Field string

+ Reason string

+ type Profile struct

+ CreatedAt time.Time

+ CurrentRevision ProfileRevision

+ Name string

+ Revision int64

+ Revisions []ProfileRevision

+ State string

+ UpdatedAt time.Time

+ type ProfilePage struct

+ Items []Profile

+ NextCursor *string

+ type ProfileRevision struct

+ CreatedAt time.Time

+ ID string

+ Number int64

+ Spec ProfileRevisionSpec

+ type ProfileRevisionSpec struct

+ Architecture string

+ Execution ExecutionPolicy

+ Lifecycle LifecyclePolicy

+ Network NetworkPolicy

+ Pool string

+ Ports []PortPolicy

+ Resources ResourcePolicy

+ Retention RetentionPolicy

+ RuntimeBundleDigest string

+ ToolchainBundleDigest string

+ type QuotaLimits struct

+ MaxActiveInstances int64

+ MaxArtifactBytes int64

+ MaxArtifacts int64

+ MaxCPUMillis int64

+ MaxConcurrentOperations int64

+ MaxMemoryBytes int64

+ MaxPortSessions int64

+ MaxSandboxes int64

+ MaxSnapshots int64

+ type QuotaUsage struct

+ ActiveInstances int64

+ ArtifactBytes int64

+ Artifacts int64

+ CPUMillis int64

+ ConcurrentOperations int64

+ MemoryBytes int64

+ PortSessions int64

+ Sandboxes int64

+ Snapshots int64

+ type RelocateSandboxRequest struct

+ RunnerPool string

+ TargetRunnerID string

+ type RemovePathRequest struct

+ Force *bool

+ Path string

+ Recursive *bool

+ type RenewLeaseRequest struct

+ DurationSeconds int64

+ type ResourcePolicy struct

+ CPUMillis int64

+ ConcurrentOperations int64

+ MemoryBytes int64

+ ProcessLimit int64

+ WorkspaceBytes int64

+ type RestoreSnapshotRequest struct

+ SnapshotID string

+ type RetentionPolicy struct

+ ArtifactRetentionSeconds int64

+ SnapshotLimit int64

+ SnapshotRetentionSeconds int64

+ type ReviseProfileRequest struct

+ Spec ProfileRevisionSpec

+ type Runner struct

+ Architectures []string

+ Capabilities []string

+ Capacity map[string]int64

+ CreatedAt time.Time

+ CredentialState string

+ ID string

+ LastSeenAt *time.Time

+ Name string

+ PoolName string

+ ProtocolVersions []string

+ Revision int64

+ SandboxStartP95Milliseconds int64

+ SandboxStartSampleCount int64

+ State string

+ UpdatedAt time.Time

+ type RunnerPage struct

+ Items []Runner

+ NextCursor *string

+ type RunnerPool struct

+ Architectures []string

+ Capabilities []string

+ CapacityPolicy map[string]int64

+ CreatedAt time.Time

+ Name string

+ ReadyRunnerCount int64

+ Revision int64

+ State string

+ UpdatedAt time.Time

+ type RunnerPoolPage struct

+ Items []RunnerPool

+ NextCursor *string

+ type Sandbox struct

+ CreatedAt time.Time

+ DeletedAt *time.Time

+ DesiredState string

+ Generation int64

+ ID string

+ Instance *Instance

+ LastActivityAt *time.Time

+ Metadata map[string]string

+ Profile string

+ ProfileRevisionID string

+ Revision int64

+ State string

+ SubjectRef string

+ TenantRef string

+ UpdatedAt time.Time

+ Workspace Workspace

+ type SandboxInspection struct

+ ActiveSessions int64

+ Generation int64

+ GuestHealthy bool

+ ObservedAt time.Time

+ SandboxID string

+ type SandboxPage struct

+ Items []Sandbox

+ NextCursor *string

+ type SandboxTiming struct

+ Execs []ExecTiming

+ Operations []OperationTiming

+ SandboxID string

+ type Snapshot struct

+ CreatedAt time.Time

+ GarbageCollectedAt *time.Time

+ ID string

+ Metadata map[string]string

+ Name string

+ RetainUntil *time.Time

+ RetentionEndedAt *time.Time

+ SandboxID string

+ SizeBytes int64

+ SourceGeneration int64

+ State string

+ SubjectRef string

+ TenantRef string

+ WorkspaceID string

+ type SnapshotPage struct

+ Items []Snapshot

+ NextCursor *string

+ type StreamCancelFrame struct

+ Sequence int64

+ Type string

+ type StreamCreditFrame struct

+ Bytes int64

+ Sequence int64

+ Type string

+ type StreamInputFrame struct

+ DataBase64 string

+ EndOfInput *bool

+ Sequence int64

+ Type string

+ type StreamOutcomeFrame struct

+ Outcome any

+ Sequence int64

+ Type string

+ type StreamOutputFrame struct

+ DataBase64 string

+ Sequence int64

+ Stream string

+ Type string

+ type StreamingExecRequest struct

+ Command ExecCommand

+ Cwd *string

+ DeadlineMilliseconds int64

+ Environment map[string]string

+ MaximumOutputBytes int64

+ WindowBytes int64

+ type SubjectUsage struct

+ Limits QuotaLimits

+ SubjectRef string

+ TenantRef string

+ Usage QuotaUsage

+ type TerminalInputFrame struct

+ DataBase64 string

+ Sequence int64

+ Type string

+ type TerminalOutputFrame struct

+ DataBase64 string

+ Sequence int64

+ Type string

+ type TerminalResizeFrame struct

+ Columns int64

+ Rows int64

+ Sequence int64

+ Type string

+ type TerminalSession struct

+ ExpiresAt time.Time

+ Generation int64

+ ID string

+ NextClientSequence int64

+ SandboxID string

+ State string

+ StreamWindowBytes int64

+ Subprotocol string

+ WebsocketURL string

+ type TouchResult struct

+ Generation int64

+ LastActivityAt time.Time

+ SandboxID string

+ type UpdateRunnerPoolRequest struct

+ Architectures *[]string

+ Capabilities *[]string

+ CapacityPolicy *map[string]int64

+ State *string

+ type UpdateSandboxMetadataRequest struct

+ Metadata map[string]string

+ type WaitSandboxRequest struct

+ DeadlineMilliseconds int64

+ States []string

+ type Workspace struct

+ CreatedAt time.Time

+ Generation int64

+ ID string

+ SizeBytes int64

+ State string

+ SubjectRef string

+ TenantRef string

+ UpdatedAt time.Time

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL