Class Schedule


  • public final class Schedule
    extends Object
    The Schedule model.
    • Constructor Detail

      • Schedule

        public Schedule()
    • Method Detail

      • enable

        public Boolean enable()
        Get the enable property: Enable or disable assessment schedule on SQL virtual machine.
        Returns:
        the enable value.
      • withEnable

        public Schedule withEnable​(Boolean enable)
        Set the enable property: Enable or disable assessment schedule on SQL virtual machine.
        Parameters:
        enable - the enable value to set.
        Returns:
        the Schedule object itself.
      • weeklyInterval

        public Integer weeklyInterval()
        Get the weeklyInterval property: Number of weeks to schedule between 2 assessment runs. Takes value from 1-6.
        Returns:
        the weeklyInterval value.
      • withWeeklyInterval

        public Schedule withWeeklyInterval​(Integer weeklyInterval)
        Set the weeklyInterval property: Number of weeks to schedule between 2 assessment runs. Takes value from 1-6.
        Parameters:
        weeklyInterval - the weeklyInterval value to set.
        Returns:
        the Schedule object itself.
      • monthlyOccurrence

        public Integer monthlyOccurrence()
        Get the monthlyOccurrence property: Occurrence of the DayOfWeek day within a month to schedule assessment. Takes values: 1,2,3,4 and -1. Use -1 for last DayOfWeek day of the month.
        Returns:
        the monthlyOccurrence value.
      • withMonthlyOccurrence

        public Schedule withMonthlyOccurrence​(Integer monthlyOccurrence)
        Set the monthlyOccurrence property: Occurrence of the DayOfWeek day within a month to schedule assessment. Takes values: 1,2,3,4 and -1. Use -1 for last DayOfWeek day of the month.
        Parameters:
        monthlyOccurrence - the monthlyOccurrence value to set.
        Returns:
        the Schedule object itself.
      • dayOfWeek

        public DayOfWeek dayOfWeek()
        Get the dayOfWeek property: Day of the week to run assessment.
        Returns:
        the dayOfWeek value.
      • withDayOfWeek

        public Schedule withDayOfWeek​(DayOfWeek dayOfWeek)
        Set the dayOfWeek property: Day of the week to run assessment.
        Parameters:
        dayOfWeek - the dayOfWeek value to set.
        Returns:
        the Schedule object itself.
      • startTime

        public String startTime()
        Get the startTime property: Time of the day in HH:mm format. Eg. 17:30.
        Returns:
        the startTime value.
      • withStartTime

        public Schedule withStartTime​(String startTime)
        Set the startTime property: Time of the day in HH:mm format. Eg. 17:30.
        Parameters:
        startTime - the startTime value to set.
        Returns:
        the Schedule object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.