cron

Documentation

Index

• type Config
  • func (cfg Config) New(w *sdk.WorkflowSpecFactory) PayloadCap
  • func (j *Config) UnmarshalJSON(b []byte) error
• type Payload
  • func (j *Payload) UnmarshalJSON(b []byte) error
• type PayloadCap
  • func ConstantPayload(value Payload) PayloadCap
  • func NewPayloadFromFields(actualExecutionTime sdk.CapDefinition[string], ...) PayloadCap
  • func PayloadWrapper(raw sdk.CapDefinition[Payload]) PayloadCap
• type Trigger
  • func (j *Trigger) UnmarshalJSON(b []byte) error

Types

type Config

type Config struct {
	// Schedule corresponds to the JSON schema field "schedule".
	Schedule string `json:"schedule" yaml:"schedule" mapstructure:"schedule"`
}

func (Config) New

func (cfg Config) New(w *sdk.WorkflowSpecFactory) PayloadCap

func (*Config) UnmarshalJSON

func (j *Config) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler.

type Payload

type Payload struct {
	// Time that cron trigger's task execution occurred (RFC3339Nano formatted)
	ActualExecutionTime string `json:"ActualExecutionTime" yaml:"ActualExecutionTime" mapstructure:"ActualExecutionTime"`

	// Time that cron trigger's task execution had been scheduled to occur
	// (RFC3339Nano formatted)
	ScheduledExecutionTime string `json:"ScheduledExecutionTime" yaml:"ScheduledExecutionTime" mapstructure:"ScheduledExecutionTime"`
}

func (*Payload) UnmarshalJSON

func (j *Payload) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler.

type PayloadCap

type PayloadCap interface {
	sdk.CapDefinition[Payload]
	ActualExecutionTime() sdk.CapDefinition[string]
	ScheduledExecutionTime() sdk.CapDefinition[string]
	// contains filtered or unexported methods
}

func ConstantPayload

func ConstantPayload(value Payload) PayloadCap

func NewPayloadFromFields

func NewPayloadFromFields(
	actualExecutionTime sdk.CapDefinition[string],
	scheduledExecutionTime sdk.CapDefinition[string]) PayloadCap

func PayloadWrapper

func PayloadWrapper(raw sdk.CapDefinition[Payload]) PayloadCap

PayloadWrapper allows access to field from an sdk.CapDefinition[Payload]

type Trigger

type Trigger struct {
	// Config corresponds to the JSON schema field "config".
	Config Config `json:"config" yaml:"config" mapstructure:"config"`

	// Outputs corresponds to the JSON schema field "outputs".
	Outputs Payload `json:"outputs" yaml:"outputs" mapstructure:"outputs"`
}

A trigger that uses a cron schedule to run periodically at fixed times, dates, or intervals.

func (*Trigger) UnmarshalJSON

func (j *Trigger) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler.