volume

type Backup struct {
	ID                string                `json:"id"`
	UpdatedAt         *time.Time            `json:"updatedAt,omitempty"`
	VolumeName        string                `json:"volumeName"`
	Size              int64                 `json:"size"`
	CreatedAt         time.Time             `json:"createdAt"`
	Status            string                `json:"status"`
	Trigger           string                `json:"trigger"`
	Destination       BackupDestination     `json:"destination"`
	Format            BackupFormat          `json:"format"`
	LocalSnapshotID   string                `json:"localSnapshotId,omitempty"`
	RemoteSnapshotID  string                `json:"remoteSnapshotId,omitempty"`
	S3DestinationID   string                `json:"s3DestinationId,omitempty"`
	RemoteInstanceID  string                `json:"remoteInstanceId,omitempty"`
	S3DestinationName string                `json:"s3DestinationName,omitempty"`
	PolicyID          string                `json:"policyId,omitempty"`
	Error             string                `json:"error,omitempty"`
	ActivityID        *string               `json:"activityId,omitempty"`
	Type              backup.ManagementType `json:"type"`
	RemoteAvailable   *bool                 `json:"remoteAvailable,omitempty"`
}

type BackupDestination string

type BackupEntry struct {
	RemoteAvailable   *bool                 `json:"remoteAvailable,omitempty"`
	ActivityID        *string               `json:"activityId,omitempty"`
	ID                string                `json:"id" doc:"Unique identifier of the backup"`
	VolumeName        string                `json:"volumeName" doc:"Name of the volume"`
	Size              int64                 `json:"size" doc:"Total size of the backup contents"`
	CreatedAt         string                `json:"createdAt" doc:"When the backup was created"`
	Status            string                `json:"status" doc:"Backup result status"`
	Trigger           string                `json:"trigger" doc:"How the backup was started"`
	Destination       BackupDestination     `json:"destination" doc:"Requested backup storage target"`
	Format            BackupFormat          `json:"format" doc:"Storage format of the backup: legacy tar.gz archive or Rustic snapshot"`
	LocalSnapshotID   string                `json:"localSnapshotId,omitempty" doc:"Snapshot ID in the local Rustic repository"`
	RemoteSnapshotID  string                `json:"remoteSnapshotId,omitempty" doc:"Snapshot ID in the S3 Rustic repository"`
	S3DestinationID   string                `json:"s3DestinationId,omitempty" doc:"S3 destination used by the backup"`
	S3DestinationName string                `json:"s3DestinationName,omitempty" doc:"Name of the S3 destination used by the backup"`
	PolicyID          string                `json:"policyId,omitempty" doc:"Backup policy that created the backup"`
	Error             string                `json:"error,omitempty" doc:"Backup error when the run failed"`
	Type              backup.ManagementType `json:"type" doc:"Whether the backup was system-managed or volume-managed"`
}

type BackupFormat string

type BackupPolicy struct {
	ID                string       `json:"id"`
	VolumeName        string       `json:"volumeName"`
	Enabled           bool         `json:"enabled"`
	Schedule          string       `json:"schedule"`
	RetentionCount    int          `json:"retentionCount"`
	StopContainers    bool         `json:"stopContainers"`
	LocalEnabled      bool         `json:"localEnabled"`
	S3Enabled         bool         `json:"s3Enabled"`
	S3DestinationID   string       `json:"s3DestinationId,omitempty"`
	S3DestinationName string       `json:"s3DestinationName,omitempty"`
	S3Available       bool         `json:"s3Available"`
	S3Bucket          string       `json:"s3Bucket,omitempty"`
	LastRun           *BackupEntry `json:"lastRun,omitempty"`
}

type BackupPolicyCollection struct {
	Policies    []BackupPolicy `json:"policies"`
	S3Available bool           `json:"s3Available"`
}

type Committer interface {
	Commit(ctx context.Context) error
}

type Create struct {
	// Name of the volume.
	//
	// Required: true
	Name string `json:"name" minLength:"1" doc:"Name of the volume"`

	// Driver is the volume driver to use.
	//
	// Required: false
	Driver string `json:"driver,omitempty" doc:"Volume driver (e.g., local, nfs)"`

	// DriverOpts contains driver-specific options.
	//
	// Required: false
	DriverOpts map[string]string `json:"driverOpts,omitempty" doc:"Driver-specific options"`

	// Labels contains user-defined metadata for the volume.
	//
	// Required: false
	Labels map[string]string `json:"labels,omitempty" doc:"User-defined labels"`
}

type CreateBackupRequest struct {
	Destination     BackupDestination `json:"destination,omitempty" doc:"Optional destination override for this manual backup"`
	PolicyID        string            `json:"policyId,omitempty" doc:"Optional backup policy whose settings should be used"`
	S3DestinationID string            `json:"s3DestinationId,omitempty" doc:"Saved S3 destination for a manual remote backup"`
}

type DiscoverBackupsRequest struct {
	S3DestinationID string `json:"s3DestinationId" doc:"S3 destination to scan for existing volume backups"`
}

type DiscoverBackupsResponse struct {
	Count  int      `json:"count" doc:"Number of newly discovered volume backups"`
	Errors []string `json:"errors,omitempty" doc:"Per-repository failures encountered during discovery"`
}

type JournalSource interface {
	JournalVolumes() []JournalVolume
}

type JournalVolume struct {
	Key     string            `json:"key"`
	OldName string            `json:"oldName"`
	NewName string            `json:"newName"`
	Driver  string            `json:"driver,omitempty"`
	Options map[string]string `json:"options,omitempty"`
	Labels  map[string]string `json:"labels,omitempty"`
}

type Migration interface {
	Apply(ctx context.Context) error
	Rollback(ctx context.Context) error
}

type ProjectVolumeRenameConflictError struct {
	VolumeName string
}

type ProjectVolumeRenameInUseError struct {
	VolumeName   string
	ContainerIDs []string
}

type ProjectVolumeRenameInsufficientSpaceError struct {
	SourceVolume string
	TargetVolume string
	Detail       string
}

type PruneReport struct {
	// VolumesDeleted is a list of volume names that were deleted.
	//
	// Required: true
	VolumesDeleted []string `json:"volumesDeleted"`

	// SpaceReclaimed is the amount of space reclaimed in bytes.
	//
	// Required: true
	SpaceReclaimed uint64 `json:"spaceReclaimed"`

	// ActivityID is the activity created by the prune action.
	//
	// Required: false
	ActivityID *string `json:"activityId,omitempty"`
}

type Rename struct {
	// Name is the new volume name.
	//
	// Required: true
	Name string `json:"name" minLength:"1" doc:"New volume name"`
}

type RenameEntry struct {
	Key           string
	OldName       string
	NewName       string
	OldVolume     volume.Volume
	CreateOptions client.VolumeCreateOptions
}

type SourceCleanupError struct {
	SourceVolume string
	Err          error
}

type TargetMissingWithSourceError struct {
	SourceVolume string
	TargetVolume string
}

type TargetPreservedDuringRollbackError struct {
	SourceVolume string
	TargetVolume string
	Err          error
}

type UpdateBackupPolicies struct {
	Policies []UpdateBackupPolicy `json:"policies"`
}

type UpdateBackupPolicy = backup.UpdateBackupPolicy

type UploadBackupRequest struct {
	S3DestinationID string `json:"s3DestinationId" doc:"S3 destination for the uploaded backup"`
}

type UsageCounts struct {
	// Inuse is the number of volumes currently in use.
	//
	// Required: true
	Inuse int `json:"inuse"`

	// Unused is the number of volumes not in use.
	//
	// Required: true
	Unused int `json:"unused"`

	// Total is the total number of volumes.
	//
	// Required: true
	Total int `json:"total"`
}

type Volume struct {
	base.EnvironmentTag

	// ID is the unique identifier of the volume.
	//
	// Required: true
	ID string `json:"id"`

	// Name of the volume.
	//
	// Required: true
	Name string `json:"name"`

	// Driver is the volume driver used.
	//
	// Required: true
	Driver string `json:"driver"`

	// Mountpoint is the path where the volume is mounted.
	//
	// Required: true
	Mountpoint string `json:"mountpoint"`

	// Scope of the volume (local, global, etc).
	//
	// Required: true
	Scope string `json:"scope"`

	// Options contains driver-specific options.
	//
	// Required: true
	Options map[string]string `json:"options"`

	// Labels contains user-defined metadata for the volume.
	//
	// Required: true
	Labels map[string]string `json:"labels"`

	// CreatedAt is the time when the volume was created.
	//
	// Required: true
	CreatedAt string `json:"createdAt"`

	// InUse indicates if the volume is currently in use by a container.
	//
	// Required: true
	InUse bool `json:"inUse"`

	// UsageData contains size and reference count information.
	//
	// Required: false
	UsageData *volume.UsageData `json:"usageData,omitempty"`

	// Size is the size of the volume in bytes.
	//
	// Required: false
	Size int64 `json:"size"`

	// Containers is a list of container IDs using this volume.
	//
	// Required: true
	Containers []string `json:"containers"`

	// ActivityID is the activity created by a mutating volume action.
	//
	// Required: false
	ActivityID *string `json:"activityId,omitempty"`
}

type VolumesExternallyRemovedError struct {
	Volumes []JournalVolume
}

type WorkspaceFileChange struct {
	Operation     string `json:"operation" binding:"required" enum:"create_file,create_folder,update_file,rename,move,delete,restore_file"`
	RelativePath  string `json:"relativePath" binding:"required"`
	NewName       string `json:"newName,omitempty"`
	NewParentPath string `json:"newParentPath,omitempty"`
	UploadIndex   *int   `json:"uploadIndex,omitempty" minimum:"0"`
	// BaselineIndex references an uploaded copy of the content an update_file
	// change was drafted against. The volume workspace revision is already
	// content-aware, so the baseline is accepted for API symmetry with
	// project workspaces but not separately compared.
	BaselineIndex *int   `json:"baselineIndex,omitempty" minimum:"0"`
	BackupID      string `json:"backupId,omitempty"`
	Recursive     bool   `json:"recursive,omitempty"`
}

type WorkspaceUpdateManifest struct {
	FileTreeRevision string                `json:"fileTreeRevision" binding:"required"`
	FileChanges      []WorkspaceFileChange `json:"fileChanges" binding:"required" minItems:"1" maxItems:"500"`
}