includes.cron.adoc Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of helidon-docs
There is a newer version: 4.1.4
///////////////////////////////////////////////////////////////////////////////

    Copyright (c) 2021, 2024 Oracle and/or its affiliates.

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

///////////////////////////////////////////////////////////////////////////////

ifndef::rootdir[:rootdir: {docdir}/..]

=== Cron expression
[source]
.Cron expression format
----
      
----

.Cron expression fields
[width="90%",cols="^3,20,^2,90,^3",frame="topbot",options="header"]
|=======================================================================================================================
| Order | Name          | Supported values  | Supported field format                                        | Optional
| 1     | seconds       | 0-59              | CONST, LIST, RANGE, WILDCARD, INCREMENT                       | false
| 2     | minutes       | 0-59              | CONST, LIST, RANGE, WILDCARD, INCREMENT                       | false
| 3     | hours         | 0-23              | CONST, LIST, RANGE, WILDCARD, INCREMENT                       | false
| 4     | day-of-month  | 1-31              | CONST, LIST, RANGE, WILDCARD, INCREMENT, ANY, LAST, WEEKDAY   | false
| 5     | month         | 1-12 or JAN-DEC   | CONST, LIST, RANGE, WILDCARD, INCREMENT                       | false
| 6     | day-of-week   | 1-7 or SUN-SAT    | CONST, LIST, RANGE, WILDCARD, INCREMENT, ANY, NTH, LAST       | false
| 7     | year          | 1970-2099         | CONST, LIST, RANGE, WILDCARD, INCREMENT                       | true
|=======================================================================================================================

.Field formats
[width="90%",cols="3,25,^2,90",frame="topbot",options="header"]
|=======================================================================================================================
| Name      | Regex format          | Example   | Description
| CONST     | \d+                   | 12        | exact value
| LIST      | \d+,\d+(,\d+)*        | 1,2,3,4   | list of constants
| RANGE     | \d+-\d+               | 15-30     | range of values from-to
| WILDCARD  | \*                    | *         | all values withing the field
| INCREMENT | \d+\/\d+              | 0/5       | initial number / increments, 2/5 means 2,7,9,11,16,...
| ANY       | \?                    | ?         | any day(apply only to day-of-week and day-of-month)
| NTH       | \#                    | 1#3       | nth day of the month, 2#3 means third monday of the month
| LAST      | \d*L(\+\d+\|\-\d+)?   | 3L-3      | last day of the month in day-of-month or last nth day in the day-of-week
| WEEKDAY   | \#                    | 1#3       | nearest weekday of the nth day of month, 1W is the first monday of the week
|=======================================================================================================================

.Examples
[width="90%",cols="3,10",frame="topbot",options="header"]
|=======================================================================================================================
| Cron expression       | Description
| * * * * * ?           | Every second
| 0/2 * * * * ? *       | Every 2 seconds
| 0 45 9 ? * *          | Every day at 9:45
| 0 15 8 ? * MON-FRI    | Every workday at 8:15
|=======================================================================================================================