Codex.Protocol.Plugin.ScheduledTaskSchedule (Codex SDK v0.17.0)

Copy Markdown View Source

Tagged schedule metadata for a plugin-provided scheduled task.

Known tags are validated against the current hourly, daily, weekdays, and weekly shapes. Unknown string tags remain lossless for additive compatibility. Weekday values remain wire strings such as "MO" and "WE".

Summary

Types

t()

@type t() :: %Codex.Protocol.Plugin.ScheduledTaskSchedule{
  days: ([String.t()] | nil) | nil,
  extra: map(),
  interval_hours: (non_neg_integer() | nil) | nil,
  time: (String.t() | nil) | nil,
  type: String.t()
}

Functions

from_map(data)

@spec from_map(map() | keyword() | t()) :: t()

parse(value)

@spec parse(map() | keyword() | t()) ::
  {:ok, t()}
  | {:error,
     {:invalid_plugin_scheduled_task_schedule,
      CliSubprocessCore.Schema.error_detail()}}

parse!(value)

@spec parse!(map() | keyword() | t()) :: t()

schema()

@spec schema() :: Zoi.schema()

to_map(value)

@spec to_map(t()) :: map()