meta

package
v1.15.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 15, 2026 License: BSD-3-Clause Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetAllJobMetadata

func GetAllJobMetadata() map[string]JobMetadata

Types

type JobMetadata

type JobMetadata struct {
	ID             string
	Name           string
	Description    string
	Category       string
	SettingsKey    string
	EnabledKey     string
	ManagerOnly    bool
	IsContinuous   bool
	CanRunManually bool
	Prerequisites  []JobPrerequisiteMetadata
}

func GetJobMetadata

func GetJobMetadata(jobID string) (JobMetadata, bool)

func (JobMetadata) ToJobStatus

func (meta JobMetadata) ToJobStatus(schedule string, nextRun *time.Time, enabled bool, prerequisites []jobschedule.JobPrerequisite) jobschedule.JobStatus

type JobPrerequisiteMetadata

type JobPrerequisiteMetadata struct {
	SettingKey  string
	Label       string
	SettingsURL string
}

type Metadata

type Metadata struct {
	// Key is the identifier for the metadata.
	//
	// Required: true
	Key string `json:"key"`

	// Label is the human-readable label for the metadata.
	//
	// Required: true
	Label string `json:"label"`

	// Type is the data type of the metadata value.
	//
	// Required: true
	Type string `json:"type"`

	// Keywords is a list of keywords associated with the metadata.
	//
	// Required: false
	Keywords []string `json:"keywords,omitempty"`

	// Description provides additional information about the metadata.
	//
	// Required: false
	Description string `json:"description,omitempty"`
}

Metadata represents metadata about a configuration or setting.

type TemplateMeta

type TemplateMeta struct {
	// Version of the template.
	//
	// Required: false
	Version *string `json:"version,omitempty"`

	// Author of the template.
	//
	// Required: false
	Author *string `json:"author,omitempty"`

	// Tags is a list of tags associated with the template.
	//
	// Required: false
	Tags []string `json:"tags,omitempty"`

	// RemoteURL is the URL to the remote template file.
	//
	// Required: false
	RemoteURL *string `json:"remoteUrl,omitempty"`

	// EnvURL is the URL to the environment file.
	//
	// Required: false
	EnvURL *string `json:"envUrl,omitempty"`

	// DocumentationURL is the URL to the template documentation.
	//
	// Required: false
	DocumentationURL *string `json:"documentationUrl,omitempty"`

	// UpdatedAt is the date and time when the template was last updated.
	//
	// Required: false
	UpdatedAt *string `json:"updatedAt,omitempty"`
}

Template represents metadata about a template.

Jump to

Keyboard shortcuts

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