Interface WarmUpConfiguration.Builder

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

  • Method Details

    • warmUpPeriodDurationInMinutes

      WarmUpConfiguration.Builder warmUpPeriodDurationInMinutes(Integer warmUpPeriodDurationInMinutes)

      The length of the warm-up period, in minutes. After you create or update the alarm, the alarm stays in INSUFFICIENT_DATA for this duration. During this time, the alarm does not perform alarm actions.

      You can change this value at any time, including after the warm-up period ends. If you change it after the warm-up period ends, the new value does not restart the warm-up period.

      Parameters:
      warmUpPeriodDurationInMinutes - The length of the warm-up period, in minutes. After you create or update the alarm, the alarm stays in INSUFFICIENT_DATA for this duration. During this time, the alarm does not perform alarm actions.

      You can change this value at any time, including after the warm-up period ends. If you change it after the warm-up period ends, the new value does not restart the warm-up period.

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

    • onlyStartEvaluatingAfterWarmUpPeriodEnds

      WarmUpConfiguration.Builder onlyStartEvaluatingAfterWarmUpPeriodEnds(Boolean onlyStartEvaluatingAfterWarmUpPeriodEnds)

      Specifies whether the alarm waits for the full warm-up period before it starts to evaluate. The default is false. If true, the alarm waits the entire WarmUpPeriodDurationInMinutes before it starts to evaluate, even if metric data arrives earlier. If false, the alarm ends the warm-up period early. Evaluation begins as soon as the alarm has enough metric data to fill its evaluation window.

      Parameters:
      onlyStartEvaluatingAfterWarmUpPeriodEnds - Specifies whether the alarm waits for the full warm-up period before it starts to evaluate. The default is false. If true, the alarm waits the entire WarmUpPeriodDurationInMinutes before it starts to evaluate, even if metric data arrives earlier. If false, the alarm ends the warm-up period early. Evaluation begins as soon as the alarm has enough metric data to fill its evaluation window.
      Returns:
      Returns a reference to this object so that method calls can be chained together.