BuildClient

Sub-client for manipulating a single Actor build.

Index

Methods

• abort
• delete
• get
• log
• wait_for_finish

Methods

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

  The data of the aborted Actor build

delete

• delete(): None

• Delete the build.

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

  ---

  Returns None

get

• get(): dict | None

• Return information about the Actor build.

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

  ---

  Returns dict | None

  The retrieved Actor build data

log

• log(): LogClient

• Get the client for the log of the Actor build.

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

  ---

  Returns LogClient

  A client allowing access to the log of this Actor build.

wait_for_finish

• wait_for_finish(*, wait_secs): dict | None

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

  ---

  Parameters

  • keyword-onlywait_secs: int | None = None

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

  Returns dict | None

  The Actor build data. If the status on the object is not one of the terminal statuses (SUCEEDED, FAILED, TIMED_OUT, ABORTED), then the build has not yet finished.