Class RecurrenceSchedule


  • public final class RecurrenceSchedule
    extends ScheduleBase
    Recurrence schedule definition.
    • Constructor Detail

      • RecurrenceSchedule

        public RecurrenceSchedule()
    • Method Detail

      • frequency

        public RecurrenceFrequency frequency()
        Get the frequency property: [Required] Specifies frequency with with which to trigger schedule.
        Returns:
        the frequency value.
      • withFrequency

        public RecurrenceSchedule withFrequency​(RecurrenceFrequency frequency)
        Set the frequency property: [Required] Specifies frequency with with which to trigger schedule.
        Parameters:
        frequency - the frequency value to set.
        Returns:
        the RecurrenceSchedule object itself.
      • interval

        public int interval()
        Get the interval property: [Required] Specifies schedule interval in conjunction with frequency.
        Returns:
        the interval value.
      • withInterval

        public RecurrenceSchedule withInterval​(int interval)
        Set the interval property: [Required] Specifies schedule interval in conjunction with frequency.
        Parameters:
        interval - the interval value to set.
        Returns:
        the RecurrenceSchedule object itself.
      • pattern

        public RecurrencePattern pattern()
        Get the pattern property: Specifies the recurrence schedule pattern.
        Returns:
        the pattern value.
      • withPattern

        public RecurrenceSchedule withPattern​(RecurrencePattern pattern)
        Set the pattern property: Specifies the recurrence schedule pattern.
        Parameters:
        pattern - the pattern value to set.
        Returns:
        the RecurrenceSchedule object itself.
      • withEndTime

        public RecurrenceSchedule withEndTime​(OffsetDateTime endTime)
        Set the endTime property: Specifies end time of schedule in ISO 8601 format. If not present, the schedule will run indefinitely.
        Overrides:
        withEndTime in class ScheduleBase
        Parameters:
        endTime - the endTime value to set.
        Returns:
        the ScheduleBase object itself.
      • withScheduleStatus

        public RecurrenceSchedule withScheduleStatus​(ScheduleStatus scheduleStatus)
        Set the scheduleStatus property: Specifies the schedule's status.
        Overrides:
        withScheduleStatus in class ScheduleBase
        Parameters:
        scheduleStatus - the scheduleStatus value to set.
        Returns:
        the ScheduleBase object itself.
      • withStartTime

        public RecurrenceSchedule withStartTime​(OffsetDateTime startTime)
        Set the startTime property: Specifies start time of schedule in ISO 8601 format.
        Overrides:
        withStartTime in class ScheduleBase
        Parameters:
        startTime - the startTime value to set.
        Returns:
        the ScheduleBase object itself.
      • withTimeZone

        public RecurrenceSchedule withTimeZone​(String timeZone)
        Set the timeZone property: Specifies time zone in which the schedule runs. TimeZone should follow Windows time zone format.
        Overrides:
        withTimeZone in class ScheduleBase
        Parameters:
        timeZone - the timeZone value to set.
        Returns:
        the ScheduleBase object itself.