Skip to content

RecurrenceScheduleConfig

kedro_azureml_pipeline.config.RecurrenceScheduleConfig

Bases: BaseModel

Recurrence schedule mapping to azure.ai.ml.entities.RecurrenceTrigger.

Parameters

Name Type Description Default
frequency str

Recurrence frequency (e.g. "day", "week").

required
interval int

Number of frequency units between runs.

required
schedule RecurrencePatternConfig or None

Optional detailed recurrence pattern.

required
start_time str or None

ISO 8601 start time.

required
end_time str or None

ISO 8601 end time.

required
time_zone str

IANA time zone (default "UTC").

required

Source Code

Show/Hide source
class RecurrenceScheduleConfig(BaseModel):
    """Recurrence schedule mapping to ``azure.ai.ml.entities.RecurrenceTrigger``.

    Parameters
    ----------
    frequency : str
        Recurrence frequency (e.g. ``"day"``, ``"week"``).
    interval : int
        Number of frequency units between runs.
    schedule : RecurrencePatternConfig or None
        Optional detailed recurrence pattern.
    start_time : str or None
        ISO 8601 start time.
    end_time : str or None
        ISO 8601 end time.
    time_zone : str
        IANA time zone (default ``"UTC"``).
    """

    model_config = ConfigDict(extra="forbid")

    frequency: str = Field(description="Recurrence frequency (e.g. 'day', 'week').")
    interval: int = Field(description="Number of frequency units between runs.")
    schedule: RecurrencePatternConfig | None = Field(default=None, description="Optional detailed recurrence pattern.")
    start_time: str | None = Field(default=None, description="ISO 8601 start time.")
    end_time: str | None = Field(default=None, description="ISO 8601 end time.")
    time_zone: str = Field(default="UTC", description="IANA time zone.")