Skip to main content
Version: 0.6

RunClient

Sub-client for manipulating a single actor run.

Hierarchy

Index

Methods

__init__

  • __init__(args, kwargs): None

abort

  • abort(*, gracefully): Dict

dataset

get

  • get(): Optional[Dict]

key_value_store

log

metamorph

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

  • Parameters

    • keyword-onlytarget_actor_id: str

      ID of the target actor that the run should be transformed into

    • optionalkeyword-onlytarget_actor_build: Optional[str] = None

      The build of the target actor. It can be either a build tag or build number. By default, the run uses the build specified in the default run configuration for the target actor (typically the latest build).

    • optionalkeyword-onlyrun_input: Optional[Any] = None

      The input to pass to the new run.

    • optionalkeyword-onlycontent_type: Optional[str] = None

      The content type of the input.

    Returns Dict

    dict: The actor run data.

request_queue

resurrect

  • resurrect(): Dict

wait_for_finish

  • wait_for_finish(*, wait_secs): Optional[Dict]
  • Wait synchronously until the run finishes or the server times out.


    Parameters

    • optionalkeyword-onlywait_secs: Optional[int] = None

      how long does the client wait for run to finish. None for indefinite.

    Returns Optional[Dict]

    dict, optional: The actor run data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED, TIMED_OUT, ABORTED), then the run has not yet finished.