Struct ActorClient 

pub struct ActorClient { /* private fields */ }

Client for a specific Actor.

Provides CRUD methods plus convenience helpers to start/call the Actor, build it, and access its runs, builds, versions and webhooks.

Implementations

impl ActorClient

pub async fn get(&self) -> ApifyClientResult<Option<Actor>>

Fetches the Actor object, or None if it does not exist.

pub async fn update<T: Serialize>( &self, new_fields: &T, ) -> ApifyClientResult<Actor>

Updates the Actor with the given fields and returns the updated object.

pub async fn delete(&self) -> ApifyClientResult<()>

Deletes the Actor.

pub async fn start<T: Serialize>( &self, input: Option<&T>, options: ActorStartOptions, ) -> ApifyClientResult<ActorRun>

Starts the Actor and returns immediately with the created run.

input is any JSON-serializable value (or None for no input). To send a non-JSON input (e.g. a ZIP archive) as raw bytes instead, use start_raw.

pub async fn start_raw( &self, input: &[u8], options: ActorStartOptions, ) -> ApifyClientResult<ActorRun>

Starts the Actor with a raw request body instead of a JSON-serializable value.

Use this for a non-JSON input, e.g. a ZIP archive paired with options.content_type = Some("application/zip".into()); the bytes are sent exactly as given, with no JSON serialization. For an object or array input, use start instead, which handles the serialization. Mirrors the reference client, whose ActorInput accepts a plain object, an array of them, or raw bytes.

pub async fn call<T: Serialize>( &self, input: Option<&T>, options: ActorStartOptions, wait_secs: Option<i64>, ) -> ApifyClientResult<ActorRun>

Starts the Actor and waits (client-side polling) for it to finish.

wait_secs controls the wait budget:

• None polls indefinitely until the run reaches a terminal state.
• Some(n) bounds the wait to roughly n seconds; if the run has not finished by then, the last fetched (still non-terminal) run is returned rather than an error. Check status / is_terminal() on the result when using Some.

pub async fn call_raw( &self, input: &[u8], options: ActorStartOptions, wait_secs: Option<i64>, ) -> ApifyClientResult<ActorRun>

Starts the Actor with a raw request body (start_raw) and waits for it to finish, exactly like call but for a non-JSON input.

pub async fn build( &self, version_number: &str, options: ActorBuildOptions, ) -> ApifyClientResult<Build>

Builds the given version of the Actor and returns the created build.

pub async fn default_build( &self, wait_for_finish: Option<i64>, ) -> ApifyClientResult<BuildClient>

Resolves the Actor’s default build and returns a client for it.

wait_for_finish optionally bounds how long (in seconds) the API waits for the build to finish before responding, matching the reference client’s defaultBuild(options).

pub async fn validate_input<T: Serialize>( &self, input: &T, ) -> ApifyClientResult<Value>

Validates the given input against the Actor’s input schema.

Uses the Actor’s default build for the input schema. To validate against a specific build, use ActorClient::validate_input_for_build.

pub async fn validate_input_for_build<T: Serialize>( &self, input: &T, build: Option<&str>, ) -> ApifyClientResult<Value>

Validates the given input against the input schema of a specific Actor build.

build is the optional tag or number of the Actor build whose input schema is used for validation (e.g. "latest" or "1.2.34"); passing None uses the default build, which is equivalent to ActorClient::validate_input. This maps to the spec’s optional build query parameter on POST /v2/actors/{actorId}/validate-input.

pub fn last_run(&self, status: Option<&str>) -> RunClient

Returns a client for the last run of this Actor, optionally filtered by run status.

status filters by run status (e.g. "SUCCEEDED", "FAILED", "RUNNING"); pass None to leave it unfiltered. This maps to the status query parameter on GET /v2/actors/{actorId}/runs/last and mirrors the reference client’s lastRun({ status }). To also filter by origin, use ActorClient::last_run_with_options.

pub fn last_run_with_options(&self, options: LastRunOptions) -> RunClient

Returns a client for the last run of this Actor, applying the given LastRunOptions (e.g. LastRunOptions::status and/or LastRunOptions::origin).

status filters by run status (e.g. "SUCCEEDED", "FAILED", "RUNNING"); origin filters by how the run was started, with accepted values being the platform’s run origins (e.g. "DEVELOPMENT", "WEB", "API", "SCHEDULER"). Both are documented optional query parameters on GET /v2/actors/{actorId}/runs/last and match the reference client’s lastRun({ status, origin }); leave a field as None to omit it.

pub fn builds(&self) -> BuildCollectionClient

Returns a client for this Actor’s build collection.

pub fn runs(&self) -> RunCollectionClient

Returns a client for this Actor’s run collection.

pub fn version(&self, version_number: &str) -> ActorVersionClient

Returns a client for a specific version of this Actor.

pub fn versions(&self) -> ActorVersionCollectionClient

Returns a client for this Actor’s version collection.

pub fn webhooks(&self) -> WebhookCollectionClient

Returns a client for this Actor’s webhook collection.

pub fn id(&self) -> &str

The Actor’s ID (or username~name) as provided.

Trait Implementations

impl Clone for ActorClient

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ActorClient

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

Formats the value using the given formatter.