@Generated(value="com.amazonaws:awsjavasdkcodegenerator") public class CanaryScheduleInput extends Object implements Serializable, Cloneable, StructuredPojo
This structure specifies how often a canary is to make runs and the date and time when it should stop making runs.
Constructor and Description 

CanaryScheduleInput() 
Modifier and Type  Method and Description 

CanaryScheduleInput 
clone() 
boolean 
equals(Object obj) 
Long 
getDurationInSeconds()
How long, in seconds, for the canary to continue making regular runs according to the schedule in the
Expression value. 
String 
getExpression()
A rate expression that defines how often the canary is to run.

int 
hashCode() 
void 
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . 
void 
setDurationInSeconds(Long durationInSeconds)
How long, in seconds, for the canary to continue making regular runs according to the schedule in the
Expression value. 
void 
setExpression(String expression)
A rate expression that defines how often the canary is to run.

String 
toString()
Returns a string representation of this object.

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

public void setExpression(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.
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.
public String getExpression()
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.
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.
public CanaryScheduleInput withExpression(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.
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.
public void setDurationInSeconds(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.
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.public Long getDurationInSeconds()
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 withDurationInSeconds(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.
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.public String toString()
toString
in class Object
Object.toString()
public CanaryScheduleInput clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
 Implementation of ProtocolMarshaller
used to marshall this object's data.