Configuration

{"content": ["A class for specifying the configuration of an actor.\n\nCan be used either globally via Configuration.get_global_configuration(),\nor it can be specific to each Actor instance on the actor.config property."]}

Index

Constructors

• __init__

Methods

• get_global_configuration

Constructors

__init__

• __init__(*, api_base_url, api_public_base_url, container_port, container_url, default_dataset_id, default_key_value_store_id, default_request_queue_id, input_key, max_used_cpu_ratio, metamorph_after_sleep_millis, persist_state_interval_millis, persist_storage, proxy_hostname, proxy_password, proxy_port, proxy_status_url, purge_on_start, token, standby_port, system_info_interval_millis): None

• {"content": ["Create a Configuration instance.\n\nAll the parameters are loaded by default from environment variables when running on the Apify platform.\nYou can override them here in the Configuration constructor, which might be useful for local testing of your actors.\n", {"

  ---

  Parameters

  • keyword-onlyapi_base_url: str | None = None

  • keyword-onlyapi_public_base_url: str | None = None

  • keyword-onlycontainer_port: int | None = None

  • keyword-onlycontainer_url: str | None = None

  • keyword-onlydefault_dataset_id: str | None = None

  • keyword-onlydefault_key_value_store_id: str | None = None

  • keyword-onlydefault_request_queue_id: str | None = None

  • keyword-onlyinput_key: str | None = None

  • keyword-onlymax_used_cpu_ratio: float | None = None

  • keyword-onlymetamorph_after_sleep_millis: int | None = None

  • keyword-onlypersist_state_interval_millis: int | None = None

  • keyword-onlypersist_storage: bool | None = None

  • keyword-onlyproxy_hostname: str | None = None

  • keyword-onlyproxy_password: str | None = None

  • keyword-onlyproxy_port: int | None = None

  • keyword-onlyproxy_status_url: str | None = None

  • keyword-onlypurge_on_start: bool | None = None

  • keyword-onlytoken: str | None = None

  • keyword-onlystandby_port: int | None = None

  • keyword-onlysystem_info_interval_millis: int | None = None

  Returns None

Methods

get_global_configuration

• get_global_configuration(): Configuration

• {"content": ["Retrieve the global configuration.\n\nThe global configuration applies when you call actor methods via their static versions, e.g. Actor.init().\nAlso accessible via Actor.config."]}

  ---

  Returns Configuration