Struct ApifyClient 

pub struct ApifyClient { /* private fields */ }

The entry point for interacting with the Apify API.

Construct it with ApifyClient::builder (or ApifyClient::new for a quick token-only setup), then obtain resource clients via the accessor methods, e.g. ApifyClient::actor, ApifyClient::dataset, ApifyClient::run.

The client is cheap to clone — all internal state is reference-counted.

Implementations

impl ApifyClient

pub fn builder() -> ApifyClientBuilder

Returns a ApifyClientBuilder for configuring a client.

pub fn new(token: impl Into<String>) -> Self

Creates a client authenticated with the given API token and default settings.

pub fn user_agent(&self) -> &str

The User-Agent header value this client sends.

pub fn api_base_url(&self) -> &str

The fully-qualified API base URL this client targets (including the /v2 suffix), e.g. https://api.apify.com/v2. Reflects any base_url override.

pub fn actors(&self) -> ActorCollectionClient

Returns a client for the Actor collection (list & create Actors).

pub fn actor(&self, id: impl Into<String>) -> ActorClient

Returns a client for a specific Actor, addressed by ID or username~name.

pub fn builds(&self) -> BuildCollectionClient

Returns a client for the Actor build collection (list builds).

pub fn build(&self, id: impl Into<String>) -> BuildClient

Returns a client for a specific Actor build.

pub fn runs(&self) -> RunCollectionClient

Returns a client for the Actor run collection (list runs).

pub fn run(&self, id: impl Into<String>) -> RunClient

Returns a client for a specific Actor run.

pub fn datasets(&self) -> DatasetCollectionClient

Returns a client for the dataset collection (list & get-or-create datasets).

pub fn dataset(&self, id: impl Into<String>) -> DatasetClient

Returns a client for a specific dataset, addressed by ID or name.

pub fn key_value_stores(&self) -> KeyValueStoreCollectionClient

Returns a client for the key-value store collection.

pub fn key_value_store(&self, id: impl Into<String>) -> KeyValueStoreClient

Returns a client for a specific key-value store, addressed by ID or name.

pub fn request_queues(&self) -> RequestQueueCollectionClient

Returns a client for the request queue collection.

pub fn request_queue(&self, id: impl Into<String>) -> RequestQueueClient

Returns a client for a specific request queue, addressed by ID or name.

pub fn tasks(&self) -> TaskCollectionClient

Returns a client for the Actor task collection (list & create tasks).

pub fn task(&self, id: impl Into<String>) -> TaskClient

Returns a client for a specific Actor task.

pub fn schedules(&self) -> ScheduleCollectionClient

Returns a client for the schedule collection (list & create schedules).

pub fn schedule(&self, id: impl Into<String>) -> ScheduleClient

Returns a client for a specific schedule.

pub fn webhooks(&self) -> WebhookCollectionClient

Returns a client for the webhook collection (list & create webhooks).

pub fn webhook(&self, id: impl Into<String>) -> WebhookClient

Returns a client for a specific webhook.

pub fn webhook_dispatches(&self) -> WebhookDispatchCollectionClient

Returns a client for the webhook dispatch collection.

pub fn webhook_dispatch(&self, id: impl Into<String>) -> WebhookDispatchClient

Returns a client for a specific webhook dispatch.

pub fn store(&self) -> StoreCollectionClient

Returns a client for browsing the Apify Store.

pub fn log(&self, build_or_run_id: impl Into<String>) -> LogClient

Returns a client for accessing a build’s or run’s log.

pub fn me(&self) -> UserClient

Returns a client for the current user (/users/me).

pub fn user(&self, id: impl Into<String>) -> UserClient

Returns a client for a specific user by ID or username.

pub async fn set_status_message( &self, message: &str, is_terminal: bool, ) -> ApifyClientResult<ActorRun>

Sets the status message of the current Actor run.

This convenience method updates the run identified by the ACTOR_RUN_ID environment variable, so it only works when called from inside an Actor run. If is_terminal is true, the message becomes final and won’t be overwritten.

Returns ApifyClientError::InvalidArgument if ACTOR_RUN_ID is not set.

Trait Implementations

impl Clone for ApifyClient

fn clone(&self) -> ApifyClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ApifyClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.