Interface CanaryScheduleOutput.Builder

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

  • Method Details

    • expression

      CanaryScheduleOutput.Builder expression(String expression)

      A rate expression or a cron expression that defines how often the canary is to run.

      For a rate expression, The syntax is rate(number unit). unit can be minute, minutes, or hour.

      For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. You can specify a frequency between rate(1 minute) and rate(1 hour).

      Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.

      Use cron(expression) to specify a cron expression. For information about the syntax for cron expressions, see Scheduling canary runs using cron.

      Parameters:
      expression - A rate expression or a cron expression that defines how often the canary is to run.

      For a rate expression, The syntax is rate(number unit). unit can be minute, minutes, or hour.

      For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. You can specify a frequency between rate(1 minute) and rate(1 hour).

      Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.

      Use cron(expression) to specify a cron expression. For information about the syntax for cron expressions, see Scheduling canary runs using cron.

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

    • durationInSeconds

      CanaryScheduleOutput.Builder durationInSeconds(Long durationInSeconds)

      How long, in seconds, for the canary to continue making regular runs after it was created. The runs are performed according to the schedule in the Expression value.

      Parameters:
      durationInSeconds - How long, in seconds, for the canary to continue making regular runs after it was created. The runs are performed according to the schedule in the Expression value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • retryConfig

      CanaryScheduleOutput.Builder retryConfig(RetryConfigOutput retryConfig)

      A structure that contains the retry configuration for a canary

      Parameters:
      retryConfig - A structure that contains the retry configuration for a canary
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • retryConfig

      default CanaryScheduleOutput.Builder retryConfig(Consumer<RetryConfigOutput.Builder> retryConfig)

      A structure that contains the retry configuration for a canary

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

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

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