BuildClient

Sub-client for manipulating a single actor build.

Hierarchy

• ActorJobBaseClient
  • BuildClient

Index

Methods

• __init__
• abort
• get
• wait_for_finish

Methods

__init__

• __init__(args, kwargs): None

• Overrides ActorJobBaseClient.__init__

  Initialize the BuildClient.

  ---

  Parameters

  • args: Any

  • kwargs: Any

  Returns None

abort

• abort(): Dict

• Abort the actor build which is starting or currently running and return its details.

  https://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build

  ---

  Returns Dict

  dict: The data of the aborted actor build

get

• get(): Optional[Dict]

• Return information about the actor build.

  https://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build

  ---

  Returns Optional[Dict]

  dict, optional: The retrieved actor build data

wait_for_finish

• wait_for_finish(*, wait_secs): Optional[Dict]

• Wait synchronously until the build finishes or the server times out.

  ---

  Parameters

  • optionalkeyword-onlywait_secs: Optional[int] = None

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

  Returns Optional[Dict]

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