Skip to main content

LogClientAsync

Async sub-client for manipulating logs.

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: ApifyClientAsync

      The ApifyClientAsync instance under which this resource client exists.

    • keyword-onlyhttp_client: HTTPClientAsync

      The HTTPClientAsync 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

get

  • async get(*, raw): str | None

get_as_bytes

  • async get_as_bytes(*, raw): bytes | None

  • Retrieve the log as raw bytes.

    https://docs.apify.com/api/v2#/reference/logs/log/get-log

    Parameters

    • optionalkeyword-onlyraw: bool = False

      If true, the log will include formatting. For example, coloring character sequences.

    Returns bytes | None

    The retrieved log as raw bytes, or None, if it does not exist.

stream

  • async stream(*, raw): AsyncIterator[impit.Response | None]

  • Retrieve the log as a stream.

    https://docs.apify.com/api/v2#/reference/logs/log/get-log

    Parameters

    • optionalkeyword-onlyraw: bool = False

      If true, the log will include formatting. For example, coloring character sequences.

    Returns AsyncIterator[impit.Response | None]

    The retrieved log as a context-managed streaming Response, or None, if it does not exist.

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