Skip to content

schedules.md

Latest commit

 

History

History
46 lines (37 loc) · 2.02 KB

schedules.md

File metadata and controls

46 lines (37 loc) · 2.02 KB
Raw

Schedules

Schedules automatically start Actor or task runs at specified times. Access the collection with client.schedules() and a single schedule with client.schedule(id).

ScheduleCollectionClient

Method Description
list(ListOptions) List schedules. Completes with PaginationList<Schedule>.
iterate(ListOptions, Long chunkSize) Lazy Flow.Publisher<Schedule> over all schedules; the options' limit caps the total yielded (null/unset or non-positive = all), chunkSize sets the per-request page size (null = server default).
create(Object) Create a schedule from a JSON-serializable definition. Completes with Schedule.

The actions array describes what the schedule runs (e.g. a RUN_ACTOR action):

Schedule schedule = client.schedules().create(Map.of(
    "name", "nightly",
    "cronExpression", "0 0 * * *",
    "isEnabled", true,
    "isExclusive", true,
    "actions", List.of(Map.of(
        "type", "RUN_ACTOR",
        "actorId", "apify/hello-world")))).join();

ScheduleClient

Method Description
get() / update(Object) / delete() CRUD.
getLog() The schedule's invocation log. Completes with Optional<String>. 
Optional<Schedule> s = client.schedule("SCHEDULE_ID").get().join();
s.ifPresent(sched -> System.out.println(sched.getCronExpression()));

Schedule fields: getId(), getUserId(), getName(), getTitle(), getDescription(), getCronExpression(), getTimezone() (IANA name, e.g. UTC), isEnabled(), isExclusive() (skip a new run while a previous one is still active), getCreatedAt() / getModifiedAt() (Instant), getNextRunAt() / getLastRunAt() (Instant, may be null), getActions() (List<JsonNode>, each entry's shape depends on its type), and getNotifications() (ScheduleNotifications, exposing isEmail()). Any field not covered by a typed getter is still available via the inherited getExtra() (see the docs index).