Package software.amazon.awssdk.services.synthetics.model

Class CanaryScheduleInput

java.lang.Object

software.amazon.awssdk.services.synthetics.model.CanaryScheduleInput

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CanaryScheduleInput.Builder,CanaryScheduleInput>

@Generated("software.amazon.awssdk:codegen")
public final class CanaryScheduleInput
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CanaryScheduleInput.Builder,CanaryScheduleInput>

This structure specifies how often a canary is to make runs and the date and time when it should stop making runs.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CanaryScheduleInput.Builder

Method Summary

Modifier and Type	Method	Description
static CanaryScheduleInput.Builder	builder()
Long	durationInSeconds()	How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	expression()	A rate expression or a cron expression that defines how often the canary is to run.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends CanaryScheduleInput.Builder>	serializableBuilderClass()
CanaryScheduleInput.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

expression

public final 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. You can't schedule a canary to wait for more than a year before running. For information about the syntax for cron expressions, see Scheduling canary runs using cron.

Returns:

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. You can't schedule a canary to wait for more than a year before running. For information about the syntax for cron expressions, see Scheduling canary runs using cron.

durationInSeconds

public final 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.

Returns:

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.

toBuilder

public CanaryScheduleInput.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CanaryScheduleInput.Builder,CanaryScheduleInput>

builder

public static CanaryScheduleInput.Builder builder()

serializableBuilderClass

public static Class<? extends CanaryScheduleInput.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo