Skip to main content
Version: 2.5

RunClient

Sub-client for manipulating a single Actor run.

Index

Methods

abort

  • abort(*, gracefully): dict

charge

  • charge(event_name, count, idempotency_key): None

dataset

delete

  • delete(): None

get

  • get(): dict | None

get_status_message_watcher

  • Get StatusMessageWatcher instance that can be used to redirect status and status messages to logs.

    StatusMessageWatcher can be explicitly started and stopped or used as a context manager.


    Parameters

    • to_logger: logging.Logger | None = None
    • check_period: timedelta = timedelta(seconds=1)

    Returns StatusMessageWatcherSync

get_streamed_log

  • Get StreamedLog instance that can be used to redirect logs.

    StreamedLog can be explicitly started and stopped or used as a context manager.


    Parameters

    • to_logger: logging.Logger | None = None
    • keyword-onlyfrom_start: bool = True

    Returns StreamedLogSync

key_value_store

log

metamorph

  • metamorph(*, target_actor_id, target_actor_build, run_input, content_type): dict

reboot

  • reboot(): dict

request_queue

resurrect

  • resurrect(*, build, memory_mbytes, timeout_secs, max_items, max_total_charge_usd, restart_on_error): dict

update

  • update(*, status_message, is_status_message_terminal, general_access): dict

wait_for_finish

  • wait_for_finish(*, wait_secs): dict | None
  • Wait synchronously until the run finishes or the server times out.


    Parameters

    • keyword-onlywait_secs: int | None = None

    Returns dict | None