Skip to content

CalendarInterval

Source code in docs_src/capo_application_signals/types/calendar_interval.py 
16
17
18
19
20
21
22
class CalendarInterval(TypedDict, closed=True):
    start_time: "datetime.datetime"
    """<p>The date and time when you want the first interval to start. Be sure to choose a time that configures the intervals the way that you want. For example, if you want weekly intervals starting on Mondays at 6 a.m., be sure to specify a start time that is a Monday at 6 a.m.</p> <p>When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>As soon as one calendar interval ends, another automatically begins.</p>"""
    duration_unit: "capo_application_signals.types.duration_unit.DurationUnit"
    """<p>Specifies the calendar interval unit.</p>"""
    duration: "capo_application_signals.types.calendar_interval_duration.CalendarIntervalDuration"
    """<p>Specifies the duration of each calendar interval. For example, if <code>Duration</code> is <code>1</code> and <code>DurationUnit</code> is <code>MONTH</code>, each interval is one month, aligned with the calendar.</p>"""

duration instance-attribute 

duration: CalendarIntervalDuration

Specifies the duration of each calendar interval. For example, if Duration is 1 and DurationUnit is MONTH, each interval is one month, aligned with the calendar.

duration_unit instance-attribute 

duration_unit: DurationUnit

Specifies the calendar interval unit.

start_time instance-attribute 

start_time: datetime

The date and time when you want the first interval to start. Be sure to choose a time that configures the intervals the way that you want. For example, if you want weekly intervals starting on Mondays at 6 a.m., be sure to specify a start time that is a Monday at 6 a.m.

When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

As soon as one calendar interval ends, another automatically begins.