Versions in this module Expand all Collapse all v0 v0.9.1 Jan 14, 2026 v0.9.0 Jan 14, 2026 Changes in this version + func Bool(b bool) param.Opt[bool] + func BoolPtr(v bool) *bool + func DefaultClientOptions() []option.RequestOption + func File(rdr io.Reader, filename string, contentType string) file + func Float(f float64) param.Opt[float64] + func FloatPtr(v float64) *float64 + func Int(i int64) param.Opt[int64] + func IntPtr(v int64) *int64 + func Opt[T comparable](v T) param.Opt[T] + func Ptr[T any](v T) *T + func String(s string) param.Opt[string] + func StringPtr(v string) *string + func Time(t time.Time) param.Opt[time.Time] + func TimePtr(v time.Time) *time.Time + type AvailableDevice struct + CurrentDriver string + DeviceID string + DeviceName string + IommuGroup int64 + JSON struct{ ... } + PciAddress string + VendorID string + VendorName string + func (r *AvailableDevice) UnmarshalJSON(data []byte) error + func (r AvailableDevice) RawJSON() string + type Client struct + Devices DeviceService + Health HealthService + Images ImageService + Ingresses IngressService + Instances InstanceService + Options []option.RequestOption + Volumes VolumeService + func NewClient(opts ...option.RequestOption) (r Client) + func (r *Client) Delete(ctx context.Context, path string, params any, res any, ...) error + func (r *Client) Execute(ctx context.Context, method string, path string, params any, res any, ...) error + func (r *Client) Get(ctx context.Context, path string, params any, res any, ...) error + func (r *Client) Patch(ctx context.Context, path string, params any, res any, ...) error + func (r *Client) Post(ctx context.Context, path string, params any, res any, ...) error + func (r *Client) Put(ctx context.Context, path string, params any, res any, ...) error + type Device struct + AttachedTo string + BoundToVfio bool + CreatedAt time.Time + DeviceID string + ID string + IommuGroup int64 + JSON struct{ ... } + Name string + PciAddress string + Type DeviceType + VendorID string + func (r *Device) UnmarshalJSON(data []byte) error + func (r Device) RawJSON() string + type DeviceNewParams struct + Name param.Opt[string] + PciAddress string + func (r *DeviceNewParams) UnmarshalJSON(data []byte) error + func (r DeviceNewParams) MarshalJSON() (data []byte, err error) + type DeviceService struct + Options []option.RequestOption + func NewDeviceService(opts ...option.RequestOption) (r DeviceService) + func (r *DeviceService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (err error) + func (r *DeviceService) Get(ctx context.Context, id string, opts ...option.RequestOption) (res *Device, err error) + func (r *DeviceService) List(ctx context.Context, opts ...option.RequestOption) (res *[]Device, err error) + func (r *DeviceService) ListAvailable(ctx context.Context, opts ...option.RequestOption) (res *[]AvailableDevice, err error) + func (r *DeviceService) New(ctx context.Context, body DeviceNewParams, opts ...option.RequestOption) (res *Device, err error) + type DeviceType string + const DeviceTypeGPU + const DeviceTypePci + type Error = apierror.Error + type HealthCheckResponse struct + JSON struct{ ... } + Status HealthCheckResponseStatus + func (r *HealthCheckResponse) UnmarshalJSON(data []byte) error + func (r HealthCheckResponse) RawJSON() string + type HealthCheckResponseStatus string + const HealthCheckResponseStatusOk + type HealthService struct + Options []option.RequestOption + func NewHealthService(opts ...option.RequestOption) (r HealthService) + func (r *HealthService) Check(ctx context.Context, opts ...option.RequestOption) (res *HealthCheckResponse, err error) + type Image struct + Cmd []string + CreatedAt time.Time + Digest string + Entrypoint []string + Env map[string]string + Error string + JSON struct{ ... } + Name string + QueuePosition int64 + SizeBytes int64 + Status ImageStatus + WorkingDir string + func (r *Image) UnmarshalJSON(data []byte) error + func (r Image) RawJSON() string + type ImageNewParams struct + Name string + func (r *ImageNewParams) UnmarshalJSON(data []byte) error + func (r ImageNewParams) MarshalJSON() (data []byte, err error) + type ImageService struct + Options []option.RequestOption + func NewImageService(opts ...option.RequestOption) (r ImageService) + func (r *ImageService) Delete(ctx context.Context, name string, opts ...option.RequestOption) (err error) + func (r *ImageService) Get(ctx context.Context, name string, opts ...option.RequestOption) (res *Image, err error) + func (r *ImageService) List(ctx context.Context, opts ...option.RequestOption) (res *[]Image, err error) + func (r *ImageService) New(ctx context.Context, body ImageNewParams, opts ...option.RequestOption) (res *Image, err error) + type ImageStatus string + const ImageStatusConverting + const ImageStatusFailed + const ImageStatusPending + const ImageStatusPulling + const ImageStatusReady + type Ingress struct + CreatedAt time.Time + ID string + JSON struct{ ... } + Name string + Rules []IngressRule + func (r *Ingress) UnmarshalJSON(data []byte) error + func (r Ingress) RawJSON() string + type IngressMatch struct + Hostname string + JSON struct{ ... } + Port int64 + func (r *IngressMatch) UnmarshalJSON(data []byte) error + func (r IngressMatch) RawJSON() string + func (r IngressMatch) ToParam() IngressMatchParam + type IngressMatchParam struct + Hostname string + Port param.Opt[int64] + func (r *IngressMatchParam) UnmarshalJSON(data []byte) error + func (r IngressMatchParam) MarshalJSON() (data []byte, err error) + type IngressNewParams struct + Name string + Rules []IngressRuleParam + func (r *IngressNewParams) UnmarshalJSON(data []byte) error + func (r IngressNewParams) MarshalJSON() (data []byte, err error) + type IngressRule struct + JSON struct{ ... } + Match IngressMatch + RedirectHTTP bool + Target IngressTarget + Tls bool + func (r *IngressRule) UnmarshalJSON(data []byte) error + func (r IngressRule) RawJSON() string + func (r IngressRule) ToParam() IngressRuleParam + type IngressRuleParam struct + Match IngressMatchParam + RedirectHTTP param.Opt[bool] + Target IngressTargetParam + Tls param.Opt[bool] + func (r *IngressRuleParam) UnmarshalJSON(data []byte) error + func (r IngressRuleParam) MarshalJSON() (data []byte, err error) + type IngressService struct + Options []option.RequestOption + func NewIngressService(opts ...option.RequestOption) (r IngressService) + func (r *IngressService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (err error) + func (r *IngressService) Get(ctx context.Context, id string, opts ...option.RequestOption) (res *Ingress, err error) + func (r *IngressService) List(ctx context.Context, opts ...option.RequestOption) (res *[]Ingress, err error) + func (r *IngressService) New(ctx context.Context, body IngressNewParams, opts ...option.RequestOption) (res *Ingress, err error) + type IngressTarget struct + Instance string + JSON struct{ ... } + Port int64 + func (r *IngressTarget) UnmarshalJSON(data []byte) error + func (r IngressTarget) RawJSON() string + func (r IngressTarget) ToParam() IngressTargetParam + type IngressTargetParam struct + Instance string + Port int64 + func (r *IngressTargetParam) UnmarshalJSON(data []byte) error + func (r IngressTargetParam) MarshalJSON() (data []byte, err error) + type Instance struct + CreatedAt time.Time + Env map[string]string + HasSnapshot bool + HotplugSize string + ID string + Image string + JSON struct{ ... } + Name string + Network InstanceNetwork + OverlaySize string + Size string + StartedAt time.Time + State InstanceState + StateError string + StoppedAt time.Time + Vcpus int64 + Volumes []VolumeMount + func (r *Instance) UnmarshalJSON(data []byte) error + func (r Instance) RawJSON() string + type InstanceLogsParams struct + Follow param.Opt[bool] + Source InstanceLogsParamsSource + Tail param.Opt[int64] + func (r InstanceLogsParams) URLQuery() (v url.Values, err error) + type InstanceLogsParamsSource string + const InstanceLogsParamsSourceApp + const InstanceLogsParamsSourceHypeman + const InstanceLogsParamsSourceVmm + type InstanceNetwork struct + Enabled bool + IP string + JSON struct{ ... } + Mac string + Name string + func (r *InstanceNetwork) UnmarshalJSON(data []byte) error + func (r InstanceNetwork) RawJSON() string + type InstanceNewParams struct + Devices []string + Env map[string]string + HotplugSize param.Opt[string] + Image string + Name string + Network InstanceNewParamsNetwork + OverlaySize param.Opt[string] + Size param.Opt[string] + Vcpus param.Opt[int64] + Volumes []VolumeMountParam + func (r *InstanceNewParams) UnmarshalJSON(data []byte) error + func (r InstanceNewParams) MarshalJSON() (data []byte, err error) + type InstanceNewParamsNetwork struct + Enabled param.Opt[bool] + func (r *InstanceNewParamsNetwork) UnmarshalJSON(data []byte) error + func (r InstanceNewParamsNetwork) MarshalJSON() (data []byte, err error) + type InstanceService struct + Options []option.RequestOption + Volumes InstanceVolumeService + func NewInstanceService(opts ...option.RequestOption) (r InstanceService) + func (r *InstanceService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (err error) + func (r *InstanceService) Get(ctx context.Context, id string, opts ...option.RequestOption) (res *Instance, err error) + func (r *InstanceService) List(ctx context.Context, opts ...option.RequestOption) (res *[]Instance, err error) + func (r *InstanceService) LogsStreaming(ctx context.Context, id string, query InstanceLogsParams, ...) (stream *ssestream.Stream[string]) + func (r *InstanceService) New(ctx context.Context, body InstanceNewParams, opts ...option.RequestOption) (res *Instance, err error) + func (r *InstanceService) Restore(ctx context.Context, id string, opts ...option.RequestOption) (res *Instance, err error) + func (r *InstanceService) Standby(ctx context.Context, id string, opts ...option.RequestOption) (res *Instance, err error) + func (r *InstanceService) Start(ctx context.Context, id string, opts ...option.RequestOption) (res *Instance, err error) + func (r *InstanceService) Stat(ctx context.Context, id string, query InstanceStatParams, ...) (res *PathInfo, err error) + func (r *InstanceService) Stop(ctx context.Context, id string, opts ...option.RequestOption) (res *Instance, err error) + type InstanceStatParams struct + FollowLinks param.Opt[bool] + Path string + func (r InstanceStatParams) URLQuery() (v url.Values, err error) + type InstanceState string + const InstanceStateCreated + const InstanceStatePaused + const InstanceStateRunning + const InstanceStateShutdown + const InstanceStateStandby + const InstanceStateStopped + const InstanceStateUnknown + type InstanceVolumeAttachParams struct + ID string + MountPath string + Readonly param.Opt[bool] + func (r *InstanceVolumeAttachParams) UnmarshalJSON(data []byte) error + func (r InstanceVolumeAttachParams) MarshalJSON() (data []byte, err error) + type InstanceVolumeDetachParams struct + ID string + type InstanceVolumeService struct + Options []option.RequestOption + func NewInstanceVolumeService(opts ...option.RequestOption) (r InstanceVolumeService) + func (r *InstanceVolumeService) Attach(ctx context.Context, volumeID string, params InstanceVolumeAttachParams, ...) (res *Instance, err error) + func (r *InstanceVolumeService) Detach(ctx context.Context, volumeID string, body InstanceVolumeDetachParams, ...) (res *Instance, err error) + type PathInfo struct + Error string + Exists bool + IsDir bool + IsFile bool + IsSymlink bool + JSON struct{ ... } + LinkTarget string + Mode int64 + Size int64 + func (r *PathInfo) UnmarshalJSON(data []byte) error + func (r PathInfo) RawJSON() string + type Volume struct + Attachments []VolumeAttachment + CreatedAt time.Time + ID string + JSON struct{ ... } + Name string + SizeGB int64 + func (r *Volume) UnmarshalJSON(data []byte) error + func (r Volume) RawJSON() string + type VolumeAttachment struct + InstanceID string + JSON struct{ ... } + MountPath string + Readonly bool + func (r *VolumeAttachment) UnmarshalJSON(data []byte) error + func (r VolumeAttachment) RawJSON() string + type VolumeMount struct + JSON struct{ ... } + MountPath string + Overlay bool + OverlaySize string + Readonly bool + VolumeID string + func (r *VolumeMount) UnmarshalJSON(data []byte) error + func (r VolumeMount) RawJSON() string + func (r VolumeMount) ToParam() VolumeMountParam + type VolumeMountParam struct + MountPath string + Overlay param.Opt[bool] + OverlaySize param.Opt[string] + Readonly param.Opt[bool] + VolumeID string + func (r *VolumeMountParam) UnmarshalJSON(data []byte) error + func (r VolumeMountParam) MarshalJSON() (data []byte, err error) + type VolumeNewParams struct + ID param.Opt[string] + Name string + SizeGB int64 + func (r *VolumeNewParams) UnmarshalJSON(data []byte) error + func (r VolumeNewParams) MarshalJSON() (data []byte, err error) + type VolumeService struct + Options []option.RequestOption + func NewVolumeService(opts ...option.RequestOption) (r VolumeService) + func (r *VolumeService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (err error) + func (r *VolumeService) Get(ctx context.Context, id string, opts ...option.RequestOption) (res *Volume, err error) + func (r *VolumeService) List(ctx context.Context, opts ...option.RequestOption) (res *[]Volume, err error) + func (r *VolumeService) New(ctx context.Context, body VolumeNewParams, opts ...option.RequestOption) (res *Volume, err error)