Expand description
Data models for Apify API resources.
Each resource is modelled with the fields most commonly used by clients, mirroring
the reference JavaScript client. To remain forward-compatible with additive changes to
the API, none of the models set deny_unknown_fields, so unknown API fields are ignored
rather than breaking deserialization. Most resource models additionally capture any unknown
fields in an extra map via #[serde(flatten)] so they remain accessible to callers.
Structs§
- Actor
- An Actor on the Apify platform.
- Actor
EnvVar - An environment variable attached to an Actor version.
- Actor
Run - A single execution of an Actor (an Actor run).
- Actor
Store List Item - A single Actor entry as returned by the Apify Store listing.
- Actor
Version - An Actor version.
- Batch
Requests Operation Result - Result of a request-queue batch add or batch delete operation.
- Build
- A build of an Actor.
- Dataset
- A dataset storage.
- KeyValue
Store - A key-value store storage.
- KeyValue
Store Key - Metadata about a single key in a key-value store.
- KeyValue
Store Keys Page - Result of listing keys in a key-value store (key-based pagination).
- KeyValue
Store Record - A record (key + value + content type) in a key-value store.
- Locked
Request Queue Head - The head of a request queue with a server-side lock applied (
POST .../head/lock). - Processed
Request - A request successfully processed by a request-queue batch add or batch delete operation.
- Request
Lock Info - Result of prolonging a request’s lock (
PUT .../requests/{requestId}/lock). - Request
Queue - A request queue storage.
- Request
Queue Head - The head of a request queue (requests waiting to be processed).
- Request
Queue Operation Info - Result of adding (or updating) a request in a queue.
- Request
Queue Request - A single request stored in a request queue.
- Request
Queue Requests Page - A page of requests returned by
GET /v2/request-queues/{queueId}/requests(cursor-based pagination over every request in the queue, as opposed toRequestQueueHead’s unlocked peek at the head). - Schedule
- A schedule that triggers Actor or task runs on a cron expression.
- Task
- An Actor task (a saved, reusable Actor configuration).
- Task
Public Config - Public-facing display configuration of a task’s public landing page.
- Unlock
Requests Result - Result of
POST /v2/request-queues/{queueId}/requests/unlock. - Unprocessed
Request - A request that a request-queue batch add operation did not process (typically due to rate
limiting), and which
crate::clients::request_queue::RequestQueueClient::batch_add_requestsretries automatically. - User
- Account information about a user.
- Webhook
- A webhook that notifies an external URL on Actor events.
- Webhook
Dispatch - A single dispatch (invocation) of a webhook.
Type Aliases§
- Extra
- Convenience alias for the catch-all map of unmodelled JSON fields.