TelemetrySchedule

TelemetrySchedule
TelemetrySchedule

The telemetry schedule configuration. The default frequency_type is WEEKLY_TELEMETRY_SCHEDULE.

  • DAILY_TELEMETRY_SCHEDULE: Requires hourOfDay and minutes. Runs every day at the specified hour and minute.

  • WEEKLY_TELEMETRY_SCHEDULE: Requires dayOfWeek, hourOfDay, and minutes. Runs every week on the specified day of the week at the given hour and minute.

  • MONTHLY_TELEMETRY_SCHEDULE: Requires dayOfMonth, hourOfDay, and minutes. Runs every month on the specified day at the given hour and minute.

JSON Example
{
    "frequency_type": "string",
    "hour_of_day": 0,
    "minutes": 0,
    "day_of_week": "string",
    "day_of_month": 0
}
frequency_type
Optional
Constraints: default: WEEKLY_TELEMETRY_SCHEDULE

Types of telemetry schedule frequency value

Possible values are : DAILY_TELEMETRY_SCHEDULE, WEEKLY_TELEMETRY_SCHEDULE, MONTHLY_TELEMETRY_SCHEDULE,
integer
hour_of_day
Optional
Constraints: minimum: 0 maximum: 23 default: 2

Hour of day

integer
minutes
Optional
Constraints: minimum: 0 maximum: 59 default: 0

Minutes

day_of_week
Optional
Constraints: default: SUNDAY

Types of telemetry schedule day of week value

Possible values are : SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY,
integer
day_of_month
Optional
Constraints: minimum: 1 maximum: 31 default: 1

Day of month