secondboxclient

package

Go to main page

Versions in this module

v0

v0.6.0

Aug 26, 2026

Changes in this version

+ type ApplicationAuthority struct

+ CreatedAt Timestamp

+ ExpiresAt *Timestamp

+ ID AuthorityID

+ Kind ApplicationAuthorityKind

+ LookupID TokenLookupID

+ Metadata Metadata

+ ProfileGrants ProfileGrantList

+ Revision int64

+ Scopes ApplicationScopeList

+ State AuthorityState

+ SubjectRef OwnershipRef

+ TenantRef OwnershipRef

+ UpdatedAt Timestamp

+ type ApplicationAuthorityKind = string

+ const ApplicationAuthorityKindApplication

+ type ApplicationAuthorityPage struct

+ Items []ApplicationAuthority

+ NextCursor *string

+ type ApplicationBearerToken = string

+ type ApplicationCredentialResponse struct

+ Authority ApplicationAuthority

+ BearerToken ApplicationBearerToken

+ type ApplicationScope = string

+ const ApplicationScopeSandboxExec

+ const ApplicationScopeSandboxFiles

+ const ApplicationScopeSandboxLifecycle

+ const ApplicationScopeSandboxPorts

+ const ApplicationScopeSandboxPortsDirect

+ const ApplicationScopeSandboxRead

+ type ApplicationScopeList = []ApplicationScope

+ type AuditAttribution struct

+ ActorAuthorityID AuthorityID

+ ActorAuthorityKind AuthorityKind

+ CorrelationMetadata AuditCorrelationMetadata

+ Operation string

+ Result AuditResult

+ SubjectRef *OwnershipRef

+ TenantRef OwnershipRef

+ type AuditCorrelationMetadata = map[string]string

+ type AuditResult = string

+ const AuditResultDenied

+ const AuditResultFailed

+ const AuditResultSucceeded

+ type AuthorityID = string

+ type AuthorityKind = string

+ const AuthorityKindApplication

+ const AuthorityKindPlatform

+ const AuthorityKindTenantController

+ type AuthorityState = string

+ const AuthorityStateActive

+ const AuthorityStateExpired

+ const AuthorityStateRevoked

type Client

+ func NewSecondBoxTenantControllerClient(rawURL, token string, httpClient *http.Client) (*Client, error)

+ func (client *Client) CleanupSubject(ctx context.Context, subjectRef OwnershipRef, expectedRevision int64, ...) (Operation, error)

+ func (client *Client) CloseSubject(ctx context.Context, subjectRef OwnershipRef, expectedRevision int64, ...) (Subject, error)

+ func (client *Client) CreateApplicationAuthority(ctx context.Context, request CreateApplicationAuthorityRequest, ...) (ApplicationCredentialResponse, error)

+ func (client *Client) CreateSubject(ctx context.Context, request CreateSubjectRequest, idempotencyKey string) (Subject, error)

+ func (client *Client) CreateTenant(ctx context.Context, request CreateTenantRequest, idempotencyKey string) (Tenant, error)

+ func (client *Client) CreateTenantControllerAuthority(ctx context.Context, tenantRef OwnershipRef, ...) (TenantControllerCredentialResponse, error)

+ func (client *Client) GetApplicationAuthority(ctx context.Context, authorityID AuthorityID) (ApplicationAuthority, error)

+ func (client *Client) GetDeploymentUsage(ctx context.Context, options PageOptions) (DeploymentUsage, error)

+ func (client *Client) GetSubject(ctx context.Context, subjectRef OwnershipRef) (Subject, error)

+ func (client *Client) GetTenant(ctx context.Context, tenantRef OwnershipRef) (Tenant, error)

+ func (client *Client) GetTenantControllerAuthority(ctx context.Context, tenantRef OwnershipRef, authorityID AuthorityID) (TenantControllerAuthority, error)

+ func (client *Client) GetTenantUsage(ctx context.Context, supplied ...PageOptions) (TenantUsage, error)

+ func (client *Client) ListApplicationAuthorities(ctx context.Context, subjectRef OwnershipRef, options PageOptions) (ApplicationAuthorityPage, error)

+ func (client *Client) ListSubjects(ctx context.Context, options PageOptions) (SubjectPage, error)

+ func (client *Client) ListTenantControllerAuthorities(ctx context.Context, tenantRef OwnershipRef, options PageOptions) (TenantControllerAuthorityPage, error)

+ func (client *Client) ListTenants(ctx context.Context, options PageOptions) (TenantPage, error)

+ func (client *Client) ReactivateTenant(ctx context.Context, tenantRef OwnershipRef, expectedRevision int64, ...) (Tenant, error)

+ func (client *Client) RevokeApplicationAuthority(ctx context.Context, authorityID AuthorityID, expectedRevision int64, ...) (ApplicationAuthority, error)

+ func (client *Client) RevokeTenantControllerAuthority(ctx context.Context, tenantRef OwnershipRef, authorityID AuthorityID, ...) (TenantControllerAuthority, error)

+ func (client *Client) RotateApplicationAuthority(ctx context.Context, authorityID AuthorityID, expectedRevision int64, ...) (ApplicationCredentialResponse, error)

+ func (client *Client) RotateTenantControllerAuthority(ctx context.Context, tenantRef OwnershipRef, authorityID AuthorityID, ...) (TenantControllerCredentialResponse, error)

+ func (client *Client) SuspendTenant(ctx context.Context, tenantRef OwnershipRef, expectedRevision int64, ...) (Tenant, error)

+ func (client *Client) UpdateSubjectQuota(ctx context.Context, subjectRef OwnershipRef, ...) (Subject, error)

+ type CreateApplicationAuthorityRequest struct

+ ExpiresAt Timestamp

+ Metadata Metadata

+ ProfileGrants ProfileGrantList

+ Scopes ApplicationScopeList

+ SubjectRef OwnershipRef

+ type CreateSubjectRequest struct

+ ExpiresAt *Timestamp

+ Metadata Metadata

+ Quota SubjectQuota

+ Ref OwnershipRef

+ type CreateTenantControllerAuthorityRequest struct

+ ExpiresAt Timestamp

+ Metadata Metadata

+ type CreateTenantRequest struct

+ AggregateQuota TenantQuota

+ AllowedApplicationScopes ApplicationScopeList

+ AllowedProfileGrants ProfileGrantList

+ ExpiresAt *Timestamp

+ ExpiryPolicy TenantExpiryPolicy

+ Metadata Metadata

+ Ref OwnershipRef

+ type DeploymentUsage struct

+ NextCursor *string

+ ObservedAt Timestamp

+ Tenants []TenantAggregateUsage

+ Usage TenantQuotaUsage

type OperationKind

+ const OperationKindSubjectCleanup

type ProblemCode

+ const ProblemCodeAuthorityKindMismatch

+ const ProblemCodeCleanupStateConflict

+ const ProblemCodeCredentialResponseUnavailable

+ const ProblemCodeGrantEscalationDenied

+ const ProblemCodeInvalidLifecycleTransition

+ const ProblemCodeManagementUnavailable

+ const ProblemCodeResourceExpired

+ const ProblemCodeTenantSuspended

+ type ProfileGrantList = []ProfileName

+ type QuotaUsage struct

+ ActiveInstances int64

+ CPUMillis int64

+ ConcurrentOperations int64

+ MemoryBytes int64

+ PortSessions int64

+ Sandboxes int64

+ Snapshots int64

+ type Subject struct

+ CleanupState SubjectCleanupState

+ CreatedAt Timestamp

+ ExpiresAt *Timestamp

+ Metadata Metadata

+ Quota SubjectQuota

+ Ref OwnershipRef

+ Revision int64

+ State SubjectState

+ TenantRef OwnershipRef

+ UpdatedAt Timestamp

+ type SubjectCleanupState = string

+ const SubjectCleanupStateFailed

+ const SubjectCleanupStateNone

+ const SubjectCleanupStatePending

+ const SubjectCleanupStateRunning

+ const SubjectCleanupStateSucceeded

+ type SubjectPage struct

+ Items []Subject

+ NextCursor *string

+ type SubjectQuota struct

+ MaxActiveInstances int64

+ MaxConcurrentOperations int64

+ MaxCpuMillis int64

+ MaxMemoryBytes int64

+ MaxPortSessions int64

+ MaxSandboxes int64

+ MaxSnapshots int64

+ type SubjectState = string

+ const SubjectStateActive

+ const SubjectStateClosed

+ const SubjectStateClosing

+ const SubjectStateExpired

+ type SubjectUsage struct

+ Limits SubjectQuota

+ SubjectRef OwnershipRef

+ Usage QuotaUsage

+ type Tenant struct

+ AggregateQuota TenantQuota

+ AllowedApplicationScopes ApplicationScopeList

+ AllowedProfileGrants ProfileGrantList

+ CreatedAt Timestamp

+ ExpiresAt *Timestamp

+ ExpiryPolicy TenantExpiryPolicy

+ Metadata Metadata

+ Ref OwnershipRef

+ Revision int64

+ State TenantState

+ UpdatedAt Timestamp

+ type TenantAggregateUsage struct

+ Limits TenantQuota

+ TenantRef OwnershipRef

+ Usage TenantQuotaUsage

+ type TenantControllerAuthority struct

+ CreatedAt Timestamp

+ ExpiresAt *Timestamp

+ Grant TenantControllerGrant

+ ID AuthorityID

+ Kind TenantControllerAuthorityKind

+ LookupID TokenLookupID

+ Metadata Metadata

+ Revision int64

+ State AuthorityState

+ TenantRef OwnershipRef

+ UpdatedAt Timestamp

+ type TenantControllerAuthorityKind = string

+ const TenantControllerAuthorityKindTenantController

+ type TenantControllerAuthorityPage struct

+ Items []TenantControllerAuthority

+ NextCursor *string

+ type TenantControllerBearerToken = string

+ type TenantControllerCredentialResponse struct

+ Authority TenantControllerAuthority

+ BearerToken TenantControllerBearerToken

+ type TenantControllerGrant = string

+ const TenantControllerGrantTenantManagement

+ type TenantExpiryPolicy struct

+ MaximumAuthorityLifetimeSeconds int64

+ MaximumSubjectLifetimeSeconds int64

+ type TenantPage struct

+ Items []Tenant

+ NextCursor *string

+ type TenantQuota struct

+ MaxActiveInstances int64

+ MaxActiveSubjects int64

+ MaxApplicationAuthorities int64

+ MaxConcurrentOperations int64

+ MaxCpuMillis 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 TenantState = string

+ const TenantStateActive

+ const TenantStateExpired

+ const TenantStateSuspended

+ type TenantUsage struct

+ Limits TenantQuota

+ NextCursor *string

+ ObservedAt Timestamp

+ Subjects []SubjectUsage

+ TenantRef OwnershipRef

+ Usage TenantQuotaUsage

+ type TokenLookupID = string

+ type UpdateSubjectQuotaRequest struct

+ Quota SubjectQuota

v0.5.2

Aug 20, 2026

v0.5.1

Aug 10, 2026

Changes in this version

type ExecFailure

+ SpawnFailureReason SpawnFailureKind

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

type ProblemCode

+ const ProblemCodeStartupModeUnsupported

+ type StartupMode = string

+ const StartupModeColdBoot

+ const StartupModeSnapshotResume

+ type StartupPolicy = contracts.StartupPolicy

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

+ type TerminalAttachedFrame struct

+ NextClientSequence *int64

+ Type string

type TerminalFrame

+ TerminalAttachedFrame *TerminalAttachedFrame

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

+ var GetSandboxOperation = operations["getSandbox"]

+ func EncodeJSONBody(value any) (io.Reader, error)

+ func ExecOutcomeError(outcome ExecOutcome) error

+ func NewIdempotencyKey() (string, error)

+ func ProblemCodeOf(err error) string

+ func RevisionETag(revision int64) string

+ type APIError struct

+ Body []byte

+ Problem *Problem

+ StatusCode int

+ func (failure *APIError) Error() string

+ type AcquireLeaseRequest = contracts.AcquireLeaseRequest

+ type ArgvCommand struct

+ Arguments []string

+ Executable string

+ Mode string

+ type Artifact struct

+ CreatedAt Timestamp

+ ExpiresAt Timestamp

+ Generation int64

+ ID OpaqueID

+ MediaType string

+ Metadata Metadata

+ Name string

+ SHA256 string

+ SandboxID OpaqueID

+ SizeBytes int64

+ type ArtifactPage struct

+ Items []Artifact

+ NextCursor *string

+ type BootStage = string

+ const BootStageArtifactVerify

+ const BootStageComputeLaunch

+ const BootStageGuestNegotiation

+ const BootStageNetworkSetup

+ const BootStageReady

+ const BootStageRunnerAdmission

+ const BootStageWorkspaceAttach

+ type BootStageTiming = contracts.BootStageTiming

+ type BootStageTimingSummary struct

+ Duration DurationPercentiles

+ Stage BootStage

+ type BootTiming = contracts.BootTiming

+ type BufferedExecRequest struct

+ Command Command

+ Cwd *WorkspacePath

+ DeadlineMilliseconds int64

+ Environment StringMap

+ MaximumOutputBytes int64

+ StdinBase64 *string

+ type CallOptions struct

+ Body io.Reader

+ ContentType string

+ Headers http.Header

+ PathParameters map[string]string

+ QueryParameters url.Values

+ type Client struct

+ func NewSecondBoxClient(rawURL, token string, httpClient *http.Client) (*Client, error)

+ func NewSecondBoxSubjectClient(rawURL, token, tenantRef, subjectRef string, httpClient *http.Client) (*Client, error)

+ func (client *Client) AdoptSandbox(ctx context.Context, sandboxID OpaqueID) (*SandboxHandle, error)

+ func (client *Client) CreateProfile(ctx context.Context, request CreateProfileRequest, idempotencyKey string) (Profile, error)

+ func (client *Client) CreateRunnerPool(ctx context.Context, request CreateRunnerPoolRequest) (RunnerPool, error)

+ func (client *Client) CreateSandbox(ctx context.Context, request CreateSandboxRequest, idempotencyKey string) (*SandboxHandle, Operation, error)

+ func (client *Client) DeleteArtifact(ctx context.Context, artifactID OpaqueID, idempotencyKey string) error

+ func (client *Client) DeleteSnapshot(ctx context.Context, snapshotID string, idempotencyKey string) (Operation, error)

+ func (client *Client) DisableProfile(ctx context.Context, name ProfileName, expectedRevision int64, ...) (Profile, error)

+ func (client *Client) Do(ctx context.Context, metadata OperationMetadata, options RequestOptions) (*http.Response, error)

+ func (client *Client) DownloadArtifact(ctx context.Context, artifactID OpaqueID, maximumBytes int64) ([]byte, error)

+ func (client *Client) GetArtifact(ctx context.Context, artifactID OpaqueID) (Artifact, error)

+ func (client *Client) GetProfile(ctx context.Context, name ProfileName) (Profile, error)

+ func (client *Client) GetRunnerPool(ctx context.Context, name ProfileName) (RunnerPool, error)

+ func (client *Client) GetSnapshot(ctx context.Context, snapshotID OpaqueID) (Snapshot, error)

+ func (client *Client) ListProfiles(ctx context.Context, options PageOptions) (ProfilePage, error)

+ func (client *Client) ListRunnerPools(ctx context.Context, options PageOptions) (RunnerPoolPage, error)

+ func (client *Client) ListSandboxes(ctx context.Context, options SandboxListOptions) (SandboxPage, error)

+ func (client *Client) ReleaseLease(ctx context.Context, leaseID string, idempotencyKey string) error

+ func (client *Client) RenewLease(ctx context.Context, leaseID string, duration time.Duration, ...) (Lease, error)

+ func (client *Client) Request(ctx context.Context, operationID string, options CallOptions) (*http.Response, error)

+ func (client *Client) RequestJSON(ctx context.Context, operationID string, options CallOptions, target any) error

+ func (client *Client) ReviseProfile(ctx context.Context, name ProfileName, expectedRevision int64, ...) (Profile, error)

+ func (client *Client) Run(ctx context.Context, request RunRequest) (*SandboxHandle, RunResult, error)

+ func (client *Client) UpdateRunnerPool(ctx context.Context, name ProfileName, expectedRevision int64, ...) (RunnerPool, error)

+ func (client *Client) ValidateProfile(ctx context.Context, name ProfileName) (Profile, error)

+ func (client *Client) WaitOperation(ctx context.Context, operationID string, interval time.Duration) (Operation, error)

+ type Command struct

+ ArgvCommand *ArgvCommand

+ ShellCommand *ShellCommand

+ func (value *Command) UnmarshalJSON(data []byte) error

+ func (value Command) MarshalJSON() ([]byte, error)

+ type CorrelationID = string

+ type CreateDirectoryRequest struct

+ Path WorkspacePath

+ Recursive bool

+ type CreatePortSessionRequest struct

+ DurationSeconds int64

+ Name string

+ type CreateProfileRequest = contracts.CreateProfileRequest

+ type CreateRunnerPoolRequest = contracts.CreateRunnerPoolRequest

+ type CreateSandboxRequest = contracts.CreateSandboxRequest

+ type CreateSnapshotRequest = contracts.CreateSnapshotRequest

+ type CreateTerminalRequest struct

+ Columns int

+ Command Command

+ Cwd *WorkspacePath

+ DeadlineMilliseconds int64

+ Detachable bool

+ Environment StringMap

+ Rows int

+ type DeploymentTimingSummary = contracts.DeploymentTimingSummary

+ type DirectoryListing struct

+ Entries []FileStat

+ Path WorkspacePath

+ type DurationPercentiles = contracts.DurationPercentiles

+ type ExecCancelled struct

+ Kind string

+ Output ExecOutput

+ type ExecDeadlineExceeded struct

+ ElapsedMilliseconds int64

+ Kind string

+ Output ExecOutput

+ type ExecExited struct

+ ElapsedMilliseconds int64

+ ExitCode int

+ Kind string

+ Output ExecOutput

+ Signal *int

+ type ExecFailure struct

+ Kind string

+ Message string

+ Output ExecOutput

+ func (failure *ExecFailure) Error() string

+ type ExecInfrastructureFailed struct

+ Kind string

+ Message string

+ Reason InfrastructureFailureKind

+ Retryable bool

+ type ExecOutcome struct

+ ExecCancelled *ExecCancelled

+ ExecDeadlineExceeded *ExecDeadlineExceeded

+ ExecExited *ExecExited

+ ExecInfrastructureFailed *ExecInfrastructureFailed

+ ExecOutputExhausted *ExecOutputExhausted

+ ExecSpawnFailed *ExecSpawnFailed

+ func (value *ExecOutcome) UnmarshalJSON(data []byte) error

+ func (value ExecOutcome) MarshalJSON() ([]byte, error)

+ type ExecOutput struct

+ StderrBase64 string

+ StdoutBase64 string

+ type ExecOutputExhausted struct

+ Kind string

+ LimitBytes int64

+ Output ExecOutput

+ type ExecResult struct

+ ElapsedMilliseconds int64

+ ExitCode int

+ Signal *int

+ Stderr []byte

+ Stdout []byte

+ func DecodeExecOutcome(outcome ExecOutcome) (ExecResult, error)

+ type ExecSpawnFailed struct

+ Kind string

+ Message string

+ Reason SpawnFailureKind

+ type ExecStream struct

+ func (stream *ExecStream) Cancel() error

+ func (stream *ExecStream) Close() error

+ func (stream *ExecStream) CloseInput() error

+ func (stream *ExecStream) GrantOutput(bytes int64) error

+ func (stream *ExecStream) Receive() (ExecStreamFrame, error)

+ func (stream *ExecStream) SendInput(data []byte) error

+ func (stream *ExecStream) SendInputFrame(data []byte, endOfInput bool) error

+ type ExecStreamFrame struct

+ StreamCancelFrame *StreamCancelFrame

+ StreamCreditFrame *StreamCreditFrame

+ StreamInputFrame *StreamInputFrame

+ StreamOutcomeFrame *StreamOutcomeFrame

+ StreamOutputFrame *StreamOutputFrame

+ StreamSignalFrame *StreamSignalFrame

+ func (value *ExecStreamFrame) UnmarshalJSON(data []byte) error

+ func (value ExecStreamFrame) MarshalJSON() ([]byte, error)

+ type ExecStreamSession struct

+ ExpiresAt Timestamp

+ Generation int64

+ ID OpaqueID

+ SandboxID OpaqueID

+ State SessionState

+ Subprotocol string

+ WebsocketURL string

+ type ExecTiming = contracts.ExecTiming

+ type ExecTimingSummary struct

+ Duration DurationPercentiles

+ Mode string

+ Outcome string

+ type ExecutionPolicy = contracts.ExecutionPolicy

+ type FileExistsResult struct

+ Exists bool

+ Path WorkspacePath

+ type FileKind = string

+ const FileKindDirectory

+ const FileKindFile

+ const FileKindSymbolicLink

+ type FileStat struct

+ Kind FileKind

+ ModifiedAt Timestamp

+ Path WorkspacePath

+ SizeBytes int64

+ type FileWriteResult struct

+ Path WorkspacePath

+ SHA256 string

+ SizeBytes int64

+ type GuestLiveness = string

+ const GuestLivenessLost

+ const GuestLivenessReady

+ const GuestLivenessStarting

+ const GuestLivenessStopped

+ const GuestLivenessUnknown

+ type HTTPRouteTimingSummary struct

+ Duration DurationPercentiles

+ Route string

+ StatusClass string

+ type InfrastructureFailureKind = string

+ const InfrastructureFailureKindAdmission

+ const InfrastructureFailureKindExecutionNode

+ const InfrastructureFailureKindGenerationFenced

+ const InfrastructureFailureKindGuestAgent

+ const InfrastructureFailureKindLeaseFenced

+ const InfrastructureFailureKindService

+ const InfrastructureFailureKindTransport

+ type Instance struct

+ CreatedAt Timestamp

+ Generation int64

+ GuestHeartbeatAt *Timestamp

+ GuestLiveness GuestLiveness

+ ID OpaqueID

+ ReadyAt *Timestamp

+ SandboxID OpaqueID

+ State InstanceState

+ StoppedAt *Timestamp

+ TerminationReason *InstanceTerminationReason

+ UpdatedAt Timestamp

+ type InstanceState = string

+ const InstanceStateDraining

+ const InstanceStateFailed

+ const InstanceStateLost

+ const InstanceStateReady

+ const InstanceStateStarting

+ const InstanceStateStopped

+ const InstanceStateStopping

+ type InstanceTerminationReason = string

+ const InstanceTerminationReasonFenced

+ const InstanceTerminationReasonGuestAgentLost

+ const InstanceTerminationReasonGuestShutdown

+ const InstanceTerminationReasonIdleTimeout

+ const InstanceTerminationReasonInternalFailure

+ const InstanceTerminationReasonMaximumDuration

+ const InstanceTerminationReasonRequestedDrain

+ const InstanceTerminationReasonRequestedStop

+ const InstanceTerminationReasonResourceExhaustion

+ const InstanceTerminationReasonRunnerLost

+ const InstanceTerminationReasonStartupFailed

+ type Lease = contracts.Lease

+ type LeaseKeeper struct

+ func (keeper *LeaseKeeper) Close() error

+ func (keeper *LeaseKeeper) Err() error

+ func (keeper *LeaseKeeper) ID() string

+ type LeaseState = string

+ const LeaseStateActive

+ const LeaseStateExpired

+ const LeaseStateFenced

+ const LeaseStateReleased

+ type LifecycleOptions struct

+ IdempotencyKey string

+ IfMatch string

+ type LifecyclePolicy = contracts.LifecyclePolicy

+ type Metadata = map[string]string

+ type NetworkDestination = contracts.NetworkDestination

+ type NetworkPolicy = contracts.NetworkPolicy

+ type OpaqueID = string

+ type Operation = contracts.Operation

+ type OperationFailure struct

+ Operation Operation

+ func (failure *OperationFailure) Error() string

+ type OperationKind = string

+ const OperationKindCancelExec

+ const OperationKindCancelTerminal

+ const OperationKindCreate

+ const OperationKindDelete

+ const OperationKindDrain

+ const OperationKindRelocate

+ const OperationKindSnapshotCreate

+ const OperationKindSnapshotDelete

+ const OperationKindSnapshotRestore

+ const OperationKindStart

+ const OperationKindStop

+ type OperationMediaType struct

+ ContentType string

+ Schema string

+ type OperationMetadata struct

+ Method string

+ OperationID string

+ PathTemplate string

+ RequestBody []OperationMediaType

+ RequestBodyRequired bool

+ func LookupOperation(operationID string) (OperationMetadata, bool)

+ type OperationStageTiming = contracts.OperationStageTiming

+ type OperationState = string

+ const OperationStateCancelled

+ const OperationStateFailed

+ const OperationStatePending

+ const OperationStateRunning

+ const OperationStateSucceeded

+ type OperationTiming = contracts.OperationTiming

+ type OperationTimingSummary struct

+ Execution DurationPercentiles

+ Kind OperationKind

+ Queue DurationPercentiles

+ State OperationState

+ Total DurationPercentiles

+ type OwnershipRef = string

+ type PageOptions struct

+ Cursor string

+ Limit int

+ type PingResult struct

+ Generation int64

+ Healthy bool

+ ObservedAt Timestamp

+ SandboxID OpaqueID

+ type PortPolicy = contracts.PortPolicy

+ type PortSession struct

+ CertificateSpkiSha256 *string

+ CreatedAt Timestamp

+ Endpoint string

+ ExpiresAt Timestamp

+ Generation int64

+ ID OpaqueID

+ Name string

+ Protocol string

+ SandboxID OpaqueID

+ State string

+ Transport string

+ type PortTunnel struct

+ func (tunnel *PortTunnel) Close() error

+ func (tunnel *PortTunnel) Read(payload []byte) (int, error)

+ func (tunnel *PortTunnel) Write(payload []byte) (int, error)

+ type Problem = contracts.Problem

+ type ProblemCode = string

+ const ProblemCodeAuthenticationFailed

+ const ProblemCodeAuthorizationFailed

+ const ProblemCodeDependencyUnavailable

+ const ProblemCodeExecutionNodeUnavailable

+ const ProblemCodeGenerationFenced

+ const ProblemCodeGuestUnavailable

+ const ProblemCodeHomeRunnerUnavailable

+ const ProblemCodeIdempotencyConflict

+ const ProblemCodeInternalError

+ const ProblemCodeInvalidRequest

+ const ProblemCodeLeaseFenced

+ const ProblemCodeLimitExceeded

+ const ProblemCodeNotFound

+ const ProblemCodePreconditionFailed

+ const ProblemCodeProfileUnavailable

+ const ProblemCodeQuotaExceeded

+ const ProblemCodeSandboxNotStopped

+ const ProblemCodeStateConflict

+ const ProblemCodeTerminalReplayEvicted

+ const ProblemCodeWaitExpired

+ const ProblemCodeWorkspaceMutationConflict

+ const ProblemCodeWorkspaceRelocationSnapshotsPresent

+ const ProblemCodeWorkspaceRelocationTargetUnavailable

+ type ProblemDetail struct

+ Field string

+ Reason string

+ type Profile = contracts.Profile

+ type ProfileName = string

+ type ProfilePage struct

+ Items []Profile

+ NextCursor *string

+ type ProfileRevision struct

+ CreatedAt Timestamp

+ ID OpaqueID

+ Number int64

+ Spec ProfileRevisionSpec

+ type ProfileRevisionSpec = contracts.ProfileRevisionSpec

+ type ProfileState = string

+ const ProfileStateDisabled

+ const ProfileStateEnabled

+ type RelocateSandboxRequest struct

+ RunnerPool *ProfileName

+ TargetRunnerID *RunnerID

+ type RemovePathRequest struct

+ Force bool

+ Path WorkspacePath

+ Recursive bool

+ type RenewLeaseRequest = contracts.RenewLeaseRequest

+ type RequestOptions struct

+ Body io.Reader

+ ContentType string

+ Headers http.Header

+ PathParameters map[string]string

+ QueryParameters url.Values

+ type ResourcePolicy = contracts.ResourcePolicy

+ type RestoreSnapshotRequest = contracts.RestoreSnapshotRequest

+ type RetentionPolicy = contracts.RetentionPolicy

+ type ReviseProfileRequest struct

+ Spec ProfileRevisionSpec

+ type RunRequest struct

+ Command Command

+ Cwd *WorkspacePath

+ DeadlineMilliseconds int64

+ Environment StringMap

+ MaximumOutputBytes int64

+ Metadata Metadata

+ Profile ProfileName

+ SourceSnapshotID string

+ StdinBase64 *string

+ type RunResult struct

+ Outcome ExecOutcome

+ Result ExecResult

+ Sandbox Sandbox

+ type Runner = contracts.Runner

+ type RunnerArchitectureList = []string

+ type RunnerCapabilityList = []string

+ type RunnerCapacityPolicy = map[string]int64

+ type RunnerID = string

+ type RunnerPage = contracts.RunnerPage

+ type RunnerPool = contracts.RunnerPool

+ type RunnerPoolPage = contracts.RunnerPoolPage

+ type RunnerPoolState = string

+ const RunnerPoolStateDraining

+ const RunnerPoolStateOffline

+ const RunnerPoolStateReady

+ type Sandbox = contracts.Sandbox

+ type SandboxDesiredState = string

+ const SandboxDesiredStateDeleted

+ const SandboxDesiredStateRunning

+ const SandboxDesiredStateStopped

+ type SandboxHandle struct

+ func NewSandboxHandle(client *Client, sandbox Sandbox) *SandboxHandle

+ func (handle *SandboxHandle) AcquireLease(ctx context.Context, duration time.Duration, idempotencyKey string) (Lease, error)

+ func (handle *SandboxHandle) CancelTerminal(ctx context.Context, sessionID OpaqueID, idempotencyKey string) (TerminalSession, error)

+ func (handle *SandboxHandle) ClosePortSession(ctx context.Context, sessionID OpaqueID, idempotencyKey string) error

+ func (handle *SandboxHandle) ConnectExecStream(ctx context.Context, session ExecStreamSession, dialer *websocket.Dialer) (*ExecStream, error)

+ func (handle *SandboxHandle) ConnectPortTunnel(ctx context.Context, session PortSession, websocketDialer *websocket.Dialer, ...) (*PortTunnel, error)

+ func (handle *SandboxHandle) ConnectTerminal(ctx context.Context, session TerminalSession, dialer *websocket.Dialer) (*Terminal, error)

+ func (handle *SandboxHandle) ConnectTerminalAfter(ctx context.Context, session TerminalSession, afterSequence int64, ...) (*Terminal, error)

+ func (handle *SandboxHandle) CreateDirectory(ctx context.Context, path WorkspacePath, recursive bool, ...) error

+ func (handle *SandboxHandle) CreateExecStream(ctx context.Context, request StreamingExecRequest, idempotencyKey string, ...) (ExecStreamSession, error)

+ func (handle *SandboxHandle) CreatePortSession(ctx context.Context, request CreatePortSessionRequest, ...) (PortSession, error)

+ func (handle *SandboxHandle) CreateSnapshot(ctx context.Context, options LifecycleOptions, request CreateSnapshotRequest) (Operation, error)

+ func (handle *SandboxHandle) CreateTerminal(ctx context.Context, request CreateTerminalRequest, idempotencyKey string, ...) (TerminalSession, error)

+ func (handle *SandboxHandle) Delete(ctx context.Context, options LifecycleOptions) (Operation, error)

+ func (handle *SandboxHandle) Drain(ctx context.Context, options LifecycleOptions) (Operation, error)

+ func (handle *SandboxHandle) Execute(ctx context.Context, request BufferedExecRequest, idempotencyKey string, ...) (ExecOutcome, error)

+ func (handle *SandboxHandle) FileExists(ctx context.Context, path WorkspacePath, leaseID string) (bool, error)

+ func (handle *SandboxHandle) GenerationHeaders(leaseID string) http.Header

+ func (handle *SandboxHandle) GetPortSession(ctx context.Context, sessionID OpaqueID) (PortSession, error)

+ func (handle *SandboxHandle) GetTerminal(ctx context.Context, sessionID OpaqueID) (TerminalSession, error)

+ func (handle *SandboxHandle) KeepLease(ctx context.Context, duration time.Duration) (*LeaseKeeper, error)

+ func (handle *SandboxHandle) ListArtifacts(ctx context.Context, options PageOptions) (ArtifactPage, error)

+ func (handle *SandboxHandle) ListDirectory(ctx context.Context, path WorkspacePath, leaseID string) (DirectoryListing, error)

+ func (handle *SandboxHandle) ListSnapshots(ctx context.Context, options PageOptions) (SnapshotPage, error)

+ func (handle *SandboxHandle) ReadFile(ctx context.Context, path WorkspacePath, maximumBytes int64, leaseID string) ([]byte, error)

+ func (handle *SandboxHandle) Refresh(ctx context.Context) (Sandbox, error)

+ func (handle *SandboxHandle) Relocate(ctx context.Context, options LifecycleOptions, request RelocateSandboxRequest) (Operation, error)

+ func (handle *SandboxHandle) RemovePath(ctx context.Context, path WorkspacePath, recursive, force bool, ...) error

+ func (handle *SandboxHandle) Restore(ctx context.Context, options LifecycleOptions, snapshotID string) (Operation, error)

+ func (handle *SandboxHandle) Snapshot() Sandbox

+ func (handle *SandboxHandle) Start(ctx context.Context, options LifecycleOptions) (Operation, error)

+ func (handle *SandboxHandle) StatFile(ctx context.Context, path WorkspacePath, leaseID string) (FileStat, error)

+ func (handle *SandboxHandle) Stop(ctx context.Context, options LifecycleOptions) (Operation, error)

+ func (handle *SandboxHandle) TakeoverLease(ctx context.Context, duration time.Duration, idempotencyKey string) (Lease, error)

+ func (handle *SandboxHandle) UpdateMetadata(ctx context.Context, metadata Metadata) (Sandbox, error)

+ func (handle *SandboxHandle) UploadArtifact(ctx context.Context, name, mediaType string, metadata Metadata, content []byte, ...) (Artifact, error)

+ func (handle *SandboxHandle) Wait(ctx context.Context, states []SandboxState, deadline time.Duration) (Sandbox, error)

+ func (handle *SandboxHandle) WaitFor(ctx context.Context, states ...SandboxState) (Sandbox, error)

+ func (handle *SandboxHandle) WriteFile(ctx context.Context, path WorkspacePath, content []byte, ...) (FileWriteResult, error)

+ type SandboxInspection struct

+ ActiveSessions int64

+ Generation int64

+ GuestHealthy bool

+ ObservedAt Timestamp

+ SandboxID OpaqueID

+ type SandboxListOptions struct

+ Metadata Metadata

+ type SandboxPage = contracts.SandboxPage

+ type SandboxState = string

+ const SandboxStateCreating

+ const SandboxStateDeleted

+ const SandboxStateDeleting

+ const SandboxStateDraining

+ const SandboxStateFailed

+ const SandboxStateReady

+ const SandboxStateStarting

+ const SandboxStateStopped

+ const SandboxStateStopping

+ type SandboxTiming = contracts.SandboxTiming

+ type SessionState = string

+ const SessionStateClosed

+ const SessionStateClosing

+ const SessionStateDetached

+ const SessionStateOpen

+ type ShellCommand struct

+ Command string

+ Mode string

+ type Snapshot = contracts.Snapshot

+ type SnapshotPage = contracts.SnapshotPage

+ type SpawnFailureKind = string

+ const SpawnFailureKindInvalidCwd

+ const SpawnFailureKindMalformedExecutable

+ const SpawnFailureKindNotFound

+ const SpawnFailureKindPermissionDenied

+ 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 ExecOutcome

+ Sequence int64

+ Type string

+ type StreamOutputFrame struct

+ DataBase64 string

+ Sequence int64

+ Stream string

+ Type string

+ type StreamSignalFrame struct

+ Sequence int64

+ Signal int

+ Type string

+ type StreamingExecRequest struct

+ Command Command

+ Cwd *WorkspacePath

+ DeadlineMilliseconds int64

+ Environment StringMap

+ MaximumOutputBytes int64

+ WindowBytes int64

+ type StringMap = map[string]string

+ type Terminal struct

+ func (terminal *Terminal) Cancel() error

+ func (terminal *Terminal) Close() error

+ func (terminal *Terminal) GrantOutput(bytes int64) error

+ func (terminal *Terminal) Receive() (TerminalFrame, error)

+ func (terminal *Terminal) Resize(rows int, columns int) error

+ func (terminal *Terminal) SendInput(data []byte) error

+ type TerminalFrame struct

+ StreamCancelFrame *StreamCancelFrame

+ StreamCreditFrame *StreamCreditFrame

+ StreamOutcomeFrame *StreamOutcomeFrame

+ TerminalInputFrame *TerminalInputFrame

+ TerminalOutputFrame *TerminalOutputFrame

+ TerminalResizeFrame *TerminalResizeFrame

+ func (value *TerminalFrame) UnmarshalJSON(data []byte) error

+ func (value TerminalFrame) MarshalJSON() ([]byte, error)

+ type TerminalInputFrame struct

+ DataBase64 string

+ Sequence int64

+ Type string

+ type TerminalOutputFrame struct

+ DataBase64 string

+ Sequence int64

+ Type string

+ type TerminalResizeFrame struct

+ Columns int

+ Rows int

+ Sequence int64

+ Type string

+ type TerminalSession struct

+ ExpiresAt Timestamp

+ Generation int64

+ ID OpaqueID

+ NextClientSequence int64

+ SandboxID OpaqueID

+ State SessionState

+ StreamWindowBytes int64

+ Subprotocol string

+ WebsocketURL string

+ type Timestamp = time.Time

+ type TouchResult struct

+ Generation int64

+ LastActivityAt Timestamp

+ SandboxID OpaqueID

+ type UpdateRunnerPoolRequest struct

+ Architectures RunnerArchitectureList

+ Capabilities RunnerCapabilityList

+ CapacityPolicy RunnerCapacityPolicy

+ State *RunnerPoolState

+ type UpdateSandboxMetadataRequest struct

+ Metadata Metadata

+ type UploadArtifactRequest struct

+ Content string

+ MediaType string

+ Metadata Metadata

+ Name string

+ SHA256 string

+ type WaitSandboxRequest struct

+ DeadlineMilliseconds int64

+ States []SandboxState

+ type Workspace struct

+ CreatedAt Timestamp

+ Generation int64

+ ID OpaqueID

+ SizeBytes int64

+ State string

+ UpdatedAt Timestamp

+ type WorkspacePath = string

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