chore: add details on setting cron timezone for rebalancing schedule #250
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
saumas
approved these changes
Dec 6, 2023
mikenorgate
force-pushed
the
cron-tz-documentation
branch
from
fd2b2b9 to
fc0b17e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
cron(String) Cron expression defining when the schedule should trigger.The
cronexpression can optionally include theCRON_TZvariable at the beginning to specify the timezone in which the schedule should be interpreted.Example:
In the example above, the
CRON_TZvariable is set to "America/New_York" indicating that the cron expression should be interpreted in the Eastern Time (ET) timezone.To retrieve a list of available timezone values, you can use the following API endpoint:
GET https://api.cast.ai/v1/time-zones
When using the
CRON_TZvariable, ensure that the specified timezone is valid and supported by checking the list of available timezones from the API endpoint. If theCRON_TZvariable is not specified, the cron expression will be interpreted in the UTC timezone.