software.amazon.awssdk.services.synthetics.model

Interface CanaryScheduleInput.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CanaryScheduleInput.Builder,CanaryScheduleInput>, SdkBuilder<CanaryScheduleInput.Builder,CanaryScheduleInput>, SdkPojo

Enclosing class:

CanaryScheduleInput

public static interface CanaryScheduleInput.Builder
extends SdkPojo, CopyableBuilder<CanaryScheduleInput.Builder,CanaryScheduleInput>

Method Summary

Modifier and Type	Method and Description
CanaryScheduleInput.Builder	durationInSeconds(Long durationInSeconds) How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value.
CanaryScheduleInput.Builder	expression(String expression) A rate expression that defines how often the canary is to run.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

expression

CanaryScheduleInput.Builder expression(String expression)

A rate expression that defines how often the canary is to run. 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.

Parameters:

expression - A rate expression that defines how often the canary is to run. 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.

Returns:

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

durationInSeconds

CanaryScheduleInput.Builder durationInSeconds(Long durationInSeconds)

How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value. If you specify 0, the canary continues making runs until you stop it. If you omit this field, the default of 0 is used.

Parameters:

durationInSeconds - How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value. If you specify 0, the canary continues making runs until you stop it. If you omit this field, the default of 0 is used.

Returns:

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