/AWS1/CL_SYNCANARYSCHDINPUT

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

CONSTRUCTOR

IMPORTING

Required arguments:

iv_expression TYPE /AWS1/SYNSTRING /AWS1/SYNSTRING

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.

Optional arguments:

iv_durationinseconds TYPE /AWS1/SYNMAXONEYEARINSECONDS /AWS1/SYNMAXONEYEARINSECONDS

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.

io_retryconfig TYPE REF TO /AWS1/CL_SYNRETRYCONFIGINPUT /AWS1/CL_SYNRETRYCONFIGINPUT

A structure that contains the retry configuration for a canary

---

Queryable Attributes

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.

Accessible with the following methods

Method	Description
GET_EXPRESSION()	Getter for EXPRESSION, with configurable default
ASK_EXPRESSION()	Getter for EXPRESSION w/ exceptions if field has no value
HAS_EXPRESSION()	Determine if EXPRESSION has a value

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.

Accessible with the following methods

Method	Description
GET_DURATIONINSECONDS()	Getter for DURATIONINSECONDS, with configurable default
ASK_DURATIONINSECONDS()	Getter for DURATIONINSECONDS w/ exceptions if field has no v
HAS_DURATIONINSECONDS()	Determine if DURATIONINSECONDS has a value

RetryConfig

A structure that contains the retry configuration for a canary

Accessible with the following methods

Method	Description
GET_RETRYCONFIG()	Getter for RETRYCONFIG