Skip to main content

BuildClient

Sub-client for manipulating a single Actor build.

Hierarchy

Index

Methods

Properties

Methods

__init__

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

  • 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

delete

  • delete(): None

get

  • get(): dict | None

get_open_api_definition

  • get_open_api_definition(): dict | None

log

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