Interface RecurrenceSettings.Builder

All Superinterfaces:
Buildable, CopyableBuilder<RecurrenceSettings.Builder,RecurrenceSettings>, SdkBuilder<RecurrenceSettings.Builder,RecurrenceSettings>, SdkPojo
Enclosing class:
RecurrenceSettings
@Mutable @NotThreadSafe public static interface RecurrenceSettings.Builder extends SdkPojo, CopyableBuilder<RecurrenceSettings.Builder,RecurrenceSettings>

  • Method Details

    • monthlySettings

      RecurrenceSettings.Builder monthlySettings(Collection<MonthlySetting> monthlySettings)

      Information about on-call rotations that recur monthly.

      Parameters:
      monthlySettings - Information about on-call rotations that recur monthly.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • monthlySettings

      RecurrenceSettings.Builder monthlySettings(MonthlySetting... monthlySettings)

      Information about on-call rotations that recur monthly.

      Parameters:
      monthlySettings - Information about on-call rotations that recur monthly.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • monthlySettings

      RecurrenceSettings.Builder monthlySettings(Consumer<MonthlySetting.Builder>... monthlySettings)

      Information about on-call rotations that recur monthly.

      This is a convenience method that creates an instance of the MonthlySetting.Builder avoiding the need to create one manually via MonthlySetting.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to monthlySettings(List<MonthlySetting>).

      Parameters:
      monthlySettings - a consumer that will call methods on MonthlySetting.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • weeklySettings

      RecurrenceSettings.Builder weeklySettings(Collection<WeeklySetting> weeklySettings)

      Information about on-call rotations that recur weekly.

      Parameters:
      weeklySettings - Information about on-call rotations that recur weekly.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • weeklySettings

      RecurrenceSettings.Builder weeklySettings(WeeklySetting... weeklySettings)

      Information about on-call rotations that recur weekly.

      Parameters:
      weeklySettings - Information about on-call rotations that recur weekly.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • weeklySettings

      RecurrenceSettings.Builder weeklySettings(Consumer<WeeklySetting.Builder>... weeklySettings)

      Information about on-call rotations that recur weekly.

      This is a convenience method that creates an instance of the WeeklySetting.Builder avoiding the need to create one manually via WeeklySetting.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to weeklySettings(List<WeeklySetting>).

      Parameters:
      weeklySettings - a consumer that will call methods on WeeklySetting.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dailySettings

      RecurrenceSettings.Builder dailySettings(Collection<HandOffTime> dailySettings)

      Information about on-call rotations that recur daily.

      Parameters:
      dailySettings - Information about on-call rotations that recur daily.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dailySettings

      RecurrenceSettings.Builder dailySettings(HandOffTime... dailySettings)

      Information about on-call rotations that recur daily.

      Parameters:
      dailySettings - Information about on-call rotations that recur daily.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dailySettings

      RecurrenceSettings.Builder dailySettings(Consumer<HandOffTime.Builder>... dailySettings)

      Information about on-call rotations that recur daily.

      This is a convenience method that creates an instance of the HandOffTime.Builder avoiding the need to create one manually via HandOffTime.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dailySettings(List<HandOffTime>).

      Parameters:
      dailySettings - a consumer that will call methods on HandOffTime.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • numberOfOnCalls

      RecurrenceSettings.Builder numberOfOnCalls(Integer numberOfOnCalls)

      The number of contacts, or shift team members designated to be on call concurrently during a shift. For example, in an on-call schedule that contains ten contacts, a value of 2 designates that two of them are on call at any given time.

      Parameters:
      numberOfOnCalls - The number of contacts, or shift team members designated to be on call concurrently during a shift. For example, in an on-call schedule that contains ten contacts, a value of 2 designates that two of them are on call at any given time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • shiftCoveragesWithStrings

      RecurrenceSettings.Builder shiftCoveragesWithStrings(Map<String,? extends Collection<CoverageTime>> shiftCoverages)

      Information about the days of the week that the on-call rotation coverage includes.

      Parameters:
      shiftCoverages - Information about the days of the week that the on-call rotation coverage includes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • shiftCoverages

      RecurrenceSettings.Builder shiftCoverages(Map<DayOfWeek,? extends Collection<CoverageTime>> shiftCoverages)

      Information about the days of the week that the on-call rotation coverage includes.

      Parameters:
      shiftCoverages - Information about the days of the week that the on-call rotation coverage includes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • recurrenceMultiplier

      RecurrenceSettings.Builder recurrenceMultiplier(Integer recurrenceMultiplier)

      The number of days, weeks, or months a single rotation lasts.

      Parameters:
      recurrenceMultiplier - The number of days, weeks, or months a single rotation lasts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.