api.md

Shared Params Types

• shared.SnapshotCompressionConfigParam

Shared Response Types

• shared.SnapshotCompressionConfig

Health

Response Types:

• hypeman.HealthCheckResponse

Methods:

• client.Health.Check(ctx context.Context) (*hypeman.HealthCheckResponse, error)

Capabilities

Response Types:

• hypeman.Capabilities
• hypeman.CapabilitiesDefaultRuntime
• hypeman.CapabilitiesHost
• hypeman.CapabilitiesImages
• hypeman.CapabilitiesNetwork
• hypeman.CapabilitiesRuntime
• hypeman.CapabilitiesServer

Methods:

• client.Capabilities.Get(ctx context.Context) (*hypeman.Capabilities, error)

Images

Response Types:

• hypeman.Image

Methods:

• client.Images.New(ctx context.Context, body hypeman.ImageNewParams) (*hypeman.Image, error)
• client.Images.List(ctx context.Context, query hypeman.ImageListParams) (*[]hypeman.Image, error)
• client.Images.Delete(ctx context.Context, name string) error
• client.Images.Get(ctx context.Context, name string) (*hypeman.Image, error)

Instances

Params Types:

• hypeman.AutoStandbyPolicyParam
• hypeman.HealthCheckParam
• hypeman.HealthCheckExecParam
• hypeman.HealthCheckHTTPParam
• hypeman.HealthCheckTcpParam
• hypeman.RestartPolicyParam
• hypeman.SetSnapshotScheduleRequestParam
• hypeman.SnapshotPolicyParam
• hypeman.SnapshotScheduleRetentionParam
• hypeman.StandbyInstanceRequestParam
• hypeman.VolumeMountParam

Response Types:

• hypeman.AutoStandbyPolicy
• hypeman.AutoStandbyStatus
• hypeman.HealthCheck
• hypeman.HealthCheckExec
• hypeman.HealthCheckHTTP
• hypeman.HealthCheckTcp
• hypeman.Instance
• hypeman.InstanceHealthStatus
• hypeman.InstanceStats
• hypeman.PathInfo
• hypeman.RestartPolicy
• hypeman.RestartStatus
• hypeman.SnapshotPolicy
• hypeman.SnapshotSchedule
• hypeman.SnapshotScheduleRetention
• hypeman.VolumeMount
• hypeman.WaitForStateResponse

Methods:

• client.Instances.New(ctx context.Context, body hypeman.InstanceNewParams) (*hypeman.Instance, error)
• client.Instances.Update(ctx context.Context, id string, body hypeman.InstanceUpdateParams) (*hypeman.Instance, error)
• client.Instances.List(ctx context.Context, query hypeman.InstanceListParams) (*[]hypeman.Instance, error)
• client.Instances.Delete(ctx context.Context, id string) error
• client.Instances.Fork(ctx context.Context, id string, body hypeman.InstanceForkParams) (*hypeman.Instance, error)
• client.Instances.Get(ctx context.Context, id string) (*hypeman.Instance, error)
• client.Instances.Logs(ctx context.Context, id string, query hypeman.InstanceLogsParams) (*string, error)
• client.Instances.Restore(ctx context.Context, id string) (*hypeman.Instance, error)
• client.Instances.Standby(ctx context.Context, id string, body hypeman.InstanceStandbyParams) (*hypeman.Instance, error)
• client.Instances.Start(ctx context.Context, id string, body hypeman.InstanceStartParams) (*hypeman.Instance, error)
• client.Instances.Stat(ctx context.Context, id string, query hypeman.InstanceStatParams) (*hypeman.PathInfo, error)
• client.Instances.Stats(ctx context.Context, id string) (*hypeman.InstanceStats, error)
• client.Instances.Stop(ctx context.Context, id string) (*hypeman.Instance, error)
• client.Instances.Wait(ctx context.Context, id string, query hypeman.InstanceWaitParams) (*hypeman.WaitForStateResponse, error)

AutoStandby

Methods:

• client.Instances.AutoStandby.Hold(ctx context.Context, id string) (*hypeman.AutoStandbyStatus, error)
• client.Instances.AutoStandby.Status(ctx context.Context, id string) (*hypeman.AutoStandbyStatus, error)

Volumes

Methods:

• client.Instances.Volumes.Attach(ctx context.Context, volumeID string, params hypeman.InstanceVolumeAttachParams) (*hypeman.Instance, error)
• client.Instances.Volumes.Detach(ctx context.Context, volumeID string, body hypeman.InstanceVolumeDetachParams) (*hypeman.Instance, error)

Snapshots

Methods:

• client.Instances.Snapshots.New(ctx context.Context, id string, body hypeman.InstanceSnapshotNewParams) (*hypeman.Snapshot, error)
• client.Instances.Snapshots.Restore(ctx context.Context, snapshotID string, params hypeman.InstanceSnapshotRestoreParams) (*hypeman.Instance, error)

SnapshotSchedule

Methods:

• client.Instances.SnapshotSchedule.Update(ctx context.Context, id string, body hypeman.InstanceSnapshotScheduleUpdateParams) (*hypeman.SnapshotSchedule, error)
• client.Instances.SnapshotSchedule.Delete(ctx context.Context, id string) error
• client.Instances.SnapshotSchedule.Get(ctx context.Context, id string) (*hypeman.SnapshotSchedule, error)

Snapshots

Params Types:

• hypeman.SnapshotKind

Response Types:

• hypeman.Snapshot
• hypeman.SnapshotKind

Methods:

• client.Snapshots.List(ctx context.Context, query hypeman.SnapshotListParams) (*[]hypeman.Snapshot, error)
• client.Snapshots.Delete(ctx context.Context, snapshotID string) error
• client.Snapshots.Fork(ctx context.Context, snapshotID string, body hypeman.SnapshotForkParams) (*hypeman.Instance, error)
• client.Snapshots.Get(ctx context.Context, snapshotID string) (*hypeman.Snapshot, error)

Volumes

Response Types:

• hypeman.Volume
• hypeman.VolumeAttachment

Methods:

• client.Volumes.New(ctx context.Context, body hypeman.VolumeNewParams) (*hypeman.Volume, error)
• client.Volumes.List(ctx context.Context, query hypeman.VolumeListParams) (*[]hypeman.Volume, error)
• client.Volumes.Delete(ctx context.Context, id string) error
• client.Volumes.NewFromArchive(ctx context.Context, body io.Reader, params hypeman.VolumeNewFromArchiveParams) (*hypeman.Volume, error)
• client.Volumes.Get(ctx context.Context, id string) (*hypeman.Volume, error)

Devices

Response Types:

• hypeman.AvailableDevice
• hypeman.Device
• hypeman.DeviceType

Methods:

• client.Devices.New(ctx context.Context, body hypeman.DeviceNewParams) (*hypeman.Device, error)
• client.Devices.Get(ctx context.Context, id string) (*hypeman.Device, error)
• client.Devices.List(ctx context.Context, query hypeman.DeviceListParams) (*[]hypeman.Device, error)
• client.Devices.Delete(ctx context.Context, id string) error
• client.Devices.ListAvailable(ctx context.Context) (*[]hypeman.AvailableDevice, error)

Ingresses

Params Types:

• hypeman.IngressMatchParam
• hypeman.IngressRuleParam
• hypeman.IngressTargetParam

Response Types:

• hypeman.Ingress
• hypeman.IngressMatch
• hypeman.IngressRule
• hypeman.IngressTarget

Methods:

• client.Ingresses.New(ctx context.Context, body hypeman.IngressNewParams) (*hypeman.Ingress, error)
• client.Ingresses.List(ctx context.Context, query hypeman.IngressListParams) (*[]hypeman.Ingress, error)
• client.Ingresses.Delete(ctx context.Context, id string) error
• client.Ingresses.Get(ctx context.Context, id string) (*hypeman.Ingress, error)

Resources

Params Types:

• hypeman.MemoryReclaimRequestParam

Response Types:

• hypeman.DiskBreakdown
• hypeman.GPUProfile
• hypeman.GPUResourceStatus
• hypeman.MemoryReclaimAction
• hypeman.MemoryReclaimResponse
• hypeman.PassthroughDevice
• hypeman.ResourceAllocation
• hypeman.ResourceStatus
• hypeman.Resources

Methods:

• client.Resources.Get(ctx context.Context) (*hypeman.Resources, error)
• client.Resources.ReclaimMemory(ctx context.Context, body hypeman.ResourceReclaimMemoryParams) (*hypeman.MemoryReclaimResponse, error)

Builders

Response Types:

• hypeman.Builder
• hypeman.BuilderStatus

Methods:

• client.Builders.New(ctx context.Context, body hypeman.BuilderNewParams) (*hypeman.Builder, error)
• client.Builders.List(ctx context.Context, query hypeman.BuilderListParams) (*[]hypeman.Builder, error)
• client.Builders.Delete(ctx context.Context, id string) error
• client.Builders.Get(ctx context.Context, id string) (*hypeman.Builder, error)
• client.Builders.Prune(ctx context.Context, id string) (*hypeman.Builder, error)

Builds

Response Types:

• hypeman.Build
• hypeman.BuildEvent
• hypeman.BuildProvenance
• hypeman.BuildStatus

Methods:

• client.Builds.New(ctx context.Context, body hypeman.BuildNewParams) (*hypeman.Build, error)
• client.Builds.List(ctx context.Context, query hypeman.BuildListParams) (*[]hypeman.Build, error)
• client.Builds.Cancel(ctx context.Context, id string) error
• client.Builds.Events(ctx context.Context, id string, query hypeman.BuildEventsParams) (*hypeman.BuildEvent, error)
• client.Builds.Get(ctx context.Context, id string) (*hypeman.Build, error)

Pushes

Params Types:

• hypeman.CreatePushRequestParam
• hypeman.PushCredentialsParam

Response Types:

• hypeman.Push
• hypeman.PushStatus

Methods:

• client.Pushes.New(ctx context.Context, body hypeman.PushNewParams) (*hypeman.Push, error)
• client.Pushes.List(ctx context.Context) (*[]hypeman.Push, error)
• client.Pushes.Get(ctx context.Context, id string) (*hypeman.Push, error)