Skip to content

tasks.md

Latest commit

 

History

History
84 lines (71 loc) · 5.33 KB

tasks.md

File metadata and controls

84 lines (71 loc) · 5.33 KB
Raw

Tasks

Tasks are pre-configured Actor runs with stored input. Access the task collection with client.tasks() and a single task with client.task(id).

TaskCollectionClient

Method Description
list(ListOptions) List tasks. Completes with PaginationList<Task>.
iterate(ListOptions, Long chunkSize) Lazy Flow.Publisher<Task> over all tasks; 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 task from a JSON-serializable definition. Completes with Task. 
Task task = client.tasks().create(Map.of(
    "actId", "apify/hello-world",
    "name", "my-task",
    "options", Map.of("build", "latest", "memoryMbytes", 256, "timeoutSecs", 60),
    "input", Map.of("message", "hello"))).join();

TaskClient

Method Description
get() / update(Object) / delete() CRUD. Complete with Optional<Task> / Task / no value.
publish() / unpublish() Publish/unpublish the task on its public landing page, by setting isPublic through update(Object). Both require write permission to both the task and its Actor; publish() additionally requires the task's Actor to be public and a configured publicConfig. unpublish() preserves publicConfig so the task can be republished without re-entering it. Complete with the updated Task.
start(Object input, TaskStartOptions) Start a task run (input overrides stored input; null uses it). Completes with ActorRun.
call(Object input, TaskStartOptions, Long waitSecs) Start and poll until finished; does not stream the run's log. Completes with ActorRun.
call(Object input, TaskCallOptions, Long waitSecs) As above, additionally streaming the run's log for the duration of the wait by default (matching the reference client's call defaulting options.log to 'default'). Use TaskCallOptions.disableLogStreaming() to opt out, or logOptions(StreamedLogOptions) for a custom destination.
getInput() The stored input. Completes with Optional<JsonNode>.
updateInput(Object) Replace the stored input. Completes with JsonNode.
lastRun(String status) / lastRun(LastRunOptions) A RunClient for the last run (see LastRunOptions).
runs() Nested run collection client.
webhooks() Read-only nested webhook collection (NestedWebhookCollectionClient, list + iterate, no create).

TaskStartOptions mirrors ActorStartOptions but omits the Actor-only contentType and forcePermissionLevel: build, memoryMbytes, timeoutSecs, waitForFinish, maxItems, maxTotalChargeUsd, restartOnError, webhooks. TaskCallOptions mirrors TaskStartOptions in turn, but additionally omits waitForFinish: that field asks the API to hold the HTTP response open server-side while the run finishes, which is redundant with (and wastes a request slot next to) call's own client-side waitSecs polling.

ActorRun run = client.task("TASK_ID").call(null, new TaskStartOptions().memoryMbytes(512L), 120L).join();
System.out.println(run.getStatus());

// Streams the run's log to a default per-run logger for the duration of the wait.
ActorRun streamed =
    client.task("TASK_ID").call(null, new TaskCallOptions().memoryMbytes(512L), 120L).join();

Task fields: getId(), getActId(), getUserId(), getName(), getTitle(), getDescription(), getCreatedAt(), getModifiedAt(), getStats() (TaskStats, exposing getTotalRuns()), getOptions() (TaskOptions: the task's stored default run configuration — getBuild() (String), getTimeoutSecs() (Long), getMemoryMbytes() (Long), getRestartOnError() (Boolean)), getInput() (a JsonNode snapshot of the stored input, from whichever response last returned this Task object; prefer TaskClient.getInput() above to fetch it fresh on-demand), getActorStandby() (ActorStandby, from com.apify.client.actor, standby-mode configuration overrides for this task, if any), getIsPublic() (Boolean; derived from publicConfig.publishedAt — use publish()/unpublish() above to change it), and getPublicConfig() (TaskPublicConfig, the task's public landing page display configuration, if any). Any field not covered by a typed getter is still available via the inherited getExtra() (see the docs index).

ActorStandby fields (all optional; null when unset): getBuild() (tag/number of the build serving standby requests), getDesiredRequestsPerActorRun(), getDisableStandbyFieldsOverride(), getIdleTimeoutSecs(), getMaxRequestsPerActorRun(), getMemoryMbytes(), getShouldPassActorInput().

TaskPublicConfig fields (all optional; null when unset): getPublishedAt() (Instant; set when the task is published, null when unpublished — read-only, changed via publish() / unpublish()), getSeoTitle(), getSeoDescription(), getCategorization() (not part of the documented schema; kept for parity with the reference JS client), getInputSchemaFields() (List<String>), getDatasetName(), getDatasetView().

Task task = client.task("TASK_ID").unpublish().join();
Boolean isPublic = task.getIsPublic();
if (isPublic != null) {
  System.out.println("published: " + isPublic);
}