Skip to main content

BuildClient

Sub-client for manipulating a single Actor build.

Hierarchy

ActorJobBaseClient
- BuildClient

Index

Methods

Properties

Methods

init

__init__(*, base_url, root_client, http_client, resource_id, resource_path, params): None

Overrides ActorJobBaseClient.__init__
Initialize a new instance.
Parameters
- keyword-onlybase_url: str
  Base URL of the API server.
- keyword-onlyroot_client: ApifyClient
  The ApifyClient instance under which this resource client exists.
- keyword-onlyhttp_client: HTTPClient
  The HTTPClient instance to be used in this client.
- optionalkeyword-onlyresource_id: str | None = None
  ID of the manipulated resource, in case of a single-resource client.
- keyword-onlyresource_path: str
  Path to the resource's endpoint on the API server.
- optionalkeyword-onlyparams: dict | None = None
  Parameters to include in all requests from this client.
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

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

get_open_api_definition

get_open_api_definition(): dict | None

Return OpenAPI definition of the Actor's build.

https://docs.apify.com/api/v2/actor-build-openapi-json-get
Returns dict | None

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

wait_for_finish

wait_for_finish(*, wait_secs): dict | None

Wait synchronously until the build finishes or the server times out.
Parameters
- optionalkeyword-onlywait_secs: int | None = None
  How long does the client wait for build to finish. None for indefinite.
Returns dict | None

Properties

http_client

http_client: HTTPClient | HTTPClientAsync

params

params: dict

resource_id

resource_id: str | None

root_client

root_client: ApifyClient | ApifyClientAsync

url

url: str

Page Options

Hide Inherited

__init__
abort
delete
get
get_open_api_definition
log
wait_for_finish
http_client
params
resource_id
root_client
url