Skip to content

ScheduledTriggerProperties

Source code in docs_src/capo_customer_profiles/types/scheduled_trigger_properties.py
class ScheduledTriggerProperties(TypedDict, closed=True):
    schedule_expression: (
        "capo_customer_profiles.types.schedule_expression.ScheduleExpression"
    )
    """<p>The scheduling expression that determines the rate at which the schedule will run, for example rate (5 minutes).</p>"""
    data_pull_mode: NotRequired[
        "capo_customer_profiles.types.data_pull_mode.DataPullMode"
    ]
    """<p>Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.</p>"""
    schedule_start_time: NotRequired["capo_customer_profiles.types.date.Date"]
    """<p>Specifies the scheduled start time for a scheduled-trigger flow.</p>"""
    schedule_end_time: NotRequired["capo_customer_profiles.types.date.Date"]
    """<p>Specifies the scheduled end time for a scheduled-trigger flow.</p>"""
    timezone: NotRequired["capo_customer_profiles.types.timezone.Timezone"]
    """<p>Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as America/New_York.</p>"""
    schedule_offset: NotRequired[
        "capo_customer_profiles.types.schedule_offset.ScheduleOffset"
    ]
    """<p>Specifies the optional offset that is added to the time interval for a schedule-triggered flow.</p>"""
    first_execution_from: NotRequired["capo_customer_profiles.types.date.Date"]
    """<p>Specifies the date range for the records to import from the connector in the first flow run.</p>"""

data_pull_mode instance-attribute

data_pull_mode: NotRequired[DataPullMode]

Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.

first_execution_from instance-attribute

first_execution_from: NotRequired[Date]

Specifies the date range for the records to import from the connector in the first flow run.

schedule_end_time instance-attribute

schedule_end_time: NotRequired[Date]

Specifies the scheduled end time for a scheduled-trigger flow.

schedule_expression instance-attribute

schedule_expression: ScheduleExpression

The scheduling expression that determines the rate at which the schedule will run, for example rate (5 minutes).

schedule_offset instance-attribute

schedule_offset: NotRequired[ScheduleOffset]

Specifies the optional offset that is added to the time interval for a schedule-triggered flow.

schedule_start_time instance-attribute

schedule_start_time: NotRequired[Date]

Specifies the scheduled start time for a scheduled-trigger flow.

timezone instance-attribute

timezone: NotRequired[Timezone]

Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as America/New_York.