jobschedule

package

v1.15.0 Latest Latest Go to latest Published: Feb 13, 2026 License: BSD-3-Clause Imports: 1 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/getarcaneapp/arcane

Links

Open Source Insights

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Config ¶

type Config struct {
	EnvironmentHealthInterval  string `json:"environmentHealthInterval"`
	EventCleanupInterval       string `json:"eventCleanupInterval"`
	AnalyticsHeartbeatInterval string `json:"analyticsHeartbeatInterval"`
	AutoUpdateInterval         string `json:"autoUpdateInterval"`
	PollingInterval            string `json:"pollingInterval"`
	ScheduledPruneInterval     string `json:"scheduledPruneInterval"`
	GitopsSyncInterval         string `json:"gitopsSyncInterval"`
	VulnerabilityScanInterval  string `json:"vulnerabilityScanInterval"`
}

Config represents the configured intervals (in minutes) for Arcane background jobs.

All fields are in minutes. This makes conversion to time.Duration straightforward in the backend.

type JobListResponse ¶

type JobListResponse struct {
	Jobs    []JobStatus `json:"jobs"`
	IsAgent bool        `json:"isAgent"`
}

JobListResponse contains all jobs and system mode information.

type JobPrerequisite ¶

type JobPrerequisite struct {
	SettingKey  string `json:"settingKey"`
	Label       string `json:"label"`
	IsMet       bool   `json:"isMet"`
	SettingsURL string `json:"settingsUrl,omitempty"`
}

JobPrerequisite represents a requirement that must be met for a job to run.

type JobRunRequest ¶

type JobRunRequest struct {
	JobID string `json:"jobId" path:"jobId" minLength:"1"`
}

JobRunRequest is the request to manually run a job.

type JobRunResponse ¶

type JobRunResponse struct {
	Success bool   `json:"success"`
	Message string `json:"message"`
}

JobRunResponse is the response after manually triggering a job.

type JobStatus ¶

type JobStatus struct {
	ID             string            `json:"id"`
	Name           string            `json:"name"`
	Description    string            `json:"description"`
	Category       string            `json:"category"`
	Schedule       string            `json:"schedule"`
	NextRun        *time.Time        `json:"nextRun,omitempty"`
	Enabled        bool              `json:"enabled"`
	ManagerOnly    bool              `json:"managerOnly"`
	IsContinuous   bool              `json:"isContinuous"`
	CanRunManually bool              `json:"canRunManually"`
	Prerequisites  []JobPrerequisite `json:"prerequisites"`
	SettingsKey    string            `json:"settingsKey,omitempty"`
}

JobStatus represents the current status and metadata for a background job.

type Update ¶

type Update struct {
	EnvironmentHealthInterval  *string `json:"environmentHealthInterval,omitempty"`
	EventCleanupInterval       *string `json:"eventCleanupInterval,omitempty"`
	AnalyticsHeartbeatInterval *string `json:"analyticsHeartbeatInterval,omitempty"`
	AutoUpdateInterval         *string `json:"autoUpdateInterval,omitempty"`
	PollingInterval            *string `json:"pollingInterval,omitempty"`
	ScheduledPruneInterval     *string `json:"scheduledPruneInterval,omitempty"`
	GitopsSyncInterval         *string `json:"gitopsSyncInterval,omitempty"`
	VulnerabilityScanInterval  *string `json:"vulnerabilityScanInterval,omitempty"`
}

Update is used to update job schedule intervals (in minutes).

Any nil field is ignored.

Source Files ¶

View all Source files

jobschedule.go

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