BuildClientAsync

Sub-client for managing a specific Actor build.

Provides methods to manage a specific Actor build, e.g. get it, abort it, or wait for it to finish. Obtain an instance via an appropriate method on the ApifyClientAsync class.

Hierarchy

• ResourceClientAsync
  • BuildClientAsync

Index

Methods

• __init__
• abort
• delete
• get
• get_open_api_definition
• log
• wait_for_finish

Properties

• resource_id

Methods

__init__

• __init__(*, base_url, public_base_url, http_client, resource_path, client_registry, resource_id, params): None

• Overrides ResourceClientAsync.__init__

  Initialize the resource client.

  ---

  Parameters

  • keyword-onlybase_url: str

    API base URL.

  • keyword-onlypublic_base_url: str

    Public CDN base URL.

  • keyword-onlyhttp_client: HttpClientAsync

    HTTP client for making requests.

  • keyword-onlyresource_path: str

    Resource endpoint path (e.g., 'actors', 'datasets').

  • keyword-onlyclient_registry: ClientRegistryAsync

    Bundle of client classes for dependency injection.

  • optionalkeyword-onlyresource_id: str | None = None

    Optional resource ID for single-resource clients.

  • optionalkeyword-onlyparams: dict | None = None

    Optional default parameters for all requests.

  Returns None

abort

• async abort(): Build

• 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 Build

  The data of the aborted Actor build.

delete

• async delete(): None

• Delete the build.

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

  ---

  Returns None

get

• async get(): Build | None

• Return information about the Actor build.

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

  ---

  Returns Build | None

  The retrieved Actor build data.

get_open_api_definition

• async get_open_api_definition(): dict

• Return OpenAPI definition of the Actor's build.

  https://docs.apify.com/api/v2/actor-build-openapi-json-get

  ---

  Returns dict

  OpenAPI definition of the Actor's build.

log

• log(): LogClientAsync

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

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

  ---

  Returns LogClientAsync

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

wait_for_finish

• async wait_for_finish(*, wait_duration): Build | None

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

  ---

  Parameters

  • optionalkeyword-onlywait_duration: timedelta | None = None

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

  Returns Build | None

  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.

Properties

resource_id

resource_id: str | None

Inherited from ResourceClientBase.resource_id

Get the resource ID.