@Generated(value="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.
| Modifier and Type | Class and Description |
|---|---|
static interface |
CanaryScheduleInput.Builder |
| Modifier and Type | Method and 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)
Indicates whether some other object is "equal to" this one by SDK fields.
|
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()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
copypublic 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.
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.
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.
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.public CanaryScheduleInput.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<CanaryScheduleInput.Builder,CanaryScheduleInput>public static CanaryScheduleInput.Builder builder()
public static Class<? extends CanaryScheduleInput.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo class,
and is generated based on a service model.
If an SdkPojo class does not have any inherited fields, equalsBySdkFields
and equals are essentially the same.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()