Skip to main content

RunClient

Struct RunClient 

Source
pub struct RunClient<'a> { /* private fields */ }
Expand description

Operations on Runs.

A Run is a single execution of an Actor or Task. This client lets you monitor progress, read results, and control lifecycle (abort, resurrect).

Implementations§

Source§

impl<'a> RunClient<'a>

Source

pub async fn get(&self, run_id: &str) -> Result<Run, ApifyError>

Fetch a Run by its unique ID.

Source

pub async fn list( &self, params: Option<ListParams>, ) -> Result<ListData<RunShort>, ApifyError>

List Runs with optional pagination.

Source

pub async fn abort(&self, run_id: &str) -> Result<Run, ApifyError>

Abort a running Run.

The Run transitions to Aborting and eventually Aborted.

Source

pub async fn metamorph( &self, run_id: &str, target_actor_id: &str, input: Option<impl Serialize>, ) -> Result<Run, ApifyError>

Metamorph a Run into a different Actor.

This is an advanced feature: the current container is re-purposed to execute another Actor, preserving state (e.g. request queues).

Source

pub async fn resurrect(&self, run_id: &str) -> Result<Run, ApifyError>

Resurrect a finished or aborted Run.

Useful for debugging or when you need to continue a partially failed job without starting from scratch.

Source

pub async fn get_dataset_items( &self, run_id: &str, params: Option<ListParams>, ) -> Result<Vec<DatasetItem>, ApifyError>

Read the default Dataset of a Run as raw serde_json::Value rows.

Datasets are Apify’s tabular output storage. Most Actors write one row per scraped item. Use get_typed_dataset_items when you know the schema.

Source

pub async fn get_typed_dataset_items<T: DeserializeOwned>( &self, run_id: &str, params: Option<ListParams>, ) -> Result<Vec<T>, ApifyError>

Read the default Dataset of a Run, deserialising rows into T.

let posts: Vec<InstagramPost> =
    client.runs().get_typed_dataset_items(&run_id, None).await?;
Source

pub async fn wait_for_finish( &self, run_id: &str, poll_interval_secs: u64, max_wait_secs: u64, ) -> Result<Run, ApifyError>

Poll a Run until it reaches a terminal status or max_wait_secs elapse.

Sleeps poll_interval_secs between requests. Returns the latest Run state even if it never becomes terminal.

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for RunClient<'a>

§

impl<'a> !UnwindSafe for RunClient<'a>

§

impl<'a> Freeze for RunClient<'a>

§

impl<'a> Send for RunClient<'a>

§

impl<'a> Sync for RunClient<'a>

§

impl<'a> Unpin for RunClient<'a>

§

impl<'a> UnsafeUnpin for RunClient<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more