Interface RecurrencePattern.Builder

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

  • Method Details

    • frequency

      RecurrencePattern.Builder frequency(String frequency)

      Defines how often the pattern repeats. This is the base unit for the recurrence schedule and works in conjunction with the Interval field to determine the exact repetition sequence.

      Parameters:
      frequency - Defines how often the pattern repeats. This is the base unit for the recurrence schedule and works in conjunction with the Interval field to determine the exact repetition sequence.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • frequency

      RecurrencePattern.Builder frequency(RecurrenceFrequency frequency)

      Defines how often the pattern repeats. This is the base unit for the recurrence schedule and works in conjunction with the Interval field to determine the exact repetition sequence.

      Parameters:
      frequency - Defines how often the pattern repeats. This is the base unit for the recurrence schedule and works in conjunction with the Interval field to determine the exact repetition sequence.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • interval

      RecurrencePattern.Builder interval(Integer interval)

      Specifies the number of frequency units between each occurrence. Must be a positive integer.

      Examples: To repeat every week, set Interval=1 with WEEKLY frequency. To repeat every two months, set Interval=2 with MONTHLY frequency.

      Parameters:
      interval - Specifies the number of frequency units between each occurrence. Must be a positive integer.

      Examples: To repeat every week, set Interval=1 with WEEKLY frequency. To repeat every two months, set Interval=2 with MONTHLY frequency.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • byMonth

      RecurrencePattern.Builder byMonth(Collection<Integer> byMonth)

      Specifies which month the event should occur in (1-12, where 1=January, 12=December). Used with YEARLY frequency to schedule events in specific month.

      Note: It does not accept multiple values in the same list

      Parameters:
      byMonth - Specifies which month the event should occur in (1-12, where 1=January, 12=December). Used with YEARLY frequency to schedule events in specific month.

      Note: It does not accept multiple values in the same list

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • byMonth

      RecurrencePattern.Builder byMonth(Integer... byMonth)

      Specifies which month the event should occur in (1-12, where 1=January, 12=December). Used with YEARLY frequency to schedule events in specific month.

      Note: It does not accept multiple values in the same list

      Parameters:
      byMonth - Specifies which month the event should occur in (1-12, where 1=January, 12=December). Used with YEARLY frequency to schedule events in specific month.

      Note: It does not accept multiple values in the same list

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • byMonthDay

      RecurrencePattern.Builder byMonthDay(Collection<Integer> byMonthDay)

      Specifies which day of the month the event should occur on (1-31). Used with MONTHLY or YEARLY frequency to schedule events on specific date within a month.

      Examples: [15] for events on the 15th of each month, [-1] for events on the last day of month.

      Note: It does not accept multiple values in the same list. If a specified day doesn't exist in a particular month (e.g., day 31 in February), the event will be skipped for that month. This field cannot be used simultaneously with ByWeekdayOccurrence as they represent different scheduling approaches (specific dates vs. relative weekday positions).

      Parameters:
      byMonthDay - Specifies which day of the month the event should occur on (1-31). Used with MONTHLY or YEARLY frequency to schedule events on specific date within a month.

      Examples: [15] for events on the 15th of each month, [-1] for events on the last day of month.

      Note: It does not accept multiple values in the same list. If a specified day doesn't exist in a particular month (e.g., day 31 in February), the event will be skipped for that month. This field cannot be used simultaneously with ByWeekdayOccurrence as they represent different scheduling approaches (specific dates vs. relative weekday positions).

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • byMonthDay

      RecurrencePattern.Builder byMonthDay(Integer... byMonthDay)

      Specifies which day of the month the event should occur on (1-31). Used with MONTHLY or YEARLY frequency to schedule events on specific date within a month.

      Examples: [15] for events on the 15th of each month, [-1] for events on the last day of month.

      Note: It does not accept multiple values in the same list. If a specified day doesn't exist in a particular month (e.g., day 31 in February), the event will be skipped for that month. This field cannot be used simultaneously with ByWeekdayOccurrence as they represent different scheduling approaches (specific dates vs. relative weekday positions).

      Parameters:
      byMonthDay - Specifies which day of the month the event should occur on (1-31). Used with MONTHLY or YEARLY frequency to schedule events on specific date within a month.

      Examples: [15] for events on the 15th of each month, [-1] for events on the last day of month.

      Note: It does not accept multiple values in the same list. If a specified day doesn't exist in a particular month (e.g., day 31 in February), the event will be skipped for that month. This field cannot be used simultaneously with ByWeekdayOccurrence as they represent different scheduling approaches (specific dates vs. relative weekday positions).

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • byWeekdayOccurrence

      RecurrencePattern.Builder byWeekdayOccurrence(Collection<Integer> byWeekdayOccurrence)

      Specifies which occurrence of a weekday within the month the event should occur on. Must be used with MONTHLY or YEARLY frequency.

      Example: 2 corresponds to second occurrence of the weekday in the month. -1 corresponds to last occurrence of the weekday in the month

      The weekday itself is specified separately in the HoursOfOperationConfig. Example: To schedule the recurring event for the 2nd Thursday of April every year, set ByWeekdayOccurrence=[2], Day=THURSDAY, ByMonth=[4], Frequency: YEARLY and INTERVAL=1.

      Parameters:
      byWeekdayOccurrence - Specifies which occurrence of a weekday within the month the event should occur on. Must be used with MONTHLY or YEARLY frequency.

      Example: 2 corresponds to second occurrence of the weekday in the month. -1 corresponds to last occurrence of the weekday in the month

      The weekday itself is specified separately in the HoursOfOperationConfig. Example: To schedule the recurring event for the 2nd Thursday of April every year, set ByWeekdayOccurrence=[2], Day=THURSDAY, ByMonth=[4], Frequency: YEARLY and INTERVAL=1.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • byWeekdayOccurrence

      RecurrencePattern.Builder byWeekdayOccurrence(Integer... byWeekdayOccurrence)

      Specifies which occurrence of a weekday within the month the event should occur on. Must be used with MONTHLY or YEARLY frequency.

      Example: 2 corresponds to second occurrence of the weekday in the month. -1 corresponds to last occurrence of the weekday in the month

      The weekday itself is specified separately in the HoursOfOperationConfig. Example: To schedule the recurring event for the 2nd Thursday of April every year, set ByWeekdayOccurrence=[2], Day=THURSDAY, ByMonth=[4], Frequency: YEARLY and INTERVAL=1.

      Parameters:
      byWeekdayOccurrence - Specifies which occurrence of a weekday within the month the event should occur on. Must be used with MONTHLY or YEARLY frequency.

      Example: 2 corresponds to second occurrence of the weekday in the month. -1 corresponds to last occurrence of the weekday in the month

      The weekday itself is specified separately in the HoursOfOperationConfig. Example: To schedule the recurring event for the 2nd Thursday of April every year, set ByWeekdayOccurrence=[2], Day=THURSDAY, ByMonth=[4], Frequency: YEARLY and INTERVAL=1.

      Returns:
      Returns a reference to this object so that method calls can be chained together.