Interface ScheduleConfig.Builder

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

  • Method Details

    • scheduleExpression

      ScheduleConfig.Builder scheduleExpression(String scheduleExpression)

      The schedule expression that specifies when to trigger the scheduled report run. This value must be a cron expression consisting of six fields separated by white spaces: cron(minutes hours day_of_month month day_of_week year).

      Parameters:
      scheduleExpression - The schedule expression that specifies when to trigger the scheduled report run. This value must be a cron expression consisting of six fields separated by white spaces: cron(minutes hours day_of_month month day_of_week year).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scheduleExpressionTimeZone

      ScheduleConfig.Builder scheduleExpressionTimeZone(String scheduleExpressionTimeZone)

      The time zone for the schedule expression, for example, UTC.

      Parameters:
      scheduleExpressionTimeZone - The time zone for the schedule expression, for example, UTC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • schedulePeriod

      ScheduleConfig.Builder schedulePeriod(SchedulePeriod schedulePeriod)

      The time period during which the schedule is active.

      Parameters:
      schedulePeriod - The time period during which the schedule is active.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • schedulePeriod

      default ScheduleConfig.Builder schedulePeriod(Consumer<SchedulePeriod.Builder> schedulePeriod)

      The time period during which the schedule is active.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to schedulePeriod(SchedulePeriod).

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

    • state

      ScheduleConfig.Builder state(String state)

      The state of the schedule. ENABLED means the scheduled report runs according to its schedule expression. DISABLED means the scheduled report is paused and will not run until re-enabled.

      Parameters:
      state - The state of the schedule. ENABLED means the scheduled report runs according to its schedule expression. DISABLED means the scheduled report is paused and will not run until re-enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      ScheduleConfig.Builder state(ScheduleState state)

      The state of the schedule. ENABLED means the scheduled report runs according to its schedule expression. DISABLED means the scheduled report is paused and will not run until re-enabled.

      Parameters:
      state - The state of the schedule. ENABLED means the scheduled report runs according to its schedule expression. DISABLED means the scheduled report is paused and will not run until re-enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: