diff --git a/.github/workflows/manual_release_stable.yaml b/.github/workflows/manual_release_stable.yaml index a952285a..224a6bf8 100644 --- a/.github/workflows/manual_release_stable.yaml +++ b/.github/workflows/manual_release_stable.yaml @@ -102,15 +102,75 @@ jobs: - name: Publish package to PyPI uses: pypa/gh-action-pypi-publish@release/v1 + version_docs: + name: Version docs + needs: [release_prepare, changelog_update, pypi_publish] + runs-on: ubuntu-latest + permissions: + contents: write + env: + NODE_VERSION: 22 + PYTHON_VERSION: 3.14 + + steps: + - name: Checkout repository + uses: actions/checkout@v6 + with: + ref: ${{ github.event.repository.default_branch }} + token: ${{ secrets.APIFY_SERVICE_ACCOUNT_GITHUB_TOKEN }} + + - name: Set up Node + uses: actions/setup-node@v6 + with: + node-version: ${{ env.NODE_VERSION }} + + - name: Set up Python + uses: actions/setup-python@v6 + with: + python-version: ${{ env.PYTHON_VERSION }} + + - name: Set up uv package manager + uses: astral-sh/setup-uv@v7 + with: + python-version: ${{ env.PYTHON_VERSION }} + + - name: Install Python dependencies + run: uv run poe install-dev + + - name: Install website dependencies + run: | + cd website + yarn install + + - name: Snapshot the current version + run: | + cd website + VERSION="$(python -c "import tomllib, pathlib; print(tomllib.loads(pathlib.Path('../pyproject.toml').read_text())['project']['version'])")" + MAJOR_MINOR="$(echo "$VERSION" | cut -d. -f1-2)" + export MAJOR_MINOR + rm -rf "versioned_docs/version-${MAJOR_MINOR}" + rm -rf "versioned_sidebars/version-${MAJOR_MINOR}-sidebars.json" + jq 'map(select(. != env.MAJOR_MINOR))' versions.json > tmp.json && mv tmp.json versions.json + bash build_api_reference.sh + npx docusaurus docs:version "$MAJOR_MINOR" + npx docusaurus api:version "$MAJOR_MINOR" + + - name: Commit and push the version snapshot + uses: EndBug/add-and-commit@v9 + with: + author_name: Apify Release Bot + author_email: noreply@apify.com + message: "docs: update versioned docs for ${{ needs.release_prepare.outputs.version_number }}" + doc_release: name: Doc release - needs: [changelog_update, pypi_publish] + needs: [changelog_update, pypi_publish, version_docs] permissions: contents: write pages: write id-token: write uses: ./.github/workflows/_release_docs.yaml with: - # Use the ref from the changelog update to include the updated changelog. - ref: ${{ needs.changelog_update.outputs.changelog_commitish }} + # Use the default branch to include both the changelog update and the versioned docs snapshot. + ref: ${{ github.event.repository.default_branch }} secrets: inherit diff --git a/pyproject.toml b/pyproject.toml index 71d925aa..eab0bcc2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -78,6 +78,9 @@ include = [ "docs/**/*.py", "website/**/*.py", ] +exclude = [ + "website/versioned_docs/**", +] [tool.ruff.lint] select = ["ALL"] @@ -181,6 +184,7 @@ python-version = "3.11" [tool.ty.src] include = ["src", "tests", "scripts", "docs", "website"] +exclude = ["website/versioned_docs"] [[tool.ty.overrides]] include = ["docs/**/*.py", "website/**/*.py"] diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index fb7766aa..fc63d70b 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -4,6 +4,7 @@ const { config } = require('@apify/docs-theme'); const { externalLinkProcessor } = require('./tools/utils/externalLink'); const { groupSort } = require('./transformDocs.js'); +const versions = require('./versions.json'); const { absoluteUrl } = config; @@ -67,6 +68,17 @@ module.exports = { label: 'GitHub', position: 'left', }, + { + type: 'docsVersionDropdown', + position: 'left', + className: 'navbar__item', + 'data-api-links': JSON.stringify([ + 'reference/next', + ...versions.map((version, i) => (i === 0 ? 'reference' : `reference/${version}`)), + ]), + dropdownItemsBefore: [], + dropdownItemsAfter: [], + }, ], }, }, @@ -124,6 +136,12 @@ module.exports = { includeGeneratedIndex: false, includePages: true, relativePaths: false, + excludeRoutes: [ + '/api/client/python/reference/[0-9]*/**', + '/api/client/python/reference/[0-9]*', + '/api/client/python/reference/next/**', + '/api/client/python/reference/next', + ], }, }, ], @@ -131,6 +149,7 @@ module.exports = { ], themeConfig: { ...config.themeConfig, + versions, tableOfContents: { ...config.themeConfig.tableOfContents, maxHeadingLevel: 5, diff --git a/website/versioned_docs/version-2.5/.gitignore b/website/versioned_docs/version-2.5/.gitignore new file mode 100644 index 00000000..1a13c363 --- /dev/null +++ b/website/versioned_docs/version-2.5/.gitignore @@ -0,0 +1 @@ +changelog.md diff --git a/website/versioned_docs/version-2.5/01_introduction/code/01_usage_async.py b/website/versioned_docs/version-2.5/01_introduction/code/01_usage_async.py new file mode 100644 index 00000000..4a45b1e2 --- /dev/null +++ b/website/versioned_docs/version-2.5/01_introduction/code/01_usage_async.py @@ -0,0 +1,21 @@ +from apify_client import ApifyClientAsync + +# You can find your API token at https://console.apify.com/settings/integrations. +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + apify_client = ApifyClientAsync(TOKEN) + + # Start an Actor and wait for it to finish. + actor_client = apify_client.actor('john-doe/my-cool-actor') + call_result = await actor_client.call() + + if call_result is None: + print('Actor run failed.') + return + + # Fetch results from the Actor run's default dataset. + dataset_client = apify_client.dataset(call_result.default_dataset_id) + list_items_result = await dataset_client.list_items() + print(f'Dataset: {list_items_result}') diff --git a/website/versioned_docs/version-2.5/01_introduction/code/01_usage_sync.py b/website/versioned_docs/version-2.5/01_introduction/code/01_usage_sync.py new file mode 100644 index 00000000..84e430fa --- /dev/null +++ b/website/versioned_docs/version-2.5/01_introduction/code/01_usage_sync.py @@ -0,0 +1,21 @@ +from apify_client import ApifyClient + +# You can find your API token at https://console.apify.com/settings/integrations. +TOKEN = 'MY-APIFY-TOKEN' + + +def main() -> None: + apify_client = ApifyClient(TOKEN) + + # Start an Actor and wait for it to finish. + actor_client = apify_client.actor('john-doe/my-cool-actor') + call_result = actor_client.call() + + if call_result is None: + print('Actor run failed.') + return + + # Fetch results from the Actor run's default dataset. + dataset_client = apify_client.dataset(call_result.default_dataset_id) + list_items_result = dataset_client.list_items() + print(f'Dataset: {list_items_result}') diff --git a/website/versioned_docs/version-2.5/01_introduction/code/02_auth_async.py b/website/versioned_docs/version-2.5/01_introduction/code/02_auth_async.py new file mode 100644 index 00000000..a584ccba --- /dev/null +++ b/website/versioned_docs/version-2.5/01_introduction/code/02_auth_async.py @@ -0,0 +1,8 @@ +from apify_client import ApifyClientAsync + +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + # Client initialization with the API token. + apify_client = ApifyClientAsync(TOKEN) diff --git a/website/versioned_docs/version-2.5/01_introduction/code/02_auth_sync.py b/website/versioned_docs/version-2.5/01_introduction/code/02_auth_sync.py new file mode 100644 index 00000000..a5f4de39 --- /dev/null +++ b/website/versioned_docs/version-2.5/01_introduction/code/02_auth_sync.py @@ -0,0 +1,8 @@ +from apify_client import ApifyClient + +TOKEN = 'MY-APIFY-TOKEN' + + +def main() -> None: + # Client initialization with the API token. + apify_client = ApifyClient(TOKEN) diff --git a/website/versioned_docs/version-2.5/01_introduction/code/03_dataset_async.py b/website/versioned_docs/version-2.5/01_introduction/code/03_dataset_async.py new file mode 100644 index 00000000..99541d2a --- /dev/null +++ b/website/versioned_docs/version-2.5/01_introduction/code/03_dataset_async.py @@ -0,0 +1,11 @@ +from apify_client import ApifyClientAsync + +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + apify_client = ApifyClientAsync(TOKEN) + dataset_client = apify_client.dataset('dataset-id') + + # Lists items from the Actor's dataset. + dataset_items = (await dataset_client.list_items()).items diff --git a/website/versioned_docs/version-2.5/01_introduction/code/03_dataset_sync.py b/website/versioned_docs/version-2.5/01_introduction/code/03_dataset_sync.py new file mode 100644 index 00000000..3cc7554d --- /dev/null +++ b/website/versioned_docs/version-2.5/01_introduction/code/03_dataset_sync.py @@ -0,0 +1,11 @@ +from apify_client import ApifyClient + +TOKEN = 'MY-APIFY-TOKEN' + + +def main() -> None: + apify_client = ApifyClient(TOKEN) + dataset_client = apify_client.dataset('dataset-id') + + # Lists items from the Actor's dataset. + dataset_items = dataset_client.list_items().items diff --git a/website/versioned_docs/version-2.5/01_introduction/code/03_input_async.py b/website/versioned_docs/version-2.5/01_introduction/code/03_input_async.py new file mode 100644 index 00000000..bef7ac72 --- /dev/null +++ b/website/versioned_docs/version-2.5/01_introduction/code/03_input_async.py @@ -0,0 +1,16 @@ +from apify_client import ApifyClientAsync + +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + apify_client = ApifyClientAsync(TOKEN) + actor_client = apify_client.actor('username/actor-name') + + # Define the input for the Actor. + run_input = { + 'some': 'input', + } + + # Start an Actor and waits for it to finish. + call_result = await actor_client.call(run_input=run_input) diff --git a/website/versioned_docs/version-2.5/01_introduction/code/03_input_sync.py b/website/versioned_docs/version-2.5/01_introduction/code/03_input_sync.py new file mode 100644 index 00000000..7fab1635 --- /dev/null +++ b/website/versioned_docs/version-2.5/01_introduction/code/03_input_sync.py @@ -0,0 +1,16 @@ +from apify_client import ApifyClient + +TOKEN = 'MY-APIFY-TOKEN' + + +def main() -> None: + apify_client = ApifyClient(TOKEN) + actor_client = apify_client.actor('username/actor-name') + + # Define the input for the Actor. + run_input = { + 'some': 'input', + } + + # Start an Actor and waits for it to finish. + call_result = actor_client.call(run_input=run_input) diff --git a/website/versioned_docs/version-2.5/01_introduction/index.mdx b/website/versioned_docs/version-2.5/01_introduction/index.mdx new file mode 100644 index 00000000..d0076ee2 --- /dev/null +++ b/website/versioned_docs/version-2.5/01_introduction/index.mdx @@ -0,0 +1,58 @@ +--- +id: introduction +title: Overview +sidebar_label: Overview +slug: / +description: "The official Python library to access the Apify API, with automatic retries, async support, and comprehensive API coverage." +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; + +import UsageAsyncExample from '!!raw-loader!./code/01_usage_async.py'; +import UsageSyncExample from '!!raw-loader!./code/01_usage_sync.py'; + +The Apify API client for Python is the official library to access the [Apify REST API](/api/v2) from your Python applications. It provides useful features like automatic retries and convenience functions that improve the experience of using the Apify API. + +The client simplifies interaction with the Apify platform by providing: + +- Intuitive methods for working with [Actors](/platform/actors), [datasets](/platform/storage/dataset), [key-value stores](/platform/storage/key-value-store), and other Apify resources +- Both synchronous and asynchronous interfaces for flexible integration +- Built-in [retries with exponential backoff](../02_concepts/05_retries.mdx) for failed requests +- Comprehensive API coverage with JSON encoding (UTF-8) for all requests and responses + +## Prerequisites + +`apify-client` requires Python 3.11 or higher. Python is available for download on the [official website](https://www.python.org/downloads/). Check your current Python version by running: + +```bash +python --version +``` + +## Installation + +The Apify client is available as the [`apify-client`](https://pypi.org/project/apify-client/) package on PyPI. + +```bash +pip install apify-client +``` + +## Quick example + +Here's an example showing how to run an Actor and retrieve its results: + + + + + {UsageAsyncExample} + + + + + {UsageSyncExample} + + + + +> You can find your API token in the [Integrations section](https://console.apify.com/account/integrations) of Apify Console. See the [Quick start guide](./quick-start.mdx) for more details on authentication. diff --git a/website/versioned_docs/version-2.5/01_introduction/quick-start.mdx b/website/versioned_docs/version-2.5/01_introduction/quick-start.mdx new file mode 100644 index 00000000..5832c2a7 --- /dev/null +++ b/website/versioned_docs/version-2.5/01_introduction/quick-start.mdx @@ -0,0 +1,106 @@ +--- +id: quick-start +title: Quick start +sidebar_label: Quick start +description: "Get started with the Apify API client for Python by running an Actor and retrieving results from its dataset." +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; + +import AuthAsyncExample from '!!raw-loader!./code/02_auth_async.py'; +import AuthSyncExample from '!!raw-loader!./code/02_auth_sync.py'; +import InputAsyncExample from '!!raw-loader!./code/03_input_async.py'; +import InputSyncExample from '!!raw-loader!./code/03_input_sync.py'; +import DatasetAsyncExample from '!!raw-loader!./code/03_dataset_async.py'; +import DatasetSyncExample from '!!raw-loader!./code/03_dataset_sync.py'; + +Learn how to authenticate, run Actors, and retrieve results using the Apify API client for Python. + +--- + +## Step 1: Authenticate the client + +To use the client, you need an [API token](https://docs.apify.com/platform/integrations/api#api-token). You can find your token under the [Integrations](https://console.apify.com/account/integrations) tab in Apify Console. Copy the token and initialize the client by providing it (`MY-APIFY-TOKEN`) as a parameter to the `ApifyClient` constructor. + + + + + {AuthAsyncExample} + + + + + {AuthSyncExample} + + + + +:::warning Secure access + +The API token is used to authorize your requests to the Apify API. You can be charged for the usage of the underlying services, so do not share your API token with untrusted parties or expose it on the client side of your applications. + +::: + +## Step 2: Run an Actor + +To start an Actor, call the [`apify_client.actor()`](/reference/class/ActorClient) method with the Actor's ID (e.g., `john-doe/my-cool-actor`). The Actor's ID is a combination of the Actor owner's username and the Actor name. You can run both your own Actors and Actors from [Apify Store](https://apify.com/store). + +To define the Actor's input, pass a dictionary to the [`call()`](/reference/class/ActorClient#call) method that matches the Actor's [input schema](https://docs.apify.com/platform/actors/development/actor-definition/input-schema). The input can include URLs to scrape, search terms, or other configuration data. + + + + + {InputAsyncExample} + + + + + {InputSyncExample} + + + + +## Step 3: Get results from the dataset + +To get the results from the dataset, call the [`apify_client.dataset()`](/reference/class/DatasetClient) method with the dataset ID, then call [`list_items()`](/reference/class/DatasetClient#list_items) to retrieve the data. You can get the dataset ID from the Actor's run dictionary (represented by `defaultDatasetId`). + + + + + {DatasetAsyncExample} + + + + + {DatasetSyncExample} + + + + +:::note Dataset access + +Running an Actor might take time, depending on the Actor's complexity and the amount of data it processes. If you want only to get data and have an immediate response, you should access the existing dataset of the finished [Actor run](https://docs.apify.com/platform/actors/running/runs-and-builds#runs). + +::: + +## Next steps + +### Concepts + +To learn more about how the client works, check out the Concepts section in the sidebar: + +- [Asyncio support](../02_concepts/01_async_support.mdx) - asynchronous programming with the client +- [Single and collection clients](../02_concepts/02_single_collection_clients.mdx) - resource clients and collection clients +- [Error handling](../02_concepts/04_error_handling.mdx) - automatic data extraction and error debugging +- [Retries](../02_concepts/05_retries.mdx) - automatic retries with exponential backoff +- [Pagination](../02_concepts/08_pagination.mdx) - iterating through large result sets + +### Guides + +For practical examples of common tasks, see the Guides section: + +- [Pass input to an Actor](../03_guides/01_passing_input_to_actor.mdx) +- [Retrieve Actor data](../03_guides/03_retrieve_actor_data.mdx) +- [Integrate with data libraries](../03_guides/04_integration_with_data_libraries.mdx) diff --git a/website/versioned_docs/version-2.5/02_concepts/01_async_support.mdx b/website/versioned_docs/version-2.5/02_concepts/01_async_support.mdx new file mode 100644 index 00000000..bdb6ab3a --- /dev/null +++ b/website/versioned_docs/version-2.5/02_concepts/01_async_support.mdx @@ -0,0 +1,18 @@ +--- +id: asyncio-support +title: Asyncio support +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; + +import AsyncSupportExample from '!!raw-loader!./code/01_async_support.py'; + +The package provides an asynchronous version of the client, [`ApifyClientAsync`](/reference/class/ApifyClientAsync), which allows you to interact with the Apify API using Python's standard async/await syntax. This enables you to perform non-blocking operations, see the Python [asyncio documentation](https://docs.python.org/3/library/asyncio-task.html) for more information. + +The following example demonstrates how to run an Actor asynchronously and stream its logs while it is running: + + + {AsyncSupportExample} + diff --git a/website/versioned_docs/version-2.5/02_concepts/02_single_collection_clients.mdx b/website/versioned_docs/version-2.5/02_concepts/02_single_collection_clients.mdx new file mode 100644 index 00000000..1a5ac0a2 --- /dev/null +++ b/website/versioned_docs/version-2.5/02_concepts/02_single_collection_clients.mdx @@ -0,0 +1,48 @@ +--- +id: single-and-collection-clients +title: Single and collection clients +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; + +import CollectionAsyncExample from '!!raw-loader!./code/02_collection_async.py'; +import CollectionSyncExample from '!!raw-loader!./code/02_collection_sync.py'; +import SingleAsyncExample from '!!raw-loader!./code/02_single_async.py'; +import SingleSyncExample from '!!raw-loader!./code/02_single_sync.py'; + +The Apify client interface is designed to be consistent and intuitive across all of its components. When you call specific methods on the main client, you create specialized clients to manage individual API resources. There are two main types of clients: + +- [`ActorClient`](/reference/class/ActorClient) - Manages a single resource. +- [`ActorCollectionClient`](/reference/class/ActorCollectionClient) - Manages a collection of resources. + + + + + {CollectionAsyncExample} + + + + + {CollectionSyncExample} + + + + +The resource ID can be the resource's `id` or a combination of `username/resource-name`. + + + + + {SingleAsyncExample} + + + + + {SingleSyncExample} + + + + +By utilizing the appropriate collection or resource client, you can simplify how you interact with the Apify API. diff --git a/website/versioned_docs/version-2.5/02_concepts/03_nested_clients.mdx b/website/versioned_docs/version-2.5/02_concepts/03_nested_clients.mdx new file mode 100644 index 00000000..386aefd1 --- /dev/null +++ b/website/versioned_docs/version-2.5/02_concepts/03_nested_clients.mdx @@ -0,0 +1,28 @@ +--- +id: nested-clients +title: Nested clients +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; + +import NestedAsyncExample from '!!raw-loader!./code/03_nested_async.py'; +import NestedSyncExample from '!!raw-loader!./code/03_nested_sync.py'; + +In some cases, the Apify client provides nested clients to simplify working with related collections. For example, you can easily manage the runs of a specific Actor without having to construct multiple endpoints or client instances manually. + + + + + {NestedAsyncExample} + + + + + {NestedSyncExample} + + + + +This direct access to [Dataset](https://docs.apify.com/platform/storage/dataset) (and other storage resources) from the [`RunClient`](/reference/class/RunClient) is especially convenient when used alongside the [`ActorClient.last_run`](/reference/class/ActorClient#last_run) method. diff --git a/website/versioned_docs/version-2.5/02_concepts/04_error_handling.mdx b/website/versioned_docs/version-2.5/02_concepts/04_error_handling.mdx new file mode 100644 index 00000000..d8859eb1 --- /dev/null +++ b/website/versioned_docs/version-2.5/02_concepts/04_error_handling.mdx @@ -0,0 +1,26 @@ +--- +id: error-handling +title: Error handling +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; + +import ErrorAsyncExample from '!!raw-loader!./code/04_error_async.py'; +import ErrorSyncExample from '!!raw-loader!./code/04_error_sync.py'; + +When you use the Apify client, it automatically extracts all relevant data from the endpoint and returns it in the expected format. Date strings, for instance, are seamlessly converted to Python `datetime.datetime` objects. If an error occurs, the client raises an [`ApifyApiError`](/reference/class/ApifyApiError). This exception wraps the raw JSON errors returned by the API and provides additional context, making it easier to debug any issues that arise. + + + + + {ErrorAsyncExample} + + + + + {ErrorSyncExample} + + + diff --git a/website/versioned_docs/version-2.5/02_concepts/05_retries.mdx b/website/versioned_docs/version-2.5/02_concepts/05_retries.mdx new file mode 100644 index 00000000..9cf0ed11 --- /dev/null +++ b/website/versioned_docs/version-2.5/02_concepts/05_retries.mdx @@ -0,0 +1,42 @@ +--- +id: retries +title: Retries +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; + +import RetriesAsyncExample from '!!raw-loader!./code/05_retries_async.py'; +import RetriesSyncExample from '!!raw-loader!./code/05_retries_sync.py'; + +When dealing with network communication, failures can occasionally occur. The Apify client automatically retries requests that fail due to: + +- Network errors +- Internal errors in the Apify API (HTTP status codes 500 and above) +- Rate limit errors (HTTP status code 429) + +By default, the client will retry a failed request up to 8 times. The retry intervals use an exponential backoff strategy: + +- The first retry occurs after approximately 500 milliseconds. +- The second retry occurs after approximately 1,000 milliseconds, and so on. + +You can customize this behavior using the following options in the [`ApifyClient`](/reference/class/ApifyClient) constructor: + +- `max_retries`: Defines the maximum number of retry attempts. +- `min_delay_between_retries_millis`: Sets the minimum delay between retries (in milliseconds). + +Retries with exponential backoff are a common strategy for handling network errors. They help to reduce the load on the server and increase the chances of a successful request. + + + + + {RetriesAsyncExample} + + + + + {RetriesSyncExample} + + + diff --git a/website/versioned_docs/version-2.5/02_concepts/06_logging.mdx b/website/versioned_docs/version-2.5/02_concepts/06_logging.mdx new file mode 100644 index 00000000..2e495878 --- /dev/null +++ b/website/versioned_docs/version-2.5/02_concepts/06_logging.mdx @@ -0,0 +1,33 @@ +--- +id: logging +title: Logging +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; + +import LoggingConfigExample from '!!raw-loader!./code/06_logging_config.py'; +import LoggingFormatterExample from '!!raw-loader!./code/06_logging_formatter.py'; + +The library logs useful debug information to the `apify_client` logger whenever it sends requests to the Apify API. You can configure this logger to print debug information to the standard output by adding a handler: + + + {LoggingConfigExample} + + +The log records include additional properties, provided via the extra argument, which can be helpful for debugging. Some of these properties are: + +- `attempt` - Number of retry attempts for the request. +- `status_code` - HTTP status code of the response. +- `url` - URL of the API endpoint being called. +- `client_method` - Method name of the client that initiated the request. +- `resource_id` - Identifier of the resource being accessed. + +To display these additional properties in the log output, you need to use a custom log formatter. Here's a basic example: + + + {LoggingFormatterExample} + + +For more information on creating and using custom log formatters, refer to the official Python [logging documentation](https://docs.python.org/3/howto/logging.html#formatters). diff --git a/website/versioned_docs/version-2.5/02_concepts/07_convenience_methods.mdx b/website/versioned_docs/version-2.5/02_concepts/07_convenience_methods.mdx new file mode 100644 index 00000000..b3014471 --- /dev/null +++ b/website/versioned_docs/version-2.5/02_concepts/07_convenience_methods.mdx @@ -0,0 +1,34 @@ +--- +id: convenience-methods +title: Convenience methods +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; + +import CallAsyncExample from '!!raw-loader!./code/07_call_async.py'; +import CallSyncExample from '!!raw-loader!./code/07_call_sync.py'; + +The Apify client provides several convenience methods to handle actions that the API alone cannot perform efficiently, such as waiting for an Actor run to finish without running into network timeouts. These methods simplify common tasks and enhance the usability of the client. + +- [`ActorClient.call`](/reference/class/ActorClient#call) - Starts an Actor and waits for it to finish, handling network timeouts internally. +- [`ActorClient.start`](/reference/class/ActorClient#start) - Explicitly waits for an Actor run to finish with customizable timeouts. + +Additionally, storage-related resources offer flexible options for data retrieval: + +- [Key-value store](https://docs.apify.com/platform/storage/key-value-store) records can be retrieved as objects, buffers, or streams. +- [Dataset](https://docs.apify.com/platform/storage/dataset) items can be fetched as individual objects, serialized data, or iterated asynchronously. + + + + + {CallAsyncExample} + + + + + {CallSyncExample} + + + diff --git a/website/versioned_docs/version-2.5/02_concepts/08_pagination.mdx b/website/versioned_docs/version-2.5/02_concepts/08_pagination.mdx new file mode 100644 index 00000000..712aee81 --- /dev/null +++ b/website/versioned_docs/version-2.5/02_concepts/08_pagination.mdx @@ -0,0 +1,38 @@ +--- +id: pagination +title: Pagination +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; + +import PaginationAsyncExample from '!!raw-loader!./code/08_pagination_async.py'; +import PaginationSyncExample from '!!raw-loader!./code/08_pagination_sync.py'; + +Most methods named `list` or `list_something` in the Apify client return a [`ListPage`](/reference/class/ListPage) object. This object provides a consistent interface for working with paginated data and includes the following properties: + +- `items` - The main results you're looking for. +- `total` - The total number of items available. +- `offset` - The starting point of the current page. +- `count` - The number of items in the current page. +- `limit` - The maximum number of items per page. + +Some methods, such as `list_keys` or `list_head`, paginate differently. Regardless, the primary results are always stored under the items property, and the limit property can be used to control the number of results returned. + +The following example demonstrates how to fetch all items from a dataset using pagination: + + + + + {PaginationAsyncExample} + + + + + {PaginationSyncExample} + + + + +The [`ListPage`](/reference/class/ListPage) interface offers several key benefits. Its consistent structure ensures predictable results for most `list` methods, providing a uniform way to work with paginated data. It also offers flexibility, allowing you to customize the `limit` and `offset` parameters to control data fetching according to your needs. Additionally, it provides scalability, enabling you to efficiently handle large datasets through pagination. This approach ensures efficient data retrieval while keeping memory usage under control, making it ideal for managing and processing large collections. diff --git a/website/versioned_docs/version-2.5/02_concepts/09_streaming.mdx b/website/versioned_docs/version-2.5/02_concepts/09_streaming.mdx new file mode 100644 index 00000000..c62da01e --- /dev/null +++ b/website/versioned_docs/version-2.5/02_concepts/09_streaming.mdx @@ -0,0 +1,38 @@ +--- +id: streaming-resources +title: Streaming resources +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; + +import StreamingAsyncExample from '!!raw-loader!./code/09_streaming_async.py'; +import StreamingSyncExample from '!!raw-loader!./code/09_streaming_sync.py'; + +Certain resources, such as dataset items, key-value store records, and logs, support streaming directly from the Apify API. This allows you to process large resources incrementally without downloading them entirely into memory, making it ideal for handling large or continuously updated data. + +Supported streaming methods: + +- [`DatasetClient.stream_items`](/reference/class/DatasetClient#stream_items) - Stream dataset items incrementally. +- [`KeyValueStoreClient.stream_record`](/reference/class/KeyValueStoreClient#stream_record) - Stream key-value store records as raw data. +- [`LogClient.stream`](/reference/class/LogClient#stream) - Stream logs in real time. + +These methods return a raw, context-managed `impit.Response` object. The response must be consumed within a with block to ensure that the connection is closed automatically, preventing memory leaks or unclosed connections. + +The following example demonstrates how to stream the logs of an Actor run incrementally: + + + + + {StreamingAsyncExample} + + + + + {StreamingSyncExample} + + + + +Streaming offers several key benefits. It ensures memory efficiency by loading only a small portion of the resource into memory at any given time, making it ideal for handling large data. It enables real-time processing, allowing you to start working with data immediately as it is received. With automatic resource management, using the `with` statement ensures that connections are properly closed, preventing memory leaks or unclosed connections. This approach is valuable for processing large logs, datasets, or files on the fly without the need to download them entirely. diff --git a/website/versioned_docs/version-2.5/02_concepts/code/01_async_support.py b/website/versioned_docs/version-2.5/02_concepts/code/01_async_support.py new file mode 100644 index 00000000..e8fe81b0 --- /dev/null +++ b/website/versioned_docs/version-2.5/02_concepts/code/01_async_support.py @@ -0,0 +1,25 @@ +import asyncio + +from apify_client import ApifyClientAsync + +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + apify_client = ApifyClientAsync(TOKEN) + actor_client = apify_client.actor('my-actor-id') + + # Start the Actor and get the run ID + run_result = await actor_client.start() + run_client = apify_client.run(run_result.id) + log_client = run_client.log() + + # Stream the logs + async with log_client.stream() as async_log_stream: + if async_log_stream: + async for bytes_chunk in async_log_stream.aiter_bytes(): + print(bytes_chunk) + + +if __name__ == '__main__': + asyncio.run(main()) diff --git a/website/versioned_docs/version-2.5/02_concepts/code/02_collection_async.py b/website/versioned_docs/version-2.5/02_concepts/code/02_collection_async.py new file mode 100644 index 00000000..85ed3290 --- /dev/null +++ b/website/versioned_docs/version-2.5/02_concepts/code/02_collection_async.py @@ -0,0 +1,16 @@ +from apify_client import ApifyClientAsync + +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + apify_client = ApifyClientAsync(TOKEN) + + # Collection clients do not require a parameter + actor_collection_client = apify_client.actors() + + # Create an Actor with the name: my-actor + my_actor = await actor_collection_client.create(name='my-actor') + + # List all of your Actors + actor_list = (await actor_collection_client.list()).items diff --git a/website/versioned_docs/version-2.5/02_concepts/code/02_collection_sync.py b/website/versioned_docs/version-2.5/02_concepts/code/02_collection_sync.py new file mode 100644 index 00000000..988e41e7 --- /dev/null +++ b/website/versioned_docs/version-2.5/02_concepts/code/02_collection_sync.py @@ -0,0 +1,16 @@ +from apify_client import ApifyClient + +TOKEN = 'MY-APIFY-TOKEN' + + +def main() -> None: + apify_client = ApifyClient(TOKEN) + + # Collection clients do not require a parameter + actor_collection_client = apify_client.actors() + + # Create an Actor with the name: my-actor + my_actor = actor_collection_client.create(name='my-actor') + + # List all of your Actors + actor_list = actor_collection_client.list().items diff --git a/website/versioned_docs/version-2.5/02_concepts/code/02_single_async.py b/website/versioned_docs/version-2.5/02_concepts/code/02_single_async.py new file mode 100644 index 00000000..c6b1a0ac --- /dev/null +++ b/website/versioned_docs/version-2.5/02_concepts/code/02_single_async.py @@ -0,0 +1,16 @@ +from apify_client import ApifyClientAsync + +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + apify_client = ApifyClientAsync(TOKEN) + + # Resource clients accept an ID of the resource + actor_client = apify_client.actor('username/actor-name') + + # Fetch the 'username/actor-name' object from the API + my_actor = await actor_client.get() + + # Start the run of 'username/actor-name' and return the Run object + my_actor_run = await actor_client.start() diff --git a/website/versioned_docs/version-2.5/02_concepts/code/02_single_sync.py b/website/versioned_docs/version-2.5/02_concepts/code/02_single_sync.py new file mode 100644 index 00000000..033e54de --- /dev/null +++ b/website/versioned_docs/version-2.5/02_concepts/code/02_single_sync.py @@ -0,0 +1,16 @@ +from apify_client import ApifyClient + +TOKEN = 'MY-APIFY-TOKEN' + + +def main() -> None: + apify_client = ApifyClient(TOKEN) + + # Resource clients accept an ID of the resource + actor_client = apify_client.actor('username/actor-name') + + # Fetch the 'username/actor-name' object from the API + my_actor = actor_client.get() + + # Start the run of 'username/actor-name' and return the Run object + my_actor_run = actor_client.start() diff --git a/website/versioned_docs/version-2.5/02_concepts/code/03_nested_async.py b/website/versioned_docs/version-2.5/02_concepts/code/03_nested_async.py new file mode 100644 index 00000000..662657c8 --- /dev/null +++ b/website/versioned_docs/version-2.5/02_concepts/code/03_nested_async.py @@ -0,0 +1,22 @@ +from apify_client import ApifyClientAsync + +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + apify_client = ApifyClientAsync(TOKEN) + + actor_client = apify_client.actor('username/actor-name') + runs_client = actor_client.runs() + + # List the last 10 runs of the Actor + actor_runs = (await runs_client.list(limit=10, desc=True)).items + + # Select the last run of the Actor that finished with a SUCCEEDED status + last_succeeded_run_client = actor_client.last_run(status='SUCCEEDED') # ty: ignore[invalid-argument-type] + + # Get dataset + actor_run_dataset_client = last_succeeded_run_client.dataset() + + # Fetch items from the run's dataset + dataset_items = (await actor_run_dataset_client.list_items()).items diff --git a/website/versioned_docs/version-2.5/02_concepts/code/03_nested_sync.py b/website/versioned_docs/version-2.5/02_concepts/code/03_nested_sync.py new file mode 100644 index 00000000..74654576 --- /dev/null +++ b/website/versioned_docs/version-2.5/02_concepts/code/03_nested_sync.py @@ -0,0 +1,22 @@ +from apify_client import ApifyClient + +TOKEN = 'MY-APIFY-TOKEN' + + +def main() -> None: + apify_client = ApifyClient(TOKEN) + + actor_client = apify_client.actor('username/actor-name') + runs_client = actor_client.runs() + + # List the last 10 runs of the Actor + actor_runs = runs_client.list(limit=10, desc=True).items + + # Select the last run of the Actor that finished with a SUCCEEDED status + last_succeeded_run_client = actor_client.last_run(status='SUCCEEDED') # ty: ignore[invalid-argument-type] + + # Get dataset + actor_run_dataset_client = last_succeeded_run_client.dataset() + + # Fetch items from the run's dataset + dataset_items = actor_run_dataset_client.list_items().items diff --git a/website/versioned_docs/version-2.5/02_concepts/code/04_error_async.py b/website/versioned_docs/version-2.5/02_concepts/code/04_error_async.py new file mode 100644 index 00000000..0057ea44 --- /dev/null +++ b/website/versioned_docs/version-2.5/02_concepts/code/04_error_async.py @@ -0,0 +1,15 @@ +from apify_client import ApifyClientAsync + +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + apify_client = ApifyClientAsync(TOKEN) + + try: + # Try to list items from non-existing dataset + dataset_client = apify_client.dataset('not-existing-dataset-id') + dataset_items = (await dataset_client.list_items()).items + except Exception as ApifyApiError: + # The exception is an instance of ApifyApiError + print(ApifyApiError) diff --git a/website/versioned_docs/version-2.5/02_concepts/code/04_error_sync.py b/website/versioned_docs/version-2.5/02_concepts/code/04_error_sync.py new file mode 100644 index 00000000..83fc3080 --- /dev/null +++ b/website/versioned_docs/version-2.5/02_concepts/code/04_error_sync.py @@ -0,0 +1,15 @@ +from apify_client import ApifyClient + +TOKEN = 'MY-APIFY-TOKEN' + + +def main() -> None: + apify_client = ApifyClient(TOKEN) + + try: + # Try to list items from non-existing dataset + dataset_client = apify_client.dataset('not-existing-dataset-id') + dataset_items = dataset_client.list_items().items + except Exception as ApifyApiError: + # The exception is an instance of ApifyApiError + print(ApifyApiError) diff --git a/website/versioned_docs/version-2.5/02_concepts/code/05_retries_async.py b/website/versioned_docs/version-2.5/02_concepts/code/05_retries_async.py new file mode 100644 index 00000000..5a349685 --- /dev/null +++ b/website/versioned_docs/version-2.5/02_concepts/code/05_retries_async.py @@ -0,0 +1,17 @@ +from datetime import timedelta + +from apify_client import ApifyClientAsync + +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + apify_client = ApifyClientAsync( + token=TOKEN, + max_retries=4, + min_delay_between_retries=timedelta(milliseconds=500), + timeout_short=timedelta(seconds=5), + timeout_medium=timedelta(seconds=30), + timeout_long=timedelta(seconds=360), + timeout_max=timedelta(seconds=360), + ) diff --git a/website/versioned_docs/version-2.5/02_concepts/code/05_retries_sync.py b/website/versioned_docs/version-2.5/02_concepts/code/05_retries_sync.py new file mode 100644 index 00000000..b714b536 --- /dev/null +++ b/website/versioned_docs/version-2.5/02_concepts/code/05_retries_sync.py @@ -0,0 +1,17 @@ +from datetime import timedelta + +from apify_client import ApifyClient + +TOKEN = 'MY-APIFY-TOKEN' + + +def main() -> None: + apify_client = ApifyClient( + token=TOKEN, + max_retries=4, + min_delay_between_retries=timedelta(milliseconds=500), + timeout_short=timedelta(seconds=5), + timeout_medium=timedelta(seconds=30), + timeout_long=timedelta(seconds=360), + timeout_max=timedelta(seconds=360), + ) diff --git a/website/versioned_docs/version-2.5/02_concepts/code/06_logging_config.py b/website/versioned_docs/version-2.5/02_concepts/code/06_logging_config.py new file mode 100644 index 00000000..e31a7fda --- /dev/null +++ b/website/versioned_docs/version-2.5/02_concepts/code/06_logging_config.py @@ -0,0 +1,6 @@ +import logging + +# Configure the Apify client logger +apify_client_logger = logging.getLogger('apify_client') +apify_client_logger.setLevel(logging.DEBUG) +apify_client_logger.addHandler(logging.StreamHandler()) diff --git a/website/versioned_docs/version-2.5/02_concepts/code/06_logging_formatter.py b/website/versioned_docs/version-2.5/02_concepts/code/06_logging_formatter.py new file mode 100644 index 00000000..efeeb695 --- /dev/null +++ b/website/versioned_docs/version-2.5/02_concepts/code/06_logging_formatter.py @@ -0,0 +1,15 @@ +import logging + +# Configure the Apify client logger +apify_client_logger = logging.getLogger('apify_client') +apify_client_logger.setLevel(logging.DEBUG) +apify_client_logger.addHandler(logging.StreamHandler()) + +# Create a custom logging formatter +formatter = logging.Formatter( + '%(asctime)s - %(name)s - %(levelname)s - %(message)s - ' + '%(attempt)s - %(status_code)s - %(url)s' +) +handler = logging.StreamHandler() +handler.setFormatter(formatter) +apify_client_logger.addHandler(handler) diff --git a/website/versioned_docs/version-2.5/02_concepts/code/07_call_async.py b/website/versioned_docs/version-2.5/02_concepts/code/07_call_async.py new file mode 100644 index 00000000..955f7532 --- /dev/null +++ b/website/versioned_docs/version-2.5/02_concepts/code/07_call_async.py @@ -0,0 +1,14 @@ +from apify_client import ApifyClientAsync + +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + apify_client = ApifyClientAsync(TOKEN) + actor_client = apify_client.actor('username/actor-name') + + # Start an Actor and waits for it to finish + finished_actor_run = await actor_client.call() + + # Starts an Actor and waits maximum 60s (1 minute) for the finish + actor_run = await actor_client.start(wait_for_finish=60) diff --git a/website/versioned_docs/version-2.5/02_concepts/code/07_call_sync.py b/website/versioned_docs/version-2.5/02_concepts/code/07_call_sync.py new file mode 100644 index 00000000..af790eaa --- /dev/null +++ b/website/versioned_docs/version-2.5/02_concepts/code/07_call_sync.py @@ -0,0 +1,14 @@ +from apify_client import ApifyClient + +TOKEN = 'MY-APIFY-TOKEN' + + +def main() -> None: + apify_client = ApifyClient(TOKEN) + actor_client = apify_client.actor('username/actor-name') + + # Start an Actor and waits for it to finish + finished_actor_run = actor_client.call() + + # Starts an Actor and waits maximum 60s (1 minute) for the finish + actor_run = actor_client.start(wait_for_finish=60) diff --git a/website/versioned_docs/version-2.5/02_concepts/code/08_pagination_async.py b/website/versioned_docs/version-2.5/02_concepts/code/08_pagination_async.py new file mode 100644 index 00000000..50e9d047 --- /dev/null +++ b/website/versioned_docs/version-2.5/02_concepts/code/08_pagination_async.py @@ -0,0 +1,35 @@ +from apify_client import ApifyClientAsync + +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + apify_client = ApifyClientAsync(TOKEN) + + # Initialize the dataset client + dataset_client = apify_client.dataset('dataset-id') + + # Define the pagination parameters + limit = 1000 # Number of items per page + offset = 0 # Starting offset + all_items = [] # List to store all fetched items + + while True: + # Fetch a page of items + response = await dataset_client.list_items(limit=limit, offset=offset) + items = response.items + total = response.total + + print(f'Fetched {len(items)} items') + + # Add the fetched items to the complete list + all_items.extend(items) + + # Exit the loop if there are no more items to fetch + if offset + limit >= total: + break + + # Increment the offset for the next page + offset += limit + + print(f'Overall fetched {len(all_items)} items') diff --git a/website/versioned_docs/version-2.5/02_concepts/code/08_pagination_sync.py b/website/versioned_docs/version-2.5/02_concepts/code/08_pagination_sync.py new file mode 100644 index 00000000..3beb4fbe --- /dev/null +++ b/website/versioned_docs/version-2.5/02_concepts/code/08_pagination_sync.py @@ -0,0 +1,35 @@ +from apify_client import ApifyClient + +TOKEN = 'MY-APIFY-TOKEN' + + +def main() -> None: + apify_client = ApifyClient(TOKEN) + + # Initialize the dataset client + dataset_client = apify_client.dataset('dataset-id') + + # Define the pagination parameters + limit = 1000 # Number of items per page + offset = 0 # Starting offset + all_items = [] # List to store all fetched items + + while True: + # Fetch a page of items + response = dataset_client.list_items(limit=limit, offset=offset) + items = response.items + total = response.total + + print(f'Fetched {len(items)} items') + + # Add the fetched items to the complete list + all_items.extend(items) + + # Exit the loop if there are no more items to fetch + if offset + limit >= total: + break + + # Increment the offset for the next page + offset += limit + + print(f'Overall fetched {len(all_items)} items') diff --git a/website/versioned_docs/version-2.5/02_concepts/code/09_streaming_async.py b/website/versioned_docs/version-2.5/02_concepts/code/09_streaming_async.py new file mode 100644 index 00000000..5459784e --- /dev/null +++ b/website/versioned_docs/version-2.5/02_concepts/code/09_streaming_async.py @@ -0,0 +1,14 @@ +from apify_client import ApifyClientAsync + +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + apify_client = ApifyClientAsync(TOKEN) + run_client = apify_client.run('MY-RUN-ID') + log_client = run_client.log() + + async with log_client.stream() as log_stream: + if log_stream: + async for bytes_chunk in log_stream.aiter_bytes(): + print(bytes_chunk) diff --git a/website/versioned_docs/version-2.5/02_concepts/code/09_streaming_sync.py b/website/versioned_docs/version-2.5/02_concepts/code/09_streaming_sync.py new file mode 100644 index 00000000..e7617ab3 --- /dev/null +++ b/website/versioned_docs/version-2.5/02_concepts/code/09_streaming_sync.py @@ -0,0 +1,14 @@ +from apify_client import ApifyClient + +TOKEN = 'MY-APIFY-TOKEN' + + +def main() -> None: + apify_client = ApifyClient(TOKEN) + run_client = apify_client.run('MY-RUN-ID') + log_client = run_client.log() + + with log_client.stream() as log_stream: + if log_stream: + for bytes_chunk in log_stream.iter_bytes(): + print(bytes_chunk) diff --git a/website/versioned_docs/version-2.5/03_guides/01_passing_input_to_actor.mdx b/website/versioned_docs/version-2.5/03_guides/01_passing_input_to_actor.mdx new file mode 100644 index 00000000..61769d73 --- /dev/null +++ b/website/versioned_docs/version-2.5/03_guides/01_passing_input_to_actor.mdx @@ -0,0 +1,28 @@ +--- +id: passing-input-to-actor +title: Passing input to Actor +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; + +import StreamingAsyncExample from '!!raw-loader!./code/01_input_async.py'; +import StreamingSyncExample from '!!raw-loader!./code/01_input_sync.py'; + +The efficient way to run an Actor and retrieve results is by passing input data directly to the `call` method. This method allows you to configure the Actor's input, execute it, and either get a reference to the running Actor or wait for its completion. + +The following example demonstrates how to pass input to the `apify/instagram-hashtag-scraper` Actor and wait for it to finish. + + + + + {StreamingAsyncExample} + + + + + {StreamingSyncExample} + + + diff --git a/website/versioned_docs/version-2.5/03_guides/02_manage_tasks_for_reusable_input.mdx b/website/versioned_docs/version-2.5/03_guides/02_manage_tasks_for_reusable_input.mdx new file mode 100644 index 00000000..9865e232 --- /dev/null +++ b/website/versioned_docs/version-2.5/03_guides/02_manage_tasks_for_reusable_input.mdx @@ -0,0 +1,28 @@ +--- +id: manage-tasks-for-reusable-input +title: Manage tasks for reusable input +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; + +import TasksAsyncExample from '!!raw-loader!./code/02_tasks_async.py'; +import TasksSyncExample from '!!raw-loader!./code/02_tasks_sync.py'; + +When you need to run multiple inputs with the same Actor, the most convenient approach is to create multiple [tasks](https://docs.apify.com/platform/actors/running/tasks), each with different input configurations. Task inputs are stored on the Apify platform when the task is created, allowing you to reuse them easily. + +The following example demonstrates how to create tasks for the `apify/instagram-hashtag-scraper` Actor with different inputs, manage task clients, and execute them asynchronously: + + + + + {TasksAsyncExample} + + + + + {TasksSyncExample} + + + diff --git a/website/versioned_docs/version-2.5/03_guides/03_retrieve_actor_data.mdx b/website/versioned_docs/version-2.5/03_guides/03_retrieve_actor_data.mdx new file mode 100644 index 00000000..f139b2a9 --- /dev/null +++ b/website/versioned_docs/version-2.5/03_guides/03_retrieve_actor_data.mdx @@ -0,0 +1,28 @@ +--- +id: retrieve-actor-data +title: Retrieve Actor data +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; + +import RetrieveAsyncExample from '!!raw-loader!./code/03_retrieve_async.py'; +import RetrieveSyncExample from '!!raw-loader!./code/03_retrieve_sync.py'; + +Actor output data is stored in [datasets](https://docs.apify.com/platform/storage/dataset), which can be retrieved from individual Actor runs. Dataset items support pagination for efficient retrieval, and multiple datasets can be merged into a single dataset for further analysis. This merged dataset can then be exported into various formats such as CSV, JSON, XLSX, or XML. Additionally, [integrations](https://docs.apify.com/platform/integrations) provide powerful tools to automate data workflows. + +The following example demonstrates how to fetch datasets from an Actor's runs, paginate through their items, and merge them into a single dataset for unified analysis: + + + + + {RetrieveAsyncExample} + + + + + {RetrieveSyncExample} + + + diff --git a/website/versioned_docs/version-2.5/03_guides/04_integration_with_data_libraries.mdx b/website/versioned_docs/version-2.5/03_guides/04_integration_with_data_libraries.mdx new file mode 100644 index 00000000..9c4cad3e --- /dev/null +++ b/website/versioned_docs/version-2.5/03_guides/04_integration_with_data_libraries.mdx @@ -0,0 +1,28 @@ +--- +id: integration-with-data-libraries +title: Integration with data libraries +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; + +import PandasAsyncExample from '!!raw-loader!./code/04_pandas_async.py'; +import PandasSyncExample from '!!raw-loader!./code/04_pandas_sync.py'; + +The Apify client for Python seamlessly integrates with data analysis libraries like [Pandas](https://pandas.pydata.org/). This allows you to load dataset items directly into a Pandas [DataFrame](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html) for efficient manipulation and analysis. Pandas provides robust data structures and tools for handling large datasets, making it a powerful addition to your Apify workflows. + +The following example demonstrates how to retrieve items from the most recent dataset of an Actor run and load them into a Pandas DataFrame for further analysis: + + + + + {PandasAsyncExample} + + + + + {PandasSyncExample} + + + diff --git a/website/versioned_docs/version-2.5/03_guides/code/01_input_async.py b/website/versioned_docs/version-2.5/03_guides/code/01_input_async.py new file mode 100644 index 00000000..c225a0a2 --- /dev/null +++ b/website/versioned_docs/version-2.5/03_guides/code/01_input_async.py @@ -0,0 +1,26 @@ +import asyncio +from datetime import timedelta + +from apify_client import ApifyClientAsync + +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + # Client initialization with the API token + apify_client = ApifyClientAsync(token=TOKEN) + + # Get the Actor client + actor_client = apify_client.actor('apify/instagram-hashtag-scraper') + + input_data = {'hashtags': ['rainbow'], 'resultsLimit': 20} + + # Run the Actor and wait for it to finish up to 60 seconds. + # Input is not persisted for next runs. + run_result = await actor_client.call( + run_input=input_data, timeout=timedelta(seconds=60) + ) + + +if __name__ == '__main__': + asyncio.run(main()) diff --git a/website/versioned_docs/version-2.5/03_guides/code/01_input_sync.py b/website/versioned_docs/version-2.5/03_guides/code/01_input_sync.py new file mode 100644 index 00000000..ea99665c --- /dev/null +++ b/website/versioned_docs/version-2.5/03_guides/code/01_input_sync.py @@ -0,0 +1,23 @@ +from datetime import timedelta + +from apify_client import ApifyClient + +TOKEN = 'MY-APIFY-TOKEN' + + +def main() -> None: + # Client initialization with the API token + apify_client = ApifyClient(token=TOKEN) + + # Get the Actor client + actor_client = apify_client.actor('apify/instagram-hashtag-scraper') + + input_data = {'hashtags': ['rainbow'], 'resultsLimit': 20} + + # Run the Actor and wait for it to finish up to 60 seconds. + # Input is not persisted for next runs. + run_result = actor_client.call(run_input=input_data, timeout=timedelta(seconds=60)) + + +if __name__ == '__main__': + main() diff --git a/website/versioned_docs/version-2.5/03_guides/code/02_tasks_async.py b/website/versioned_docs/version-2.5/03_guides/code/02_tasks_async.py new file mode 100644 index 00000000..19e38304 --- /dev/null +++ b/website/versioned_docs/version-2.5/03_guides/code/02_tasks_async.py @@ -0,0 +1,45 @@ +import asyncio + +from apify_client import ApifyClientAsync + +TOKEN = 'MY-APIFY-TOKEN' +HASHTAGS = ['zebra', 'lion', 'hippo'] + + +async def main() -> None: + apify_client = ApifyClientAsync(token=TOKEN) + + # Create Apify tasks + apify_tasks = [] + apify_tasks_client = apify_client.tasks() + + for hashtag in HASHTAGS: + apify_task = await apify_tasks_client.create( + name=f'hashtags-{hashtag}', + actor_id='apify/instagram-hashtag-scraper', + task_input={'hashtags': [hashtag], 'resultsLimit': 20}, + memory_mbytes=1024, + ) + apify_tasks.append(apify_task) + + print('Tasks created:', apify_tasks) + + # Create Apify task clients + apify_task_clients = [apify_client.task(task.id) for task in apify_tasks] + + print('Task clients created:', apify_task_clients) + + # Execute Apify tasks + async with asyncio.TaskGroup() as tg: + tasks = [tg.create_task(client.call()) for client in apify_task_clients] + + task_run_results = [task.result() for task in tasks] + + # Filter out None results (tasks that failed to return a run) + successful_runs = [run for run in task_run_results if run is not None] + + print('Task results:', successful_runs) + + +if __name__ == '__main__': + asyncio.run(main()) diff --git a/website/versioned_docs/version-2.5/03_guides/code/02_tasks_sync.py b/website/versioned_docs/version-2.5/03_guides/code/02_tasks_sync.py new file mode 100644 index 00000000..e869727b --- /dev/null +++ b/website/versioned_docs/version-2.5/03_guides/code/02_tasks_sync.py @@ -0,0 +1,40 @@ +from apify_client import ApifyClient + +TOKEN = 'MY-APIFY-TOKEN' +HASHTAGS = ['zebra', 'lion', 'hippo'] + + +def main() -> None: + apify_client = ApifyClient(token=TOKEN) + + # Create Apify tasks + apify_tasks = [] + apify_tasks_client = apify_client.tasks() + + for hashtag in HASHTAGS: + apify_task = apify_tasks_client.create( + name=f'hashtags-{hashtag}', + actor_id='apify/instagram-hashtag-scraper', + task_input={'hashtags': [hashtag], 'resultsLimit': 20}, + memory_mbytes=1024, + ) + apify_tasks.append(apify_task) + + print('Tasks created:', apify_tasks) + + # Create Apify task clients + apify_task_clients = [apify_client.task(task.id) for task in apify_tasks] + + print('Task clients created:', apify_task_clients) + + # Execute Apify tasks + task_run_results = [client.call() for client in apify_task_clients] + + # Filter out None results (tasks that failed to return a run) + successful_runs = [run for run in task_run_results if run is not None] + + print('Task results:', successful_runs) + + +if __name__ == '__main__': + main() diff --git a/website/versioned_docs/version-2.5/03_guides/code/03_retrieve_async.py b/website/versioned_docs/version-2.5/03_guides/code/03_retrieve_async.py new file mode 100644 index 00000000..fc60d068 --- /dev/null +++ b/website/versioned_docs/version-2.5/03_guides/code/03_retrieve_async.py @@ -0,0 +1,33 @@ +import asyncio + +from apify_client import ApifyClientAsync + +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + # Client initialization with the API token + apify_client = ApifyClientAsync(token=TOKEN) + actor_client = apify_client.actor('apify/instagram-hashtag-scraper') + runs_client = actor_client.runs() + + # See pagination to understand how to get more datasets + actor_datasets = await runs_client.list(limit=20) + + datasets_client = apify_client.datasets() + merging_dataset = await datasets_client.get_or_create(name='merge-dataset') + + for dataset_item in actor_datasets.items: + # Dataset items can be handled here. Dataset items can be paginated + dataset_client = apify_client.dataset(dataset_item.id) + dataset_items = await dataset_client.list_items(limit=1000) + + # Items can be pushed to single dataset + merging_dataset_client = apify_client.dataset(merging_dataset.id) + await merging_dataset_client.push_items(dataset_items.items) + + # ... + + +if __name__ == '__main__': + asyncio.run(main()) diff --git a/website/versioned_docs/version-2.5/03_guides/code/03_retrieve_sync.py b/website/versioned_docs/version-2.5/03_guides/code/03_retrieve_sync.py new file mode 100644 index 00000000..24e05e2f --- /dev/null +++ b/website/versioned_docs/version-2.5/03_guides/code/03_retrieve_sync.py @@ -0,0 +1,31 @@ +from apify_client import ApifyClient + +TOKEN = 'MY-APIFY-TOKEN' + + +def main() -> None: + # Client initialization with the API token + apify_client = ApifyClient(token=TOKEN) + actor_client = apify_client.actor('apify/instagram-hashtag-scraper') + runs_client = actor_client.runs() + + # See pagination to understand how to get more datasets + actor_datasets = runs_client.list(limit=20) + + datasets_client = apify_client.datasets() + merging_dataset = datasets_client.get_or_create(name='merge-dataset') + + for dataset_item in actor_datasets.items: + # Dataset items can be handled here. Dataset items can be paginated + dataset_client = apify_client.dataset(dataset_item.id) + dataset_items = dataset_client.list_items(limit=1000) + + # Items can be pushed to single dataset + merging_dataset_client = apify_client.dataset(merging_dataset.id) + merging_dataset_client.push_items(dataset_items.items) + + # ... + + +if __name__ == '__main__': + main() diff --git a/website/versioned_docs/version-2.5/03_guides/code/04_pandas_async.py b/website/versioned_docs/version-2.5/03_guides/code/04_pandas_async.py new file mode 100644 index 00000000..aecc0655 --- /dev/null +++ b/website/versioned_docs/version-2.5/03_guides/code/04_pandas_async.py @@ -0,0 +1,27 @@ +import asyncio + +import pandas as pd + +from apify_client import ApifyClientAsync + +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + # Initialize the Apify client + apify_client = ApifyClientAsync(token=TOKEN) + actor_client = apify_client.actor('apify/web-scraper') + run_client = actor_client.last_run() + dataset_client = run_client.dataset() + + # Load items from last dataset run + dataset_data = await dataset_client.list_items() + + # Pass dataset items to Pandas DataFrame + data_frame = pd.DataFrame(dataset_data.items) + + print(data_frame.info) + + +if __name__ == '__main__': + asyncio.run(main()) diff --git a/website/versioned_docs/version-2.5/03_guides/code/04_pandas_sync.py b/website/versioned_docs/version-2.5/03_guides/code/04_pandas_sync.py new file mode 100644 index 00000000..a42e074f --- /dev/null +++ b/website/versioned_docs/version-2.5/03_guides/code/04_pandas_sync.py @@ -0,0 +1,25 @@ +import pandas as pd + +from apify_client import ApifyClient + +TOKEN = 'MY-APIFY-TOKEN' + + +def main() -> None: + # Initialize the Apify client + apify_client = ApifyClient(token=TOKEN) + actor_client = apify_client.actor('apify/web-scraper') + run_client = actor_client.last_run() + dataset_client = run_client.dataset() + + # Load items from last dataset run + dataset_data = dataset_client.list_items() + + # Pass dataset items to Pandas DataFrame + data_frame = pd.DataFrame(dataset_data.items) + + print(data_frame.info) + + +if __name__ == '__main__': + main() diff --git a/website/versioned_docs/version-2.5/04_upgrading/upgrading_to_v2.md b/website/versioned_docs/version-2.5/04_upgrading/upgrading_to_v2.md new file mode 100644 index 00000000..f34233a8 --- /dev/null +++ b/website/versioned_docs/version-2.5/04_upgrading/upgrading_to_v2.md @@ -0,0 +1,43 @@ +--- +id: upgrading-to-v2 +title: Upgrading to v2 +--- + +This page summarizes the breaking changes between Apify Python API Client v1.x and v2.0. + +## Python version support + +Support for Python 3.9 has been dropped. The Apify Python API Client v2.x now requires Python 3.10 or later. Make sure your environment is running a compatible version before upgrading. + +## New underlying HTTP library + +In v2.0, the Apify Python API client switched from using [`httpx`](https://www.python-httpx.org/) to [`impit`](https://github.com/apify/impit) as the underlying HTTP library. However, this change shouldn't have much impact on the end user. + +## API method changes + +Several public methods have changed their signatures or behavior. + +### Removed parameters and attributes + +- The `parse_response` parameter has been removed from the `HTTPClient.call()` method. This was an internal parameter that added a private attribute to the `Response` object. +- The private `_maybe_parsed_body` attribute has been removed from the `Response` object. + +### KeyValueStoreClient + +- The deprecated parameters `as_bytes` and `as_file` have been removed from `KeyValueStoreClient.get_record()`. Use the dedicated methods `get_record_as_bytes()` and `stream_record()` instead. + +### DatasetClient + +- The `unwind` parameter no longer accepts a single string value. Use a list of strings instead: `unwind=['items']` rather than `unwind='items'`. + +## Module reorganization + +Some modules have been restructured. + +### Constants + +- Deprecated constant re-exports from `consts.py` have been removed. Constants should now be imported from the [apify-shared-python](https://github.com/apify/apify-shared-python) package if needed. + +### Errors + +- Error classes are now accessible from the public `apify_client.errors` module. See the [API documentation](https://docs.apify.com/api/client/python/reference/class/ApifyApiError) for a complete list of available error classes. diff --git a/website/versioned_docs/version-2.5/api-packages.json b/website/versioned_docs/version-2.5/api-packages.json new file mode 100644 index 00000000..61a377ca --- /dev/null +++ b/website/versioned_docs/version-2.5/api-packages.json @@ -0,0 +1,10 @@ +[ + { + "entryPoints": { "index": { "label": "Index", "path": "src/apify_client" } }, + "packageRoot": "..", + "packagePath": ".", + "packageSlug": ".", + "packageName": "apify-client", + "packageVersion": "2.5.0" + } +] diff --git a/website/versioned_docs/version-2.5/api-typedoc.json b/website/versioned_docs/version-2.5/api-typedoc.json new file mode 100644 index 00000000..4d34cfd8 --- /dev/null +++ b/website/versioned_docs/version-2.5/api-typedoc.json @@ -0,0 +1,37978 @@ +{ + "id": 0, + "name": "apify-client", + "kind": 1, + "kindString": "Project", + "flags": {}, + "originalName": "", + "children": [ + { + "id": 1, + "name": "ApifyClientError", + "module": "apify_client.errors", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Base class for errors specific to the Apify API Client." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/errors.py", + "line": 9, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/errors.py#L9" + } + ] + }, + { + "id": 2, + "name": "ApifyApiError", + "module": "apify_client.errors", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Error specific to requests to the Apify API.\n\nAn `ApifyApiError` is thrown for successful HTTP requests that reach the API, but the API responds with\nan error response. Typically, those are rate limit errors and internal errors, which are automatically retried,\nor validation errors, which are thrown immediately, because a correction by the user is needed." + } + ] + }, + "children": [ + { + "id": 3, + "name": "__init__", + "module": "apify_client.errors", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a new instance.\n\nArgs:\n response: The response to the failed API call.\n attempt: Which attempt was the request that failed.\n method: The HTTP method used for the request." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/errors.py", + "line": 21, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/errors.py#L21" + } + ], + "signatures": [ + { + "id": 4, + "name": "__init__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a new instance.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 5, + "name": "response", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "impit.Response" + } + }, + { + "id": 6, + "name": "attempt", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "int" + } + }, + { + "id": 7, + "name": "method", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + }, + "defaultValue": "'GET'" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 3 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/errors.py", + "line": 13, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/errors.py#L13" + } + ] + }, + { + "id": 8, + "name": "InvalidResponseBodyError", + "module": "apify_client.errors", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Error caused by the response body failing to be parsed.\n\nThis error exists for the quite common situation, where only a partial JSON response is received and an attempt\nto parse the JSON throws an error. In most cases this can be resolved by retrying the request. We do that by\nidentifying this error in the HTTPClient." + } + ] + }, + "children": [ + { + "id": 9, + "name": "__init__", + "module": "apify_client.errors", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a new instance.\n\nArgs:\n response: The response which failed to be parsed." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/errors.py", + "line": 65, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/errors.py#L65" + } + ], + "signatures": [ + { + "id": 10, + "name": "__init__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a new instance.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 11, + "name": "response", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "impit.Response" + } + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 9 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/errors.py", + "line": 57, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/errors.py#L57" + } + ] + }, + { + "id": 12, + "name": "WebhookDispatchCollectionClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for listing webhook dispatches." + } + ] + }, + "children": [ + { + "id": 13, + "name": "list", + "module": "apify_client.clients.resource_clients.webhook_dispatch_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List all webhook dispatches of a user.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n\nArgs:\n limit: How many webhook dispatches to retrieve.\n offset: What webhook dispatch to include as first when retrieving the list.\n desc: Whether to sort the webhook dispatches in descending order based on the date of their creation.\n\nReturns:\n The retrieved webhook dispatches of a user." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook_dispatch_collection.py", + "line": 18, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook_dispatch_collection.py#L18" + } + ], + "signatures": [ + { + "id": 14, + "name": "list", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List all webhook dispatches of a user.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 15, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 16, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 17, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 13 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook_dispatch_collection.py", + "line": 11, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook_dispatch_collection.py#L11" + } + ] + }, + { + "id": 18, + "name": "WebhookDispatchCollectionClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for listing webhook dispatches." + } + ] + }, + "children": [ + { + "id": 19, + "name": "list", + "module": "apify_client.clients.resource_clients.webhook_dispatch_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List all webhook dispatches of a user.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n\nArgs:\n limit: How many webhook dispatches to retrieve.\n offset: What webhook dispatch to include as first when retrieving the list.\n desc: Whether to sort the webhook dispatches in descending order based on the date of their creation.\n\nReturns:\n The retrieved webhook dispatches of a user." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook_dispatch_collection.py", + "line": 47, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook_dispatch_collection.py#L47" + } + ], + "signatures": [ + { + "id": 20, + "name": "list", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List all webhook dispatches of a user.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 21, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 22, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 23, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 19 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook_dispatch_collection.py", + "line": 40, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook_dispatch_collection.py#L40" + } + ] + }, + { + "id": 24, + "name": "WebhookDispatchClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for querying information about a webhook dispatch." + } + ] + }, + "children": [ + { + "id": 25, + "name": "get", + "module": "apify_client.clients.resource_clients.webhook_dispatch", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the webhook dispatch.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatch-object/get-webhook-dispatch\n\nReturns:\n The retrieved webhook dispatch, or None if it does not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook_dispatch.py", + "line": 15, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook_dispatch.py#L15" + } + ], + "signatures": [ + { + "id": 26, + "name": "get", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the webhook dispatch.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatch-object/get-webhook-dispatch\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 25 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook_dispatch.py", + "line": 8, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook_dispatch.py#L8" + } + ] + }, + { + "id": 27, + "name": "WebhookDispatchClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for querying information about a webhook dispatch." + } + ] + }, + "children": [ + { + "id": 28, + "name": "get", + "module": "apify_client.clients.resource_clients.webhook_dispatch", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the webhook dispatch.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatch-object/get-webhook-dispatch\n\nReturns:\n The retrieved webhook dispatch, or None if it does not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook_dispatch.py", + "line": 33, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook_dispatch.py#L33" + } + ], + "signatures": [ + { + "id": 29, + "name": "get", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the webhook dispatch.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatch-object/get-webhook-dispatch\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 28 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook_dispatch.py", + "line": 26, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook_dispatch.py#L26" + } + ] + }, + { + "id": 30, + "name": "WebhookCollectionClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating webhooks." + } + ] + }, + "children": [ + { + "id": 31, + "name": "list", + "module": "apify_client.clients.resource_clients.webhook_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available webhooks.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n\nArgs:\n limit: How many webhooks to retrieve.\n offset: What webhook to include as first when retrieving the list.\n desc: Whether to sort the webhooks in descending order based on their date of creation.\n\nReturns:\n The list of available webhooks matching the specified filters." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook_collection.py", + "line": 22, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook_collection.py#L22" + } + ], + "signatures": [ + { + "id": 32, + "name": "list", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available webhooks.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 33, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 34, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 35, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 36, + "name": "create", + "module": "apify_client.clients.resource_clients.webhook_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new webhook.\n\nYou have to specify exactly one out of actor_id, actor_task_id or actor_run_id.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/create-webhook\n\nArgs:\n event_types: List of event types that should trigger the webhook. At least one is required.\n request_url: URL that will be invoked once the webhook is triggered.\n payload_template: Specification of the payload that will be sent to request_url.\n headers_template: Headers that will be sent to the request_url.\n actor_id: Id of the Actor whose runs should trigger the webhook.\n actor_task_id: Id of the Actor task whose runs should trigger the webhook.\n actor_run_id: Id of the Actor run which should trigger the webhook.\n ignore_ssl_errors: Whether the webhook should ignore SSL errors returned by request_url.\n do_not_retry: Whether the webhook should retry sending the payload to request_url upon failure.\n idempotency_key: A unique identifier of a webhook. You can use it to ensure that you won't create\n the same webhook multiple times.\n is_ad_hoc: Set to True if you want the webhook to be triggered only the first time the condition\n is fulfilled. Only applicable when actor_run_id is filled.\n\nReturns:\n The created webhook." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook_collection.py", + "line": 43, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook_collection.py#L43" + } + ], + "signatures": [ + { + "id": 37, + "name": "create", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new webhook.\n\nYou have to specify exactly one out of actor_id, actor_task_id or actor_run_id.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/create-webhook\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 38, + "name": "event_types", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[WebhookEventType]" + } + }, + { + "id": 39, + "name": "request_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 40, + "name": "payload_template", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 41, + "name": "headers_template", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 42, + "name": "actor_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 43, + "name": "actor_task_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 44, + "name": "actor_run_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 45, + "name": "ignore_ssl_errors", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 46, + "name": "do_not_retry", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 47, + "name": "idempotency_key", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 48, + "name": "is_ad_hoc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 36, + 31 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook_collection.py", + "line": 15, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook_collection.py#L15" + } + ] + }, + { + "id": 49, + "name": "WebhookCollectionClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating webhooks." + } + ] + }, + "children": [ + { + "id": 50, + "name": "list", + "module": "apify_client.clients.resource_clients.webhook_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available webhooks.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n\nArgs:\n limit: How many webhooks to retrieve.\n offset: What webhook to include as first when retrieving the list.\n desc: Whether to sort the webhooks in descending order based on their date of creation.\n\nReturns:\n The list of available webhooks matching the specified filters." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook_collection.py", + "line": 106, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook_collection.py#L106" + } + ], + "signatures": [ + { + "id": 51, + "name": "list", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available webhooks.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 52, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 53, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 54, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 55, + "name": "create", + "module": "apify_client.clients.resource_clients.webhook_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new webhook.\n\nYou have to specify exactly one out of actor_id, actor_task_id or actor_run_id.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/create-webhook\n\nArgs:\n event_types: List of event types that should trigger the webhook. At least one is required.\n request_url: URL that will be invoked once the webhook is triggered.\n payload_template: Specification of the payload that will be sent to request_url.\n headers_template: Headers that will be sent to the request_url.\n actor_id: Id of the Actor whose runs should trigger the webhook.\n actor_task_id: Id of the Actor task whose runs should trigger the webhook.\n actor_run_id: Id of the Actor run which should trigger the webhook.\n ignore_ssl_errors: Whether the webhook should ignore SSL errors returned by request_url.\n do_not_retry: Whether the webhook should retry sending the payload to request_url upon failure.\n idempotency_key: A unique identifier of a webhook. You can use it to ensure that you won't create\n the same webhook multiple times.\n is_ad_hoc: Set to True if you want the webhook to be triggered only the first time the condition\n is fulfilled. Only applicable when actor_run_id is filled.\n\nReturns:\n The created webhook." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook_collection.py", + "line": 127, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook_collection.py#L127" + } + ], + "signatures": [ + { + "id": 56, + "name": "create", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new webhook.\n\nYou have to specify exactly one out of actor_id, actor_task_id or actor_run_id.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/create-webhook\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 57, + "name": "event_types", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[WebhookEventType]" + } + }, + { + "id": 58, + "name": "request_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 59, + "name": "payload_template", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 60, + "name": "headers_template", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 61, + "name": "actor_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 62, + "name": "actor_task_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 63, + "name": "actor_run_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 64, + "name": "ignore_ssl_errors", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 65, + "name": "do_not_retry", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 66, + "name": "idempotency_key", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 67, + "name": "is_ad_hoc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 55, + 50 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook_collection.py", + "line": 99, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook_collection.py#L99" + } + ] + }, + { + "id": 68, + "name": "get_webhook_representation", + "module": "apify_client.clients.resource_clients.webhook", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Prepare webhook dictionary representation for clients." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook.py", + "line": 23, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook.py#L23" + } + ], + "signatures": [ + { + "id": 69, + "name": "get_webhook_representation", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Prepare webhook dictionary representation for clients." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 70, + "name": "event_types", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[WebhookEventType] | None" + }, + "defaultValue": "None" + }, + { + "id": 71, + "name": "request_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 72, + "name": "payload_template", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 73, + "name": "headers_template", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 74, + "name": "actor_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 75, + "name": "actor_task_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 76, + "name": "actor_run_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 77, + "name": "ignore_ssl_errors", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 78, + "name": "do_not_retry", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 79, + "name": "idempotency_key", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 80, + "name": "is_ad_hoc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 81, + "name": "WebhookClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating a single webhook." + } + ] + }, + "children": [ + { + "id": 82, + "name": "get", + "module": "apify_client.clients.resource_clients.webhook", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/get-webhook\n\nReturns:\n The retrieved webhook, or None if it does not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook.py", + "line": 69, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook.py#L69" + } + ], + "signatures": [ + { + "id": 83, + "name": "get", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/get-webhook\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 84, + "name": "update", + "module": "apify_client.clients.resource_clients.webhook", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/update-webhook\n\nArgs:\n event_types: List of event types that should trigger the webhook. At least one is required.\n request_url: URL that will be invoked once the webhook is triggered.\n payload_template: Specification of the payload that will be sent to request_url.\n headers_template: Headers that will be sent to the request_url.\n actor_id: Id of the Actor whose runs should trigger the webhook.\n actor_task_id: Id of the Actor task whose runs should trigger the webhook.\n actor_run_id: Id of the Actor run which should trigger the webhook.\n ignore_ssl_errors: Whether the webhook should ignore SSL errors returned by request_url.\n do_not_retry: Whether the webhook should retry sending the payload to request_url upon failure.\n is_ad_hoc: Set to True if you want the webhook to be triggered only the first time the condition\n is fulfilled. Only applicable when actor_run_id is filled.\n\nReturns:\n The updated webhook." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook.py", + "line": 79, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook.py#L79" + } + ], + "signatures": [ + { + "id": 85, + "name": "update", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/update-webhook\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 86, + "name": "event_types", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[WebhookEventType] | None" + }, + "defaultValue": "None" + }, + { + "id": 87, + "name": "request_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 88, + "name": "payload_template", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 89, + "name": "headers_template", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 90, + "name": "actor_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 91, + "name": "actor_task_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 92, + "name": "actor_run_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 93, + "name": "ignore_ssl_errors", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 94, + "name": "do_not_retry", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 95, + "name": "is_ad_hoc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 96, + "name": "delete", + "module": "apify_client.clients.resource_clients.webhook", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/delete-webhook" + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook.py", + "line": 128, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook.py#L128" + } + ], + "signatures": [ + { + "id": 97, + "name": "delete", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/delete-webhook" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] + }, + { + "id": 98, + "name": "test", + "module": "apify_client.clients.resource_clients.webhook", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Test a webhook.\n\nCreates a webhook dispatch with a dummy payload.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook\n\nReturns:\n The webhook dispatch created by the test." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook.py", + "line": 135, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook.py#L135" + } + ], + "signatures": [ + { + "id": 99, + "name": "test", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Test a webhook.\n\nCreates a webhook dispatch with a dummy payload.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 100, + "name": "dispatches", + "module": "apify_client.clients.resource_clients.webhook", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get dispatches of the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection/get-collection\n\nReturns:\n A client allowing access to dispatches of this webhook using its list method." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook.py", + "line": 159, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook.py#L159" + } + ], + "signatures": [ + { + "id": 101, + "name": "dispatches", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get dispatches of the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection/get-collection\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "WebhookDispatchCollectionClient", + "id": 12 + }, + "parameters": [] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 96, + 100, + 82, + 98, + 84 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook.py", + "line": 62, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook.py#L62" + } + ] + }, + { + "id": 102, + "name": "WebhookClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating a single webhook." + } + ] + }, + "children": [ + { + "id": 103, + "name": "get", + "module": "apify_client.clients.resource_clients.webhook", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/get-webhook\n\nReturns:\n The retrieved webhook, or None if it does not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook.py", + "line": 179, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook.py#L179" + } + ], + "signatures": [ + { + "id": 104, + "name": "get", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/get-webhook\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 105, + "name": "update", + "module": "apify_client.clients.resource_clients.webhook", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/update-webhook\n\nArgs:\n event_types: List of event types that should trigger the webhook. At least one is required.\n request_url: URL that will be invoked once the webhook is triggered.\n payload_template: Specification of the payload that will be sent to request_url.\n headers_template: Headers that will be sent to the request_url.\n actor_id: Id of the Actor whose runs should trigger the webhook.\n actor_task_id: Id of the Actor task whose runs should trigger the webhook.\n actor_run_id: Id of the Actor run which should trigger the webhook.\n ignore_ssl_errors: Whether the webhook should ignore SSL errors returned by request_url.\n do_not_retry: Whether the webhook should retry sending the payload to request_url upon failure.\n is_ad_hoc: Set to True if you want the webhook to be triggered only the first time the condition\n is fulfilled. Only applicable when actor_run_id is filled.\n\nReturns:\n The updated webhook." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook.py", + "line": 189, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook.py#L189" + } + ], + "signatures": [ + { + "id": 106, + "name": "update", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/update-webhook\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 107, + "name": "event_types", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[WebhookEventType] | None" + }, + "defaultValue": "None" + }, + { + "id": 108, + "name": "request_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 109, + "name": "payload_template", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 110, + "name": "headers_template", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 111, + "name": "actor_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 112, + "name": "actor_task_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 113, + "name": "actor_run_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 114, + "name": "ignore_ssl_errors", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 115, + "name": "do_not_retry", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 116, + "name": "is_ad_hoc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 117, + "name": "delete", + "module": "apify_client.clients.resource_clients.webhook", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/delete-webhook" + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook.py", + "line": 238, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook.py#L238" + } + ], + "signatures": [ + { + "id": 118, + "name": "delete", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/delete-webhook" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] + }, + { + "id": 119, + "name": "test", + "module": "apify_client.clients.resource_clients.webhook", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Test a webhook.\n\nCreates a webhook dispatch with a dummy payload.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook\n\nReturns:\n The webhook dispatch created by the test." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook.py", + "line": 245, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook.py#L245" + } + ], + "signatures": [ + { + "id": 120, + "name": "test", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Test a webhook.\n\nCreates a webhook dispatch with a dummy payload.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 121, + "name": "dispatches", + "module": "apify_client.clients.resource_clients.webhook", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get dispatches of the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection/get-collection\n\nReturns:\n A client allowing access to dispatches of this webhook using its list method." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook.py", + "line": 269, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook.py#L269" + } + ], + "signatures": [ + { + "id": 122, + "name": "dispatches", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get dispatches of the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection/get-collection\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "WebhookDispatchCollectionClientAsync", + "id": 18 + }, + "parameters": [] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 117, + 121, + 103, + 119, + 105 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook.py", + "line": 172, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook.py#L172" + } + ] + }, + { + "id": 123, + "name": "UserClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for querying user data." + } + ] + }, + "children": [ + { + "id": 124, + "name": "get", + "module": "apify_client.clients.resource_clients.user", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about user account.\n\nYou receive all or only public info based on your token permissions.\n\nhttps://docs.apify.com/api/v2#/reference/users\n\nReturns:\n The retrieved user data, or None if the user does not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/user.py", + "line": 25, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/user.py#L25" + } + ], + "signatures": [ + { + "id": 125, + "name": "get", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about user account.\n\nYou receive all or only public info based on your token permissions.\n\nhttps://docs.apify.com/api/v2#/reference/users\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 126, + "name": "monthly_usage", + "module": "apify_client.clients.resource_clients.user", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return monthly usage of the user account.\n\nThis includes a complete usage summary for the current usage cycle, an overall sum, as well as a daily breakdown\nof usage. It is the same information which is available on the account's Billing page. The information includes\nuse of storage, data transfer, and request queue usage.\n\nhttps://docs.apify.com/api/v2/#/reference/users/monthly-usage\n\nReturns:\n The retrieved request, or None, if it did not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/user.py", + "line": 37, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/user.py#L37" + } + ], + "signatures": [ + { + "id": 127, + "name": "monthly_usage", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return monthly usage of the user account.\n\nThis includes a complete usage summary for the current usage cycle, an overall sum, as well as a daily breakdown\nof usage. It is the same information which is available on the account's Billing page. The information includes\nuse of storage, data transfer, and request queue usage.\n\nhttps://docs.apify.com/api/v2/#/reference/users/monthly-usage\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 128, + "name": "limits", + "module": "apify_client.clients.resource_clients.user", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return a complete summary of the user account's limits.\n\nIt is the same information which is available on the account's Limits page. The returned data includes\nthe current usage cycle, a summary of the account's limits, and the current usage.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n\nReturns:\n The retrieved request, or None, if it did not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/user.py", + "line": 62, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/user.py#L62" + } + ], + "signatures": [ + { + "id": 129, + "name": "limits", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return a complete summary of the user account's limits.\n\nIt is the same information which is available on the account's Limits page. The returned data includes\nthe current usage cycle, a summary of the account's limits, and the current usage.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 130, + "name": "update_limits", + "module": "apify_client.clients.resource_clients.user", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the account's limits manageable on your account's Limits page." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/user.py", + "line": 86, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/user.py#L86" + } + ], + "signatures": [ + { + "id": 131, + "name": "update_limits", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the account's limits manageable on your account's Limits page." + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 132, + "name": "max_monthly_usage_usd", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 133, + "name": "data_retention_days", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 124, + 128, + 126, + 130 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/user.py", + "line": 15, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/user.py#L15" + } + ] + }, + { + "id": 134, + "name": "UserClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for querying user data." + } + ] + }, + "children": [ + { + "id": 135, + "name": "get", + "module": "apify_client.clients.resource_clients.user", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about user account.\n\nYou receive all or only public info based on your token permissions.\n\nhttps://docs.apify.com/api/v2#/reference/users\n\nReturns:\n The retrieved user data, or None if the user does not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/user.py", + "line": 116, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/user.py#L116" + } + ], + "signatures": [ + { + "id": 136, + "name": "get", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about user account.\n\nYou receive all or only public info based on your token permissions.\n\nhttps://docs.apify.com/api/v2#/reference/users\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 137, + "name": "monthly_usage", + "module": "apify_client.clients.resource_clients.user", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return monthly usage of the user account.\n\nThis includes a complete usage summary for the current usage cycle, an overall sum, as well as a daily breakdown\nof usage. It is the same information which is available on the account's Billing page. The information includes\nuse of storage, data transfer, and request queue usage.\n\nhttps://docs.apify.com/api/v2/#/reference/users/monthly-usage\n\nReturns:\n The retrieved request, or None, if it did not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/user.py", + "line": 128, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/user.py#L128" + } + ], + "signatures": [ + { + "id": 138, + "name": "monthly_usage", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return monthly usage of the user account.\n\nThis includes a complete usage summary for the current usage cycle, an overall sum, as well as a daily breakdown\nof usage. It is the same information which is available on the account's Billing page. The information includes\nuse of storage, data transfer, and request queue usage.\n\nhttps://docs.apify.com/api/v2/#/reference/users/monthly-usage\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 139, + "name": "limits", + "module": "apify_client.clients.resource_clients.user", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return a complete summary of the user account's limits.\n\nIt is the same information which is available on the account's Limits page. The returned data includes\nthe current usage cycle, a summary of the account's limits, and the current usage.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n\nReturns:\n The retrieved request, or None, if it did not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/user.py", + "line": 153, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/user.py#L153" + } + ], + "signatures": [ + { + "id": 140, + "name": "limits", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return a complete summary of the user account's limits.\n\nIt is the same information which is available on the account's Limits page. The returned data includes\nthe current usage cycle, a summary of the account's limits, and the current usage.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 141, + "name": "update_limits", + "module": "apify_client.clients.resource_clients.user", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the account's limits manageable on your account's Limits page." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/user.py", + "line": 177, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/user.py#L177" + } + ], + "signatures": [ + { + "id": 142, + "name": "update_limits", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the account's limits manageable on your account's Limits page." + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 143, + "name": "max_monthly_usage_usd", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 144, + "name": "data_retention_days", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 135, + 139, + 137, + 141 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/user.py", + "line": 106, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/user.py#L106" + } + ] + }, + { + "id": 145, + "name": "TaskCollectionClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating tasks." + } + ] + }, + "children": [ + { + "id": 146, + "name": "list", + "module": "apify_client.clients.resource_clients.task_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available tasks.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n\nArgs:\n limit: How many tasks to list.\n offset: What task to include as first when retrieving the list.\n desc: Whether to sort the tasks in descending order based on their creation date.\n\nReturns:\n The list of available tasks matching the specified filters." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/task_collection.py", + "line": 20, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task_collection.py#L20" + } + ], + "signatures": [ + { + "id": 147, + "name": "list", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available tasks.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 148, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 149, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 150, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 151, + "name": "create", + "module": "apify_client.clients.resource_clients.task_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/create-task\n\nArgs:\n actor_id: Id of the Actor that should be run.\n name: Name of the task.\n build: Actor build to run. It can be either a build tag or build number. By default, the run uses\n the build specified in the task settings (typically latest).\n memory_mbytes: Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\n in the task settings.\n max_items: Maximum number of results that will be returned by runs of this task. If the Actor of this task\n is charged per result, you will not be charged for more results than the given limit.\n timeout_secs: Optional timeout for the run, in seconds. By default, the run uses timeout specified\n in the task settings.\n restart_on_error: If true, the Task run process will be restarted whenever it exits with\n a non-zero status code.\n task_input: Task input object.\n title: A human-friendly equivalent of the name.\n actor_standby_desired_requests_per_actor_run: The desired number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_max_requests_per_actor_run: The maximum number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_idle_timeout_secs: If the Actor run does not receive any requests for this time,\n it will be shut down.\n actor_standby_build: The build tag or number to run when the Actor is in Standby mode.\n actor_standby_memory_mbytes: The memory in megabytes to use when the Actor is in Standby mode.\n\nReturns:\n The created task." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/task_collection.py", + "line": 41, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task_collection.py#L41" + } + ], + "signatures": [ + { + "id": 152, + "name": "create", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/create-task\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 153, + "name": "actor_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 154, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 155, + "name": "build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 156, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 157, + "name": "memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 158, + "name": "max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 159, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 160, + "name": "task_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + }, + { + "id": 161, + "name": "title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 162, + "name": "actor_standby_desired_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 163, + "name": "actor_standby_max_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 164, + "name": "actor_standby_idle_timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 165, + "name": "actor_standby_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 166, + "name": "actor_standby_memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 151, + 146 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/task_collection.py", + "line": 13, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task_collection.py#L13" + } + ] + }, + { + "id": 167, + "name": "TaskCollectionClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating tasks." + } + ] + }, + "children": [ + { + "id": 168, + "name": "list", + "module": "apify_client.clients.resource_clients.task_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available tasks.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n\nArgs:\n limit: How many tasks to list.\n offset: What task to include as first when retrieving the list.\n desc: Whether to sort the tasks in descending order based on their creation date.\n\nReturns:\n The list of available tasks matching the specified filters." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/task_collection.py", + "line": 117, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task_collection.py#L117" + } + ], + "signatures": [ + { + "id": 169, + "name": "list", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available tasks.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 170, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 171, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 172, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 173, + "name": "create", + "module": "apify_client.clients.resource_clients.task_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/create-task\n\nArgs:\n actor_id: Id of the Actor that should be run.\n name: Name of the task.\n build: Actor build to run. It can be either a build tag or build number. By default, the run uses\n the build specified in the task settings (typically latest).\n memory_mbytes: Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\n in the task settings.\n max_items: Maximum number of results that will be returned by runs of this task. If the Actor of this task\n is charged per result, you will not be charged for more results than the given limit.\n timeout_secs: Optional timeout for the run, in seconds. By default, the run uses timeout specified\n in the task settings.\n restart_on_error: If true, the Task run process will be restarted whenever it exits with\n a non-zero status code.\n task_input: Task input object.\n title: A human-friendly equivalent of the name.\n actor_standby_desired_requests_per_actor_run: The desired number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_max_requests_per_actor_run: The maximum number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_idle_timeout_secs: If the Actor run does not receive any requests for this time,\n it will be shut down.\n actor_standby_build: The build tag or number to run when the Actor is in Standby mode.\n actor_standby_memory_mbytes: The memory in megabytes to use when the Actor is in Standby mode.\n\nReturns:\n The created task." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/task_collection.py", + "line": 138, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task_collection.py#L138" + } + ], + "signatures": [ + { + "id": 174, + "name": "create", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/create-task\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 175, + "name": "actor_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 176, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 177, + "name": "build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 178, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 179, + "name": "memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 180, + "name": "max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 181, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 182, + "name": "task_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + }, + { + "id": 183, + "name": "title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 184, + "name": "actor_standby_desired_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 185, + "name": "actor_standby_max_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 186, + "name": "actor_standby_idle_timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 187, + "name": "actor_standby_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 188, + "name": "actor_standby_memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 173, + 168 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/task_collection.py", + "line": 110, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task_collection.py#L110" + } + ] + }, + { + "id": 189, + "name": "get_task_representation", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the dictionary representation of a task." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 26, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L26" + } + ], + "signatures": [ + { + "id": 190, + "name": "get_task_representation", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the dictionary representation of a task." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 191, + "name": "actor_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 192, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 193, + "name": "task_input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + }, + { + "id": 194, + "name": "build", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 195, + "name": "max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 196, + "name": "memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 197, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 198, + "name": "title", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 199, + "name": "actor_standby_desired_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 200, + "name": "actor_standby_max_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 201, + "name": "actor_standby_idle_timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 202, + "name": "actor_standby_build", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 203, + "name": "actor_standby_memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 204, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 205, + "name": "TaskClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating a single task." + } + ] + }, + "children": [ + { + "id": 206, + "name": "get", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/get-task\n\nReturns:\n The retrieved task." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 73, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L73" + } + ], + "signatures": [ + { + "id": 207, + "name": "get", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/get-task\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 208, + "name": "update", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the task with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/update-task\n\nArgs:\n name: Name of the task.\n build: Actor build to run. It can be either a build tag or build number. By default, the run uses\n the build specified in the task settings (typically latest).\n max_items: Maximum number of results that will be returned by this run. If the Actor is charged per result,\n you will not be charged for more results than the given limit.\n memory_mbytes: Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\n in the task settings.\n timeout_secs: Optional timeout for the run, in seconds. By default, the run uses timeout specified\n in the task settings.\n restart_on_error: If true, the Task run process will be restarted whenever it exits with\n a non-zero status code.\n task_input: Task input dictionary.\n title: A human-friendly equivalent of the name.\n actor_standby_desired_requests_per_actor_run: The desired number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_max_requests_per_actor_run: The maximum number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_idle_timeout_secs: If the Actor run does not receive any requests for this time,\n it will be shut down.\n actor_standby_build: The build tag or number to run when the Actor is in Standby mode.\n actor_standby_memory_mbytes: The memory in megabytes to use when the Actor is in Standby mode.\n\nReturns:\n The updated task." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 83, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L83" + } + ], + "signatures": [ + { + "id": 209, + "name": "update", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the task with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/update-task\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 210, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 211, + "name": "task_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + }, + { + "id": 212, + "name": "build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 213, + "name": "max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 214, + "name": "memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 215, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 216, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 217, + "name": "title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 218, + "name": "actor_standby_desired_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 219, + "name": "actor_standby_max_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 220, + "name": "actor_standby_idle_timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 221, + "name": "actor_standby_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 222, + "name": "actor_standby_memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 223, + "name": "delete", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task" + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 148, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L148" + } + ], + "signatures": [ + { + "id": 224, + "name": "delete", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] + }, + { + "id": 225, + "name": "start", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the task and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n\nArgs:\n task_input: Task input dictionary.\n build: Specifies the Actor build to run. It can be either a build tag or build number. By default,\n the run uses the build specified in the task settings (typically latest).\n max_items: Maximum number of results that will be returned by this run. If the Actor is charged\n per result, you will not be charged for more results than the given limit.\n memory_mbytes: Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\n in the task settings.\n timeout_secs: Optional timeout for the run, in seconds. By default, the run uses timeout specified\n in the task settings.\n restart_on_error: If true, the Task run process will be restarted whenever it exits with\n a non-zero status code.\n wait_for_finish: The maximum number of seconds the server waits for the run to finish. By default,\n it is 0, the maximum value is 60.\n webhooks: Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\n the Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\n If you already have a webhook set up for the Actor or task, you do not have to add it again here.\n Each webhook is represented by a dictionary containing these items:\n * `event_types`: List of ``WebhookEventType`` values which trigger the webhook.\n * `request_url`: URL to which to send the webhook HTTP request.\n * `payload_template`: Optional template for the request payload.\n\nReturns:\n The run object." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 155, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L155" + } + ], + "signatures": [ + { + "id": 226, + "name": "start", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the task and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 227, + "name": "task_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + }, + { + "id": 228, + "name": "build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 229, + "name": "max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 230, + "name": "memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 231, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 232, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 233, + "name": "wait_for_finish", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 234, + "name": "webhooks", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 235, + "name": "call", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start a task and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_secs argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n\nArgs:\n task_input: Task input dictionary.\n build: Specifies the Actor build to run. It can be either a build tag or build number. By default,\n the run uses the build specified in the task settings (typically latest).\n max_items: Maximum number of results that will be returned by this run. If the Actor is charged per result,\n you will not be charged for more results than the given limit.\n memory_mbytes: Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\n in the task settings.\n timeout_secs: Optional timeout for the run, in seconds. By default, the run uses timeout specified\n in the task settings.\n restart_on_error: If true, the Task run process will be restarted whenever it exits with\n a non-zero status code.\n webhooks: Specifies optional webhooks associated with the Actor run, which can be used to receive\n a notification e.g. when the Actor finished or failed. Note: if you already have a webhook set up for\n the Actor or task, you do not have to add it again here.\n wait_secs: The maximum number of seconds the server waits for the task run to finish. If not provided,\n waits indefinitely.\n\nReturns:\n The run object." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 216, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L216" + } + ], + "signatures": [ + { + "id": 236, + "name": "call", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start a task and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_secs argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [ + { + "id": 237, + "name": "task_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + }, + { + "id": 238, + "name": "build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 239, + "name": "max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 240, + "name": "memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 241, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 242, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 243, + "name": "webhooks", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 244, + "name": "wait_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 245, + "name": "get_input", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/get-task-input\n\nReturns:\n Retrieved task input." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 267, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L267" + } + ], + "signatures": [ + { + "id": 246, + "name": "get_input", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/get-task-input\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 247, + "name": "update_input", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/update-task-input\n\nReturns:\n Retrieved task input." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 286, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L286" + } + ], + "signatures": [ + { + "id": 248, + "name": "update_input", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/update-task-input\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 249, + "name": "task_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "dict" + } + } + ] + } + ] + }, + { + "id": 250, + "name": "runs", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the runs of this task." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 302, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L302" + } + ], + "signatures": [ + { + "id": 251, + "name": "runs", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the runs of this task." + } + ] + }, + "type": { + "type": "reference", + "name": "RunCollectionClient", + "id": 397 + }, + "parameters": [] + } + ] + }, + { + "id": 252, + "name": "last_run", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the last run of this task.\n\nLast run is retrieved based on the start time of the runs.\n\nArgs:\n status: Consider only runs with this status.\n origin: Consider only runs started with this origin.\n\nReturns:\n The resource client for the last run of this task." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 306, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L306" + } + ], + "signatures": [ + { + "id": 253, + "name": "last_run", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the last run of this task.\n\nLast run is retrieved based on the start time of the runs.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "RunClient", + "id": 415 + }, + "parameters": [ + { + "id": 254, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorJobStatus | None" + }, + "defaultValue": "None" + }, + { + "id": 255, + "name": "origin", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "MetaOrigin | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 256, + "name": "webhooks", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for webhooks associated with this task." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 329, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L329" + } + ], + "signatures": [ + { + "id": 257, + "name": "webhooks", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for webhooks associated with this task." + } + ] + }, + "type": { + "type": "reference", + "name": "WebhookCollectionClient", + "id": 30 + }, + "parameters": [] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 235, + 223, + 206, + 245, + 252, + 250, + 225, + 208, + 247, + 256 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 66, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L66" + } + ] + }, + { + "id": 258, + "name": "TaskClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating a single task." + } + ] + }, + "children": [ + { + "id": 259, + "name": "get", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/get-task\n\nReturns:\n The retrieved task." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 341, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L341" + } + ], + "signatures": [ + { + "id": 260, + "name": "get", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/get-task\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 261, + "name": "update", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the task with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/update-task\n\nArgs:\n name: Name of the task.\n build: Actor build to run. It can be either a build tag or build number. By default, the run uses\n the build specified in the task settings (typically latest).\n max_items: Maximum number of results that will be returned by this run. If the Actor is charged per result,\n you will not be charged for more results than the given limit.\n memory_mbytes: Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\n in the task settings.\n timeout_secs: Optional timeout for the run, in seconds. By default, the run uses timeout specified\n in the task settings.\n restart_on_error: If true, the Task run process will be restarted whenever it exits with\n a non-zero status code.\n task_input: Task input dictionary.\n title: A human-friendly equivalent of the name.\n actor_standby_desired_requests_per_actor_run: The desired number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_max_requests_per_actor_run: The maximum number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_idle_timeout_secs: If the Actor run does not receive any requests for this time,\n it will be shut down.\n actor_standby_build: The build tag or number to run when the Actor is in Standby mode.\n actor_standby_memory_mbytes: The memory in megabytes to use when the Actor is in Standby mode.\n\nReturns:\n The updated task." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 351, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L351" + } + ], + "signatures": [ + { + "id": 262, + "name": "update", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the task with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/update-task\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 263, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 264, + "name": "task_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + }, + { + "id": 265, + "name": "build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 266, + "name": "max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 267, + "name": "memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 268, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 269, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 270, + "name": "title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 271, + "name": "actor_standby_desired_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 272, + "name": "actor_standby_max_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 273, + "name": "actor_standby_idle_timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 274, + "name": "actor_standby_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 275, + "name": "actor_standby_memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 276, + "name": "delete", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task" + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 416, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L416" + } + ], + "signatures": [ + { + "id": 277, + "name": "delete", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] + }, + { + "id": 278, + "name": "start", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the task and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n\nArgs:\n task_input: Task input dictionary.\n build: Specifies the Actor build to run. It can be either a build tag or build number. By default,\n the run uses the build specified in the task settings (typically latest).\n max_items: Maximum number of results that will be returned by this run. If the Actor is charged\n per result, you will not be charged for more results than the given limit.\n memory_mbytes: Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\n in the task settings.\n timeout_secs: Optional timeout for the run, in seconds. By default, the run uses timeout specified\n in the task settings.\n restart_on_error: If true, the Task run process will be restarted whenever it exits with\n a non-zero status code.\n wait_for_finish: The maximum number of seconds the server waits for the run to finish. By default,\n it is 0, the maximum value is 60.\n webhooks: Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\n the Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\n If you already have a webhook set up for the Actor or task, you do not have to add it again here.\n Each webhook is represented by a dictionary containing these items:\n * `event_types`: List of ``WebhookEventType`` values which trigger the webhook.\n * `request_url`: URL to which to send the webhook HTTP request.\n * `payload_template`: Optional template for the request payload.\n\nReturns:\n The run object." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 423, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L423" + } + ], + "signatures": [ + { + "id": 279, + "name": "start", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the task and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 280, + "name": "task_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + }, + { + "id": 281, + "name": "build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 282, + "name": "max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 283, + "name": "memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 284, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 285, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 286, + "name": "wait_for_finish", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 287, + "name": "webhooks", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 288, + "name": "call", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start a task and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_secs argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n\nArgs:\n task_input: Task input dictionary.\n build: Specifies the Actor build to run. It can be either a build tag or build number. By default,\n the run uses the build specified in the task settings (typically latest).\n max_items: Maximum number of results that will be returned by this run. If the Actor is charged per result,\n you will not be charged for more results than the given limit.\n memory_mbytes: Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\n in the task settings.\n timeout_secs: Optional timeout for the run, in seconds. By default, the run uses timeout specified\n in the task settings.\n restart_on_error: If true, the Task run process will be restarted whenever it exits with\n a non-zero status code.\n webhooks: Specifies optional webhooks associated with the Actor run, which can be used to receive\n a notification e.g. when the Actor finished or failed. Note: if you already have a webhook set up for\n the Actor or task, you do not have to add it again here.\n wait_secs: The maximum number of seconds the server waits for the task run to finish. If not provided,\n waits indefinitely.\n\nReturns:\n The run object." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 484, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L484" + } + ], + "signatures": [ + { + "id": 289, + "name": "call", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start a task and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_secs argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [ + { + "id": 290, + "name": "task_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + }, + { + "id": 291, + "name": "build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 292, + "name": "max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 293, + "name": "memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 294, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 295, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 296, + "name": "webhooks", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 297, + "name": "wait_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 298, + "name": "get_input", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/get-task-input\n\nReturns:\n Retrieved task input." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 535, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L535" + } + ], + "signatures": [ + { + "id": 299, + "name": "get_input", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/get-task-input\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 300, + "name": "update_input", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/update-task-input\n\nReturns:\n Retrieved task input." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 554, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L554" + } + ], + "signatures": [ + { + "id": 301, + "name": "update_input", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/update-task-input\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 302, + "name": "task_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "dict" + } + } + ] + } + ] + }, + { + "id": 303, + "name": "runs", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the runs of this task." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 570, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L570" + } + ], + "signatures": [ + { + "id": 304, + "name": "runs", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the runs of this task." + } + ] + }, + "type": { + "type": "reference", + "name": "RunCollectionClientAsync", + "id": 406 + }, + "parameters": [] + } + ] + }, + { + "id": 305, + "name": "last_run", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the last run of this task.\n\nLast run is retrieved based on the start time of the runs.\n\nArgs:\n status: Consider only runs with this status.\n origin: Consider only runs started with this origin.\n\nReturns:\n The resource client for the last run of this task." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 574, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L574" + } + ], + "signatures": [ + { + "id": 306, + "name": "last_run", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the last run of this task.\n\nLast run is retrieved based on the start time of the runs.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "RunClientAsync", + "id": 468 + }, + "parameters": [ + { + "id": 307, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorJobStatus | None" + }, + "defaultValue": "None" + }, + { + "id": 308, + "name": "origin", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "MetaOrigin | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 309, + "name": "webhooks", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for webhooks associated with this task." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 597, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L597" + } + ], + "signatures": [ + { + "id": 310, + "name": "webhooks", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for webhooks associated with this task." + } + ] + }, + "type": { + "type": "reference", + "name": "WebhookCollectionClientAsync", + "id": 49 + }, + "parameters": [] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 288, + 276, + 259, + 298, + 305, + 303, + 278, + 261, + 300, + 309 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 334, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L334" + } + ] + }, + { + "id": 311, + "name": "StoreCollectionClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for Apify store." + } + ] + }, + "children": [ + { + "id": 312, + "name": "list", + "module": "apify_client.clients.resource_clients.store_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List Actors in Apify store.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n\nArgs:\n limit: How many Actors to list.\n offset: What Actor to include as first when retrieving the list.\n search: String to search by. The search runs on the following fields: title, name, description, username,\n readme.\n sort_by: Specifies the field by which to sort the results.\n category: Filter by this category.\n username: Filter by this username.\n pricing_model: Filter by this pricing model.\n\nReturns:\n The list of available tasks matching the specified filters." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/store_collection.py", + "line": 18, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/store_collection.py#L18" + } + ], + "signatures": [ + { + "id": 313, + "name": "list", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List Actors in Apify store.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 314, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 315, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 316, + "name": "search", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 317, + "name": "sort_by", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 318, + "name": "category", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 319, + "name": "username", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 320, + "name": "pricing_model", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 312 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/store_collection.py", + "line": 11, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/store_collection.py#L11" + } + ] + }, + { + "id": 321, + "name": "StoreCollectionClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for Apify store." + } + ] + }, + "children": [ + { + "id": 322, + "name": "list", + "module": "apify_client.clients.resource_clients.store_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List Actors in Apify store.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n\nArgs:\n limit: How many Actors to list.\n offset: What Actor to include as first when retrieving the list.\n search: String to search by. The search runs on the following fields: title, name, description, username,\n readme.\n sort_by: Specifies the field by which to sort the results.\n category: Filter by this category.\n username: Filter by this username.\n pricing_model: Filter by this pricing model.\n\nReturns:\n The list of available tasks matching the specified filters." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/store_collection.py", + "line": 64, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/store_collection.py#L64" + } + ], + "signatures": [ + { + "id": 323, + "name": "list", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List Actors in Apify store.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 324, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 325, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 326, + "name": "search", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 327, + "name": "sort_by", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 328, + "name": "category", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 329, + "name": "username", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 330, + "name": "pricing_model", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 322 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/store_collection.py", + "line": 57, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/store_collection.py#L57" + } + ] + }, + { + "id": 331, + "name": "ScheduleCollectionClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating schedules." + } + ] + }, + "children": [ + { + "id": 332, + "name": "list", + "module": "apify_client.clients.resource_clients.schedule_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available schedules.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n\nArgs:\n limit: How many schedules to retrieve.\n offset: What schedules to include as first when retrieving the list.\n desc: Whether to sort the schedules in descending order based on their modification date.\n\nReturns:\n The list of available schedules matching the specified filters." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/schedule_collection.py", + "line": 20, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule_collection.py#L20" + } + ], + "signatures": [ + { + "id": 333, + "name": "list", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available schedules.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 334, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 335, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 336, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 337, + "name": "create", + "module": "apify_client.clients.resource_clients.schedule_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule\n\nArgs:\n cron_expression: The cron expression used by this schedule.\n is_enabled: True if the schedule should be enabled.\n is_exclusive: When set to true, don't start Actor or Actor task if it's still running from the previous\n schedule.\n name: The name of the schedule to create.\n actions: Actors or tasks that should be run on this schedule. See the API documentation for exact structure.\n description: Description of this schedule.\n timezone: Timezone in which your cron expression runs (TZ database name from\n https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).\n title: Title of this schedule.\n\nReturns:\n The created schedule." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/schedule_collection.py", + "line": 41, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule_collection.py#L41" + } + ], + "signatures": [ + { + "id": 338, + "name": "create", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 339, + "name": "cron_expression", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 340, + "name": "is_enabled", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "bool" + } + }, + { + "id": 341, + "name": "is_exclusive", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "bool" + } + }, + { + "id": 342, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 343, + "name": "actions", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 344, + "name": "description", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 345, + "name": "timezone", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 346, + "name": "title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 337, + 332 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/schedule_collection.py", + "line": 13, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule_collection.py#L13" + } + ] + }, + { + "id": 347, + "name": "ScheduleCollectionClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating schedules." + } + ] + }, + "children": [ + { + "id": 348, + "name": "list", + "module": "apify_client.clients.resource_clients.schedule_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available schedules.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n\nArgs:\n limit: How many schedules to retrieve.\n offset: What schedules to include as first when retrieving the list.\n desc: Whether to sort the schedules in descending order based on their modification date.\n\nReturns:\n The list of available schedules matching the specified filters." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/schedule_collection.py", + "line": 96, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule_collection.py#L96" + } + ], + "signatures": [ + { + "id": 349, + "name": "list", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available schedules.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 350, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 351, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 352, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 353, + "name": "create", + "module": "apify_client.clients.resource_clients.schedule_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule\n\nArgs:\n cron_expression: The cron expression used by this schedule.\n is_enabled: True if the schedule should be enabled.\n is_exclusive: When set to true, don't start Actor or Actor task if it's still running from the previous\n schedule.\n name: The name of the schedule to create.\n actions: Actors or tasks that should be run on this schedule. See the API documentation for exact structure.\n description: Description of this schedule.\n timezone: Timezone in which your cron expression runs (TZ database name from\n https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).\n title: Title of this schedule.\n\nReturns:\n The created schedule." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/schedule_collection.py", + "line": 117, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule_collection.py#L117" + } + ], + "signatures": [ + { + "id": 354, + "name": "create", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 355, + "name": "cron_expression", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 356, + "name": "is_enabled", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "bool" + } + }, + { + "id": 357, + "name": "is_exclusive", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "bool" + } + }, + { + "id": 358, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 359, + "name": "actions", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 360, + "name": "description", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 361, + "name": "timezone", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 362, + "name": "title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 353, + 348 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/schedule_collection.py", + "line": 89, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule_collection.py#L89" + } + ] + }, + { + "id": 363, + "name": "ScheduleClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating a single schedule." + } + ] + }, + "children": [ + { + "id": 364, + "name": "get", + "module": "apify_client.clients.resource_clients.schedule", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/get-schedule\n\nReturns:\n The retrieved schedule." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/schedule.py", + "line": 40, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule.py#L40" + } + ], + "signatures": [ + { + "id": 365, + "name": "get", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/get-schedule\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 366, + "name": "update", + "module": "apify_client.clients.resource_clients.schedule", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the schedule with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/update-schedule\n\nArgs:\n cron_expression: The cron expression used by this schedule.\n is_enabled: True if the schedule should be enabled.\n is_exclusive: When set to true, don't start Actor or Actor task if it's still running from the previous\n schedule.\n name: The name of the schedule to create.\n actions: Actors or tasks that should be run on this schedule. See the API documentation for exact structure.\n description: Description of this schedule.\n timezone: Timezone in which your cron expression runs (TZ database name from\n https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).\n title: A human-friendly equivalent of the name.\n\nReturns:\n The updated schedule." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/schedule.py", + "line": 50, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule.py#L50" + } + ], + "signatures": [ + { + "id": 367, + "name": "update", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the schedule with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/update-schedule\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 368, + "name": "cron_expression", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 369, + "name": "is_enabled", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 370, + "name": "is_exclusive", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 371, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 372, + "name": "actions", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 373, + "name": "description", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 374, + "name": "timezone", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 375, + "name": "title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 376, + "name": "delete", + "module": "apify_client.clients.resource_clients.schedule", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule" + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/schedule.py", + "line": 94, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule.py#L94" + } + ], + "signatures": [ + { + "id": 377, + "name": "delete", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] + }, + { + "id": 378, + "name": "get_log", + "module": "apify_client.clients.resource_clients.schedule", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return log for the given schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-log/get-schedule-log\n\nReturns:\n Retrieved log of the given schedule." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/schedule.py", + "line": 101, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule.py#L101" + } + ], + "signatures": [ + { + "id": 379, + "name": "get_log", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return log for the given schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-log/get-schedule-log\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "list | None" + }, + "parameters": [] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 376, + 364, + 378, + 366 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/schedule.py", + "line": 33, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule.py#L33" + } + ] + }, + { + "id": 380, + "name": "ScheduleClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating a single schedule." + } + ] + }, + "children": [ + { + "id": 381, + "name": "get", + "module": "apify_client.clients.resource_clients.schedule", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/get-schedule\n\nReturns:\n The retrieved schedule." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/schedule.py", + "line": 129, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule.py#L129" + } + ], + "signatures": [ + { + "id": 382, + "name": "get", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/get-schedule\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 383, + "name": "update", + "module": "apify_client.clients.resource_clients.schedule", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the schedule with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/update-schedule\n\nArgs:\n cron_expression: The cron expression used by this schedule.\n is_enabled: True if the schedule should be enabled.\n is_exclusive: When set to true, don't start Actor or Actor task if it's still running from the previous\n schedule.\n name: The name of the schedule to create.\n actions: Actors or tasks that should be run on this schedule. See the API documentation for exact structure.\n description: Description of this schedule.\n timezone: Timezone in which your cron expression runs (TZ database name from\n https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).\n title: A human-friendly equivalent of the name.\n\nReturns:\n The updated schedule." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/schedule.py", + "line": 139, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule.py#L139" + } + ], + "signatures": [ + { + "id": 384, + "name": "update", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the schedule with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/update-schedule\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 385, + "name": "cron_expression", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 386, + "name": "is_enabled", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 387, + "name": "is_exclusive", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 388, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 389, + "name": "actions", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 390, + "name": "description", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 391, + "name": "timezone", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 392, + "name": "title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 393, + "name": "delete", + "module": "apify_client.clients.resource_clients.schedule", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule" + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/schedule.py", + "line": 183, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule.py#L183" + } + ], + "signatures": [ + { + "id": 394, + "name": "delete", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] + }, + { + "id": 395, + "name": "get_log", + "module": "apify_client.clients.resource_clients.schedule", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return log for the given schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-log/get-schedule-log\n\nReturns:\n Retrieved log of the given schedule." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/schedule.py", + "line": 190, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule.py#L190" + } + ], + "signatures": [ + { + "id": 396, + "name": "get_log", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return log for the given schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-log/get-schedule-log\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "list | None" + }, + "parameters": [] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 393, + 381, + 395, + 383 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/schedule.py", + "line": 122, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule.py#L122" + } + ] + }, + { + "id": 397, + "name": "RunCollectionClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for listing Actor runs." + } + ] + }, + "children": [ + { + "id": 398, + "name": "list", + "module": "apify_client.clients.resource_clients.run_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List all Actor runs.\n\nList all Actor runs, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n\nArgs:\n limit: How many runs to retrieve.\n offset: What run to include as first when retrieving the list.\n desc: Whether to sort the runs in descending order based on their start date.\n status: Retrieve only runs with the provided statuses.\n started_before: Only return runs started before this date (inclusive).\n started_after: Only return runs started after this date (inclusive).\n\nReturns:\n The retrieved Actor runs." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run_collection.py", + "line": 23, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run_collection.py#L23" + } + ], + "signatures": [ + { + "id": 399, + "name": "list", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List all Actor runs.\n\nList all Actor runs, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 400, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 401, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 402, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 403, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorJobStatus | list[ActorJobStatus] | None" + }, + "defaultValue": "None" + }, + { + "id": 404, + "name": "started_before", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | datetime | None" + }, + "defaultValue": "None" + }, + { + "id": 405, + "name": "started_after", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | datetime | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 398 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run_collection.py", + "line": 16, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run_collection.py#L16" + } + ] + }, + { + "id": 406, + "name": "RunCollectionClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for listing Actor runs." + } + ] + }, + "children": [ + { + "id": 407, + "name": "list", + "module": "apify_client.clients.resource_clients.run_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List all Actor runs.\n\nList all Actor runs, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n\nArgs:\n limit: How many runs to retrieve.\n offset: What run to include as first when retrieving the list.\n desc: Whether to sort the runs in descending order based on their start date.\n status: Retrieve only runs with the provided statuses.\n started_before: Only return runs started before this date (inclusive).\n started_after: Only return runs started after this date (inclusive).\n\nReturns:\n The retrieved Actor runs." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run_collection.py", + "line": 74, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run_collection.py#L74" + } + ], + "signatures": [ + { + "id": 408, + "name": "list", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List all Actor runs.\n\nList all Actor runs, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 409, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 410, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 411, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 412, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorJobStatus | list[ActorJobStatus] | None" + }, + "defaultValue": "None" + }, + { + "id": 413, + "name": "started_before", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | datetime | None" + }, + "defaultValue": "None" + }, + { + "id": 414, + "name": "started_after", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | datetime | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 407 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run_collection.py", + "line": 67, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run_collection.py#L67" + } + ] + }, + { + "id": 415, + "name": "RunClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating a single Actor run." + } + ] + }, + "children": [ + { + "id": 416, + "name": "get", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/get-run\n\nReturns:\n The retrieved Actor run data." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 46, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L46" + } + ], + "signatures": [ + { + "id": 417, + "name": "get", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/get-run\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 418, + "name": "update", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the run with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/update-run\n\nArgs:\n status_message: The new status message for the run.\n is_status_message_terminal: Set this flag to True if this is the final status message of the Actor run.\n general_access: Determines how others can access the run and its storages.\n\nReturns:\n The updated run." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 56, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L56" + } + ], + "signatures": [ + { + "id": 419, + "name": "update", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the run with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/update-run\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 420, + "name": "status_message", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 421, + "name": "is_status_message_terminal", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 422, + "name": "general_access", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "RunGeneralAccess | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 423, + "name": "delete", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run" + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 83, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L83" + } + ], + "signatures": [ + { + "id": 424, + "name": "delete", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] + }, + { + "id": 425, + "name": "abort", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Abort the Actor run which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run\n\nArgs:\n gracefully: If True, the Actor run will abort gracefully. It will send `aborting` and `persistStates`\n events into the run and force-stop the run after 30 seconds. It is helpful in cases where you plan\n to resurrect the run later.\n\nReturns:\n The data of the aborted Actor run." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 90, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L90" + } + ], + "signatures": [ + { + "id": 426, + "name": "abort", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Abort the Actor run which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 427, + "name": "gracefully", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 428, + "name": "wait_for_finish", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wait synchronously until the run finishes or the server times out.\n\nArgs:\n wait_secs: How long does the client wait for run to finish. None for indefinite.\n\nReturns:\n The Actor run data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\n TIMED_OUT, ABORTED), then the run has not yet finished." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 105, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L105" + } + ], + "signatures": [ + { + "id": 429, + "name": "wait_for_finish", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wait synchronously until the run finishes or the server times out.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [ + { + "id": 430, + "name": "wait_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 431, + "name": "metamorph", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Transform an Actor run into a run of another Actor with a new input.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run\n\nArgs:\n target_actor_id: ID of the target Actor that the run should be transformed into.\n target_actor_build: The build of the target Actor. It can be either a build tag or build number.\n By default, the run uses the build specified in the default run configuration for the target Actor\n (typically the latest build).\n run_input: The input to pass to the new run.\n content_type: The content type of the input.\n\nReturns:\n The Actor run data." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 117, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L117" + } + ], + "signatures": [ + { + "id": 432, + "name": "metamorph", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Transform an Actor run into a run of another Actor with a new input.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 433, + "name": "target_actor_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 434, + "name": "target_actor_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 435, + "name": "run_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Any" + }, + "defaultValue": "None" + }, + { + "id": 436, + "name": "content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 437, + "name": "resurrect", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resurrect a finished Actor run.\n\nOnly finished runs, i.e. runs with status FINISHED, FAILED, ABORTED and TIMED-OUT can be resurrected.\nRun status will be updated to RUNNING and its container will be restarted with the same default storages.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run/resurrect-run\n\nArgs:\n build: Which Actor build the resurrected run should use. It can be either a build tag or build number.\n By default, the resurrected run uses the same build as before.\n memory_mbytes: New memory limit for the resurrected run, in megabytes. By default, the resurrected run\n uses the same memory limit as before.\n timeout_secs: New timeout for the resurrected run, in seconds. By default, the resurrected run uses the\n same timeout as before.\n max_items: Maximum number of items that the resurrected pay-per-result run will return. By default, the\n resurrected run uses the same limit as before. Limit can be only increased.\n max_total_charge_usd: Maximum cost for the resurrected pay-per-event run in USD. By default, the\n resurrected run uses the same limit as before. Limit can be only increased.\n restart_on_error: Determines whether the resurrected run will be restarted if it fails.\n By default, the resurrected run uses the same setting as before.\n\nReturns:\n The Actor run data." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 156, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L156" + } + ], + "signatures": [ + { + "id": 438, + "name": "resurrect", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resurrect a finished Actor run.\n\nOnly finished runs, i.e. runs with status FINISHED, FAILED, ABORTED and TIMED-OUT can be resurrected.\nRun status will be updated to RUNNING and its container will be restarted with the same default storages.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run/resurrect-run\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 439, + "name": "build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 440, + "name": "memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 441, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 442, + "name": "max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 443, + "name": "max_total_charge_usd", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Decimal | None" + }, + "defaultValue": "None" + }, + { + "id": 444, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 445, + "name": "reboot", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Reboot an Actor run. Only runs that are running, i.e. runs with status RUNNING can be rebooted.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run\n\nReturns:\n The Actor run data." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 207, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L207" + } + ], + "signatures": [ + { + "id": 446, + "name": "reboot", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Reboot an Actor run. Only runs that are running, i.e. runs with status RUNNING can be rebooted.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [] + } + ] + }, + { + "id": 447, + "name": "dataset", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the default dataset of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\nReturns:\n A client allowing access to the default dataset of this Actor run." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 221, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L221" + } + ], + "signatures": [ + { + "id": 448, + "name": "dataset", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the default dataset of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "DatasetClient", + "id": 892 + }, + "parameters": [] + } + ] + }, + { + "id": 449, + "name": "key_value_store", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the default key-value store of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\nReturns:\n A client allowing access to the default key-value store of this Actor run." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 233, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L233" + } + ], + "signatures": [ + { + "id": 450, + "name": "key_value_store", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the default key-value store of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "KeyValueStoreClient", + "id": 772 + }, + "parameters": [] + } + ] + }, + { + "id": 451, + "name": "request_queue", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the default request queue of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\nReturns:\n A client allowing access to the default request_queue of this Actor run." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 245, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L245" + } + ], + "signatures": [ + { + "id": 452, + "name": "request_queue", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the default request queue of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "RequestQueueClient", + "id": 542 + }, + "parameters": [] + } + ] + }, + { + "id": 453, + "name": "log", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the log of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\nReturns:\n A client allowing access to the log of this Actor run." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 257, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L257" + } + ], + "signatures": [ + { + "id": 454, + "name": "log", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the log of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "LogClient", + "id": 662 + }, + "parameters": [] + } + ] + }, + { + "id": 455, + "name": "get_streamed_log", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get `StreamedLog` instance that can be used to redirect logs.\n\n `StreamedLog` can be explicitly started and stopped or used as a context manager.\n\nArgs:\n to_logger: `Logger` used for logging the redirected messages. If not provided, a new logger is created\n from_start: If `True`, all logs from the start of the actor run will be redirected. If `False`, only newly\n arrived logs will be redirected. This can be useful for redirecting only a small portion of relevant\n logs for long-running actors in stand-by.\n\nReturns:\n `StreamedLog` instance for redirected logs." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 269, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L269" + } + ], + "signatures": [ + { + "id": 456, + "name": "get_streamed_log", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get `StreamedLog` instance that can be used to redirect logs.\n\n `StreamedLog` can be explicitly started and stopped or used as a context manager.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "StreamedLogSync", + "id": 687 + }, + "parameters": [ + { + "id": 457, + "name": "to_logger", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "logging.Logger | None" + }, + "defaultValue": "None" + }, + { + "id": 458, + "name": "from_start", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "defaultValue": "True" + } + ] + } + ] + }, + { + "id": 459, + "name": "charge", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Charge for an event of a Pay-Per-Event Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run\n\nReturns:\n Status and message of the charge event." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 296, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L296" + } + ], + "signatures": [ + { + "id": 460, + "name": "charge", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Charge for an event of a Pay-Per-Event Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 461, + "name": "event_name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 462, + "name": "count", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 463, + "name": "idempotency_key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 464, + "name": "get_status_message_watcher", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get `StatusMessageWatcher` instance that can be used to redirect status and status messages to logs.\n\n`StatusMessageWatcher` can be explicitly started and stopped or used as a context manager.\n\nArgs:\n to_logger: `Logger` used for logging the status and status messages. If not provided, a new logger is\n created.\n check_period: The period with which the status message will be polled.\n\nReturns:\n `StatusMessageWatcher` instance." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 332, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L332" + } + ], + "signatures": [ + { + "id": 465, + "name": "get_status_message_watcher", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get `StatusMessageWatcher` instance that can be used to redirect status and status messages to logs.\n\n`StatusMessageWatcher` can be explicitly started and stopped or used as a context manager.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "StatusMessageWatcherSync", + "id": 733 + }, + "parameters": [ + { + "id": 466, + "name": "to_logger", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "logging.Logger | None" + }, + "defaultValue": "None" + }, + { + "id": 467, + "name": "check_period", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "timedelta" + }, + "defaultValue": "timedelta(seconds=1)" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 425, + 459, + 447, + 423, + 416, + 464, + 455, + 449, + 453, + 431, + 445, + 451, + 437, + 418, + 428 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 39, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L39" + } + ] + }, + { + "id": 468, + "name": "RunClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating a single Actor run." + } + ] + }, + "children": [ + { + "id": 469, + "name": "get", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/get-run\n\nReturns:\n The retrieved Actor run data." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 368, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L368" + } + ], + "signatures": [ + { + "id": 470, + "name": "get", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/get-run\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 471, + "name": "update", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the run with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/update-run\n\nArgs:\n status_message: The new status message for the run.\n is_status_message_terminal: Set this flag to True if this is the final status message of the Actor run.\n general_access: Determines how others can access the run and its storages.\n\nReturns:\n The updated run." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 378, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L378" + } + ], + "signatures": [ + { + "id": 472, + "name": "update", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the run with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/update-run\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 473, + "name": "status_message", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 474, + "name": "is_status_message_terminal", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 475, + "name": "general_access", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "RunGeneralAccess | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 476, + "name": "abort", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Abort the Actor run which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run\n\nArgs:\n gracefully: If True, the Actor run will abort gracefully. It will send `aborting` and `persistStates`\n events into the run and force-stop the run after 30 seconds. It is helpful in cases where you plan\n to resurrect the run later.\n\nReturns:\n The data of the aborted Actor run." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 405, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L405" + } + ], + "signatures": [ + { + "id": 477, + "name": "abort", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Abort the Actor run which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 478, + "name": "gracefully", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 479, + "name": "wait_for_finish", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wait synchronously until the run finishes or the server times out.\n\nArgs:\n wait_secs: How long does the client wait for run to finish. None for indefinite.\n\nReturns:\n The Actor run data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\n TIMED_OUT, ABORTED), then the run has not yet finished." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 420, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L420" + } + ], + "signatures": [ + { + "id": 480, + "name": "wait_for_finish", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wait synchronously until the run finishes or the server times out.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [ + { + "id": 481, + "name": "wait_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 482, + "name": "delete", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run" + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 432, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L432" + } + ], + "signatures": [ + { + "id": 483, + "name": "delete", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] + }, + { + "id": 484, + "name": "metamorph", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Transform an Actor run into a run of another Actor with a new input.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run\n\nArgs:\n target_actor_id: ID of the target Actor that the run should be transformed into.\n target_actor_build: The build of the target Actor. It can be either a build tag or build number.\n By default, the run uses the build specified in the default run configuration for the target Actor\n (typically the latest build).\n run_input: The input to pass to the new run.\n content_type: The content type of the input.\n\nReturns:\n The Actor run data." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 439, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L439" + } + ], + "signatures": [ + { + "id": 485, + "name": "metamorph", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Transform an Actor run into a run of another Actor with a new input.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 486, + "name": "target_actor_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 487, + "name": "target_actor_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 488, + "name": "run_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Any" + }, + "defaultValue": "None" + }, + { + "id": 489, + "name": "content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 490, + "name": "resurrect", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resurrect a finished Actor run.\n\nOnly finished runs, i.e. runs with status FINISHED, FAILED, ABORTED and TIMED-OUT can be resurrected.\nRun status will be updated to RUNNING and its container will be restarted with the same default storages.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run/resurrect-run\n\nArgs:\n build: Which Actor build the resurrected run should use. It can be either a build tag or build number.\n By default, the resurrected run uses the same build as before.\n memory_mbytes: New memory limit for the resurrected run, in megabytes. By default, the resurrected run\n uses the same memory limit as before.\n timeout_secs: New timeout for the resurrected run, in seconds. By default, the resurrected run uses the\n same timeout as before.\n max_items: Maximum number of items that the resurrected pay-per-result run will return. By default, the\n resurrected run uses the same limit as before. Limit can be only increased.\n max_total_charge_usd: Maximum cost for the resurrected pay-per-event run in USD. By default, the\n resurrected run uses the same limit as before. Limit can be only increased.\n restart_on_error: Determines whether the resurrected run will be restarted if it fails.\n By default, the resurrected run uses the same setting as before.\n\nReturns:\n The Actor run data." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 481, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L481" + } + ], + "signatures": [ + { + "id": 491, + "name": "resurrect", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resurrect a finished Actor run.\n\nOnly finished runs, i.e. runs with status FINISHED, FAILED, ABORTED and TIMED-OUT can be resurrected.\nRun status will be updated to RUNNING and its container will be restarted with the same default storages.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run/resurrect-run\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 492, + "name": "build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 493, + "name": "memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 494, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 495, + "name": "max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 496, + "name": "max_total_charge_usd", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Decimal | None" + }, + "defaultValue": "None" + }, + { + "id": 497, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 498, + "name": "reboot", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Reboot an Actor run. Only runs that are running, i.e. runs with status RUNNING can be rebooted.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run\n\nReturns:\n The Actor run data." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 532, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L532" + } + ], + "signatures": [ + { + "id": 499, + "name": "reboot", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Reboot an Actor run. Only runs that are running, i.e. runs with status RUNNING can be rebooted.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [] + } + ] + }, + { + "id": 500, + "name": "dataset", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the default dataset of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\nReturns:\n A client allowing access to the default dataset of this Actor run." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 546, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L546" + } + ], + "signatures": [ + { + "id": 501, + "name": "dataset", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the default dataset of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "DatasetClientAsync", + "id": 1002 + }, + "parameters": [] + } + ] + }, + { + "id": 502, + "name": "key_value_store", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the default key-value store of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\nReturns:\n A client allowing access to the default key-value store of this Actor run." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 558, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L558" + } + ], + "signatures": [ + { + "id": 503, + "name": "key_value_store", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the default key-value store of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "KeyValueStoreClientAsync", + "id": 821 + }, + "parameters": [] + } + ] + }, + { + "id": 504, + "name": "request_queue", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the default request queue of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\nReturns:\n A client allowing access to the default request_queue of this Actor run." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 570, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L570" + } + ], + "signatures": [ + { + "id": 505, + "name": "request_queue", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the default request queue of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "RequestQueueClientAsync", + "id": 602 + }, + "parameters": [] + } + ] + }, + { + "id": 506, + "name": "log", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the log of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\nReturns:\n A client allowing access to the log of this Actor run." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 582, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L582" + } + ], + "signatures": [ + { + "id": 507, + "name": "log", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the log of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "LogClientAsync", + "id": 672 + }, + "parameters": [] + } + ] + }, + { + "id": 508, + "name": "get_streamed_log", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get `StreamedLog` instance that can be used to redirect logs.\n\n `StreamedLog` can be explicitly started and stopped or used as a context manager.\n\nArgs:\n to_logger: `Logger` used for logging the redirected messages. If not provided, a new logger is created\n from_start: If `True`, all logs from the start of the actor run will be redirected. If `False`, only newly\n arrived logs will be redirected. This can be useful for redirecting only a small portion of relevant\n logs for long-running actors in stand-by.\n\nReturns:\n `StreamedLog` instance for redirected logs." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 594, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L594" + } + ], + "signatures": [ + { + "id": 509, + "name": "get_streamed_log", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get `StreamedLog` instance that can be used to redirect logs.\n\n `StreamedLog` can be explicitly started and stopped or used as a context manager.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "StreamedLogAsync", + "id": 699 + }, + "parameters": [ + { + "id": 510, + "name": "to_logger", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "logging.Logger | None" + }, + "defaultValue": "None" + }, + { + "id": 511, + "name": "from_start", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "defaultValue": "True" + } + ] + } + ] + }, + { + "id": 512, + "name": "charge", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Charge for an event of a Pay-Per-Event Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run\n\nReturns:\n Status and message of the charge event." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 623, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L623" + } + ], + "signatures": [ + { + "id": 513, + "name": "charge", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Charge for an event of a Pay-Per-Event Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 514, + "name": "event_name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 515, + "name": "count", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 516, + "name": "idempotency_key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 517, + "name": "get_status_message_watcher", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get `StatusMessageWatcher` instance that can be used to redirect status and status messages to logs.\n\n`StatusMessageWatcher` can be explicitly started and stopped or used as a context manager.\n\nArgs:\n to_logger: `Logger` used for logging the status and status messages. If not provided, a new logger is\n created.\n check_period: The period with which the status message will be polled.\n\nReturns:\n `StatusMessageWatcher` instance." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 658, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L658" + } + ], + "signatures": [ + { + "id": 518, + "name": "get_status_message_watcher", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get `StatusMessageWatcher` instance that can be used to redirect status and status messages to logs.\n\n`StatusMessageWatcher` can be explicitly started and stopped or used as a context manager.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "StatusMessageWatcherAsync", + "id": 716 + }, + "parameters": [ + { + "id": 519, + "name": "to_logger", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "logging.Logger | None" + }, + "defaultValue": "None" + }, + { + "id": 520, + "name": "check_period", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "timedelta" + }, + "defaultValue": "timedelta(seconds=1)" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 476, + 512, + 500, + 482, + 469, + 517, + 508, + 502, + 506, + 484, + 498, + 504, + 490, + 471, + 479 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 361, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L361" + } + ] + }, + { + "id": 521, + "name": "RequestQueueCollectionClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating request queues." + } + ] + }, + "children": [ + { + "id": 522, + "name": "list", + "module": "apify_client.clients.resource_clients.request_queue_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available request queues.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n\nArgs:\n unnamed: Whether to include unnamed request queues in the list.\n limit: How many request queues to retrieve.\n offset: What request queue to include as first when retrieving the list.\n desc: Whether to sort therequest queues in descending order based on their modification date.\n\nReturns:\n The list of available request queues matching the specified filters." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue_collection.py", + "line": 18, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue_collection.py#L18" + } + ], + "signatures": [ + { + "id": 523, + "name": "list", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available request queues.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 524, + "name": "unnamed", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 525, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 526, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 527, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 528, + "name": "get_or_create", + "module": "apify_client.clients.resource_clients.request_queue_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a named request queue, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/create-request-queue\n\nArgs:\n name: The name of the request queue to retrieve or create.\n\nReturns:\n The retrieved or newly-created request queue." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue_collection.py", + "line": 41, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue_collection.py#L41" + } + ], + "signatures": [ + { + "id": 529, + "name": "get_or_create", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a named request queue, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/create-request-queue\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 530, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 528, + 522 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue_collection.py", + "line": 11, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue_collection.py#L11" + } + ] + }, + { + "id": 531, + "name": "RequestQueueCollectionClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating request queues." + } + ] + }, + "children": [ + { + "id": 532, + "name": "list", + "module": "apify_client.clients.resource_clients.request_queue_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available request queues.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n\nArgs:\n unnamed: Whether to include unnamed request queues in the list.\n limit: How many request queues to retrieve.\n offset: What request queue to include as first when retrieving the list.\n desc: Whether to sort therequest queues in descending order based on their modification date.\n\nReturns:\n The list of available request queues matching the specified filters." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue_collection.py", + "line": 62, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue_collection.py#L62" + } + ], + "signatures": [ + { + "id": 533, + "name": "list", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available request queues.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 534, + "name": "unnamed", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 535, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 536, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 537, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 538, + "name": "get_or_create", + "module": "apify_client.clients.resource_clients.request_queue_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a named request queue, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/create-request-queue\n\nArgs:\n name: The name of the request queue to retrieve or create.\n\nReturns:\n The retrieved or newly-created request queue." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue_collection.py", + "line": 85, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue_collection.py#L85" + } + ], + "signatures": [ + { + "id": 539, + "name": "get_or_create", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a named request queue, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/create-request-queue\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 540, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 538, + 532 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue_collection.py", + "line": 55, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue_collection.py#L55" + } + ] + }, + { + "id": 541, + "name": "BatchAddRequestsResult", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Result of the batch add requests operation.\n\nArgs:\n processedRequests: List of successfully added requests.\n unprocessedRequests: List of requests that failed to be added." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 36, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L36" + } + ] + }, + { + "id": 542, + "name": "RequestQueueClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating a single request queue." + } + ] + }, + "children": [ + { + "id": 543, + "name": "__init__", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a new instance.\n\nArgs:\n client_key: A unique identifier of the client accessing the request queue." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 51, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L51" + } + ], + "signatures": [ + { + "id": 544, + "name": "__init__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a new instance.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 545, + "name": "args", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Any" + } + }, + { + "id": 546, + "name": "client_key", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 547, + "name": "kwargs", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Any" + } + } + ] + } + ] + }, + { + "id": 548, + "name": "get", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/get-request-queue\n\nReturns:\n The retrieved request queue, or None, if it does not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 66, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L66" + } + ], + "signatures": [ + { + "id": 549, + "name": "get", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/get-request-queue\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 550, + "name": "update", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the request queue with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/update-request-queue\n\nArgs:\n name: The new name for the request queue.\n general_access: Determines how others can access the request queue.\n\nReturns:\n The updated request queue." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 76, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L76" + } + ], + "signatures": [ + { + "id": 551, + "name": "update", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the request queue with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/update-request-queue\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 552, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 553, + "name": "general_access", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "StorageGeneralAccess | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 554, + "name": "delete", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request-queue" + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 95, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L95" + } + ], + "signatures": [ + { + "id": 555, + "name": "delete", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request-queue" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] + }, + { + "id": 556, + "name": "list_head", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a given number of requests from the beginning of the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head/get-head\n\nArgs:\n limit: How many requests to retrieve.\n\nReturns:\n The desired number of requests from the beginning of the queue." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 102, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L102" + } + ], + "signatures": [ + { + "id": 557, + "name": "list_head", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a given number of requests from the beginning of the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head/get-head\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 558, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 559, + "name": "list_and_lock_head", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a given number of unlocked requests from the beginning of the queue and lock them for a given time.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head-with-locks/get-head-and-lock\n\nArgs:\n lock_secs: How long the requests will be locked for, in seconds.\n limit: How many requests to retrieve.\n\nReturns:\n The desired number of locked requests from the beginning of the queue." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 124, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L124" + } + ], + "signatures": [ + { + "id": 560, + "name": "list_and_lock_head", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a given number of unlocked requests from the beginning of the queue and lock them for a given time.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head-with-locks/get-head-and-lock\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 561, + "name": "lock_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "int" + } + }, + { + "id": 562, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 563, + "name": "add_request", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Add a request to the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/add-request\n\nArgs:\n request: The request to add to the queue.\n forefront: Whether to add the request to the head or the end of the queue.\n\nReturns:\n The added request." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 147, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L147" + } + ], + "signatures": [ + { + "id": 564, + "name": "add_request", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Add a request to the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/add-request\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 565, + "name": "request", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "dict" + } + }, + { + "id": 566, + "name": "forefront", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 567, + "name": "get_request", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n\nArgs:\n request_id: ID of the request to retrieve.\n\nReturns:\n The retrieved request, or None, if it did not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 171, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L171" + } + ], + "signatures": [ + { + "id": 568, + "name": "get_request", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [ + { + "id": 569, + "name": "request_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 570, + "name": "update_request", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update a request in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/update-request\n\nArgs:\n request: The updated request.\n forefront: Whether to put the updated request in the beginning or the end of the queue.\n\nReturns:\n The updated request." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 196, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L196" + } + ], + "signatures": [ + { + "id": 571, + "name": "update_request", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update a request in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/update-request\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 572, + "name": "request", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "dict" + } + }, + { + "id": 573, + "name": "forefront", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 574, + "name": "delete_request", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/delete-request\n\nArgs:\n request_id: ID of the request to delete." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 222, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L222" + } + ], + "signatures": [ + { + "id": 575, + "name": "delete_request", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/delete-request\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 576, + "name": "request_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 577, + "name": "prolong_request_lock", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Prolong the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock\n\nArgs:\n request_id: ID of the request to prolong the lock.\n forefront: Whether to put the request in the beginning or the end of the queue after lock expires.\n lock_secs: By how much to prolong the lock, in seconds." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 241, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L241" + } + ], + "signatures": [ + { + "id": 578, + "name": "prolong_request_lock", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Prolong the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 579, + "name": "request_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 580, + "name": "forefront", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 581, + "name": "lock_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "int" + } + } + ] + } + ] + }, + { + "id": 582, + "name": "delete_request_lock", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock\n\nArgs:\n request_id: ID of the request to delete the lock.\n forefront: Whether to put the request in the beginning or the end of the queue after the lock is deleted." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 268, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L268" + } + ], + "signatures": [ + { + "id": 583, + "name": "delete_request_lock", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 584, + "name": "request_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 585, + "name": "forefront", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 586, + "name": "batch_add_requests", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Add requests to the request queue in batches.\n\nRequests are split into batches based on size and processed in parallel.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/add-requests\n\nArgs:\n requests: List of requests to be added to the queue.\n forefront: Whether to add requests to the front of the queue.\n max_parallel: Specifies the maximum number of parallel tasks for API calls. This is only applicable\n to the async client. For the sync client, this value must be set to 1, as parallel execution\n is not supported.\n max_unprocessed_requests_retries: Deprecated argument. Will be removed in next major release.\n min_delay_between_unprocessed_requests_retries: Deprecated argument. Will be removed in next major release.\n\nReturns:\n Result containing lists of processed and unprocessed requests." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 286, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L286" + } + ], + "signatures": [ + { + "id": 587, + "name": "batch_add_requests", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Add requests to the request queue in batches.\n\nRequests are split into batches based on size and processed in parallel.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/add-requests\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "BatchAddRequestsResult", + "id": 541 + }, + "parameters": [ + { + "id": 588, + "name": "requests", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "list[dict]" + } + }, + { + "id": 589, + "name": "forefront", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "defaultValue": "False" + }, + { + "id": 590, + "name": "max_parallel", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "int" + }, + "defaultValue": "1" + }, + { + "id": 591, + "name": "max_unprocessed_requests_retries", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 592, + "name": "min_delay_between_unprocessed_requests_retries", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "timedelta | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 593, + "name": "batch_delete_requests", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete given requests from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests\n\nArgs:\n requests: List of the requests to delete." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 364, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L364" + } + ], + "signatures": [ + { + "id": 594, + "name": "batch_delete_requests", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete given requests from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 595, + "name": "requests", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "list[dict]" + } + } + ] + } + ] + }, + { + "id": 596, + "name": "list_requests", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List requests in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n\nArgs:\n limit: How many requests to retrieve.\n exclusive_start_id: All requests up to this one (including) are skipped from the result." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 384, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L384" + } + ], + "signatures": [ + { + "id": 597, + "name": "list_requests", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List requests in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 598, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 599, + "name": "exclusive_start_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 600, + "name": "unlock_requests", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Unlock all requests in the queue, which were locked by the same clientKey or from the same Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/unlock-requests\n\nReturns:\n dict: Result of the unlock operation" + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 409, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L409" + } + ], + "signatures": [ + { + "id": 601, + "name": "unlock_requests", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Unlock all requests in the queue, which were locked by the same clientKey or from the same Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/unlock-requests\n\n" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Result of the unlock operation" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [] + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 543 + ] + }, + { + "title": "Methods", + "children": [ + 563, + 586, + 593, + 554, + 574, + 582, + 548, + 567, + 559, + 556, + 596, + 577, + 600, + 550, + 570 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 48, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L48" + } + ] + }, + { + "id": 602, + "name": "RequestQueueClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating a single request queue." + } + ] + }, + "children": [ + { + "id": 603, + "name": "__init__", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a new instance.\n\nArgs:\n client_key: A unique identifier of the client accessing the request queue." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 431, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L431" + } + ], + "signatures": [ + { + "id": 604, + "name": "__init__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a new instance.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 605, + "name": "args", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Any" + } + }, + { + "id": 606, + "name": "client_key", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 607, + "name": "kwargs", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Any" + } + } + ] + } + ] + }, + { + "id": 608, + "name": "get", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/get-request-queue\n\nReturns:\n The retrieved request queue, or None, if it does not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 446, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L446" + } + ], + "signatures": [ + { + "id": 609, + "name": "get", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/get-request-queue\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 610, + "name": "update", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the request queue with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/update-request-queue\n\nArgs:\n name: The new name for the request queue.\n general_access: Determines how others can access the request queue.\n\nReturns:\n The updated request queue." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 456, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L456" + } + ], + "signatures": [ + { + "id": 611, + "name": "update", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the request queue with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/update-request-queue\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 612, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 613, + "name": "general_access", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "StorageGeneralAccess | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 614, + "name": "delete", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request-queue" + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 475, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L475" + } + ], + "signatures": [ + { + "id": 615, + "name": "delete", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request-queue" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] + }, + { + "id": 616, + "name": "list_head", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a given number of requests from the beginning of the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head/get-head\n\nArgs:\n limit: How many requests to retrieve.\n\nReturns:\n The desired number of requests from the beginning of the queue." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 482, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L482" + } + ], + "signatures": [ + { + "id": 617, + "name": "list_head", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a given number of requests from the beginning of the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head/get-head\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 618, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 619, + "name": "list_and_lock_head", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a given number of unlocked requests from the beginning of the queue and lock them for a given time.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head-with-locks/get-head-and-lock\n\nArgs:\n lock_secs: How long the requests will be locked for, in seconds.\n limit: How many requests to retrieve.\n\nReturns:\n The desired number of locked requests from the beginning of the queue." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 504, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L504" + } + ], + "signatures": [ + { + "id": 620, + "name": "list_and_lock_head", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a given number of unlocked requests from the beginning of the queue and lock them for a given time.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head-with-locks/get-head-and-lock\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 621, + "name": "lock_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "int" + } + }, + { + "id": 622, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 623, + "name": "add_request", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Add a request to the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/add-request\n\nArgs:\n request: The request to add to the queue.\n forefront: Whether to add the request to the head or the end of the queue.\n\nReturns:\n The added request." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 527, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L527" + } + ], + "signatures": [ + { + "id": 624, + "name": "add_request", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Add a request to the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/add-request\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 625, + "name": "request", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "dict" + } + }, + { + "id": 626, + "name": "forefront", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 627, + "name": "get_request", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n\nArgs:\n request_id: ID of the request to retrieve.\n\nReturns:\n The retrieved request, or None, if it did not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 551, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L551" + } + ], + "signatures": [ + { + "id": 628, + "name": "get_request", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [ + { + "id": 629, + "name": "request_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 630, + "name": "update_request", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update a request in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/update-request\n\nArgs:\n request: The updated request.\n forefront: Whether to put the updated request in the beginning or the end of the queue.\n\nReturns:\n The updated request." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 576, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L576" + } + ], + "signatures": [ + { + "id": 631, + "name": "update_request", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update a request in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/update-request\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 632, + "name": "request", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "dict" + } + }, + { + "id": 633, + "name": "forefront", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 634, + "name": "delete_request", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/delete-request\n\nArgs:\n request_id: ID of the request to delete." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 602, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L602" + } + ], + "signatures": [ + { + "id": 635, + "name": "delete_request", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/delete-request\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 636, + "name": "request_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 637, + "name": "prolong_request_lock", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Prolong the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock\n\nArgs:\n request_id: ID of the request to prolong the lock.\n forefront: Whether to put the request in the beginning or the end of the queue after lock expires.\n lock_secs: By how much to prolong the lock, in seconds." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 619, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L619" + } + ], + "signatures": [ + { + "id": 638, + "name": "prolong_request_lock", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Prolong the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 639, + "name": "request_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 640, + "name": "forefront", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 641, + "name": "lock_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "int" + } + } + ] + } + ] + }, + { + "id": 642, + "name": "delete_request_lock", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock\n\nArgs:\n request_id: ID of the request to delete the lock.\n forefront: Whether to put the request in the beginning or the end of the queue after the lock is deleted." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 646, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L646" + } + ], + "signatures": [ + { + "id": 643, + "name": "delete_request_lock", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 644, + "name": "request_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 645, + "name": "forefront", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 646, + "name": "batch_add_requests", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Add requests to the request queue in batches.\n\nRequests are split into batches based on size and processed in parallel.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/add-requests\n\nArgs:\n requests: List of requests to be added to the queue.\n forefront: Whether to add requests to the front of the queue.\n max_parallel: Specifies the maximum number of parallel tasks for API calls. This is only applicable\n to the async client. For the sync client, this value must be set to 1, as parallel execution\n is not supported.\n max_unprocessed_requests_retries: Deprecated argument. Will be removed in next major release.\n min_delay_between_unprocessed_requests_retries: Deprecated argument. Will be removed in next major release.\n\nReturns:\n Result containing lists of processed and unprocessed requests." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 713, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L713" + } + ], + "signatures": [ + { + "id": 647, + "name": "batch_add_requests", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Add requests to the request queue in batches.\n\nRequests are split into batches based on size and processed in parallel.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/add-requests\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "BatchAddRequestsResult", + "id": 541 + }, + "parameters": [ + { + "id": 648, + "name": "requests", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "list[dict]" + } + }, + { + "id": 649, + "name": "forefront", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "defaultValue": "False" + }, + { + "id": 650, + "name": "max_parallel", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "int" + }, + "defaultValue": "5" + }, + { + "id": 651, + "name": "max_unprocessed_requests_retries", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 652, + "name": "min_delay_between_unprocessed_requests_retries", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "timedelta | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 653, + "name": "batch_delete_requests", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete given requests from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests\n\nArgs:\n requests: List of the requests to delete." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 793, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L793" + } + ], + "signatures": [ + { + "id": 654, + "name": "batch_delete_requests", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete given requests from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 655, + "name": "requests", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "list[dict]" + } + } + ] + } + ] + }, + { + "id": 656, + "name": "list_requests", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List requests in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n\nArgs:\n limit: How many requests to retrieve.\n exclusive_start_id: All requests up to this one (including) are skipped from the result." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 812, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L812" + } + ], + "signatures": [ + { + "id": 657, + "name": "list_requests", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List requests in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 658, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 659, + "name": "exclusive_start_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 660, + "name": "unlock_requests", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Unlock all requests in the queue, which were locked by the same clientKey or from the same Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/unlock-requests\n\nReturns:\n dict: Result of the unlock operation" + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 837, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L837" + } + ], + "signatures": [ + { + "id": 661, + "name": "unlock_requests", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Unlock all requests in the queue, which were locked by the same clientKey or from the same Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/unlock-requests\n\n" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Result of the unlock operation" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [] + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 603 + ] + }, + { + "title": "Methods", + "children": [ + 623, + 646, + 653, + 614, + 634, + 642, + 608, + 627, + 619, + 616, + 656, + 637, + 660, + 610, + 630 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 428, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L428" + } + ] + }, + { + "id": 662, + "name": "LogClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating logs." + } + ] + }, + "children": [ + { + "id": 663, + "name": "get", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the log as text.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\nArgs:\n raw: If true, the log will include formatting. For example, coloring character sequences.\n\nReturns:\n The retrieved log, or None, if it does not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 35, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L35" + } + ], + "signatures": [ + { + "id": 664, + "name": "get", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the log as text.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "parameters": [ + { + "id": 665, + "name": "raw", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "defaultValue": "False" + } + ] + } + ] + }, + { + "id": 666, + "name": "get_as_bytes", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the log as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\nArgs:\n raw: If true, the log will include formatting. For example, coloring character sequences.\n\nReturns:\n The retrieved log as raw bytes, or None, if it does not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 60, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L60" + } + ], + "signatures": [ + { + "id": 667, + "name": "get_as_bytes", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the log as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "bytes | None" + }, + "parameters": [ + { + "id": 668, + "name": "raw", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "defaultValue": "False" + } + ] + } + ] + }, + { + "id": 669, + "name": "stream", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the log as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\nArgs:\n raw: If true, the log will include formatting. For example, coloring character sequences.\n\nReturns:\n The retrieved log as a context-managed streaming `Response`, or None, if it does not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 86, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L86" + } + ], + "signatures": [ + { + "id": 670, + "name": "stream", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the log as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "Iterator[impit.Response | None]" + }, + "parameters": [ + { + "id": 671, + "name": "raw", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "defaultValue": "False" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 663, + 666, + 669 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 28, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L28" + } + ] + }, + { + "id": 672, + "name": "LogClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating logs." + } + ] + }, + "children": [ + { + "id": 673, + "name": "get", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the log as text.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\nArgs:\n raw: If true, the log will include formatting. For example, coloring character sequences.\n\nReturns:\n The retrieved log, or None, if it does not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 122, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L122" + } + ], + "signatures": [ + { + "id": 674, + "name": "get", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the log as text.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "parameters": [ + { + "id": 675, + "name": "raw", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "defaultValue": "False" + } + ] + } + ] + }, + { + "id": 676, + "name": "get_as_bytes", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the log as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\nArgs:\n raw: If true, the log will include formatting. For example, coloring character sequences.\n\nReturns:\n The retrieved log as raw bytes, or None, if it does not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 147, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L147" + } + ], + "signatures": [ + { + "id": 677, + "name": "get_as_bytes", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the log as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "bytes | None" + }, + "parameters": [ + { + "id": 678, + "name": "raw", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "defaultValue": "False" + } + ] + } + ] + }, + { + "id": 679, + "name": "stream", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the log as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\nArgs:\n raw: If true, the log will include formatting. For example, coloring character sequences.\n\nReturns:\n The retrieved log as a context-managed streaming `Response`, or None, if it does not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 173, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L173" + } + ], + "signatures": [ + { + "id": 680, + "name": "stream", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the log as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "AsyncIterator[impit.Response | None]" + }, + "parameters": [ + { + "id": 681, + "name": "raw", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "defaultValue": "False" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 673, + 676, + 679 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 115, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L115" + } + ] + }, + { + "id": 682, + "name": "StreamedLog", + "module": "apify_client.clients.resource_clients.log", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Utility class for streaming logs from another Actor.\n\nIt uses buffer to deal with possibly chunked logs. Chunked logs are stored in buffer. Chunks are expected to contain\nspecific markers that indicate the start of the log message. Each time a new chunk with complete split marker\narrives, the buffer is processed, logged and emptied.\n\nThis works only if the logs have datetime marker in ISO format. For example, `2025-05-12T15:35:59.429Z` This is the\ndefault log standard for the actors." + } + ] + }, + "children": [ + { + "id": 683, + "name": "__init__", + "module": "apify_client.clients.resource_clients.log", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize `StreamedLog`.\n\nArgs:\n to_logger: The logger to which the logs will be redirected.\n from_start: If `True`, all logs from the start of the actor run will be redirected. If `False`, only newly\n arrived logs will be redirected. This can be useful for redirecting only a small portion of relevant\n logs for long-running actors in stand-by." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 216, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L216" + } + ], + "signatures": [ + { + "id": 684, + "name": "__init__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize `StreamedLog`.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 685, + "name": "to_logger", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "logging.Logger" + } + }, + { + "id": 686, + "name": "from_start", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "defaultValue": "True" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 683 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 202, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L202" + } + ] + }, + { + "id": 687, + "name": "StreamedLogSync", + "module": "apify_client.clients.resource_clients.log", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sync variant of `StreamedLog` that is logging in threads." + } + ] + }, + "children": [ + { + "id": 688, + "name": "start", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the streaming thread. The caller has to handle any cleanup by manually calling the `stop` method." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 290, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L290" + } + ], + "signatures": [ + { + "id": 689, + "name": "start", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the streaming thread. The caller has to handle any cleanup by manually calling the `stop` method." + } + ] + }, + "type": { + "type": "reference", + "name": "Thread" + }, + "parameters": [] + } + ] + }, + { + "id": 690, + "name": "stop", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Signal the streaming thread to stop logging and wait for it to finish." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 299, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L299" + } + ], + "signatures": [ + { + "id": 691, + "name": "stop", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Signal the streaming thread to stop logging and wait for it to finish." + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] + }, + { + "id": 692, + "name": "__enter__", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the streaming thread within the context. Exiting the context will finish the streaming thread." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 308, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L308" + } + ], + "signatures": [ + { + "id": 693, + "name": "__enter__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the streaming thread within the context. Exiting the context will finish the streaming thread." + } + ] + }, + "type": { + "type": "reference", + "name": "Self" + }, + "parameters": [] + } + ] + }, + { + "id": 694, + "name": "__exit__", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stop the streaming thread." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 313, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L313" + } + ], + "signatures": [ + { + "id": 695, + "name": "__exit__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stop the streaming thread." + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 696, + "name": "exc_type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "type[BaseException] | None" + } + }, + { + "id": 697, + "name": "exc_val", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "BaseException | None" + } + }, + { + "id": 698, + "name": "exc_tb", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "TracebackType | None" + } + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 692, + 694, + 688, + 690 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 281, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L281" + } + ] + }, + { + "id": 699, + "name": "StreamedLogAsync", + "module": "apify_client.clients.resource_clients.log", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async variant of `StreamedLog` that is logging in tasks." + } + ] + }, + "children": [ + { + "id": 700, + "name": "start", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the streaming task. The caller has to handle any cleanup by manually calling the `stop` method." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 341, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L341" + } + ], + "signatures": [ + { + "id": 701, + "name": "start", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the streaming task. The caller has to handle any cleanup by manually calling the `stop` method." + } + ] + }, + "type": { + "type": "reference", + "name": "Task" + }, + "parameters": [] + } + ] + }, + { + "id": 702, + "name": "stop", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stop the streaming task." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 348, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L348" + } + ], + "signatures": [ + { + "id": 703, + "name": "stop", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stop the streaming task." + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] + }, + { + "id": 704, + "name": "__aenter__", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the streaming task within the context. Exiting the context will cancel the streaming task." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 359, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L359" + } + ], + "signatures": [ + { + "id": 705, + "name": "__aenter__", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the streaming task within the context. Exiting the context will cancel the streaming task." + } + ] + }, + "type": { + "type": "reference", + "name": "Self" + }, + "parameters": [] + } + ] + }, + { + "id": 706, + "name": "__aexit__", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Cancel the streaming task." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 364, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L364" + } + ], + "signatures": [ + { + "id": 707, + "name": "__aexit__", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Cancel the streaming task." + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 708, + "name": "exc_type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "type[BaseException] | None" + } + }, + { + "id": 709, + "name": "exc_val", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "BaseException | None" + } + }, + { + "id": 710, + "name": "exc_tb", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "TracebackType | None" + } + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 704, + 706, + 700, + 702 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 333, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L333" + } + ] + }, + { + "id": 711, + "name": "StatusMessageWatcher", + "module": "apify_client.clients.resource_clients.log", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Utility class for logging status messages from another Actor run.\n\nStatus message is logged at fixed time intervals, and there is no guarantee that all messages will be logged,\nespecially in cases of frequent status message changes." + } + ] + }, + "children": [ + { + "id": 712, + "name": "__init__", + "module": "apify_client.clients.resource_clients.log", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize `StatusMessageWatcher`.\n\nArgs:\n to_logger: The logger to which the status message will be redirected.\n check_period: The period with which the status message will be polled." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 394, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L394" + } + ], + "signatures": [ + { + "id": 713, + "name": "__init__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize `StatusMessageWatcher`.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 714, + "name": "to_logger", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "logging.Logger" + } + }, + { + "id": 715, + "name": "check_period", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "timedelta" + }, + "defaultValue": "timedelta(seconds=5)" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 712 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 381, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L381" + } + ] + }, + { + "id": 716, + "name": "StatusMessageWatcherAsync", + "module": "apify_client.clients.resource_clients.log", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async variant of `StatusMessageWatcher` that is logging in task." + } + ] + }, + "children": [ + { + "id": 717, + "name": "__init__", + "module": "apify_client.clients.resource_clients.log", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize `StatusMessageWatcherAsync`.\n\nArgs:\n run_client: The client for run that will be used to get a status and message.\n to_logger: The logger to which the status message will be redirected.\n check_period: The period with which the status message will be polled." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 432, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L432" + } + ], + "signatures": [ + { + "id": 718, + "name": "__init__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize `StatusMessageWatcherAsync`.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 719, + "name": "run_client", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "RunClientAsync", + "id": 468 + } + }, + { + "id": 720, + "name": "to_logger", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "logging.Logger" + } + }, + { + "id": 721, + "name": "check_period", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "timedelta" + }, + "defaultValue": "timedelta(seconds=1)" + } + ] + } + ] + }, + { + "id": 722, + "name": "start", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the logging task. The caller has to handle any cleanup by manually calling the `stop` method." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 446, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L446" + } + ], + "signatures": [ + { + "id": 723, + "name": "start", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the logging task. The caller has to handle any cleanup by manually calling the `stop` method." + } + ] + }, + "type": { + "type": "reference", + "name": "Task" + }, + "parameters": [] + } + ] + }, + { + "id": 724, + "name": "stop", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stop the logging task." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 453, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L453" + } + ], + "signatures": [ + { + "id": 725, + "name": "stop", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stop the logging task." + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] + }, + { + "id": 726, + "name": "__aenter__", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the logging task within the context. Exiting the context will cancel the logging task." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 464, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L464" + } + ], + "signatures": [ + { + "id": 727, + "name": "__aenter__", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the logging task within the context. Exiting the context will cancel the logging task." + } + ] + }, + "type": { + "type": "reference", + "name": "Self" + }, + "parameters": [] + } + ] + }, + { + "id": 728, + "name": "__aexit__", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Cancel the logging task." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 469, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L469" + } + ], + "signatures": [ + { + "id": 729, + "name": "__aexit__", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Cancel the logging task." + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 730, + "name": "exc_type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "type[BaseException] | None" + } + }, + { + "id": 731, + "name": "exc_val", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "BaseException | None" + } + }, + { + "id": 732, + "name": "exc_tb", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "TracebackType | None" + } + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 717 + ] + }, + { + "title": "Methods", + "children": [ + 726, + 728, + 722, + 724 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 429, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L429" + } + ] + }, + { + "id": 733, + "name": "StatusMessageWatcherSync", + "module": "apify_client.clients.resource_clients.log", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sync variant of `StatusMessageWatcher` that is logging in thread." + } + ] + }, + "children": [ + { + "id": 734, + "name": "__init__", + "module": "apify_client.clients.resource_clients.log", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize `StatusMessageWatcherSync`.\n\nArgs:\n run_client: The client for run that will be used to get a status and message.\n to_logger: The logger to which the status message will be redirected.\n check_period: The period with which the status message will be polled." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 487, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L487" + } + ], + "signatures": [ + { + "id": 735, + "name": "__init__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize `StatusMessageWatcherSync`.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 736, + "name": "run_client", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "RunClient", + "id": 415 + } + }, + { + "id": 737, + "name": "to_logger", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "logging.Logger" + } + }, + { + "id": 738, + "name": "check_period", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "timedelta" + }, + "defaultValue": "timedelta(seconds=1)" + } + ] + } + ] + }, + { + "id": 739, + "name": "start", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the logging thread. The caller has to handle any cleanup by manually calling the `stop` method." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 502, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L502" + } + ], + "signatures": [ + { + "id": 740, + "name": "start", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the logging thread. The caller has to handle any cleanup by manually calling the `stop` method." + } + ] + }, + "type": { + "type": "reference", + "name": "Thread" + }, + "parameters": [] + } + ] + }, + { + "id": 741, + "name": "stop", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Signal the _logging_thread thread to stop logging and wait for it to finish." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 511, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L511" + } + ], + "signatures": [ + { + "id": 742, + "name": "stop", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Signal the _logging_thread thread to stop logging and wait for it to finish." + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] + }, + { + "id": 743, + "name": "__enter__", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the logging task within the context. Exiting the context will cancel the logging task." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 521, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L521" + } + ], + "signatures": [ + { + "id": 744, + "name": "__enter__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the logging task within the context. Exiting the context will cancel the logging task." + } + ] + }, + "type": { + "type": "reference", + "name": "Self" + }, + "parameters": [] + } + ] + }, + { + "id": 745, + "name": "__exit__", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Cancel the logging task." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 526, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L526" + } + ], + "signatures": [ + { + "id": 746, + "name": "__exit__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Cancel the logging task." + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 747, + "name": "exc_type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "type[BaseException] | None" + } + }, + { + "id": 748, + "name": "exc_val", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "BaseException | None" + } + }, + { + "id": 749, + "name": "exc_tb", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "TracebackType | None" + } + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 734 + ] + }, + { + "title": "Methods", + "children": [ + 743, + 745, + 739, + 741 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 484, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L484" + } + ] + }, + { + "id": 750, + "name": "KeyValueStoreCollectionClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating key-value stores." + } + ] + }, + "children": [ + { + "id": 751, + "name": "list", + "module": "apify_client.clients.resource_clients.key_value_store_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available key-value stores.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n\nArgs:\n unnamed: Whether to include unnamed key-value stores in the list.\n limit: How many key-value stores to retrieve.\n offset: What key-value store to include as first when retrieving the list.\n desc: Whether to sort the key-value stores in descending order based on their modification date.\n\nReturns:\n The list of available key-value stores matching the specified filters." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store_collection.py", + "line": 19, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store_collection.py#L19" + } + ], + "signatures": [ + { + "id": 752, + "name": "list", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available key-value stores.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 753, + "name": "unnamed", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 754, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 755, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 756, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 757, + "name": "get_or_create", + "module": "apify_client.clients.resource_clients.key_value_store_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a named key-value store, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/create-key-value-store\n\nArgs:\n name: The name of the key-value store to retrieve or create.\n schema: The schema of the key-value store.\n\nReturns:\n The retrieved or newly-created key-value store." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store_collection.py", + "line": 42, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store_collection.py#L42" + } + ], + "signatures": [ + { + "id": 758, + "name": "get_or_create", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a named key-value store, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/create-key-value-store\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 759, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 760, + "name": "schema", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 757, + 751 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store_collection.py", + "line": 12, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store_collection.py#L12" + } + ] + }, + { + "id": 761, + "name": "KeyValueStoreCollectionClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating key-value stores." + } + ] + }, + "children": [ + { + "id": 762, + "name": "list", + "module": "apify_client.clients.resource_clients.key_value_store_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available key-value stores.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n\nArgs:\n unnamed: Whether to include unnamed key-value stores in the list.\n limit: How many key-value stores to retrieve.\n offset: What key-value store to include as first when retrieving the list.\n desc: Whether to sort the key-value stores in descending order based on their modification date.\n\nReturns:\n The list of available key-value stores matching the specified filters." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store_collection.py", + "line": 69, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store_collection.py#L69" + } + ], + "signatures": [ + { + "id": 763, + "name": "list", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available key-value stores.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 764, + "name": "unnamed", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 765, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 766, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 767, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 768, + "name": "get_or_create", + "module": "apify_client.clients.resource_clients.key_value_store_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a named key-value store, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/create-key-value-store\n\nArgs:\n name: The name of the key-value store to retrieve or create.\n schema: The schema of the key-value store.\n\nReturns:\n The retrieved or newly-created key-value store." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store_collection.py", + "line": 92, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store_collection.py#L92" + } + ], + "signatures": [ + { + "id": 769, + "name": "get_or_create", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a named key-value store, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/create-key-value-store\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 770, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 771, + "name": "schema", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 768, + 762 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store_collection.py", + "line": 62, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store_collection.py#L62" + } + ] + }, + { + "id": 772, + "name": "KeyValueStoreClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating a single key-value store." + } + ] + }, + "children": [ + { + "id": 773, + "name": "get", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/get-store\n\nReturns:\n The retrieved key-value store, or None if it does not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 37, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L37" + } + ], + "signatures": [ + { + "id": 774, + "name": "get", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/get-store\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 775, + "name": "update", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the key-value store with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/update-store\n\nArgs:\n name: The new name for key-value store.\n general_access: Determines how others can access the key-value store.\n\nReturns:\n The updated key-value store." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 47, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L47" + } + ], + "signatures": [ + { + "id": 776, + "name": "update", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the key-value store with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/update-store\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 777, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 778, + "name": "general_access", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "StorageGeneralAccess | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 779, + "name": "delete", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/delete-store" + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 66, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L66" + } + ], + "signatures": [ + { + "id": 780, + "name": "delete", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/delete-store" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] + }, + { + "id": 781, + "name": "list_keys", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the keys in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n\nArgs:\n limit: Number of keys to be returned. Maximum value is 1000.\n exclusive_start_key: All keys up to this one (including) are skipped from the result.\n collection: The name of the collection in store schema to list keys from.\n prefix: The prefix of the keys to be listed.\n signature: Signature used to access the items.\n\nReturns:\n The list of keys in the key-value store matching the given arguments." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 73, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L73" + } + ], + "signatures": [ + { + "id": 782, + "name": "list_keys", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the keys in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 783, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 784, + "name": "exclusive_start_key", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 785, + "name": "collection", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 786, + "name": "prefix", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 787, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 788, + "name": "get_record", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the given record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n\nArgs:\n key: Key of the record to retrieve.\n signature: Signature used to access the items.\n\nReturns:\n The requested record, or None, if the record does not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 113, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L113" + } + ], + "signatures": [ + { + "id": 789, + "name": "get_record", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the given record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [ + { + "id": 790, + "name": "key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 791, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 792, + "name": "record_exists", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Check if given record is present in the key-value store.\n\nhttps://docs.apify.com/api/v2/key-value-store-record-head\n\nArgs:\n key: Key of the record to check.\n\nReturns:\n True if the record exists, False otherwise." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 143, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L143" + } + ], + "signatures": [ + { + "id": 793, + "name": "record_exists", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Check if given record is present in the key-value store.\n\nhttps://docs.apify.com/api/v2/key-value-store-record-head\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "parameters": [ + { + "id": 794, + "name": "key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 795, + "name": "get_record_as_bytes", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the given record from the key-value store, without parsing it.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n\nArgs:\n key: Key of the record to retrieve.\n signature: Signature used to access the items.\n\nReturns:\n The requested record, or None, if the record does not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 168, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L168" + } + ], + "signatures": [ + { + "id": 796, + "name": "get_record_as_bytes", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the given record from the key-value store, without parsing it.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [ + { + "id": 797, + "name": "key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 798, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 799, + "name": "stream_record", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the given record from the key-value store, as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n\nArgs:\n key: Key of the record to retrieve.\n signature: Signature used to access the items.\n\nReturns:\n The requested record as a context-managed streaming Response, or None, if the record does not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 199, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L199" + } + ], + "signatures": [ + { + "id": 800, + "name": "stream_record", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the given record from the key-value store, as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "Iterator[dict | None]" + }, + "parameters": [ + { + "id": 801, + "name": "key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 802, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 803, + "name": "set_record", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set a value to the given record in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record\n\nArgs:\n key: The key of the record to save the value to.\n value: The value to save into the record.\n content_type: The content type of the saved value." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 233, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L233" + } + ], + "signatures": [ + { + "id": 804, + "name": "set_record", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set a value to the given record in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 805, + "name": "key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 806, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Any" + } + }, + { + "id": 807, + "name": "content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 808, + "name": "delete_record", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the specified record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/delete-record\n\nArgs:\n key: The key of the record which to delete." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 260, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L260" + } + ], + "signatures": [ + { + "id": 809, + "name": "delete_record", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the specified record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/delete-record\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 810, + "name": "key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 811, + "name": "get_record_public_url", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generate a URL that can be used to access key-value store record.\n\nIf the client has permission to access the key-value store's URL signing key, the URL will include a signature\nto verify its authenticity.\n\nArgs:\n key: The key for which the URL should be generated.\n\nReturns:\n A public URL that can be used to access the value of the given key in the KVS." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 275, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L275" + } + ], + "signatures": [ + { + "id": 812, + "name": "get_record_public_url", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generate a URL that can be used to access key-value store record.\n\nIf the client has permission to access the key-value store's URL signing key, the URL will include a signature\nto verify its authenticity.\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "str" + }, + "parameters": [ + { + "id": 813, + "name": "key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 814, + "name": "create_keys_public_url", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generate a URL that can be used to access key-value store keys.\n\nIf the client has permission to access the key-value store's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in_secs` option.\nThis value sets the expiration duration in seconds from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `prefix`) will be included as query parameters in the URL.\n\nReturns:\n The public key-value store keys URL." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 305, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L305" + } + ], + "signatures": [ + { + "id": 815, + "name": "create_keys_public_url", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generate a URL that can be used to access key-value store keys.\n\nIf the client has permission to access the key-value store's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in_secs` option.\nThis value sets the expiration duration in seconds from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `prefix`) will be included as query parameters in the URL.\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "str" + }, + "parameters": [ + { + "id": 816, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 817, + "name": "exclusive_start_key", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 818, + "name": "collection", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 819, + "name": "prefix", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 820, + "name": "expires_in_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 814, + 779, + 808, + 773, + 788, + 795, + 811, + 781, + 792, + 803, + 799, + 775 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 30, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L30" + } + ] + }, + { + "id": 821, + "name": "KeyValueStoreClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating a single key-value store." + } + ] + }, + "children": [ + { + "id": 822, + "name": "get", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/get-store\n\nReturns:\n The retrieved key-value store, or None if it does not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 361, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L361" + } + ], + "signatures": [ + { + "id": 823, + "name": "get", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/get-store\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 824, + "name": "update", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the key-value store with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/update-store\n\nArgs:\n name: The new name for key-value store.\n general_access: Determines how others can access the key-value store.\n\nReturns:\n The updated key-value store." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 371, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L371" + } + ], + "signatures": [ + { + "id": 825, + "name": "update", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the key-value store with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/update-store\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 826, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 827, + "name": "general_access", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "StorageGeneralAccess | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 828, + "name": "delete", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/delete-store" + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 390, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L390" + } + ], + "signatures": [ + { + "id": 829, + "name": "delete", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/delete-store" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] + }, + { + "id": 830, + "name": "list_keys", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the keys in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n\nArgs:\n limit: Number of keys to be returned. Maximum value is 1000.\n exclusive_start_key: All keys up to this one (including) are skipped from the result.\n collection: The name of the collection in store schema to list keys from.\n prefix: The prefix of the keys to be listed.\n signature: Signature used to access the items.\n\nReturns:\n The list of keys in the key-value store matching the given arguments." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 397, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L397" + } + ], + "signatures": [ + { + "id": 831, + "name": "list_keys", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the keys in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 832, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 833, + "name": "exclusive_start_key", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 834, + "name": "collection", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 835, + "name": "prefix", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 836, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 837, + "name": "get_record", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the given record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n\nArgs:\n key: Key of the record to retrieve.\n signature: Signature used to access the items.\n\nReturns:\n The requested record, or None, if the record does not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 437, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L437" + } + ], + "signatures": [ + { + "id": 838, + "name": "get_record", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the given record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [ + { + "id": 839, + "name": "key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 840, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 841, + "name": "record_exists", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Check if given record is present in the key-value store.\n\nhttps://docs.apify.com/api/v2/key-value-store-record-head\n\nArgs:\n key: Key of the record to check.\n\nReturns:\n True if the record exists, False otherwise." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 467, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L467" + } + ], + "signatures": [ + { + "id": 842, + "name": "record_exists", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Check if given record is present in the key-value store.\n\nhttps://docs.apify.com/api/v2/key-value-store-record-head\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "parameters": [ + { + "id": 843, + "name": "key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 844, + "name": "get_record_as_bytes", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the given record from the key-value store, without parsing it.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n\nArgs:\n key: Key of the record to retrieve.\n signature: Signature used to access the items.\n\nReturns:\n The requested record, or None, if the record does not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 492, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L492" + } + ], + "signatures": [ + { + "id": 845, + "name": "get_record_as_bytes", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the given record from the key-value store, without parsing it.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [ + { + "id": 846, + "name": "key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 847, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 848, + "name": "stream_record", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the given record from the key-value store, as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n\nArgs:\n key: Key of the record to retrieve.\n signature: Signature used to access the items.\n\nReturns:\n The requested record as a context-managed streaming Response, or None, if the record does not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 523, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L523" + } + ], + "signatures": [ + { + "id": 849, + "name": "stream_record", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the given record from the key-value store, as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "AsyncIterator[dict | None]" + }, + "parameters": [ + { + "id": 850, + "name": "key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 851, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 852, + "name": "set_record", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set a value to the given record in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record\n\nArgs:\n key: The key of the record to save the value to.\n value: The value to save into the record.\n content_type: The content type of the saved value." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 557, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L557" + } + ], + "signatures": [ + { + "id": 853, + "name": "set_record", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set a value to the given record in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 854, + "name": "key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 855, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Any" + } + }, + { + "id": 856, + "name": "content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 857, + "name": "delete_record", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the specified record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/delete-record\n\nArgs:\n key: The key of the record which to delete." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 584, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L584" + } + ], + "signatures": [ + { + "id": 858, + "name": "delete_record", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the specified record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/delete-record\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 859, + "name": "key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 860, + "name": "get_record_public_url", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generate a URL that can be used to access key-value store record.\n\nIf the client has permission to access the key-value store's URL signing key, the URL will include a signature\nto verify its authenticity.\n\nArgs:\n key: The key for which the URL should be generated.\n\nReturns:\n A public URL that can be used to access the value of the given key in the KVS." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 599, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L599" + } + ], + "signatures": [ + { + "id": 861, + "name": "get_record_public_url", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generate a URL that can be used to access key-value store record.\n\nIf the client has permission to access the key-value store's URL signing key, the URL will include a signature\nto verify its authenticity.\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "str" + }, + "parameters": [ + { + "id": 862, + "name": "key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 863, + "name": "create_keys_public_url", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generate a URL that can be used to access key-value store keys.\n\nIf the client has permission to access the key-value store's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in_secs` option.\nThis value sets the expiration duration in seconds from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `prefix`) will be included as query parameters in the URL.\n\nReturns:\n The public key-value store keys URL." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 629, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L629" + } + ], + "signatures": [ + { + "id": 864, + "name": "create_keys_public_url", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generate a URL that can be used to access key-value store keys.\n\nIf the client has permission to access the key-value store's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in_secs` option.\nThis value sets the expiration duration in seconds from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `prefix`) will be included as query parameters in the URL.\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "str" + }, + "parameters": [ + { + "id": 865, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 866, + "name": "exclusive_start_key", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 867, + "name": "collection", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 868, + "name": "prefix", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 869, + "name": "expires_in_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 863, + 828, + 857, + 822, + 837, + 844, + 860, + 830, + 841, + 852, + 848, + 824 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 354, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L354" + } + ] + }, + { + "id": 870, + "name": "DatasetCollectionClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating datasets." + } + ] + }, + "children": [ + { + "id": 871, + "name": "list", + "module": "apify_client.clients.resource_clients.dataset_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available datasets.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n\nArgs:\n unnamed: Whether to include unnamed datasets in the list.\n limit: How many datasets to retrieve.\n offset: What dataset to include as first when retrieving the list.\n desc: Whether to sort the datasets in descending order based on their modification date.\n\nReturns:\n The list of available datasets matching the specified filters." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/dataset_collection.py", + "line": 19, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset_collection.py#L19" + } + ], + "signatures": [ + { + "id": 872, + "name": "list", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available datasets.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 873, + "name": "unnamed", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 874, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 875, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 876, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 877, + "name": "get_or_create", + "module": "apify_client.clients.resource_clients.dataset_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a named dataset, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/create-dataset\n\nArgs:\n name: The name of the dataset to retrieve or create.\n schema: The schema of the dataset.\n\nReturns:\n The retrieved or newly-created dataset." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/dataset_collection.py", + "line": 42, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset_collection.py#L42" + } + ], + "signatures": [ + { + "id": 878, + "name": "get_or_create", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a named dataset, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/create-dataset\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 879, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 880, + "name": "schema", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 877, + 871 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/dataset_collection.py", + "line": 12, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset_collection.py#L12" + } + ] + }, + { + "id": 881, + "name": "DatasetCollectionClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating datasets." + } + ] + }, + "children": [ + { + "id": 882, + "name": "list", + "module": "apify_client.clients.resource_clients.dataset_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available datasets.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n\nArgs:\n unnamed: Whether to include unnamed datasets in the list.\n limit: How many datasets to retrieve.\n offset: What dataset to include as first when retrieving the list.\n desc: Whether to sort the datasets in descending order based on their modification date.\n\nReturns:\n The list of available datasets matching the specified filters." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/dataset_collection.py", + "line": 64, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset_collection.py#L64" + } + ], + "signatures": [ + { + "id": 883, + "name": "list", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available datasets.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 884, + "name": "unnamed", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 885, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 886, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 887, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 888, + "name": "get_or_create", + "module": "apify_client.clients.resource_clients.dataset_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a named dataset, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/create-dataset\n\nArgs:\n name: The name of the dataset to retrieve or create.\n schema: The schema of the dataset.\n\nReturns:\n The retrieved or newly-created dataset." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/dataset_collection.py", + "line": 87, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset_collection.py#L87" + } + ], + "signatures": [ + { + "id": 889, + "name": "get_or_create", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a named dataset, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/create-dataset\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 890, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 891, + "name": "schema", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 888, + 882 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/dataset_collection.py", + "line": 57, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset_collection.py#L57" + } + ] + }, + { + "id": 892, + "name": "DatasetClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating a single dataset." + } + ] + }, + "children": [ + { + "id": 893, + "name": "get", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset\n\nReturns:\n The retrieved dataset, or None, if it does not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 38, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L38" + } + ], + "signatures": [ + { + "id": 894, + "name": "get", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 895, + "name": "update", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the dataset with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset\n\nArgs:\n name: The new name for the dataset.\n general_access: Determines how others can access the dataset.\n\nReturns:\n The updated dataset." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 48, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L48" + } + ], + "signatures": [ + { + "id": 896, + "name": "update", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the dataset with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 897, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 898, + "name": "general_access", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "StorageGeneralAccess | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 899, + "name": "delete", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset" + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 67, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L67" + } + ], + "signatures": [ + { + "id": 900, + "name": "delete", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] + }, + { + "id": 901, + "name": "list_items", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the items of the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\nArgs:\n offset: Number of items that should be skipped at the start. The default value is 0.\n limit: Maximum number of items to return. By default there is no limit.\n desc: By default, results are returned in the same order as they were stored. To reverse the order,\n set this parameter to True.\n clean: If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\n the # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\n parameters. Note that since some objects might be skipped from the output, that the result might\n contain less items than the limit value.\n fields: A list of fields which should be picked from the items, only these fields will remain\n in the resulting record objects. Note that the fields in the outputted items are sorted the same\n way as they are specified in the fields parameter. You can use this feature to effectively fix\n the output format.\n omit: A list of fields which should be omitted from the items.\n unwind: A list of fields which should be unwound, in order which they should be processed. Each field\n should be either an array or an object. If the field is an array then every element of the array\n will become a separate record and merged with parent object. If the unwound field is an object then\n it is merged with the parent object. If the unwound field is missing or its value is neither an array\n nor an object and therefore cannot be merged with a parent object, then the item gets preserved\n as it is. Note that the unwound items ignore the desc parameter.\n skip_empty: If True, then empty items are skipped from the output. Note that if used, the results might\n contain less items than the limit value.\n skip_hidden: If True, then hidden fields are skipped from the output, i.e. fields starting with\n the # character.\n flatten: A list of fields that should be flattened.\n view: Name of the dataset view to be used.\n signature: Signature used to access the items.\n\nReturns:\n A page of the list of dataset items according to the specified filters." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 74, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L74" + } + ], + "signatures": [ + { + "id": 902, + "name": "list_items", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the items of the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage", + "id": 1725 + }, + "parameters": [ + { + "id": 903, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 904, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 905, + "name": "clean", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 906, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 907, + "name": "fields", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 908, + "name": "omit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 909, + "name": "unwind", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 910, + "name": "skip_empty", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 911, + "name": "skip_hidden", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 912, + "name": "flatten", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 913, + "name": "view", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 914, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 915, + "name": "iterate_items", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the items in the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\nArgs:\n offset: Number of items that should be skipped at the start. The default value is 0.\n limit: Maximum number of items to return. By default there is no limit.\n desc: By default, results are returned in the same order as they were stored. To reverse the order,\n set this parameter to True.\n clean: If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\n the # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\n parameters. Note that since some objects might be skipped from the output, that the result might\n contain less items than the limit value.\n fields: A list of fields which should be picked from the items, only these fields will remain in\n the resulting record objects. Note that the fields in the outputted items are sorted the same way\n as they are specified in the fields parameter. You can use this feature to effectively fix\n the output format.\n omit: A list of fields which should be omitted from the items.\n unwind: A list of fields which should be unwound, in order which they should be processed. Each field\n should be either an array or an object. If the field is an array then every element of the array\n will become a separate record and merged with parent object. If the unwound field is an object then\n it is merged with the parent object. If the unwound field is missing or its value is neither an array\n nor an object and therefore cannot be merged with a parent object, then the item gets preserved\n as it is. Note that the unwound items ignore the desc parameter.\n skip_empty: If True, then empty items are skipped from the output. Note that if used, the results might\n contain less items than the limit value.\n skip_hidden: If True, then hidden fields are skipped from the output, i.e. fields starting with\n the # character.\n signature: Signature used to access the items.\n\nYields:\n An item from the dataset." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 163, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L163" + } + ], + "signatures": [ + { + "id": 916, + "name": "iterate_items", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the items in the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "Iterator[dict]" + }, + "parameters": [ + { + "id": 917, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "int" + }, + "defaultValue": "0" + }, + { + "id": 918, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 919, + "name": "clean", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 920, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 921, + "name": "fields", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 922, + "name": "omit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 923, + "name": "unwind", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 924, + "name": "skip_empty", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 925, + "name": "skip_hidden", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 926, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 927, + "name": "download_items", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the items in the dataset as raw bytes.\n\nDeprecated: this function is a deprecated alias of `get_items_as_bytes`. It will be removed in\na future version.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\nArgs:\n item_format: Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\n The default value is json.\n offset: Number of items that should be skipped at the start. The default value is 0.\n limit: Maximum number of items to return. By default there is no limit.\n desc: By default, results are returned in the same order as they were stored. To reverse the order,\n set this parameter to True.\n clean: If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\n the # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\n parameters. Note that since some objects might be skipped from the output, that the result might\n contain less items than the limit value.\n bom: All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\n the UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\n to override this default behavior, specify bom=True query parameter to include the BOM or bom=False\n to skip it.\n delimiter: A delimiter character for CSV files. The default delimiter is a simple comma (,).\n fields: A list of fields which should be picked from the items, only these fields will remain in\n the resulting record objects. Note that the fields in the outputted items are sorted the same way\n as they are specified in the fields parameter. You can use this feature to effectively fix the\n output format.\n omit: A list of fields which should be omitted from the items.\n unwind: A list of fields which should be unwound, in order which they should be processed. Each field\n should be either an array or an object. If the field is an array then every element of the array\n will become a separate record and merged with parent object. If the unwound field is an object then\n it is merged with the parent object. If the unwound field is missing or its value is neither an array\n nor an object and therefore cannot be merged with a parent object, then the item gets preserved\n as it is. Note that the unwound items ignore the desc parameter.\n skip_empty: If True, then empty items are skipped from the output. Note that if used, the results might\n contain less items than the limit value.\n skip_header_row: If True, then header row in the csv format is skipped.\n skip_hidden: If True, then hidden fields are skipped from the output, i.e. fields starting with\n the # character.\n xml_root: Overrides default root element name of xml output. By default the root element is items.\n xml_row: Overrides default element name that wraps each page or page function result object in xml output.\n By default the element name is item.\n flatten: A list of fields that should be flattened.\n signature: Signature used to access the items.\n\nReturns:\n The dataset items as raw bytes." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 246, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L246" + } + ], + "signatures": [ + { + "id": 928, + "name": "download_items", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the items in the dataset as raw bytes.\n\nDeprecated: this function is a deprecated alias of `get_items_as_bytes`. It will be removed in\na future version.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "bytes" + }, + "parameters": [ + { + "id": 929, + "name": "item_format", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + }, + "defaultValue": "'json'" + }, + { + "id": 930, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 931, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 932, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 933, + "name": "clean", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 934, + "name": "bom", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 935, + "name": "delimiter", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 936, + "name": "fields", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 937, + "name": "omit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 938, + "name": "unwind", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 939, + "name": "skip_empty", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 940, + "name": "skip_header_row", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 941, + "name": "skip_hidden", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 942, + "name": "xml_root", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 943, + "name": "xml_row", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 944, + "name": "flatten", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 945, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 946, + "name": "get_items_as_bytes", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the items in the dataset as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\nArgs:\n item_format: Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\n The default value is json.\n offset: Number of items that should be skipped at the start. The default value is 0.\n limit: Maximum number of items to return. By default there is no limit.\n desc: By default, results are returned in the same order as they were stored. To reverse the order,\n set this parameter to True.\n clean: If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\n the # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\n parameters. Note that since some objects might be skipped from the output, that the result might\n contain less items than the limit value.\n bom: All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\n the UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\n to override this default behavior, specify bom=True query parameter to include the BOM or bom=False\n to skip it.\n delimiter: A delimiter character for CSV files. The default delimiter is a simple comma (,).\n fields: A list of fields which should be picked from the items, only these fields will remain\n in the resulting record objects. Note that the fields in the outputted items are sorted the same\n way as they are specified in the fields parameter. You can use this feature to effectively fix\n the output format.\n You can use this feature to effectively fix the output format.\n omit: A list of fields which should be omitted from the items.\n unwind: A list of fields which should be unwound, in order which they should be processed. Each field\n should be either an array or an object. If the field is an array then every element of the array\n will become a separate record and merged with parent object. If the unwound field is an object then\n it is merged with the parent object. If the unwound field is missing or its value is neither an array\n nor an object and therefore cannot be merged with a parent object, then the item gets preserved\n as it is. Note that the unwound items ignore the desc parameter.\n skip_empty: If True, then empty items are skipped from the output. Note that if used, the results might\n contain less items than the limit value.\n skip_header_row: If True, then header row in the csv format is skipped.\n skip_hidden: If True, then hidden fields are skipped from the output, i.e. fields starting with\n the # character.\n xml_root: Overrides default root element name of xml output. By default the root element is items.\n xml_row: Overrides default element name that wraps each page or page function result object in xml output.\n By default the element name is item.\n flatten: A list of fields that should be flattened.\n signature: Signature used to access the items.\n\nReturns:\n The dataset items as raw bytes." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 341, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L341" + } + ], + "signatures": [ + { + "id": 947, + "name": "get_items_as_bytes", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the items in the dataset as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "bytes" + }, + "parameters": [ + { + "id": 948, + "name": "item_format", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + }, + "defaultValue": "'json'" + }, + { + "id": 949, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 950, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 951, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 952, + "name": "clean", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 953, + "name": "bom", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 954, + "name": "delimiter", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 955, + "name": "fields", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 956, + "name": "omit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 957, + "name": "unwind", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 958, + "name": "skip_empty", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 959, + "name": "skip_header_row", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 960, + "name": "skip_hidden", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 961, + "name": "xml_root", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 962, + "name": "xml_row", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 963, + "name": "flatten", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 964, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 965, + "name": "stream_items", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the items in the dataset as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\nArgs:\n item_format: Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\n The default value is json.\n offset: Number of items that should be skipped at the start. The default value is 0.\n limit: Maximum number of items to return. By default there is no limit.\n desc: By default, results are returned in the same order as they were stored. To reverse the order,\n set this parameter to True.\n clean: If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\n the # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\n parameters. Note that since some objects might be skipped from the output, that the result might\n contain less items than the limit value.\n bom: All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\n the UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\n to override this default behavior, specify bom=True query parameter to include the BOM or bom=False\n to skip it.\n delimiter: A delimiter character for CSV files. The default delimiter is a simple comma (,).\n fields: A list of fields which should be picked from the items, only these fields will remain\n in the resulting record objects. Note that the fields in the outputted items are sorted the same\n way as they are specified in the fields parameter. You can use this feature to effectively fix\n the output format.\n You can use this feature to effectively fix the output format.\n omit: A list of fields which should be omitted from the items.\n unwind: A list of fields which should be unwound, in order which they should be processed. Each field\n should be either an array or an object. If the field is an array then every element of the array\n will become a separate record and merged with parent object. If the unwound field is an object then\n it is merged with the parent object. If the unwound field is missing or its value is neither an array\n nor an object and therefore cannot be merged with a parent object, then the item gets preserved\n as it is. Note that the unwound items ignore the desc parameter.\n skip_empty: If True, then empty items are skipped from the output. Note that if used, the results might\n contain less items than the limit value.\n skip_header_row: If True, then header row in the csv format is skipped.\n skip_hidden: If True, then hidden fields are skipped from the output, i.e. fields starting with\n the # character.\n xml_root: Overrides default root element name of xml output. By default the root element is items.\n xml_row: Overrides default element name that wraps each page or page function result object in xml output.\n By default the element name is item.\n signature: Signature used to access the items.\n\nReturns:\n The dataset items as a context-managed streaming `Response`." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 437, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L437" + } + ], + "signatures": [ + { + "id": 966, + "name": "stream_items", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the items in the dataset as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "Iterator[impit.Response]" + }, + "parameters": [ + { + "id": 967, + "name": "item_format", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + }, + "defaultValue": "'json'" + }, + { + "id": 968, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 969, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 970, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 971, + "name": "clean", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 972, + "name": "bom", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 973, + "name": "delimiter", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 974, + "name": "fields", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 975, + "name": "omit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 976, + "name": "unwind", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 977, + "name": "skip_empty", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 978, + "name": "skip_header_row", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 979, + "name": "skip_hidden", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 980, + "name": "xml_root", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 981, + "name": "xml_row", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 982, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 983, + "name": "push_items", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Push items to the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/put-items\n\nArgs:\n items: The items which to push in the dataset. Either a stringified JSON, a dictionary, or a list\n of strings or dictionaries." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 534, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L534" + } + ], + "signatures": [ + { + "id": 984, + "name": "push_items", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Push items to the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/put-items\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 985, + "name": "items", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "JSONSerializable", + "id": 1724 + } + } + ] + } + ] + }, + { + "id": 986, + "name": "get_statistics", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the dataset statistics.\n\nhttps://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get\n\nReturns:\n The dataset statistics or None if the dataset does not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 561, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L561" + } + ], + "signatures": [ + { + "id": 987, + "name": "get_statistics", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the dataset statistics.\n\nhttps://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 988, + "name": "create_items_public_url", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generate a URL that can be used to access dataset items.\n\nIf the client has permission to access the dataset's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in_secs` option.\nThis value sets the expiration duration in seconds from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `offset`) will be included as query parameters in the URL.\n\nReturns:\n The public dataset items URL." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 582, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L582" + } + ], + "signatures": [ + { + "id": 989, + "name": "create_items_public_url", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generate a URL that can be used to access dataset items.\n\nIf the client has permission to access the dataset's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in_secs` option.\nThis value sets the expiration duration in seconds from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `offset`) will be included as query parameters in the URL.\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "str" + }, + "parameters": [ + { + "id": 990, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 991, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 992, + "name": "clean", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 993, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 994, + "name": "fields", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 995, + "name": "omit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 996, + "name": "unwind", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 997, + "name": "skip_empty", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 998, + "name": "skip_hidden", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 999, + "name": "flatten", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1000, + "name": "view", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1001, + "name": "expires_in_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 988, + 899, + 927, + 893, + 946, + 986, + 915, + 901, + 983, + 965, + 895 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 31, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L31" + } + ] + }, + { + "id": 1002, + "name": "DatasetClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating a single dataset." + } + ] + }, + "children": [ + { + "id": 1003, + "name": "get", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset\n\nReturns:\n The retrieved dataset, or None, if it does not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 651, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L651" + } + ], + "signatures": [ + { + "id": 1004, + "name": "get", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 1005, + "name": "update", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the dataset with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset\n\nArgs:\n name: The new name for the dataset.\n general_access: Determines how others can access the dataset.\n\nReturns:\n The updated dataset." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 661, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L661" + } + ], + "signatures": [ + { + "id": 1006, + "name": "update", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the dataset with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1007, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1008, + "name": "general_access", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "StorageGeneralAccess | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 1009, + "name": "delete", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset" + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 680, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L680" + } + ], + "signatures": [ + { + "id": 1010, + "name": "delete", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] + }, + { + "id": 1011, + "name": "list_items", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the items of the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\nArgs:\n offset: Number of items that should be skipped at the start. The default value is 0.\n limit: Maximum number of items to return. By default there is no limit.\n desc: By default, results are returned in the same order as they were stored. To reverse the order,\n set this parameter to True.\n clean: If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\n the # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\n parameters. Note that since some objects might be skipped from the output, that the result might\n contain less items than the limit value.\n fields: A list of fields which should be picked from the items, only these fields will remain\n in the resulting record objects. Note that the fields in the outputted items are sorted the same\n way as they are specified in the fields parameter. You can use this feature to effectively fix\n the output format.\n omit: A list of fields which should be omitted from the items.\n unwind: A list of fields which should be unwound, in order which they should be processed. Each field\n should be either an array or an object. If the field is an array then every element of the array\n will become a separate record and merged with parent object. If the unwound field is an object then\n it is merged with the parent object. If the unwound field is missing or its value is neither an array\n nor an object and therefore cannot be merged with a parent object, then the item gets preserved\n as it is. Note that the unwound items ignore the desc parameter.\n skip_empty: If True, then empty items are skipped from the output. Note that if used, the results might\n contain less items than the limit value.\n skip_hidden: If True, then hidden fields are skipped from the output, i.e. fields starting with\n the # character.\n flatten: A list of fields that should be flattened.\n view: Name of the dataset view to be used.\n signature: Signature used to access the items.\n\nReturns:\n A page of the list of dataset items according to the specified filters." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 687, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L687" + } + ], + "signatures": [ + { + "id": 1012, + "name": "list_items", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the items of the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage", + "id": 1725 + }, + "parameters": [ + { + "id": 1013, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1014, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1015, + "name": "clean", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1016, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1017, + "name": "fields", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1018, + "name": "omit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1019, + "name": "unwind", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1020, + "name": "skip_empty", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1021, + "name": "skip_hidden", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1022, + "name": "flatten", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1023, + "name": "view", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1024, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 1025, + "name": "iterate_items", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the items in the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\nArgs:\n offset: Number of items that should be skipped at the start. The default value is 0.\n limit: Maximum number of items to return. By default there is no limit.\n desc: By default, results are returned in the same order as they were stored. To reverse the order,\n set this parameter to True.\n clean: If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\n the # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\n parameters. Note that since some objects might be skipped from the output, that the result might\n contain less items than the limit value.\n fields: A list of fields which should be picked from the items, only these fields will remain in\n the resulting record objects. Note that the fields in the outputted items are sorted the same way\n as they are specified in the fields parameter. You can use this feature to effectively fix\n the output format.\n omit: A list of fields which should be omitted from the items.\n unwind: A list of fields which should be unwound, in order which they should be processed. Each field\n should be either an array or an object. If the field is an array then every element of the array\n will become a separate record and merged with parent object. If the unwound field is an object then\n it is merged with the parent object. If the unwound field is missing or its value is neither an array\n nor an object and therefore cannot be merged with a parent object, then the item gets preserved\n as it is. Note that the unwound items ignore the desc parameter.\n skip_empty: If True, then empty items are skipped from the output. Note that if used, the results might\n contain less items than the limit value.\n skip_hidden: If True, then hidden fields are skipped from the output, i.e. fields starting with\n the # character.\n signature: Signature used to access the items.\n\nYields:\n An item from the dataset." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 776, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L776" + } + ], + "signatures": [ + { + "id": 1026, + "name": "iterate_items", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the items in the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "AsyncIterator[dict]" + }, + "parameters": [ + { + "id": 1027, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "int" + }, + "defaultValue": "0" + }, + { + "id": 1028, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1029, + "name": "clean", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1030, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1031, + "name": "fields", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1032, + "name": "omit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1033, + "name": "unwind", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1034, + "name": "skip_empty", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1035, + "name": "skip_hidden", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1036, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 1037, + "name": "get_items_as_bytes", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the items in the dataset as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\nArgs:\n item_format: Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\n The default value is json.\n offset: Number of items that should be skipped at the start. The default value is 0.\n limit: Maximum number of items to return. By default there is no limit.\n desc: By default, results are returned in the same order as they were stored. To reverse the order,\n set this parameter to True.\n clean: If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\n the # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\n parameters. Note that since some objects might be skipped from the output, that the result might\n contain less items than the limit value.\n bom: All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\n the UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\n to override this default behavior, specify bom=True query parameter to include the BOM or bom=False\n to skip it.\n delimiter: A delimiter character for CSV files. The default delimiter is a simple comma (,).\n fields: A list of fields which should be picked from the items, only these fields will remain\n in the resulting record objects. Note that the fields in the outputted items are sorted the same\n way as they are specified in the fields parameter. You can use this feature to effectively fix\n the output format.\n You can use this feature to effectively fix the output format.\n omit: A list of fields which should be omitted from the items.\n unwind: A list of fields which should be unwound, in order which they should be processed. Each field\n should be either an array or an object. If the field is an array then every element of the array\n will become a separate record and merged with parent object. If the unwound field is an object then\n it is merged with the parent object. If the unwound field is missing or its value is neither an array\n nor an object and therefore cannot be merged with a parent object, then the item gets preserved\n as it is. Note that the unwound items ignore the desc parameter.\n skip_empty: If True, then empty items are skipped from the output. Note that if used, the results might\n contain less items than the limit value.\n skip_header_row: If True, then header row in the csv format is skipped.\n skip_hidden: If True, then hidden fields are skipped from the output, i.e. fields starting with\n the # character.\n xml_root: Overrides default root element name of xml output. By default the root element is items.\n xml_row: Overrides default element name that wraps each page or page function result object in xml output.\n By default the element name is item.\n flatten: A list of fields that should be flattened.\n signature: Signature used to access the items.\n\nReturns:\n The dataset items as raw bytes." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 860, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L860" + } + ], + "signatures": [ + { + "id": 1038, + "name": "get_items_as_bytes", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the items in the dataset as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "bytes" + }, + "parameters": [ + { + "id": 1039, + "name": "item_format", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + }, + "defaultValue": "'json'" + }, + { + "id": 1040, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1041, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1042, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1043, + "name": "clean", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1044, + "name": "bom", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1045, + "name": "delimiter", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1046, + "name": "fields", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1047, + "name": "omit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1048, + "name": "unwind", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1049, + "name": "skip_empty", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1050, + "name": "skip_header_row", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1051, + "name": "skip_hidden", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1052, + "name": "xml_root", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1053, + "name": "xml_row", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1054, + "name": "flatten", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1055, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 1056, + "name": "stream_items", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the items in the dataset as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\nArgs:\n item_format: Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\n The default value is json.\n offset: Number of items that should be skipped at the start. The default value is 0.\n limit: Maximum number of items to return. By default there is no limit.\n desc: By default, results are returned in the same order as they were stored. To reverse the order,\n set this parameter to True.\n clean: If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\n the # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\n parameters. Note that since some objects might be skipped from the output, that the result might\n contain less items than the limit value.\n bom: All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\n the UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\n to override this default behavior, specify bom=True query parameter to include the BOM or bom=False\n to skip it.\n delimiter: A delimiter character for CSV files. The default delimiter is a simple comma (,).\n fields: A list of fields which should be picked from the items, only these fields will remain\n in the resulting record objects. Note that the fields in the outputted items are sorted the same\n way as they are specified in the fields parameter. You can use this feature to effectively fix\n the output format.\n You can use this feature to effectively fix the output format.\n omit: A list of fields which should be omitted from the items.\n unwind: A list of fields which should be unwound, in order which they should be processed. Each field\n should be either an array or an object. If the field is an array then every element of the array\n will become a separate record and merged with parent object. If the unwound field is an object then\n it is merged with the parent object. If the unwound field is missing or its value is neither an array\n nor an object and therefore cannot be merged with a parent object, then the item gets preserved\n as it is. Note that the unwound items ignore the desc parameter.\n skip_empty: If True, then empty items are skipped from the output. Note that if used, the results might\n contain less items than the limit value.\n skip_header_row: If True, then header row in the csv format is skipped.\n skip_hidden: If True, then hidden fields are skipped from the output, i.e. fields starting with\n the # character.\n xml_root: Overrides default root element name of xml output. By default the root element is items.\n xml_row: Overrides default element name that wraps each page or page function result object in xml output.\n By default the element name is item.\n signature: Signature used to access the items.\n\nReturns:\n The dataset items as a context-managed streaming `Response`." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 956, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L956" + } + ], + "signatures": [ + { + "id": 1057, + "name": "stream_items", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the items in the dataset as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "AsyncIterator[impit.Response]" + }, + "parameters": [ + { + "id": 1058, + "name": "item_format", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + }, + "defaultValue": "'json'" + }, + { + "id": 1059, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1060, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1061, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1062, + "name": "clean", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1063, + "name": "bom", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1064, + "name": "delimiter", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1065, + "name": "fields", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1066, + "name": "omit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1067, + "name": "unwind", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1068, + "name": "skip_empty", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1069, + "name": "skip_header_row", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1070, + "name": "skip_hidden", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1071, + "name": "xml_root", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1072, + "name": "xml_row", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1073, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 1074, + "name": "push_items", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Push items to the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/put-items\n\nArgs:\n items: The items which to push in the dataset. Either a stringified JSON, a dictionary, or a list\n of strings or dictionaries." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 1053, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L1053" + } + ], + "signatures": [ + { + "id": 1075, + "name": "push_items", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Push items to the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/put-items\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 1076, + "name": "items", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "JSONSerializable", + "id": 1724 + } + } + ] + } + ] + }, + { + "id": 1077, + "name": "get_statistics", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the dataset statistics.\n\nhttps://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get\n\nReturns:\n The dataset statistics or None if the dataset does not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 1080, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L1080" + } + ], + "signatures": [ + { + "id": 1078, + "name": "get_statistics", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the dataset statistics.\n\nhttps://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 1079, + "name": "create_items_public_url", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generate a URL that can be used to access dataset items.\n\nIf the client has permission to access the dataset's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in_secs` option.\nThis value sets the expiration duration in seconds from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `offset`) will be included as query parameters in the URL.\n\nReturns:\n The public dataset items URL." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 1101, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L1101" + } + ], + "signatures": [ + { + "id": 1080, + "name": "create_items_public_url", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generate a URL that can be used to access dataset items.\n\nIf the client has permission to access the dataset's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in_secs` option.\nThis value sets the expiration duration in seconds from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `offset`) will be included as query parameters in the URL.\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "str" + }, + "parameters": [ + { + "id": 1081, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1082, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1083, + "name": "clean", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1084, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1085, + "name": "fields", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1086, + "name": "omit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1087, + "name": "unwind", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1088, + "name": "skip_empty", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1089, + "name": "skip_hidden", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1090, + "name": "flatten", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1091, + "name": "view", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1092, + "name": "expires_in_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 1079, + 1009, + 1003, + 1037, + 1077, + 1025, + 1011, + 1074, + 1056, + 1005 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 644, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L644" + } + ] + }, + { + "id": 1093, + "name": "BuildCollectionClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for listing Actor builds." + } + ] + }, + "children": [ + { + "id": 1094, + "name": "list", + "module": "apify_client.clients.resource_clients.build_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List all Actor builds.\n\nList all Actor builds, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n\nArgs:\n limit: How many builds to retrieve.\n offset: What build to include as first when retrieving the list.\n desc: Whether to sort the builds in descending order based on their start date.\n\nReturns:\n The retrieved Actor builds." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/build_collection.py", + "line": 18, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build_collection.py#L18" + } + ], + "signatures": [ + { + "id": 1095, + "name": "list", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List all Actor builds.\n\nList all Actor builds, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 1096, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1097, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1098, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 1094 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/build_collection.py", + "line": 11, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build_collection.py#L11" + } + ] + }, + { + "id": 1099, + "name": "BuildCollectionClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for listing Actor builds." + } + ] + }, + "children": [ + { + "id": 1100, + "name": "list", + "module": "apify_client.clients.resource_clients.build_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List all Actor builds.\n\nList all Actor builds, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n\nArgs:\n limit: How many builds to retrieve.\n offset: What build to include as first when retrieving the list.\n desc: Whether to sort the builds in descending order based on their start date.\n\nReturns:\n The retrieved Actor builds." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/build_collection.py", + "line": 51, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build_collection.py#L51" + } + ], + "signatures": [ + { + "id": 1101, + "name": "list", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List all Actor builds.\n\nList all Actor builds, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 1102, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1103, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1104, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 1100 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/build_collection.py", + "line": 44, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build_collection.py#L44" + } + ] + }, + { + "id": 1105, + "name": "BuildClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating a single Actor build." + } + ] + }, + "children": [ + { + "id": 1106, + "name": "get", + "module": "apify_client.clients.resource_clients.build", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build\n\nReturns:\n The retrieved Actor build data." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/build.py", + "line": 16, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build.py#L16" + } + ], + "signatures": [ + { + "id": 1107, + "name": "get", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 1108, + "name": "delete", + "module": "apify_client.clients.resource_clients.build", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build" + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/build.py", + "line": 26, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build.py#L26" + } + ], + "signatures": [ + { + "id": 1109, + "name": "delete", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] + }, + { + "id": 1110, + "name": "abort", + "module": "apify_client.clients.resource_clients.build", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Abort the Actor build which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build\n\nReturns:\n The data of the aborted Actor build." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/build.py", + "line": 33, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build.py#L33" + } + ], + "signatures": [ + { + "id": 1111, + "name": "abort", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Abort the Actor build which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [] + } + ] + }, + { + "id": 1112, + "name": "get_open_api_definition", + "module": "apify_client.clients.resource_clients.build", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return OpenAPI definition of the Actor's build.\n\nhttps://docs.apify.com/api/v2/actor-build-openapi-json-get\n\nReturns:\n OpenAPI definition of the Actor's build." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/build.py", + "line": 43, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build.py#L43" + } + ], + "signatures": [ + { + "id": 1113, + "name": "get_open_api_definition", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return OpenAPI definition of the Actor's build.\n\nhttps://docs.apify.com/api/v2/actor-build-openapi-json-get\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 1114, + "name": "wait_for_finish", + "module": "apify_client.clients.resource_clients.build", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wait synchronously until the build finishes or the server times out.\n\nArgs:\n wait_secs: How long does the client wait for build to finish. None for indefinite.\n\nReturns:\n The Actor build data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\n TIMED_OUT, ABORTED), then the build has not yet finished." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/build.py", + "line": 60, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build.py#L60" + } + ], + "signatures": [ + { + "id": 1115, + "name": "wait_for_finish", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wait synchronously until the build finishes or the server times out.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [ + { + "id": 1116, + "name": "wait_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 1117, + "name": "log", + "module": "apify_client.clients.resource_clients.build", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the log of the Actor build.\n\nhttps://docs.apify.com/api/v2/#/reference/actor-builds/build-log/get-log\n\nReturns:\n A client allowing access to the log of this Actor build." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/build.py", + "line": 72, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build.py#L72" + } + ], + "signatures": [ + { + "id": 1118, + "name": "log", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the log of the Actor build.\n\nhttps://docs.apify.com/api/v2/#/reference/actor-builds/build-log/get-log\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "LogClient", + "id": 662 + }, + "parameters": [] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 1110, + 1108, + 1106, + 1112, + 1117, + 1114 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/build.py", + "line": 9, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build.py#L9" + } + ] + }, + { + "id": 1119, + "name": "BuildClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating a single Actor build." + } + ] + }, + "children": [ + { + "id": 1120, + "name": "get", + "module": "apify_client.clients.resource_clients.build", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build\n\nReturns:\n The retrieved Actor build data." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/build.py", + "line": 92, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build.py#L92" + } + ], + "signatures": [ + { + "id": 1121, + "name": "get", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 1122, + "name": "abort", + "module": "apify_client.clients.resource_clients.build", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Abort the Actor build which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build\n\nReturns:\n The data of the aborted Actor build." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/build.py", + "line": 102, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build.py#L102" + } + ], + "signatures": [ + { + "id": 1123, + "name": "abort", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Abort the Actor build which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [] + } + ] + }, + { + "id": 1124, + "name": "delete", + "module": "apify_client.clients.resource_clients.build", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build" + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/build.py", + "line": 112, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build.py#L112" + } + ], + "signatures": [ + { + "id": 1125, + "name": "delete", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] + }, + { + "id": 1126, + "name": "get_open_api_definition", + "module": "apify_client.clients.resource_clients.build", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return OpenAPI definition of the Actor's build.\n\nhttps://docs.apify.com/api/v2/actor-build-openapi-json-get\n\nReturns:\n OpenAPI definition of the Actor's build." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/build.py", + "line": 119, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build.py#L119" + } + ], + "signatures": [ + { + "id": 1127, + "name": "get_open_api_definition", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return OpenAPI definition of the Actor's build.\n\nhttps://docs.apify.com/api/v2/actor-build-openapi-json-get\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 1128, + "name": "wait_for_finish", + "module": "apify_client.clients.resource_clients.build", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wait synchronously until the build finishes or the server times out.\n\nArgs:\n wait_secs: How long does the client wait for build to finish. None for indefinite.\n\nReturns:\n The Actor build data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\n TIMED_OUT, ABORTED), then the build has not yet finished." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/build.py", + "line": 136, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build.py#L136" + } + ], + "signatures": [ + { + "id": 1129, + "name": "wait_for_finish", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wait synchronously until the build finishes or the server times out.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [ + { + "id": 1130, + "name": "wait_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 1131, + "name": "log", + "module": "apify_client.clients.resource_clients.build", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the log of the Actor build.\n\nhttps://docs.apify.com/api/v2/#/reference/actor-builds/build-log/get-log\n\nReturns:\n A client allowing access to the log of this Actor build." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/build.py", + "line": 148, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build.py#L148" + } + ], + "signatures": [ + { + "id": 1132, + "name": "log", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the log of the Actor build.\n\nhttps://docs.apify.com/api/v2/#/reference/actor-builds/build-log/get-log\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "LogClientAsync", + "id": 672 + }, + "parameters": [] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 1122, + 1124, + 1120, + 1126, + 1131, + 1128 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/build.py", + "line": 85, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build.py#L85" + } + ] + }, + { + "id": 1133, + "name": "ActorVersionCollectionClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating Actor versions." + } + ] + }, + "children": [ + { + "id": 1134, + "name": "list", + "module": "apify_client.clients.resource_clients.actor_version_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available Actor versions.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n\nReturns:\n The list of available Actor versions." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_version_collection.py", + "line": 22, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version_collection.py#L22" + } + ], + "signatures": [ + { + "id": 1135, + "name": "list", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available Actor versions.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [] + } + ] + }, + { + "id": 1136, + "name": "create", + "module": "apify_client.clients.resource_clients.actor_version_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/create-version\n\nArgs:\n version_number: Major and minor version of the Actor (e.g. `1.0`).\n build_tag: Tag that is automatically set to the latest successful build of the current version.\n env_vars: Environment variables that will be available to the Actor run process, and optionally\n also to the build process. See the API docs for their exact structure.\n apply_env_vars_to_build: Whether the environment variables specified for the Actor run will also\n be set to the Actor build process.\n source_type: What source type is the Actor version using.\n source_files: Source code comprised of multiple files, each an item of the array. Required\n when `source_type` is `ActorSourceType.SOURCE_FILES`. See the API docs for the exact structure.\n git_repo_url: The URL of a Git repository from which the source code will be cloned.\n Required when `source_type` is `ActorSourceType.GIT_REPO`.\n tarball_url: The URL of a tarball or a zip archive from which the source code will be downloaded.\n Required when `source_type` is `ActorSourceType.TARBALL`.\n github_gist_url: The URL of a GitHub Gist from which the source will be downloaded.\n Required when `source_type` is `ActorSourceType.GITHUB_GIST`.\n\nReturns:\n The created Actor version." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_version_collection.py", + "line": 32, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version_collection.py#L32" + } + ], + "signatures": [ + { + "id": 1137, + "name": "create", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/create-version\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1138, + "name": "version_number", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1139, + "name": "build_tag", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1140, + "name": "env_vars", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1141, + "name": "apply_env_vars_to_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1142, + "name": "source_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorSourceType", + "id": 1772 + } + }, + { + "id": 1143, + "name": "source_files", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1144, + "name": "git_repo_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1145, + "name": "tarball_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1146, + "name": "github_gist_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 1136, + 1134 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_version_collection.py", + "line": 15, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version_collection.py#L15" + } + ] + }, + { + "id": 1147, + "name": "ActorVersionCollectionClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating Actor versions." + } + ] + }, + "children": [ + { + "id": 1148, + "name": "list", + "module": "apify_client.clients.resource_clients.actor_version_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available Actor versions.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n\nReturns:\n The list of available Actor versions." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_version_collection.py", + "line": 91, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version_collection.py#L91" + } + ], + "signatures": [ + { + "id": 1149, + "name": "list", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available Actor versions.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [] + } + ] + }, + { + "id": 1150, + "name": "create", + "module": "apify_client.clients.resource_clients.actor_version_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/create-version\n\nArgs:\n version_number: Major and minor version of the Actor (e.g. `1.0`).\n build_tag: Tag that is automatically set to the latest successful build of the current version.\n env_vars: Environment variables that will be available to the Actor run process, and optionally\n also to the build process. See the API docs for their exact structure.\n apply_env_vars_to_build: Whether the environment variables specified for the Actor run will also\n be set to the Actor build process.\n source_type: What source type is the Actor version using.\n source_files: Source code comprised of multiple files, each an item of the array. Required\n when `source_type` is `ActorSourceType.SOURCE_FILES`. See the API docs for the exact structure.\n git_repo_url: The URL of a Git repository from which the source code will be cloned.\n Required when `source_type` is `ActorSourceType.GIT_REPO`.\n tarball_url: The URL of a tarball or a zip archive from which the source code will be downloaded.\n Required when `source_type` is `ActorSourceType.TARBALL`.\n github_gist_url: The URL of a GitHub Gist from which the source will be downloaded.\n Required when `source_type` is `ActorSourceType.GITHUB_GIST`.\n\nReturns:\n The created Actor version." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_version_collection.py", + "line": 101, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version_collection.py#L101" + } + ], + "signatures": [ + { + "id": 1151, + "name": "create", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/create-version\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1152, + "name": "version_number", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1153, + "name": "build_tag", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1154, + "name": "env_vars", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1155, + "name": "apply_env_vars_to_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1156, + "name": "source_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorSourceType", + "id": 1772 + } + }, + { + "id": 1157, + "name": "source_files", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1158, + "name": "git_repo_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1159, + "name": "tarball_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1160, + "name": "github_gist_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 1150, + 1148 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_version_collection.py", + "line": 84, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version_collection.py#L84" + } + ] + }, + { + "id": 1161, + "name": "ActorVersionClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating a single Actor version." + } + ] + }, + "children": [ + { + "id": 1162, + "name": "get", + "module": "apify_client.clients.resource_clients.actor_version", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/get-version\n\nReturns:\n The retrieved Actor version data." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_version.py", + "line": 49, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version.py#L49" + } + ], + "signatures": [ + { + "id": 1163, + "name": "get", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/get-version\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 1164, + "name": "update", + "module": "apify_client.clients.resource_clients.actor_version", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the Actor version with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/update-version\n\nArgs:\n build_tag: Tag that is automatically set to the latest successful build of the current version.\n env_vars: Environment variables that will be available to the Actor run process, and optionally\n also to the build process. See the API docs for their exact structure.\n apply_env_vars_to_build: Whether the environment variables specified for the Actor run will also\n be set to the Actor build process.\n source_type: What source type is the Actor version using.\n source_files: Source code comprised of multiple files, each an item of the array. Required when\n `source_type` is `ActorSourceType.SOURCE_FILES`. See the API docs for the exact structure.\n git_repo_url: The URL of a Git repository from which the source code will be cloned.\n Required when `source_type` is `ActorSourceType.GIT_REPO`.\n tarball_url: The URL of a tarball or a zip archive from which the source code will be downloaded.\n Required when `source_type` is `ActorSourceType.TARBALL`.\n github_gist_url: The URL of a GitHub Gist from which the source will be downloaded.\n Required when `source_type` is `ActorSourceType.GITHUB_GIST`.\n\nReturns:\n The updated Actor version." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_version.py", + "line": 59, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version.py#L59" + } + ], + "signatures": [ + { + "id": 1165, + "name": "update", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the Actor version with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/update-version\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1166, + "name": "build_tag", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1167, + "name": "env_vars", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1168, + "name": "apply_env_vars_to_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1169, + "name": "source_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorSourceType | None" + }, + "defaultValue": "None" + }, + { + "id": 1170, + "name": "source_files", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1171, + "name": "git_repo_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1172, + "name": "tarball_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1173, + "name": "github_gist_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 1174, + "name": "delete", + "module": "apify_client.clients.resource_clients.actor_version", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/delete-version" + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_version.py", + "line": 107, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version.py#L107" + } + ], + "signatures": [ + { + "id": 1175, + "name": "delete", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/delete-version" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] + }, + { + "id": 1176, + "name": "env_vars", + "module": "apify_client.clients.resource_clients.actor_version", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the environment variables of this Actor version." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_version.py", + "line": 114, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version.py#L114" + } + ], + "signatures": [ + { + "id": 1177, + "name": "env_vars", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the environment variables of this Actor version." + } + ] + }, + "type": { + "type": "reference", + "name": "ActorEnvVarCollectionClient", + "id": 1201 + }, + "parameters": [] + } + ] + }, + { + "id": 1178, + "name": "env_var", + "module": "apify_client.clients.resource_clients.actor_version", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the specified environment variable of this Actor version.\n\nArgs:\n env_var_name: The name of the environment variable for which to retrieve the resource client.\n\nReturns:\n The resource client for the specified Actor environment variable." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_version.py", + "line": 118, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version.py#L118" + } + ], + "signatures": [ + { + "id": 1179, + "name": "env_var", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the specified environment variable of this Actor version.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ActorEnvVarClient", + "id": 1222 + }, + "parameters": [ + { + "id": 1180, + "name": "env_var_name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 1174, + 1178, + 1176, + 1162, + 1164 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_version.py", + "line": 42, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version.py#L42" + } + ] + }, + { + "id": 1181, + "name": "ActorVersionClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating a single Actor version." + } + ] + }, + "children": [ + { + "id": 1182, + "name": "get", + "module": "apify_client.clients.resource_clients.actor_version", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/get-version\n\nReturns:\n The retrieved Actor version data." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_version.py", + "line": 137, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version.py#L137" + } + ], + "signatures": [ + { + "id": 1183, + "name": "get", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/get-version\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 1184, + "name": "update", + "module": "apify_client.clients.resource_clients.actor_version", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the Actor version with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/update-version\n\nArgs:\n build_tag: Tag that is automatically set to the latest successful build of the current version.\n env_vars: Environment variables that will be available to the Actor run process, and optionally\n also to the build process. See the API docs for their exact structure.\n apply_env_vars_to_build: Whether the environment variables specified for the Actor run will also\n be set to the Actor build process.\n source_type: What source type is the Actor version using.\n source_files: Source code comprised of multiple files, each an item of the array. Required when\n `source_type` is `ActorSourceType.SOURCE_FILES`. See the API docs for the exact structure.\n git_repo_url: The URL of a Git repository from which the source code will be cloned.\n Required when `source_type` is `ActorSourceType.GIT_REPO`.\n tarball_url: The URL of a tarball or a zip archive from which the source code will be downloaded.\n Required when `source_type` is `ActorSourceType.TARBALL`.\n github_gist_url: The URL of a GitHub Gist from which the source will be downloaded.\n Required when `source_type` is `ActorSourceType.GITHUB_GIST`.\n\nReturns:\n The updated Actor version." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_version.py", + "line": 147, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version.py#L147" + } + ], + "signatures": [ + { + "id": 1185, + "name": "update", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the Actor version with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/update-version\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1186, + "name": "build_tag", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1187, + "name": "env_vars", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1188, + "name": "apply_env_vars_to_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1189, + "name": "source_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorSourceType | None" + }, + "defaultValue": "None" + }, + { + "id": 1190, + "name": "source_files", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1191, + "name": "git_repo_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1192, + "name": "tarball_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1193, + "name": "github_gist_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 1194, + "name": "delete", + "module": "apify_client.clients.resource_clients.actor_version", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/delete-version" + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_version.py", + "line": 195, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version.py#L195" + } + ], + "signatures": [ + { + "id": 1195, + "name": "delete", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/delete-version" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] + }, + { + "id": 1196, + "name": "env_vars", + "module": "apify_client.clients.resource_clients.actor_version", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the environment variables of this Actor version." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_version.py", + "line": 202, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version.py#L202" + } + ], + "signatures": [ + { + "id": 1197, + "name": "env_vars", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the environment variables of this Actor version." + } + ] + }, + "type": { + "type": "reference", + "name": "ActorEnvVarCollectionClientAsync", + "id": 1209 + }, + "parameters": [] + } + ] + }, + { + "id": 1198, + "name": "env_var", + "module": "apify_client.clients.resource_clients.actor_version", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the specified environment variable of this Actor version.\n\nArgs:\n env_var_name: The name of the environment variable for which to retrieve the resource client.\n\nReturns:\n The resource client for the specified Actor environment variable." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_version.py", + "line": 206, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version.py#L206" + } + ], + "signatures": [ + { + "id": 1199, + "name": "env_var", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the specified environment variable of this Actor version.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ActorEnvVarClientAsync", + "id": 1232 + }, + "parameters": [ + { + "id": 1200, + "name": "env_var_name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 1194, + 1198, + 1196, + 1182, + 1184 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_version.py", + "line": 130, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version.py#L130" + } + ] + }, + { + "id": 1201, + "name": "ActorEnvVarCollectionClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating actor env vars." + } + ] + }, + "children": [ + { + "id": 1202, + "name": "list", + "module": "apify_client.clients.resource_clients.actor_env_var_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available actor environment variables.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n\nReturns:\n The list of available actor environment variables." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_env_var_collection.py", + "line": 20, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_env_var_collection.py#L20" + } + ], + "signatures": [ + { + "id": 1203, + "name": "list", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available actor environment variables.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [] + } + ] + }, + { + "id": 1204, + "name": "create", + "module": "apify_client.clients.resource_clients.actor_env_var_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable\n\nArgs:\n is_secret: Whether the environment variable is secret or not.\n name: The name of the environment variable.\n value: The value of the environment variable.\n\nReturns:\n The created actor environment variable." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_env_var_collection.py", + "line": 30, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_env_var_collection.py#L30" + } + ], + "signatures": [ + { + "id": 1205, + "name": "create", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1206, + "name": "is_secret", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1207, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1208, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 1204, + 1202 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_env_var_collection.py", + "line": 13, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_env_var_collection.py#L13" + } + ] + }, + { + "id": 1209, + "name": "ActorEnvVarCollectionClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating actor env vars." + } + ] + }, + "children": [ + { + "id": 1210, + "name": "list", + "module": "apify_client.clients.resource_clients.actor_env_var_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available actor environment variables.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n\nReturns:\n The list of available actor environment variables." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_env_var_collection.py", + "line": 65, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_env_var_collection.py#L65" + } + ], + "signatures": [ + { + "id": 1211, + "name": "list", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available actor environment variables.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [] + } + ] + }, + { + "id": 1212, + "name": "create", + "module": "apify_client.clients.resource_clients.actor_env_var_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable\n\nArgs:\n is_secret: Whether the environment variable is secret or not.\n name: The name of the environment variable.\n value: The value of the environment variable.\n\nReturns:\n The created actor environment variable." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_env_var_collection.py", + "line": 75, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_env_var_collection.py#L75" + } + ], + "signatures": [ + { + "id": 1213, + "name": "create", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1214, + "name": "is_secret", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1215, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1216, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 1212, + 1210 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_env_var_collection.py", + "line": 58, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_env_var_collection.py#L58" + } + ] + }, + { + "id": 1217, + "name": "get_actor_env_var_representation", + "module": "apify_client.clients.resource_clients.actor_env_var", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return an environment variable representation of the Actor in a dictionary." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_env_var.py", + "line": 9, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_env_var.py#L9" + } + ], + "signatures": [ + { + "id": 1218, + "name": "get_actor_env_var_representation", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return an environment variable representation of the Actor in a dictionary." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1219, + "name": "is_secret", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1220, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1221, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 1222, + "name": "ActorEnvVarClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating a single Actor environment variable." + } + ] + }, + "children": [ + { + "id": 1223, + "name": "get", + "module": "apify_client.clients.resource_clients.actor_env_var", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable\n\nReturns:\n The retrieved Actor environment variable data." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_env_var.py", + "line": 30, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_env_var.py#L30" + } + ], + "signatures": [ + { + "id": 1224, + "name": "get", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 1225, + "name": "update", + "module": "apify_client.clients.resource_clients.actor_env_var", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the Actor environment variable with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable\n\nArgs:\n is_secret: Whether the environment variable is secret or not.\n name: The name of the environment variable.\n value: The value of the environment variable.\n\nReturns:\n The updated Actor environment variable." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_env_var.py", + "line": 40, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_env_var.py#L40" + } + ], + "signatures": [ + { + "id": 1226, + "name": "update", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the Actor environment variable with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1227, + "name": "is_secret", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1228, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1229, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 1230, + "name": "delete", + "module": "apify_client.clients.resource_clients.actor_env_var", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable" + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_env_var.py", + "line": 67, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_env_var.py#L67" + } + ], + "signatures": [ + { + "id": 1231, + "name": "delete", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 1230, + 1223, + 1225 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_env_var.py", + "line": 23, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_env_var.py#L23" + } + ] + }, + { + "id": 1232, + "name": "ActorEnvVarClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating a single Actor environment variable." + } + ] + }, + "children": [ + { + "id": 1233, + "name": "get", + "module": "apify_client.clients.resource_clients.actor_env_var", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable\n\nReturns:\n The retrieved Actor environment variable data." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_env_var.py", + "line": 82, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_env_var.py#L82" + } + ], + "signatures": [ + { + "id": 1234, + "name": "get", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 1235, + "name": "update", + "module": "apify_client.clients.resource_clients.actor_env_var", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the Actor environment variable with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable\n\nArgs:\n is_secret: Whether the environment variable is secret or not.\n name: The name of the environment variable.\n value: The value of the environment variable.\n\nReturns:\n The updated Actor environment variable." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_env_var.py", + "line": 92, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_env_var.py#L92" + } + ], + "signatures": [ + { + "id": 1236, + "name": "update", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the Actor environment variable with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1237, + "name": "is_secret", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1238, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1239, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 1240, + "name": "delete", + "module": "apify_client.clients.resource_clients.actor_env_var", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable" + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_env_var.py", + "line": 119, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_env_var.py#L119" + } + ], + "signatures": [ + { + "id": 1241, + "name": "delete", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 1240, + 1233, + 1235 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_env_var.py", + "line": 75, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_env_var.py#L75" + } + ] + }, + { + "id": 1242, + "name": "ActorCollectionClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating Actors." + } + ] + }, + "children": [ + { + "id": 1243, + "name": "list", + "module": "apify_client.clients.resource_clients.actor_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the Actors the user has created or used.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n\nArgs:\n my: If True, will return only Actors which the user has created themselves.\n limit: How many Actors to list.\n offset: What Actor to include as first when retrieving the list.\n desc: Whether to sort the Actors in descending order based on their creation date.\n sort_by: Field to sort the results by.\n\nReturns:\n The list of available Actors matching the specified filters." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_collection.py", + "line": 20, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_collection.py#L20" + } + ], + "signatures": [ + { + "id": 1244, + "name": "list", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the Actors the user has created or used.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 1245, + "name": "my", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1246, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1247, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1248, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1249, + "name": "sort_by", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Literal['createdAt', 'stats.lastRunStartedAt'] | None" + }, + "defaultValue": "'createdAt'" + } + ] + } + ] + }, + { + "id": 1250, + "name": "create", + "module": "apify_client.clients.resource_clients.actor_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor\n\nArgs:\n name: The name of the Actor.\n title: The title of the Actor (human-readable).\n description: The description for the Actor.\n seo_title: The title of the Actor optimized for search engines.\n seo_description: The description of the Actor optimized for search engines.\n versions: The list of Actor versions.\n restart_on_error: If true, the Actor run process will be restarted whenever it exits with\n a non-zero status code.\n is_public: Whether the Actor is public.\n is_deprecated: Whether the Actor is deprecated.\n is_anonymously_runnable: Whether the Actor is anonymously runnable.\n categories: The categories to which the Actor belongs to.\n default_run_build: Tag or number of the build that you want to run by default.\n default_run_max_items: Default limit of the number of results that will be returned by runs\n of this Actor, if the Actor is charged per result.\n default_run_memory_mbytes: Default amount of memory allocated for the runs of this Actor, in megabytes.\n default_run_timeout_secs: Default timeout for the runs of this Actor in seconds.\n example_run_input_body: Input to be prefilled as default input to new users of this Actor.\n example_run_input_content_type: The content type of the example run input.\n actor_standby_is_enabled: Whether the Actor Standby is enabled.\n actor_standby_desired_requests_per_actor_run: The desired number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_max_requests_per_actor_run: The maximum number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_idle_timeout_secs: If the Actor run does not receive any requests for this time,\n it will be shut down.\n actor_standby_build: The build tag or number to run when the Actor is in Standby mode.\n actor_standby_memory_mbytes: The memory in megabytes to use when the Actor is in Standby mode.\n\nReturns:\n The created Actor." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_collection.py", + "line": 45, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_collection.py#L45" + } + ], + "signatures": [ + { + "id": 1251, + "name": "create", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1252, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1253, + "name": "title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1254, + "name": "description", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1255, + "name": "seo_title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1256, + "name": "seo_description", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1257, + "name": "versions", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1258, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1259, + "name": "is_public", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1260, + "name": "is_deprecated", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1261, + "name": "is_anonymously_runnable", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1262, + "name": "categories", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1263, + "name": "default_run_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1264, + "name": "default_run_max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1265, + "name": "default_run_memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1266, + "name": "default_run_timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1267, + "name": "example_run_input_body", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Any" + }, + "defaultValue": "None" + }, + { + "id": 1268, + "name": "example_run_input_content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1269, + "name": "actor_standby_is_enabled", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1270, + "name": "actor_standby_desired_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1271, + "name": "actor_standby_max_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1272, + "name": "actor_standby_idle_timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1273, + "name": "actor_standby_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1274, + "name": "actor_standby_memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 1250, + 1243 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_collection.py", + "line": 13, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_collection.py#L13" + } + ] + }, + { + "id": 1275, + "name": "ActorCollectionClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating Actors." + } + ] + }, + "children": [ + { + "id": 1276, + "name": "list", + "module": "apify_client.clients.resource_clients.actor_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the Actors the user has created or used.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n\nArgs:\n my: If True, will return only Actors which the user has created themselves.\n limit: How many Actors to list.\n offset: What Actor to include as first when retrieving the list.\n desc: Whether to sort the Actors in descending order based on their creation date.\n sort_by: Field to sort the results by.\n\nReturns:\n The list of available Actors matching the specified filters." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_collection.py", + "line": 145, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_collection.py#L145" + } + ], + "signatures": [ + { + "id": 1277, + "name": "list", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the Actors the user has created or used.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 1278, + "name": "my", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1279, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1280, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1281, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1282, + "name": "sort_by", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Literal['createdAt', 'stats.lastRunStartedAt'] | None" + }, + "defaultValue": "'createdAt'" + } + ] + } + ] + }, + { + "id": 1283, + "name": "create", + "module": "apify_client.clients.resource_clients.actor_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor\n\nArgs:\n name: The name of the Actor.\n title: The title of the Actor (human-readable).\n description: The description for the Actor.\n seo_title: The title of the Actor optimized for search engines.\n seo_description: The description of the Actor optimized for search engines.\n versions: The list of Actor versions.\n restart_on_error: If true, the Actor run process will be restarted whenever it exits with\n a non-zero status code.\n is_public: Whether the Actor is public.\n is_deprecated: Whether the Actor is deprecated.\n is_anonymously_runnable: Whether the Actor is anonymously runnable.\n categories: The categories to which the Actor belongs to.\n default_run_build: Tag or number of the build that you want to run by default.\n default_run_max_items: Default limit of the number of results that will be returned by runs\n of this Actor, if the Actor is charged per result.\n default_run_memory_mbytes: Default amount of memory allocated for the runs of this Actor, in megabytes.\n default_run_timeout_secs: Default timeout for the runs of this Actor in seconds.\n example_run_input_body: Input to be prefilled as default input to new users of this Actor.\n example_run_input_content_type: The content type of the example run input.\n actor_standby_is_enabled: Whether the Actor Standby is enabled.\n actor_standby_desired_requests_per_actor_run: The desired number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_max_requests_per_actor_run: The maximum number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_idle_timeout_secs: If the Actor run does not receive any requests for this time,\n it will be shut down.\n actor_standby_build: The build tag or number to run when the Actor is in Standby mode.\n actor_standby_memory_mbytes: The memory in megabytes to use when the Actor is in Standby mode.\n\nReturns:\n The created Actor." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_collection.py", + "line": 170, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_collection.py#L170" + } + ], + "signatures": [ + { + "id": 1284, + "name": "create", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1285, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1286, + "name": "title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1287, + "name": "description", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1288, + "name": "seo_title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1289, + "name": "seo_description", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1290, + "name": "versions", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1291, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1292, + "name": "is_public", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1293, + "name": "is_deprecated", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1294, + "name": "is_anonymously_runnable", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1295, + "name": "categories", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1296, + "name": "default_run_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1297, + "name": "default_run_max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1298, + "name": "default_run_memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1299, + "name": "default_run_timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1300, + "name": "example_run_input_body", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Any" + }, + "defaultValue": "None" + }, + { + "id": 1301, + "name": "example_run_input_content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1302, + "name": "actor_standby_is_enabled", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1303, + "name": "actor_standby_desired_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1304, + "name": "actor_standby_max_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1305, + "name": "actor_standby_idle_timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1306, + "name": "actor_standby_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1307, + "name": "actor_standby_memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 1283, + 1276 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_collection.py", + "line": 138, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_collection.py#L138" + } + ] + }, + { + "id": 1308, + "name": "get_actor_representation", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get dictionary representation of the Actor." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 35, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L35" + } + ], + "signatures": [ + { + "id": 1309, + "name": "get_actor_representation", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get dictionary representation of the Actor." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1310, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + } + }, + { + "id": 1311, + "name": "title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1312, + "name": "description", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1313, + "name": "seo_title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1314, + "name": "seo_description", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1315, + "name": "versions", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1316, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1317, + "name": "is_public", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1318, + "name": "is_deprecated", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1319, + "name": "is_anonymously_runnable", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1320, + "name": "categories", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1321, + "name": "default_run_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1322, + "name": "default_run_max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1323, + "name": "default_run_memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1324, + "name": "default_run_timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1325, + "name": "default_run_force_permission_level", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorPermissionLevel | None" + }, + "defaultValue": "None" + }, + { + "id": 1326, + "name": "example_run_input_body", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Any" + }, + "defaultValue": "None" + }, + { + "id": 1327, + "name": "example_run_input_content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1328, + "name": "actor_standby_is_enabled", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1329, + "name": "actor_standby_desired_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1330, + "name": "actor_standby_max_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1331, + "name": "actor_standby_idle_timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1332, + "name": "actor_standby_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1333, + "name": "actor_standby_memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1334, + "name": "pricing_infos", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1335, + "name": "actor_permission_level", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorPermissionLevel | None" + }, + "defaultValue": "None" + }, + { + "id": 1336, + "name": "tagged_builds", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict[str, None | dict[str, str]] | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 1337, + "name": "ActorClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating a single Actor." + } + ] + }, + "children": [ + { + "id": 1338, + "name": "get", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor\n\nReturns:\n The retrieved Actor." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 124, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L124" + } + ], + "signatures": [ + { + "id": 1339, + "name": "get", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 1340, + "name": "update", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the Actor with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor\n\nArgs:\n name: The name of the Actor.\n title: The title of the Actor (human-readable).\n description: The description for the Actor.\n seo_title: The title of the Actor optimized for search engines.\n seo_description: The description of the Actor optimized for search engines.\n versions: The list of Actor versions.\n restart_on_error: If true, the Actor run process will be restarted whenever it exits with\n a non-zero status code.\n is_public: Whether the Actor is public.\n is_deprecated: Whether the Actor is deprecated.\n is_anonymously_runnable: Whether the Actor is anonymously runnable.\n categories: The categories to which the Actor belongs to.\n default_run_build: Tag or number of the build that you want to run by default.\n default_run_max_items: Default limit of the number of results that will be returned\n by runs of this Actor, if the Actor is charged per result.\n default_run_memory_mbytes: Default amount of memory allocated for the runs of this Actor, in megabytes.\n default_run_timeout_secs: Default timeout for the runs of this Actor in seconds.\n example_run_input_body: Input to be prefilled as default input to new users of this Actor.\n example_run_input_content_type: The content type of the example run input.\n actor_standby_is_enabled: Whether the Actor Standby is enabled.\n actor_standby_desired_requests_per_actor_run: The desired number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_max_requests_per_actor_run: The maximum number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_idle_timeout_secs: If the Actor run does not receive any requests for this time,\n it will be shut down.\n actor_standby_build: The build tag or number to run when the Actor is in Standby mode.\n actor_standby_memory_mbytes: The memory in megabytes to use when the Actor is in Standby mode.\n pricing_infos: A list of objects that describes the pricing of the Actor.\n actor_permission_level: The permission level of the Actor on Apify platform.\n tagged_builds: A dictionary mapping build tag names to their settings. Use it to create, update,\n or remove build tags. To assign a tag, provide a dict with 'buildId' key. To remove a tag,\n set its value to None. Example: {'latest': {'buildId': 'abc'}, 'beta': None}.\n\nReturns:\n The updated Actor." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 134, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L134" + } + ], + "signatures": [ + { + "id": 1341, + "name": "update", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the Actor with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1342, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1343, + "name": "title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1344, + "name": "description", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1345, + "name": "seo_title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1346, + "name": "seo_description", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1347, + "name": "versions", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1348, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1349, + "name": "is_public", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1350, + "name": "is_deprecated", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1351, + "name": "is_anonymously_runnable", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1352, + "name": "categories", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1353, + "name": "default_run_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1354, + "name": "default_run_max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1355, + "name": "default_run_memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1356, + "name": "default_run_timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1357, + "name": "example_run_input_body", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Any" + }, + "defaultValue": "None" + }, + { + "id": 1358, + "name": "example_run_input_content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1359, + "name": "actor_standby_is_enabled", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1360, + "name": "actor_standby_desired_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1361, + "name": "actor_standby_max_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1362, + "name": "actor_standby_idle_timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1363, + "name": "actor_standby_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1364, + "name": "actor_standby_memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1365, + "name": "pricing_infos", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1366, + "name": "actor_permission_level", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorPermissionLevel | None" + }, + "defaultValue": "None" + }, + { + "id": 1367, + "name": "tagged_builds", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict[str, None | dict[str, str]] | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 1368, + "name": "delete", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor" + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 237, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L237" + } + ], + "signatures": [ + { + "id": 1369, + "name": "delete", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] + }, + { + "id": 1370, + "name": "start", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the Actor and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n\nArgs:\n run_input: The input to pass to the Actor run.\n content_type: The content type of the input.\n build: Specifies the Actor build to run. It can be either a build tag or build number. By default,\n the run uses the build specified in the default run configuration for the Actor (typically latest).\n max_items: Maximum number of results that will be returned by this run. If the Actor is charged\n per result, you will not be charged for more results than the given limit.\n max_total_charge_usd: A limit on the total charged amount for pay-per-event actors.\n restart_on_error: If true, the Actor run process will be restarted whenever it exits with\n a non-zero status code.\n memory_mbytes: Memory limit for the run, in megabytes. By default, the run uses a memory limit\n specified in the default run configuration for the Actor.\n timeout_secs: Optional timeout for the run, in seconds. By default, the run uses timeout specified\n in the default run configuration for the Actor.\n force_permission_level: Override the Actor's permissions for this run. If not set, the Actor will run\n with permissions configured in the Actor settings.\n wait_for_finish: The maximum number of seconds the server waits for the run to finish. By default,\n it is 0, the maximum value is 60.\n webhooks: Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\n the Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\n If you already have a webhook set up for the Actor or task, you do not have to add it again here.\n Each webhook is represented by a dictionary containing these items:\n * `event_types`: List of `WebhookEventType` values which trigger the webhook.\n * `request_url`: URL to which to send the webhook HTTP request.\n * `payload_template`: Optional template for the request payload.\n\nReturns:\n The run object." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 244, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L244" + } + ], + "signatures": [ + { + "id": 1371, + "name": "start", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the Actor and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1372, + "name": "run_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Any" + }, + "defaultValue": "None" + }, + { + "id": 1373, + "name": "content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1374, + "name": "build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1375, + "name": "max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1376, + "name": "max_total_charge_usd", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Decimal | None" + }, + "defaultValue": "None" + }, + { + "id": 1377, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1378, + "name": "memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1379, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1380, + "name": "force_permission_level", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorPermissionLevel | None" + }, + "defaultValue": "None" + }, + { + "id": 1381, + "name": "wait_for_finish", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1382, + "name": "webhooks", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 1383, + "name": "call", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the Actor and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_secs argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n\nArgs:\n run_input: The input to pass to the Actor run.\n content_type: The content type of the input.\n build: Specifies the Actor build to run. It can be either a build tag or build number. By default,\n the run uses the build specified in the default run configuration for the Actor (typically latest).\n max_items: Maximum number of results that will be returned by this run. If the Actor is charged\n per result, you will not be charged for more results than the given limit.\n max_total_charge_usd: A limit on the total charged amount for pay-per-event actors.\n restart_on_error: If true, the Actor run process will be restarted whenever it exits with\n a non-zero status code.\n memory_mbytes: Memory limit for the run, in megabytes. By default, the run uses a memory limit\n specified in the default run configuration for the Actor.\n timeout_secs: Optional timeout for the run, in seconds. By default, the run uses timeout specified\n in the default run configuration for the Actor.\n force_permission_level: Override the Actor's permissions for this run. If not set, the Actor will run\n with permissions configured in the Actor settings.\n webhooks: Optional webhooks (https://docs.apify.com/webhooks) associated with the Actor run, which can\n be used to receive a notification, e.g. when the Actor finished or failed. If you already have\n a webhook set up for the Actor, you do not have to add it again here.\n wait_secs: The maximum number of seconds the server waits for the run to finish. If not provided,\n waits indefinitely.\n logger: Logger used to redirect logs from the Actor run. Using \"default\" literal means that a predefined\n default logger will be used. Setting `None` will disable any log propagation. Passing custom logger\n will redirect logs to the provided logger. The logger is also used to capture status and status message\n of the other Actor run.\n\nReturns:\n The run object." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 316, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L316" + } + ], + "signatures": [ + { + "id": 1384, + "name": "call", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the Actor and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_secs argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [ + { + "id": 1385, + "name": "run_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Any" + }, + "defaultValue": "None" + }, + { + "id": 1386, + "name": "content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1387, + "name": "build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1388, + "name": "max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1389, + "name": "max_total_charge_usd", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Decimal | None" + }, + "defaultValue": "None" + }, + { + "id": 1390, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1391, + "name": "memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1392, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1393, + "name": "webhooks", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1394, + "name": "force_permission_level", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorPermissionLevel | None" + }, + "defaultValue": "None" + }, + { + "id": 1395, + "name": "wait_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1396, + "name": "logger", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Logger | None | Literal['default']" + }, + "defaultValue": "'default'" + } + ] + } + ] + }, + { + "id": 1397, + "name": "build", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Build the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor\n\nArgs:\n version_number: Actor version number to be built.\n beta_packages: If True, then the Actor is built with beta versions of Apify NPM packages. By default,\n the build uses latest stable packages.\n tag: Tag to be applied to the build on success. By default, the tag is taken from the Actor version's\n build tag property.\n use_cache: If true, the Actor's Docker container will be rebuilt using layer cache\n (https://docs.docker.com/develop/develop-images/dockerfile_best-practices/`leverage`-build-cache).\n This is to enable quick rebuild during development. By default, the cache is not used.\n wait_for_finish: The maximum number of seconds the server waits for the build to finish before returning.\n By default it is 0, the maximum value is 60.\n\nReturns:\n The build object." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 390, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L390" + } + ], + "signatures": [ + { + "id": 1398, + "name": "build", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Build the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1399, + "name": "version_number", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1400, + "name": "beta_packages", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1401, + "name": "tag", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1402, + "name": "use_cache", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1403, + "name": "wait_for_finish", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 1404, + "name": "builds", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the builds of this Actor." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 434, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L434" + } + ], + "signatures": [ + { + "id": 1405, + "name": "builds", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the builds of this Actor." + } + ] + }, + "type": { + "type": "reference", + "name": "BuildCollectionClient", + "id": 1093 + }, + "parameters": [] + } + ] + }, + { + "id": 1406, + "name": "runs", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the runs of this Actor." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 438, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L438" + } + ], + "signatures": [ + { + "id": 1407, + "name": "runs", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the runs of this Actor." + } + ] + }, + "type": { + "type": "reference", + "name": "RunCollectionClient", + "id": 397 + }, + "parameters": [] + } + ] + }, + { + "id": 1408, + "name": "default_build", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve Actor's default build.\n\nhttps://docs.apify.com/api/v2/act-build-default-get\n\nArgs:\n wait_for_finish: The maximum number of seconds the server waits for the build to finish before returning.\n By default it is 0, the maximum value is 60.\n\nReturns:\n The resource client for the default build of this Actor." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 442, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L442" + } + ], + "signatures": [ + { + "id": 1409, + "name": "default_build", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve Actor's default build.\n\nhttps://docs.apify.com/api/v2/act-build-default-get\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "BuildClient", + "id": 1105 + }, + "parameters": [ + { + "id": 1410, + "name": "wait_for_finish", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 1411, + "name": "last_run", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the last run of this Actor.\n\nLast run is retrieved based on the start time of the runs.\n\nArgs:\n status: Consider only runs with this status.\n origin: Consider only runs started with this origin.\n\nReturns:\n The resource client for the last run of this Actor." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 472, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L472" + } + ], + "signatures": [ + { + "id": 1412, + "name": "last_run", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the last run of this Actor.\n\nLast run is retrieved based on the start time of the runs.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "RunClient", + "id": 415 + }, + "parameters": [ + { + "id": 1413, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorJobStatus | None" + }, + "defaultValue": "None" + }, + { + "id": 1414, + "name": "origin", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "MetaOrigin | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 1415, + "name": "versions", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the versions of this Actor." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 500, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L500" + } + ], + "signatures": [ + { + "id": 1416, + "name": "versions", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the versions of this Actor." + } + ] + }, + "type": { + "type": "reference", + "name": "ActorVersionCollectionClient", + "id": 1133 + }, + "parameters": [] + } + ] + }, + { + "id": 1417, + "name": "version", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the specified version of this Actor.\n\nArgs:\n version_number: The version number for which to retrieve the resource client.\n\nReturns:\n The resource client for the specified Actor version." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 504, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L504" + } + ], + "signatures": [ + { + "id": 1418, + "name": "version", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the specified version of this Actor.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ActorVersionClient", + "id": 1161 + }, + "parameters": [ + { + "id": 1419, + "name": "version_number", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 1420, + "name": "webhooks", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for webhooks associated with this Actor." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 515, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L515" + } + ], + "signatures": [ + { + "id": 1421, + "name": "webhooks", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for webhooks associated with this Actor." + } + ] + }, + "type": { + "type": "reference", + "name": "WebhookCollectionClient", + "id": 30 + }, + "parameters": [] + } + ] + }, + { + "id": 1422, + "name": "validate_input", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Validate an input for the Actor that defines an input schema.\n\nArgs:\n run_input: The input to validate.\n build_tag: The actor's build tag.\n content_type: The content type of the input.\n\nReturns:\n True if the input is valid, else raise an exception with validation error details." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 519, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L519" + } + ], + "signatures": [ + { + "id": 1423, + "name": "validate_input", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Validate an input for the Actor that defines an input schema.\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "parameters": [ + { + "id": 1424, + "name": "run_input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Any" + }, + "defaultValue": "None" + }, + { + "id": 1425, + "name": "build_tag", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1426, + "name": "content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 1397, + 1404, + 1383, + 1408, + 1368, + 1338, + 1411, + 1406, + 1370, + 1340, + 1422, + 1417, + 1415, + 1420 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 117, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L117" + } + ] + }, + { + "id": 1427, + "name": "ActorClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating a single Actor." + } + ] + }, + "children": [ + { + "id": 1428, + "name": "get", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor\n\nReturns:\n The retrieved Actor." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 552, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L552" + } + ], + "signatures": [ + { + "id": 1429, + "name": "get", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 1430, + "name": "update", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the Actor with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor\n\nArgs:\n name: The name of the Actor.\n title: The title of the Actor (human-readable).\n description: The description for the Actor.\n seo_title: The title of the Actor optimized for search engines.\n seo_description: The description of the Actor optimized for search engines.\n versions: The list of Actor versions.\n restart_on_error: If true, the Actor run process will be restarted whenever it exits with\n a non-zero status code.\n is_public: Whether the Actor is public.\n is_deprecated: Whether the Actor is deprecated.\n is_anonymously_runnable: Whether the Actor is anonymously runnable.\n categories: The categories to which the Actor belongs to.\n default_run_build: Tag or number of the build that you want to run by default.\n default_run_max_items: Default limit of the number of results that will be returned\n by runs of this Actor, if the Actor is charged per result.\n default_run_memory_mbytes: Default amount of memory allocated for the runs of this Actor, in megabytes.\n default_run_timeout_secs: Default timeout for the runs of this Actor in seconds.\n example_run_input_body: Input to be prefilled as default input to new users of this Actor.\n example_run_input_content_type: The content type of the example run input.\n actor_standby_is_enabled: Whether the Actor Standby is enabled.\n actor_standby_desired_requests_per_actor_run: The desired number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_max_requests_per_actor_run: The maximum number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_idle_timeout_secs: If the Actor run does not receive any requests for this time,\n it will be shut down.\n actor_standby_build: The build tag or number to run when the Actor is in Standby mode.\n actor_standby_memory_mbytes: The memory in megabytes to use when the Actor is in Standby mode.\n pricing_infos: A list of objects that describes the pricing of the Actor.\n actor_permission_level: The permission level of the Actor on Apify platform.\n tagged_builds: A dictionary mapping build tag names to their settings. Use it to create, update,\n or remove build tags. To assign a tag, provide a dict with 'buildId' key. To remove a tag,\n set its value to None. Example: {'latest': {'buildId': 'abc'}, 'beta': None}.\n\nReturns:\n The updated Actor." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 562, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L562" + } + ], + "signatures": [ + { + "id": 1431, + "name": "update", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the Actor with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1432, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1433, + "name": "title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1434, + "name": "description", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1435, + "name": "seo_title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1436, + "name": "seo_description", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1437, + "name": "versions", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1438, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1439, + "name": "is_public", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1440, + "name": "is_deprecated", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1441, + "name": "is_anonymously_runnable", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1442, + "name": "categories", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1443, + "name": "default_run_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1444, + "name": "default_run_max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1445, + "name": "default_run_memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1446, + "name": "default_run_timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1447, + "name": "example_run_input_body", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Any" + }, + "defaultValue": "None" + }, + { + "id": 1448, + "name": "example_run_input_content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1449, + "name": "actor_standby_is_enabled", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1450, + "name": "actor_standby_desired_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1451, + "name": "actor_standby_max_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1452, + "name": "actor_standby_idle_timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1453, + "name": "actor_standby_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1454, + "name": "actor_standby_memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1455, + "name": "pricing_infos", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1456, + "name": "actor_permission_level", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorPermissionLevel | None" + }, + "defaultValue": "None" + }, + { + "id": 1457, + "name": "tagged_builds", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict[str, None | dict[str, str]] | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 1458, + "name": "delete", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor" + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 665, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L665" + } + ], + "signatures": [ + { + "id": 1459, + "name": "delete", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] + }, + { + "id": 1460, + "name": "start", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the Actor and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n\nArgs:\n run_input: The input to pass to the Actor run.\n content_type: The content type of the input.\n build: Specifies the Actor build to run. It can be either a build tag or build number. By default,\n the run uses the build specified in the default run configuration for the Actor (typically latest).\n max_items: Maximum number of results that will be returned by this run. If the Actor is charged\n per result, you will not be charged for more results than the given limit.\n max_total_charge_usd: A limit on the total charged amount for pay-per-event actors.\n restart_on_error: If true, the Actor run process will be restarted whenever it exits with\n a non-zero status code.\n memory_mbytes: Memory limit for the run, in megabytes. By default, the run uses a memory limit\n specified in the default run configuration for the Actor.\n timeout_secs: Optional timeout for the run, in seconds. By default, the run uses timeout specified\n in the default run configuration for the Actor.\n force_permission_level: Override the Actor's permissions for this run. If not set, the Actor will run\n with permissions configured in the Actor settings.\n wait_for_finish: The maximum number of seconds the server waits for the run to finish. By default,\n it is 0, the maximum value is 60.\n webhooks: Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\n the Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\n If you already have a webhook set up for the Actor or task, you do not have to add it again here.\n Each webhook is represented by a dictionary containing these items:\n * `event_types`: List of `WebhookEventType` values which trigger the webhook.\n * `request_url`: URL to which to send the webhook HTTP request.\n * `payload_template`: Optional template for the request payload.\n\nReturns:\n The run object." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 672, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L672" + } + ], + "signatures": [ + { + "id": 1461, + "name": "start", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the Actor and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1462, + "name": "run_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Any" + }, + "defaultValue": "None" + }, + { + "id": 1463, + "name": "content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1464, + "name": "build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1465, + "name": "max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1466, + "name": "max_total_charge_usd", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Decimal | None" + }, + "defaultValue": "None" + }, + { + "id": 1467, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1468, + "name": "memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1469, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1470, + "name": "force_permission_level", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorPermissionLevel | None" + }, + "defaultValue": "None" + }, + { + "id": 1471, + "name": "wait_for_finish", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1472, + "name": "webhooks", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 1473, + "name": "call", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the Actor and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_secs argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n\nArgs:\n run_input: The input to pass to the Actor run.\n content_type: The content type of the input.\n build: Specifies the Actor build to run. It can be either a build tag or build number. By default,\n the run uses the build specified in the default run configuration for the Actor (typically latest).\n max_items: Maximum number of results that will be returned by this run. If the Actor is charged\n per result, you will not be charged for more results than the given limit.\n max_total_charge_usd: A limit on the total charged amount for pay-per-event actors.\n restart_on_error: If true, the Actor run process will be restarted whenever it exits with\n a non-zero status code.\n memory_mbytes: Memory limit for the run, in megabytes. By default, the run uses a memory limit\n specified in the default run configuration for the Actor.\n timeout_secs: Optional timeout for the run, in seconds. By default, the run uses timeout specified\n in the default run configuration for the Actor.\n force_permission_level: Override the Actor's permissions for this run. If not set, the Actor will run\n with permissions configured in the Actor settings.\n webhooks: Optional webhooks (https://docs.apify.com/webhooks) associated with the Actor run, which can\n be used to receive a notification, e.g. when the Actor finished or failed. If you already have\n a webhook set up for the Actor, you do not have to add it again here.\n wait_secs: The maximum number of seconds the server waits for the run to finish. If not provided,\n waits indefinitely.\n logger: Logger used to redirect logs from the Actor run. Using \"default\" literal means that a predefined\n default logger will be used. Setting `None` will disable any log propagation. Passing custom logger\n will redirect logs to the provided logger. The logger is also used to capture status and status message\n of the other Actor run.\n\nReturns:\n The run object." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 744, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L744" + } + ], + "signatures": [ + { + "id": 1474, + "name": "call", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the Actor and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_secs argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [ + { + "id": 1475, + "name": "run_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Any" + }, + "defaultValue": "None" + }, + { + "id": 1476, + "name": "content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1477, + "name": "build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1478, + "name": "max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1479, + "name": "max_total_charge_usd", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Decimal | None" + }, + "defaultValue": "None" + }, + { + "id": 1480, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1481, + "name": "memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1482, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1483, + "name": "webhooks", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1484, + "name": "force_permission_level", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorPermissionLevel | None" + }, + "defaultValue": "None" + }, + { + "id": 1485, + "name": "wait_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1486, + "name": "logger", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Logger | None | Literal['default']" + }, + "defaultValue": "'default'" + } + ] + } + ] + }, + { + "id": 1487, + "name": "build", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Build the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor\n\nArgs:\n version_number: Actor version number to be built.\n beta_packages: If True, then the Actor is built with beta versions of Apify NPM packages. By default,\n the build uses latest stable packages.\n tag: Tag to be applied to the build on success. By default, the tag is taken from the Actor version's\n build tag property.\n use_cache: If true, the Actor's Docker container will be rebuilt using layer cache\n (https://docs.docker.com/develop/develop-images/dockerfile_best-practices/`leverage`-build-cache).\n This is to enable quick rebuild during development. By default, the cache is not used.\n wait_for_finish: The maximum number of seconds the server waits for the build to finish before returning.\n By default it is 0, the maximum value is 60.\n\nReturns:\n The build object." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 822, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L822" + } + ], + "signatures": [ + { + "id": 1488, + "name": "build", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Build the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1489, + "name": "version_number", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1490, + "name": "beta_packages", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1491, + "name": "tag", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1492, + "name": "use_cache", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1493, + "name": "wait_for_finish", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 1494, + "name": "builds", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the builds of this Actor." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 866, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L866" + } + ], + "signatures": [ + { + "id": 1495, + "name": "builds", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the builds of this Actor." + } + ] + }, + "type": { + "type": "reference", + "name": "BuildCollectionClientAsync", + "id": 1099 + }, + "parameters": [] + } + ] + }, + { + "id": 1496, + "name": "runs", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the runs of this Actor." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 870, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L870" + } + ], + "signatures": [ + { + "id": 1497, + "name": "runs", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the runs of this Actor." + } + ] + }, + "type": { + "type": "reference", + "name": "RunCollectionClientAsync", + "id": 406 + }, + "parameters": [] + } + ] + }, + { + "id": 1498, + "name": "default_build", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve Actor's default build.\n\nhttps://docs.apify.com/api/v2/act-build-default-get\n\nArgs:\n wait_for_finish: The maximum number of seconds the server waits for the build to finish before returning.\n By default it is 0, the maximum value is 60.\n\nReturns:\n The resource client for the default build of this Actor." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 874, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L874" + } + ], + "signatures": [ + { + "id": 1499, + "name": "default_build", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve Actor's default build.\n\nhttps://docs.apify.com/api/v2/act-build-default-get\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "BuildClientAsync", + "id": 1119 + }, + "parameters": [ + { + "id": 1500, + "name": "wait_for_finish", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 1501, + "name": "last_run", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the last run of this Actor.\n\nLast run is retrieved based on the start time of the runs.\n\nArgs:\n status: Consider only runs with this status.\n origin: Consider only runs started with this origin.\n\nReturns:\n The resource client for the last run of this Actor." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 908, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L908" + } + ], + "signatures": [ + { + "id": 1502, + "name": "last_run", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the last run of this Actor.\n\nLast run is retrieved based on the start time of the runs.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "RunClientAsync", + "id": 468 + }, + "parameters": [ + { + "id": 1503, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorJobStatus | None" + }, + "defaultValue": "None" + }, + { + "id": 1504, + "name": "origin", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "MetaOrigin | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 1505, + "name": "versions", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the versions of this Actor." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 936, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L936" + } + ], + "signatures": [ + { + "id": 1506, + "name": "versions", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the versions of this Actor." + } + ] + }, + "type": { + "type": "reference", + "name": "ActorVersionCollectionClientAsync", + "id": 1147 + }, + "parameters": [] + } + ] + }, + { + "id": 1507, + "name": "version", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the specified version of this Actor.\n\nArgs:\n version_number: The version number for which to retrieve the resource client.\n\nReturns:\n The resource client for the specified Actor version." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 940, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L940" + } + ], + "signatures": [ + { + "id": 1508, + "name": "version", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the specified version of this Actor.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ActorVersionClientAsync", + "id": 1181 + }, + "parameters": [ + { + "id": 1509, + "name": "version_number", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 1510, + "name": "webhooks", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for webhooks associated with this Actor." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 951, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L951" + } + ], + "signatures": [ + { + "id": 1511, + "name": "webhooks", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for webhooks associated with this Actor." + } + ] + }, + "type": { + "type": "reference", + "name": "WebhookCollectionClientAsync", + "id": 49 + }, + "parameters": [] + } + ] + }, + { + "id": 1512, + "name": "validate_input", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Validate an input for the Actor that defines an input schema.\n\nArgs:\n run_input: The input to validate.\n build_tag: The actor's build tag.\n content_type: The content type of the input.\n\nReturns:\n True if the input is valid, else raise an exception with validation error details." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 955, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L955" + } + ], + "signatures": [ + { + "id": 1513, + "name": "validate_input", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Validate an input for the Actor that defines an input schema.\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "parameters": [ + { + "id": 1514, + "name": "run_input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Any" + }, + "defaultValue": "None" + }, + { + "id": 1515, + "name": "build_tag", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1516, + "name": "content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 1487, + 1494, + 1473, + 1498, + 1458, + 1428, + 1501, + 1496, + 1460, + 1430, + 1512, + 1507, + 1505, + 1510 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 545, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L545" + } + ] + }, + { + "id": 1517, + "name": "ListPage", + "module": "apify_client.clients.base.resource_collection_client", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A single page of items returned from a list() method." + } + ] + }, + "children": [ + { + "id": 1518, + "name": "items", + "module": "apify_client.clients.base.resource_collection_client", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List of returned objects on this page" + } + ] + }, + "type": { + "type": "reference", + "name": "list[T]" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/base/resource_collection_client.py", + "line": 14, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/resource_collection_client.py#L14" + } + ] + }, + { + "id": 1519, + "name": "count", + "module": "apify_client.clients.base.resource_collection_client", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Count of the returned objects on this page" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "int" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/base/resource_collection_client.py", + "line": 17, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/resource_collection_client.py#L17" + } + ] + }, + { + "id": 1520, + "name": "offset", + "module": "apify_client.clients.base.resource_collection_client", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The limit on the number of returned objects offset specified in the API call" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "int" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/base/resource_collection_client.py", + "line": 20, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/resource_collection_client.py#L20" + } + ] + }, + { + "id": 1521, + "name": "limit", + "module": "apify_client.clients.base.resource_collection_client", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The offset of the first object specified in the API call" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "int" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/base/resource_collection_client.py", + "line": 23, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/resource_collection_client.py#L23" + } + ] + }, + { + "id": 1522, + "name": "total", + "module": "apify_client.clients.base.resource_collection_client", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Total number of objects matching the API call criteria" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "int" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/base/resource_collection_client.py", + "line": 26, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/resource_collection_client.py#L26" + } + ] + }, + { + "id": 1523, + "name": "desc", + "module": "apify_client.clients.base.resource_collection_client", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the listing is descending or not" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/base/resource_collection_client.py", + "line": 29, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/resource_collection_client.py#L29" + } + ] + }, + { + "id": 1524, + "name": "__init__", + "module": "apify_client.clients.base.resource_collection_client", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a ListPage instance from the API response data." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/base/resource_collection_client.py", + "line": 32, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/resource_collection_client.py#L32" + } + ], + "signatures": [ + { + "id": 1525, + "name": "__init__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a ListPage instance from the API response data." + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 1526, + "name": "data", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "dict" + } + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1524 + ] + }, + { + "title": "Properties", + "children": [ + 1519, + 1523, + 1518, + 1521, + 1520, + 1522 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/base/resource_collection_client.py", + "line": 11, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/resource_collection_client.py#L11" + } + ] + }, + { + "id": 1527, + "name": "ResourceCollectionClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Base class for sub-clients manipulating a resource collection." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/base/resource_collection_client.py", + "line": 42, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/resource_collection_client.py#L42" + } + ] + }, + { + "id": 1528, + "name": "ResourceCollectionClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Base class for async sub-clients manipulating a resource collection." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/base/resource_collection_client.py", + "line": 75, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/resource_collection_client.py#L75" + } + ] + }, + { + "id": 1529, + "name": "ResourceClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Base class for sub-clients manipulating a single resource." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/base/resource_client.py", + "line": 8, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/resource_client.py#L8" + } + ] + }, + { + "id": 1530, + "name": "ResourceClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Base class for async sub-clients manipulating a single resource." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/base/resource_client.py", + "line": 51, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/resource_client.py#L51" + } + ] + }, + { + "id": 1531, + "name": "BaseClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Base class for sub-clients." + } + ] + }, + "children": [ + { + "id": 1532, + "name": "__init__", + "module": "apify_client.clients.base.base_client", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a new instance.\n\nArgs:\n base_url: Base URL of the API server.\n root_client: The ApifyClient instance under which this resource client exists.\n http_client: The HTTPClient instance to be used in this client.\n resource_id: ID of the manipulated resource, in case of a single-resource client.\n resource_path: Path to the resource's endpoint on the API server.\n params: Parameters to include in all requests from this client." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/base/base_client.py", + "line": 56, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/base_client.py#L56" + } + ], + "signatures": [ + { + "id": 1533, + "name": "__init__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a new instance.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 1534, + "name": "base_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1535, + "name": "root_client", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ApifyClient", + "id": 1551 + } + }, + { + "id": 1536, + "name": "http_client", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "HTTPClient" + } + }, + { + "id": 1537, + "name": "resource_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1538, + "name": "resource_path", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1539, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1532 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/base/base_client.py", + "line": 50, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/base_client.py#L50" + } + ] + }, + { + "id": 1540, + "name": "BaseClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Base class for async sub-clients." + } + ] + }, + "children": [ + { + "id": 1541, + "name": "__init__", + "module": "apify_client.clients.base.base_client", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a new instance.\n\nArgs:\n base_url: Base URL of the API server.\n root_client: The ApifyClientAsync instance under which this resource client exists.\n http_client: The HTTPClientAsync instance to be used in this client.\n resource_id: ID of the manipulated resource, in case of a single-resource client.\n resource_path: Path to the resource's endpoint on the API server.\n params: Parameters to include in all requests from this client." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/base/base_client.py", + "line": 97, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/base_client.py#L97" + } + ], + "signatures": [ + { + "id": 1542, + "name": "__init__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a new instance.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 1543, + "name": "base_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1544, + "name": "root_client", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ApifyClientAsync", + "id": 1620 + } + }, + { + "id": 1545, + "name": "http_client", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "HTTPClientAsync" + } + }, + { + "id": 1546, + "name": "resource_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1547, + "name": "resource_path", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1548, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1541 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/base/base_client.py", + "line": 91, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/base_client.py#L91" + } + ] + }, + { + "id": 1549, + "name": "ActorJobBaseClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Base sub-client class for Actor runs and Actor builds." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/base/actor_job_base_client.py", + "line": 20, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/actor_job_base_client.py#L20" + } + ] + }, + { + "id": 1550, + "name": "ActorJobBaseClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Base async sub-client class for Actor runs and Actor builds." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/base/actor_job_base_client.py", + "line": 76, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/actor_job_base_client.py#L76" + } + ] + }, + { + "id": 1551, + "name": "ApifyClient", + "module": "apify_client", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Apify API client." + } + ] + }, + "children": [ + { + "id": 1552, + "name": "__init__", + "module": "apify_client.client", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a new instance.\n\nArgs:\n token: The Apify API token.\n api_url: The URL of the Apify API server to which to connect. Defaults to https://api.apify.com. It can\n be an internal URL that is not globally accessible, in such case `api_public_url` should be set as well.\n api_public_url: The globally accessible URL of the Apify API server. It should be set only if the `api_url`\n is an internal URL that is not globally accessible.\n max_retries: How many times to retry a failed request at most.\n min_delay_between_retries_millis: How long will the client wait between retrying requests\n (increases exponentially from this value).\n timeout_secs: The socket timeout of the HTTP requests sent to the Apify API.\n headers: Set headers to client for all requests." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 123, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L123" + } + ], + "signatures": [ + { + "id": 1553, + "name": "__init__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a new instance.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 1554, + "name": "token", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1555, + "name": "api_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1556, + "name": "api_public_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1557, + "name": "max_retries", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "8" + }, + { + "id": 1558, + "name": "min_delay_between_retries_millis", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "500" + }, + { + "id": 1559, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "DEFAULT_TIMEOUT" + }, + { + "id": 1560, + "name": "headers", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 1561, + "name": "actor", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single Actor.\n\nArgs:\n actor_id: ID of the Actor to be manipulated." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 171, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L171" + } + ], + "signatures": [ + { + "id": 1562, + "name": "actor", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single Actor.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ActorClient", + "id": 1337 + }, + "parameters": [ + { + "id": 1563, + "name": "actor_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 1564, + "name": "actors", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating Actors." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 179, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L179" + } + ], + "signatures": [ + { + "id": 1565, + "name": "actors", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating Actors." + } + ] + }, + "type": { + "type": "reference", + "name": "ActorCollectionClient", + "id": 1242 + }, + "parameters": [] + } + ] + }, + { + "id": 1566, + "name": "build", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single Actor build.\n\nArgs:\n build_id: ID of the Actor build to be manipulated." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 183, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L183" + } + ], + "signatures": [ + { + "id": 1567, + "name": "build", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single Actor build.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "BuildClient", + "id": 1105 + }, + "parameters": [ + { + "id": 1568, + "name": "build_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 1569, + "name": "builds", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple builds of a user." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 191, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L191" + } + ], + "signatures": [ + { + "id": 1570, + "name": "builds", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple builds of a user." + } + ] + }, + "type": { + "type": "reference", + "name": "BuildCollectionClient", + "id": 1093 + }, + "parameters": [] + } + ] + }, + { + "id": 1571, + "name": "run", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single Actor run.\n\nArgs:\n run_id: ID of the Actor run to be manipulated." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 195, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L195" + } + ], + "signatures": [ + { + "id": 1572, + "name": "run", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single Actor run.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "RunClient", + "id": 415 + }, + "parameters": [ + { + "id": 1573, + "name": "run_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 1574, + "name": "runs", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple Actor runs of a user." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 203, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L203" + } + ], + "signatures": [ + { + "id": 1575, + "name": "runs", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple Actor runs of a user." + } + ] + }, + "type": { + "type": "reference", + "name": "RunCollectionClient", + "id": 397 + }, + "parameters": [] + } + ] + }, + { + "id": 1576, + "name": "dataset", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single dataset.\n\nArgs:\n dataset_id: ID of the dataset to be manipulated." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 207, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L207" + } + ], + "signatures": [ + { + "id": 1577, + "name": "dataset", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single dataset.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "DatasetClient", + "id": 892 + }, + "parameters": [ + { + "id": 1578, + "name": "dataset_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 1579, + "name": "datasets", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating datasets." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 215, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L215" + } + ], + "signatures": [ + { + "id": 1580, + "name": "datasets", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating datasets." + } + ] + }, + "type": { + "type": "reference", + "name": "DatasetCollectionClient", + "id": 870 + }, + "parameters": [] + } + ] + }, + { + "id": 1581, + "name": "key_value_store", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single key-value store.\n\nArgs:\n key_value_store_id: ID of the key-value store to be manipulated." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 219, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L219" + } + ], + "signatures": [ + { + "id": 1582, + "name": "key_value_store", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single key-value store.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "KeyValueStoreClient", + "id": 772 + }, + "parameters": [ + { + "id": 1583, + "name": "key_value_store_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 1584, + "name": "key_value_stores", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating key-value stores." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 227, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L227" + } + ], + "signatures": [ + { + "id": 1585, + "name": "key_value_stores", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating key-value stores." + } + ] + }, + "type": { + "type": "reference", + "name": "KeyValueStoreCollectionClient", + "id": 750 + }, + "parameters": [] + } + ] + }, + { + "id": 1586, + "name": "request_queue", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single request queue.\n\nArgs:\n request_queue_id: ID of the request queue to be manipulated.\n client_key: A unique identifier of the client accessing the request queue." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 231, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L231" + } + ], + "signatures": [ + { + "id": 1587, + "name": "request_queue", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single request queue.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "RequestQueueClient", + "id": 542 + }, + "parameters": [ + { + "id": 1588, + "name": "request_queue_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1589, + "name": "client_key", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 1590, + "name": "request_queues", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating request queues." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 240, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L240" + } + ], + "signatures": [ + { + "id": 1591, + "name": "request_queues", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating request queues." + } + ] + }, + "type": { + "type": "reference", + "name": "RequestQueueCollectionClient", + "id": 521 + }, + "parameters": [] + } + ] + }, + { + "id": 1592, + "name": "webhook", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single webhook.\n\nArgs:\n webhook_id: ID of the webhook to be manipulated." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 244, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L244" + } + ], + "signatures": [ + { + "id": 1593, + "name": "webhook", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single webhook.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "WebhookClient", + "id": 81 + }, + "parameters": [ + { + "id": 1594, + "name": "webhook_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 1595, + "name": "webhooks", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple webhooks of a user." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 252, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L252" + } + ], + "signatures": [ + { + "id": 1596, + "name": "webhooks", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple webhooks of a user." + } + ] + }, + "type": { + "type": "reference", + "name": "WebhookCollectionClient", + "id": 30 + }, + "parameters": [] + } + ] + }, + { + "id": 1597, + "name": "webhook_dispatch", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for accessing a single webhook dispatch.\n\nArgs:\n webhook_dispatch_id: ID of the webhook dispatch to access." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 256, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L256" + } + ], + "signatures": [ + { + "id": 1598, + "name": "webhook_dispatch", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for accessing a single webhook dispatch.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "WebhookDispatchClient", + "id": 24 + }, + "parameters": [ + { + "id": 1599, + "name": "webhook_dispatch_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 1600, + "name": "webhook_dispatches", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple webhook dispatches of a user." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 264, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L264" + } + ], + "signatures": [ + { + "id": 1601, + "name": "webhook_dispatches", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple webhook dispatches of a user." + } + ] + }, + "type": { + "type": "reference", + "name": "WebhookDispatchCollectionClient", + "id": 12 + }, + "parameters": [] + } + ] + }, + { + "id": 1602, + "name": "schedule", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single schedule.\n\nArgs:\n schedule_id: ID of the schedule to be manipulated." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 268, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L268" + } + ], + "signatures": [ + { + "id": 1603, + "name": "schedule", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single schedule.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ScheduleClient", + "id": 363 + }, + "parameters": [ + { + "id": 1604, + "name": "schedule_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 1605, + "name": "schedules", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating schedules." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 276, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L276" + } + ], + "signatures": [ + { + "id": 1606, + "name": "schedules", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating schedules." + } + ] + }, + "type": { + "type": "reference", + "name": "ScheduleCollectionClient", + "id": 331 + }, + "parameters": [] + } + ] + }, + { + "id": 1607, + "name": "log", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for retrieving logs.\n\nArgs:\n build_or_run_id: ID of the Actor build or run for which to access the log." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 280, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L280" + } + ], + "signatures": [ + { + "id": 1608, + "name": "log", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for retrieving logs.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "LogClient", + "id": 662 + }, + "parameters": [ + { + "id": 1609, + "name": "build_or_run_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 1610, + "name": "task", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single task.\n\nArgs:\n task_id: ID of the task to be manipulated." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 288, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L288" + } + ], + "signatures": [ + { + "id": 1611, + "name": "task", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single task.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "TaskClient", + "id": 205 + }, + "parameters": [ + { + "id": 1612, + "name": "task_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 1613, + "name": "tasks", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating tasks." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 296, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L296" + } + ], + "signatures": [ + { + "id": 1614, + "name": "tasks", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating tasks." + } + ] + }, + "type": { + "type": "reference", + "name": "TaskCollectionClient", + "id": 145 + }, + "parameters": [] + } + ] + }, + { + "id": 1615, + "name": "user", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying users.\n\nArgs:\n user_id: ID of user to be queried. If None, queries the user belonging to the token supplied to the client." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 300, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L300" + } + ], + "signatures": [ + { + "id": 1616, + "name": "user", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying users.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "UserClient", + "id": 123 + }, + "parameters": [ + { + "id": 1617, + "name": "user_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 1618, + "name": "store", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for Apify store." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 308, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L308" + } + ], + "signatures": [ + { + "id": 1619, + "name": "store", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for Apify store." + } + ] + }, + "type": { + "type": "reference", + "name": "StoreCollectionClient", + "id": 311 + }, + "parameters": [] + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1552 + ] + }, + { + "title": "Methods", + "children": [ + 1561, + 1564, + 1566, + 1569, + 1576, + 1579, + 1581, + 1584, + 1607, + 1586, + 1590, + 1571, + 1574, + 1602, + 1605, + 1618, + 1610, + 1613, + 1615, + 1592, + 1597, + 1600, + 1595 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 118, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L118" + } + ] + }, + { + "id": 1620, + "name": "ApifyClientAsync", + "module": "apify_client", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The asynchronous version of the Apify API client." + } + ] + }, + "children": [ + { + "id": 1621, + "name": "__init__", + "module": "apify_client.client", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a new instance.\n\nArgs:\n token: The Apify API token.\n api_url: The URL of the Apify API server to which to connect. Defaults to https://api.apify.com. It can\n be an internal URL that is not globally accessible, in such case `api_public_url` should be set as well.\n api_public_url: The globally accessible URL of the Apify API server. It should be set only if the `api_url`\n is an internal URL that is not globally accessible.\n max_retries: How many times to retry a failed request at most.\n min_delay_between_retries_millis: How long will the client wait between retrying requests\n (increases exponentially from this value).\n timeout_secs: The socket timeout of the HTTP requests sent to the Apify API.\n headers: Set headers to client for all requests." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 318, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L318" + } + ], + "signatures": [ + { + "id": 1622, + "name": "__init__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a new instance.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 1623, + "name": "token", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1624, + "name": "api_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1625, + "name": "api_public_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1626, + "name": "max_retries", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "8" + }, + { + "id": 1627, + "name": "min_delay_between_retries_millis", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "500" + }, + { + "id": 1628, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "DEFAULT_TIMEOUT" + }, + { + "id": 1629, + "name": "headers", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 1630, + "name": "actor", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single Actor.\n\nArgs:\n actor_id: ID of the Actor to be manipulated." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 366, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L366" + } + ], + "signatures": [ + { + "id": 1631, + "name": "actor", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single Actor.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ActorClientAsync", + "id": 1427 + }, + "parameters": [ + { + "id": 1632, + "name": "actor_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 1633, + "name": "actors", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating Actors." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 374, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L374" + } + ], + "signatures": [ + { + "id": 1634, + "name": "actors", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating Actors." + } + ] + }, + "type": { + "type": "reference", + "name": "ActorCollectionClientAsync", + "id": 1275 + }, + "parameters": [] + } + ] + }, + { + "id": 1635, + "name": "build", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single Actor build.\n\nArgs:\n build_id: ID of the Actor build to be manipulated." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 378, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L378" + } + ], + "signatures": [ + { + "id": 1636, + "name": "build", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single Actor build.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "BuildClientAsync", + "id": 1119 + }, + "parameters": [ + { + "id": 1637, + "name": "build_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 1638, + "name": "builds", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple builds of a user." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 386, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L386" + } + ], + "signatures": [ + { + "id": 1639, + "name": "builds", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple builds of a user." + } + ] + }, + "type": { + "type": "reference", + "name": "BuildCollectionClientAsync", + "id": 1099 + }, + "parameters": [] + } + ] + }, + { + "id": 1640, + "name": "run", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single Actor run.\n\nArgs:\n run_id: ID of the Actor run to be manipulated." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 390, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L390" + } + ], + "signatures": [ + { + "id": 1641, + "name": "run", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single Actor run.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "RunClientAsync", + "id": 468 + }, + "parameters": [ + { + "id": 1642, + "name": "run_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 1643, + "name": "runs", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple Actor runs of a user." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 398, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L398" + } + ], + "signatures": [ + { + "id": 1644, + "name": "runs", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple Actor runs of a user." + } + ] + }, + "type": { + "type": "reference", + "name": "RunCollectionClientAsync", + "id": 406 + }, + "parameters": [] + } + ] + }, + { + "id": 1645, + "name": "dataset", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single dataset.\n\nArgs:\n dataset_id: ID of the dataset to be manipulated." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 402, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L402" + } + ], + "signatures": [ + { + "id": 1646, + "name": "dataset", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single dataset.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "DatasetClientAsync", + "id": 1002 + }, + "parameters": [ + { + "id": 1647, + "name": "dataset_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 1648, + "name": "datasets", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating datasets." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 410, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L410" + } + ], + "signatures": [ + { + "id": 1649, + "name": "datasets", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating datasets." + } + ] + }, + "type": { + "type": "reference", + "name": "DatasetCollectionClientAsync", + "id": 881 + }, + "parameters": [] + } + ] + }, + { + "id": 1650, + "name": "key_value_store", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single key-value store.\n\nArgs:\n key_value_store_id: ID of the key-value store to be manipulated." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 414, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L414" + } + ], + "signatures": [ + { + "id": 1651, + "name": "key_value_store", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single key-value store.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "KeyValueStoreClientAsync", + "id": 821 + }, + "parameters": [ + { + "id": 1652, + "name": "key_value_store_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 1653, + "name": "key_value_stores", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating key-value stores." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 422, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L422" + } + ], + "signatures": [ + { + "id": 1654, + "name": "key_value_stores", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating key-value stores." + } + ] + }, + "type": { + "type": "reference", + "name": "KeyValueStoreCollectionClientAsync", + "id": 761 + }, + "parameters": [] + } + ] + }, + { + "id": 1655, + "name": "request_queue", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single request queue.\n\nArgs:\n request_queue_id: ID of the request queue to be manipulated.\n client_key: A unique identifier of the client accessing the request queue." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 426, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L426" + } + ], + "signatures": [ + { + "id": 1656, + "name": "request_queue", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single request queue.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "RequestQueueClientAsync", + "id": 602 + }, + "parameters": [ + { + "id": 1657, + "name": "request_queue_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1658, + "name": "client_key", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 1659, + "name": "request_queues", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating request queues." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 435, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L435" + } + ], + "signatures": [ + { + "id": 1660, + "name": "request_queues", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating request queues." + } + ] + }, + "type": { + "type": "reference", + "name": "RequestQueueCollectionClientAsync", + "id": 531 + }, + "parameters": [] + } + ] + }, + { + "id": 1661, + "name": "webhook", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single webhook.\n\nArgs:\n webhook_id: ID of the webhook to be manipulated." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 439, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L439" + } + ], + "signatures": [ + { + "id": 1662, + "name": "webhook", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single webhook.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "WebhookClientAsync", + "id": 102 + }, + "parameters": [ + { + "id": 1663, + "name": "webhook_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 1664, + "name": "webhooks", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple webhooks of a user." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 447, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L447" + } + ], + "signatures": [ + { + "id": 1665, + "name": "webhooks", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple webhooks of a user." + } + ] + }, + "type": { + "type": "reference", + "name": "WebhookCollectionClientAsync", + "id": 49 + }, + "parameters": [] + } + ] + }, + { + "id": 1666, + "name": "webhook_dispatch", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for accessing a single webhook dispatch.\n\nArgs:\n webhook_dispatch_id: ID of the webhook dispatch to access." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 451, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L451" + } + ], + "signatures": [ + { + "id": 1667, + "name": "webhook_dispatch", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for accessing a single webhook dispatch.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "WebhookDispatchClientAsync", + "id": 27 + }, + "parameters": [ + { + "id": 1668, + "name": "webhook_dispatch_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 1669, + "name": "webhook_dispatches", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple webhook dispatches of a user." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 459, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L459" + } + ], + "signatures": [ + { + "id": 1670, + "name": "webhook_dispatches", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple webhook dispatches of a user." + } + ] + }, + "type": { + "type": "reference", + "name": "WebhookDispatchCollectionClientAsync", + "id": 18 + }, + "parameters": [] + } + ] + }, + { + "id": 1671, + "name": "schedule", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single schedule.\n\nArgs:\n schedule_id: ID of the schedule to be manipulated." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 463, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L463" + } + ], + "signatures": [ + { + "id": 1672, + "name": "schedule", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single schedule.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ScheduleClientAsync", + "id": 380 + }, + "parameters": [ + { + "id": 1673, + "name": "schedule_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 1674, + "name": "schedules", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating schedules." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 471, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L471" + } + ], + "signatures": [ + { + "id": 1675, + "name": "schedules", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating schedules." + } + ] + }, + "type": { + "type": "reference", + "name": "ScheduleCollectionClientAsync", + "id": 347 + }, + "parameters": [] + } + ] + }, + { + "id": 1676, + "name": "log", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for retrieving logs.\n\nArgs:\n build_or_run_id: ID of the Actor build or run for which to access the log." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 475, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L475" + } + ], + "signatures": [ + { + "id": 1677, + "name": "log", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for retrieving logs.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "LogClientAsync", + "id": 672 + }, + "parameters": [ + { + "id": 1678, + "name": "build_or_run_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 1679, + "name": "task", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single task.\n\nArgs:\n task_id: ID of the task to be manipulated." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 483, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L483" + } + ], + "signatures": [ + { + "id": 1680, + "name": "task", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single task.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "TaskClientAsync", + "id": 258 + }, + "parameters": [ + { + "id": 1681, + "name": "task_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 1682, + "name": "tasks", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating tasks." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 491, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L491" + } + ], + "signatures": [ + { + "id": 1683, + "name": "tasks", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating tasks." + } + ] + }, + "type": { + "type": "reference", + "name": "TaskCollectionClientAsync", + "id": 167 + }, + "parameters": [] + } + ] + }, + { + "id": 1684, + "name": "user", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying users.\n\nArgs:\n user_id: ID of user to be queried. If None, queries the user belonging to the token supplied to the client." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 495, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L495" + } + ], + "signatures": [ + { + "id": 1685, + "name": "user", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying users.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "UserClientAsync", + "id": 134 + }, + "parameters": [ + { + "id": 1686, + "name": "user_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 1687, + "name": "store", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for Apify store." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 503, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L503" + } + ], + "signatures": [ + { + "id": 1688, + "name": "store", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for Apify store." + } + ] + }, + "type": { + "type": "reference", + "name": "StoreCollectionClientAsync", + "id": 321 + }, + "parameters": [] + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1621 + ] + }, + { + "title": "Methods", + "children": [ + 1630, + 1633, + 1635, + 1638, + 1645, + 1648, + 1650, + 1653, + 1676, + 1655, + 1659, + 1640, + 1643, + 1671, + 1674, + 1687, + 1679, + 1682, + 1684, + 1661, + 1666, + 1669, + 1664 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 313, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L313" + } + ] + }, + { + "id": 1689, + "name": "filter_out_none_values_recursively", + "module": "apify_client._utils", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return copy of the dictionary, recursively omitting all keys for which values are None." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/_utils.py", + "line": 37, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_utils.py#L37" + } + ], + "signatures": [ + { + "id": 1690, + "name": "filter_out_none_values_recursively", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return copy of the dictionary, recursively omitting all keys for which values are None." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1691, + "name": "dictionary", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "dict" + } + } + ] + } + ] + }, + { + "id": 1692, + "name": "filter_out_none_values_recursively_internal", + "module": "apify_client._utils", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Recursively filters out None values from a dictionary.\n\nUnfortunately, it's necessary to have an internal function for the correct result typing,\nwithout having to create complicated overloads" + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/_utils.py", + "line": 42, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_utils.py#L42" + } + ], + "signatures": [ + { + "id": 1693, + "name": "filter_out_none_values_recursively_internal", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Recursively filters out None values from a dictionary.\n\nUnfortunately, it's necessary to have an internal function for the correct result typing,\nwithout having to create complicated overloads" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [ + { + "id": 1694, + "name": "dictionary", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "dict" + } + }, + { + "id": 1695, + "name": "remove_empty_dicts", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 1696, + "name": "parse_date_fields", + "module": "apify_client._utils", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Recursively parse date fields in a list or dictionary up to the specified depth." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/_utils.py", + "line": 73, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_utils.py#L73" + } + ], + "signatures": [ + { + "id": 1697, + "name": "parse_date_fields", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Recursively parse date fields in a list or dictionary up to the specified depth." + } + ] + }, + "type": { + "type": "reference", + "name": "list | dict" + }, + "parameters": [ + { + "id": 1698, + "name": "data", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "list | dict" + } + }, + { + "id": 1699, + "name": "max_depth", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "int" + }, + "defaultValue": "PARSE_DATE_FIELDS_MAX_DEPTH" + } + ] + } + ] + }, + { + "id": 1700, + "name": "is_content_type_json", + "module": "apify_client._utils", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Check if the given content type is JSON." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/_utils.py", + "line": 99, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_utils.py#L99" + } + ], + "signatures": [ + { + "id": 1701, + "name": "is_content_type_json", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Check if the given content type is JSON." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "parameters": [ + { + "id": 1702, + "name": "content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 1703, + "name": "is_content_type_xml", + "module": "apify_client._utils", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Check if the given content type is XML." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/_utils.py", + "line": 104, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_utils.py#L104" + } + ], + "signatures": [ + { + "id": 1704, + "name": "is_content_type_xml", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Check if the given content type is XML." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "parameters": [ + { + "id": 1705, + "name": "content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 1706, + "name": "is_content_type_text", + "module": "apify_client._utils", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Check if the given content type is text." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/_utils.py", + "line": 109, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_utils.py#L109" + } + ], + "signatures": [ + { + "id": 1707, + "name": "is_content_type_text", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Check if the given content type is text." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "parameters": [ + { + "id": 1708, + "name": "content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 1709, + "name": "is_file_or_bytes", + "module": "apify_client._utils", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Check if the input value is a file-like object or bytes.\n\nThe check for IOBase is not ideal, it would be better to use duck typing,\nbut then the check would be super complex, judging from how the 'requests' library does it.\nThis way should be good enough for the vast majority of use cases, if it causes issues, we can improve it later." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/_utils.py", + "line": 114, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_utils.py#L114" + } + ], + "signatures": [ + { + "id": 1710, + "name": "is_file_or_bytes", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Check if the input value is a file-like object or bytes.\n\nThe check for IOBase is not ideal, it would be better to use duck typing,\nbut then the check would be super complex, judging from how the 'requests' library does it.\nThis way should be good enough for the vast majority of use cases, if it causes issues, we can improve it later." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "parameters": [ + { + "id": 1711, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Any" + } + } + ] + } + ] + }, + { + "id": 1712, + "name": "json_dumps", + "module": "apify_client._utils", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Dump JSON to a string with the correct settings and serializer." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/_utils.py", + "line": 124, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_utils.py#L124" + } + ], + "signatures": [ + { + "id": 1713, + "name": "json_dumps", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Dump JSON to a string with the correct settings and serializer." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "str" + }, + "parameters": [ + { + "id": 1714, + "name": "obj", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Any" + } + } + ] + } + ] + }, + { + "id": 1715, + "name": "maybe_extract_enum_member_value", + "module": "apify_client._utils", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Extract the value of an enumeration member if it is an Enum, otherwise return the original value." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/_utils.py", + "line": 129, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_utils.py#L129" + } + ], + "signatures": [ + { + "id": 1716, + "name": "maybe_extract_enum_member_value", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Extract the value of an enumeration member if it is an Enum, otherwise return the original value." + } + ] + }, + "type": { + "type": "reference", + "name": "Any" + }, + "parameters": [ + { + "id": 1717, + "name": "maybe_enum_member", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Any" + } + } + ] + } + ] + }, + { + "id": 1718, + "name": "encode_webhook_list_to_base64", + "module": "apify_client._utils", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Encode a list of dictionaries representing webhooks to their base64-encoded representation for the API." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/_utils.py", + "line": 230, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_utils.py#L230" + } + ], + "signatures": [ + { + "id": 1719, + "name": "encode_webhook_list_to_base64", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Encode a list of dictionaries representing webhooks to their base64-encoded representation for the API." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "str" + }, + "parameters": [ + { + "id": 1720, + "name": "webhooks", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "list[dict]" + } + } + ] + } + ] + }, + { + "id": 1721, + "name": "is_retryable_error", + "module": "apify_client._utils", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Check if the given error is retryable.\n\nAll ``impit.HTTPError`` subclasses are considered retryable because they represent transport-level failures\n(network issues, timeouts, protocol errors, body decoding errors) that are typically transient. HTTP status\ncode errors are handled separately in ``_make_request`` based on the response status code, not here." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/_utils.py", + "line": 283, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_utils.py#L283" + } + ], + "signatures": [ + { + "id": 1722, + "name": "is_retryable_error", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Check if the given error is retryable.\n\nAll ``impit.HTTPError`` subclasses are considered retryable because they represent transport-level failures\n(network issues, timeouts, protocol errors, body decoding errors) that are typically transient. HTTP status\ncode errors are handled separately in ``_make_request`` based on the response status code, not here." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "parameters": [ + { + "id": 1723, + "name": "exc", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Exception" + } + } + ] + } + ] + }, + { + "id": 1724, + "name": "JSONSerializable", + "module": "apify_client._types", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Type for representing json-serializable values. It's close enough to the real thing supported by json.parse.\nIt was suggested in a discussion with (and approved by) Guido van Rossum, so I'd consider it correct enough." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/_types.py", + "line": 5, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_types.py#L5" + } + ] + }, + { + "id": 1725, + "name": "ListPage", + "module": "apify_client._types", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A single page of items returned from a list() method." + } + ] + }, + "children": [ + { + "id": 1726, + "name": "items", + "module": "apify_client._types", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List of returned objects on this page." + } + ] + }, + "type": { + "type": "reference", + "name": "list[T]" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/_types.py", + "line": 16, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_types.py#L16" + } + ] + }, + { + "id": 1727, + "name": "count", + "module": "apify_client._types", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Count of the returned objects on this page." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "int" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/_types.py", + "line": 19, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_types.py#L19" + } + ] + }, + { + "id": 1728, + "name": "offset", + "module": "apify_client._types", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The limit on the number of returned objects offset specified in the API call." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "int" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/_types.py", + "line": 22, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_types.py#L22" + } + ] + }, + { + "id": 1729, + "name": "limit", + "module": "apify_client._types", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The offset of the first object specified in the API call" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "int" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/_types.py", + "line": 25, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_types.py#L25" + } + ] + }, + { + "id": 1730, + "name": "total", + "module": "apify_client._types", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Total number of objects matching the API call criteria." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "int" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/_types.py", + "line": 28, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_types.py#L28" + } + ] + }, + { + "id": 1731, + "name": "desc", + "module": "apify_client._types", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the listing is descending or not." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/_types.py", + "line": 31, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_types.py#L31" + } + ] + }, + { + "id": 1732, + "name": "__init__", + "module": "apify_client._types", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a ListPage instance from the API response data." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/_types.py", + "line": 34, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_types.py#L34" + } + ], + "signatures": [ + { + "id": 1733, + "name": "__init__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a ListPage instance from the API response data." + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 1734, + "name": "data", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "dict" + } + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1732 + ] + }, + { + "title": "Properties", + "children": [ + 1727, + 1731, + 1726, + 1729, + 1728, + 1730 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/_types.py", + "line": 13, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_types.py#L13" + } + ] + }, + { + "id": 1735, + "name": "Statistics", + "module": "apify_client._statistics", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Statistics about API client usage and rate limit errors." + } + ] + }, + "children": [ + { + "id": 1736, + "name": "calls", + "module": "apify_client._statistics", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Total number of API method calls made by the client." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "int" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/_statistics.py", + "line": 9, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_statistics.py#L9" + } + ] + }, + { + "id": 1737, + "name": "requests", + "module": "apify_client._statistics", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Total number of HTTP requests sent, including retries." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "int" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/_statistics.py", + "line": 12, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_statistics.py#L12" + } + ] + }, + { + "id": 1738, + "name": "rate_limit_errors", + "module": "apify_client._statistics", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List tracking which retry attempts encountered rate limit (429) errors." + } + ] + }, + "type": { + "type": "reference", + "name": "defaultdict[int, int]" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/_statistics.py", + "line": 15, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_statistics.py#L15" + } + ] + }, + { + "id": 1739, + "name": "add_rate_limit_error", + "module": "apify_client._statistics", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Add rate limit error for specific attempt.\n\nArgs:\n attempt: The attempt number (1-based indexing)." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/_statistics.py", + "line": 18, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_statistics.py#L18" + } + ], + "signatures": [ + { + "id": 1740, + "name": "add_rate_limit_error", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Add rate limit error for specific attempt.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 1741, + "name": "attempt", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "int" + } + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Errors", + "children": [ + 1739, + 1738 + ] + }, + { + "title": "Properties", + "children": [ + 1736, + 1737 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/_statistics.py", + "line": 6, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_statistics.py#L6" + } + ] + }, + { + "id": 1742, + "name": "create_redirect_logger", + "module": "apify_client._logging", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a logger for redirecting logs from another Actor.\n\nArgs:\n name: The name of the logger. It can be used to inherit from other loggers. Example: `apify.xyz` will use logger\n named `xyz` and make it a children of `apify` logger.\n\nReturns:\n The created logger." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/_logging.py", + "line": 129, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_logging.py#L129" + } + ], + "signatures": [ + { + "id": 1743, + "name": "create_redirect_logger", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a logger for redirecting logs from another Actor.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "logging.Logger" + }, + "parameters": [ + { + "id": 1744, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 1745, + "name": "RedirectLogFormatter", + "module": "apify_client._logging", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Formatter applied to default redirect logger." + } + ] + }, + "children": [ + { + "id": 1746, + "name": "format", + "module": "apify_client._logging", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Format the log by prepending logger name to the original message.\n\nArgs:\n record: Log record to be formatted.\n\nReturns:\n Formatted log message." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/_logging.py", + "line": 160, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_logging.py#L160" + } + ], + "signatures": [ + { + "id": 1747, + "name": "format", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Format the log by prepending logger name to the original message.\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "str" + }, + "parameters": [ + { + "id": 1748, + "name": "record", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "logging.LogRecord" + } + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 1746 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/_logging.py", + "line": 157, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_logging.py#L157" + } + ] + }, + { + "id": 1749, + "name": "encode_base62", + "module": "apify_shared.utils", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Encode the given number to base62." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/utils.py", + "line": 10, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/utils.py#L10" + } + ], + "signatures": [ + { + "id": 1750, + "name": "encode_base62", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Encode the given number to base62." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "str" + }, + "parameters": [ + { + "id": 1751, + "name": "num", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "int" + } + } + ] + } + ] + }, + { + "id": 1752, + "name": "create_hmac_signature", + "module": "apify_shared.utils", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generate an HMAC signature and encodes it using Base62. Base62 encoding reduces the signature length.\n\nHMAC signature is truncated to 30 characters to make it shorter.\n\nArgs:\n secret_key: Secret key used for signing signatures.\n message: Message to be signed.\n\nReturns:\n Base62 encoded signature." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/utils.py", + "line": 24, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/utils.py#L24" + } + ], + "signatures": [ + { + "id": 1753, + "name": "create_hmac_signature", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generate an HMAC signature and encodes it using Base62. Base62 encoding reduces the signature length.\n\nHMAC signature is truncated to 30 characters to make it shorter.\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "str" + }, + "parameters": [ + { + "id": 1754, + "name": "secret_key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1755, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, + { + "id": 1756, + "name": "create_storage_content_signature", + "module": "apify_shared.utils", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a secure signature for a resource like a dataset or key-value store.\n\nThis signature is used to generate a signed URL for authenticated access, which can be expiring or permanent.\nThe signature is created using HMAC with the provided secret key and includes the resource ID, expiration time,\nand version.\n\nNote: expires_in_millis is optional. If not provided, the signature will not expire." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/utils.py", + "line": 43, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/utils.py#L43" + } + ], + "signatures": [ + { + "id": 1757, + "name": "create_storage_content_signature", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a secure signature for a resource like a dataset or key-value store.\n\nThis signature is used to generate a signed URL for authenticated access, which can be expiring or permanent.\nThe signature is created using HMAC with the provided secret key and includes the resource ID, expiration time,\nand version.\n\nNote: expires_in_millis is optional. If not provided, the signature will not expire." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "str" + }, + "parameters": [ + { + "id": 1758, + "name": "resource_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1759, + "name": "url_signing_secret_key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1760, + "name": "expires_in_millis", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1761, + "name": "version", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "int" + }, + "defaultValue": "0" + } + ] + } + ] + }, + { + "id": 1762, + "name": "ActorJobStatus", + "module": "apify_shared.consts", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Available statuses for Actor jobs (runs or builds).\n\nThese statuses represent the lifecycle of an Actor execution,\nfrom initialization to completion or termination." + } + ] + }, + "children": [ + { + "id": 1763, + "name": "READY", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor job has been initialized but not yet started." + } + ] + }, + "type": { + "type": "literal", + "value": "'READY'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 14, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L14" + } + ] + }, + { + "id": 1764, + "name": "RUNNING", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor job is currently executing." + } + ] + }, + "type": { + "type": "literal", + "value": "'RUNNING'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 17, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L17" + } + ] + }, + { + "id": 1765, + "name": "SUCCEEDED", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor job completed successfully without errors." + } + ] + }, + "type": { + "type": "literal", + "value": "'SUCCEEDED'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 20, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L20" + } + ] + }, + { + "id": 1766, + "name": "FAILED", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor job or build failed due to an error or exception." + } + ] + }, + "type": { + "type": "literal", + "value": "'FAILED'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 23, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L23" + } + ] + }, + { + "id": 1767, + "name": "TIMING_OUT", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor job is currently in the process of timing out." + } + ] + }, + "type": { + "type": "literal", + "value": "'TIMING-OUT'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 26, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L26" + } + ] + }, + { + "id": 1768, + "name": "TIMED_OUT", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor job was terminated due to timeout." + } + ] + }, + "type": { + "type": "literal", + "value": "'TIMED-OUT'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 29, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L29" + } + ] + }, + { + "id": 1769, + "name": "ABORTING", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor job is currently being aborted by user request." + } + ] + }, + "type": { + "type": "literal", + "value": "'ABORTING'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 32, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L32" + } + ] + }, + { + "id": 1770, + "name": "ABORTED", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor job was successfully aborted by user request." + } + ] + }, + "type": { + "type": "literal", + "value": "'ABORTED'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 35, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L35" + } + ] + }, + { + "id": 1771, + "name": "is_terminal", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether this Actor job status is terminal." + } + ] + }, + "type": { + "type": "literal" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 39, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L39" + } + ] + } + ], + "groups": [ + { + "title": "Enumeration Members", + "children": [ + 1770, + 1769, + 1766, + 1771, + 1763, + 1764, + 1765, + 1768, + 1767 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 7, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L7" + } + ] + }, + { + "id": 1772, + "name": "ActorSourceType", + "module": "apify_shared.consts", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Available source code types for Actors.\n\nDefines how Actor source code is stored and accessed\nfor building and executing Actors on the platform." + } + ] + }, + "children": [ + { + "id": 1773, + "name": "SOURCE_FILES", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor source code consists of multiple individual files uploaded directly." + } + ] + }, + "type": { + "type": "literal", + "value": "'SOURCE_FILES'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 56, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L56" + } + ] + }, + { + "id": 1774, + "name": "GIT_REPO", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor source code is cloned from a Git repository (GitHub, GitLab, etc.)." + } + ] + }, + "type": { + "type": "literal", + "value": "'GIT_REPO'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 59, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L59" + } + ] + }, + { + "id": 1775, + "name": "TARBALL", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor source code is downloaded from a tarball or ZIP archive." + } + ] + }, + "type": { + "type": "literal", + "value": "'TARBALL'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 62, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L62" + } + ] + }, + { + "id": 1776, + "name": "GITHUB_GIST", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor source code is retrieved from a GitHub Gist." + } + ] + }, + "type": { + "type": "literal", + "value": "'GITHUB_GIST'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 65, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L65" + } + ] + } + ], + "groups": [ + { + "title": "Enumeration Members", + "children": [ + 1774, + 1776, + 1773, + 1775 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 49, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L49" + } + ] + }, + { + "id": 1777, + "name": "ActorEventTypes", + "module": "apify_shared.consts", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Event types that can be sent to Actors during execution.\n\nThese events provide real-time information about system state\nand lifecycle changes that Actors can respond to." + } + ] + }, + "children": [ + { + "id": 1778, + "name": "SYSTEM_INFO", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Information about resource usage and system metrics of the Actor." + } + ] + }, + "type": { + "type": "literal", + "value": "'systemInfo'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 76, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L76" + } + ] + }, + { + "id": 1779, + "name": "MIGRATING", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Notification that the Actor is about to be migrated to another server." + } + ] + }, + "type": { + "type": "literal", + "value": "'migrating'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 79, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L79" + } + ] + }, + { + "id": 1780, + "name": "PERSIST_STATE", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Signal to persist Actor state - sent every minute or before migration." + } + ] + }, + "type": { + "type": "literal", + "value": "'persistState'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 82, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L82" + } + ] + }, + { + "id": 1781, + "name": "ABORTING", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Notification that the Actor is being terminated and should clean up." + } + ] + }, + "type": { + "type": "literal", + "value": "'aborting'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 85, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L85" + } + ] + } + ], + "groups": [ + { + "title": "Enumeration Members", + "children": [ + 1781, + 1779, + 1780, + 1778 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 69, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L69" + } + ] + }, + { + "id": 1782, + "name": "ActorEnvVars", + "module": "apify_shared.consts", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Environment variables with ACTOR_ prefix set by the Apify platform.\n\nThese variables provide essential context about the current Actor run,\nincluding identifiers, resource limits, and configuration details.\nAll variables are automatically set by the platform during Actor execution." + } + ] + }, + "children": [ + { + "id": 1783, + "name": "BUILD_ID", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Unique identifier of the Actor build used for this run." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR_BUILD_ID'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 97, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L97" + } + ] + }, + { + "id": 1784, + "name": "BUILD_NUMBER", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sequential build number of the Actor build used for this run." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR_BUILD_NUMBER'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 100, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L100" + } + ] + }, + { + "id": 1785, + "name": "BUILD_TAGS", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated list of tags associated with the Actor build." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR_BUILD_TAGS'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 103, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L103" + } + ] + }, + { + "id": 1786, + "name": "DEFAULT_DATASET_ID", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Unique identifier of the default dataset for storing Actor results." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR_DEFAULT_DATASET_ID'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 106, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L106" + } + ] + }, + { + "id": 1787, + "name": "DEFAULT_KEY_VALUE_STORE_ID", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Unique identifier of the default key-value store for Actor data." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR_DEFAULT_KEY_VALUE_STORE_ID'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 109, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L109" + } + ] + }, + { + "id": 1788, + "name": "DEFAULT_REQUEST_QUEUE_ID", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Unique identifier of the default request queue for Actor URLs." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR_DEFAULT_REQUEST_QUEUE_ID'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 112, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L112" + } + ] + }, + { + "id": 1789, + "name": "EVENTS_WEBSOCKET_URL", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "WebSocket URL for receiving real-time events from the platform." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR_EVENTS_WEBSOCKET_URL'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 115, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L115" + } + ] + }, + { + "id": 1790, + "name": "FULL_NAME", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Full Actor name in format 'username/actor-name' for identification." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR_FULL_NAME'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 118, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L118" + } + ] + }, + { + "id": 1791, + "name": "ID", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Unique identifier of the Actor definition." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR_ID'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 121, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L121" + } + ] + }, + { + "id": 1792, + "name": "INPUT_KEY", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Key in the default key-value store where Actor input is stored (usually 'INPUT')." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR_INPUT_KEY'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 124, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L124" + } + ] + }, + { + "id": 1793, + "name": "MAX_PAID_DATASET_ITEMS", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of dataset items that will be charged for pay-per-result Actors." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR_MAX_PAID_DATASET_ITEMS'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 127, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L127" + } + ] + }, + { + "id": 1794, + "name": "MAX_TOTAL_CHARGE_USD", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum total charge limit in USD for pay-per-event Actors." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR_MAX_TOTAL_CHARGE_USD'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 130, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L130" + } + ] + }, + { + "id": 1795, + "name": "MEMORY_MBYTES", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Amount of memory allocated to the Actor run in megabytes." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR_MEMORY_MBYTES'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 133, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L133" + } + ] + }, + { + "id": 1796, + "name": "PERMISSION_LEVEL", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Permission level of the Actor." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR_PERMISSION_LEVEL'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 136, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L136" + } + ] + }, + { + "id": 1797, + "name": "RUN_ID", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Unique identifier of this specific Actor run execution." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR_RUN_ID'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 139, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L139" + } + ] + }, + { + "id": 1798, + "name": "STANDBY_PORT", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "TCP port number for Actor standby mode HTTP server." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR_STANDBY_PORT'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 142, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L142" + } + ] + }, + { + "id": 1799, + "name": "STANDBY_URL", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public URL for accessing the Actor in standby mode." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR_STANDBY_URL'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 145, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L145" + } + ] + }, + { + "id": 1800, + "name": "STARTED_AT", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "ISO 8601 timestamp when the Actor run was started (UTC timezone)." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR_STARTED_AT'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 148, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L148" + } + ] + }, + { + "id": 1801, + "name": "TASK_ID", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Unique identifier of the Actor task (empty if run directly via API)." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR_TASK_ID'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 151, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L151" + } + ] + }, + { + "id": 1802, + "name": "TIMEOUT_AT", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "ISO 8601 timestamp when the Actor run will timeout (UTC timezone)." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR_TIMEOUT_AT'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 154, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L154" + } + ] + }, + { + "id": 1803, + "name": "WEB_SERVER_PORT", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "TCP port number for the Actor's built-in HTTP web server." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR_WEB_SERVER_PORT'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 157, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L157" + } + ] + }, + { + "id": 1804, + "name": "WEB_SERVER_URL", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public URL for accessing the Actor's built-in HTTP web server." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR_WEB_SERVER_URL'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 160, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L160" + } + ] + } + ], + "groups": [ + { + "title": "Enumeration Members", + "children": [ + 1783, + 1784, + 1785, + 1786, + 1787, + 1788, + 1789, + 1790, + 1791, + 1792, + 1793, + 1794, + 1795, + 1796, + 1797, + 1798, + 1799, + 1800, + 1801, + 1802, + 1803, + 1804 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 89, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L89" + } + ] + }, + { + "id": 1805, + "name": "ApifyEnvVars", + "module": "apify_shared.consts", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Environment variables with APIFY_ prefix set by the Apify platform.\n\nThese variables provide configuration, authentication, and platform-specific\nsettings for Actors running on the Apify platform. They control behavior\nlike logging, proxy settings, browser configuration, and platform integration." + } + ] + }, + "children": [ + { + "id": 1806, + "name": "API_BASE_URL", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Base URL of the Apify API (typically 'https://api.apify.com')." + } + ] + }, + "type": { + "type": "literal", + "value": "'APIFY_API_BASE_URL'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 172, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L172" + } + ] + }, + { + "id": 1807, + "name": "API_PUBLIC_BASE_URL", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public URL of the Apify API accessible from external networks." + } + ] + }, + "type": { + "type": "literal", + "value": "'APIFY_API_PUBLIC_BASE_URL'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 175, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L175" + } + ] + }, + { + "id": 1808, + "name": "DEDICATED_CPUS", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Number of dedicated CPU cores allocated to the Actor based on memory allocation." + } + ] + }, + "type": { + "type": "literal", + "value": "'APIFY_DEDICATED_CPUS'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 178, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L178" + } + ] + }, + { + "id": 1809, + "name": "DEFAULT_BROWSER_PATH", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "File system path to the default browser executable for web scraping." + } + ] + }, + "type": { + "type": "literal", + "value": "'APIFY_DEFAULT_BROWSER_PATH'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 181, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L181" + } + ] + }, + { + "id": 1810, + "name": "DISABLE_BROWSER_SANDBOX", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set to '1' to disable browser sandbox mode for compatibility with containerized environments." + } + ] + }, + "type": { + "type": "literal", + "value": "'APIFY_DISABLE_BROWSER_SANDBOX'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 184, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L184" + } + ] + }, + { + "id": 1811, + "name": "DISABLE_OUTDATED_WARNING", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set to '1' to suppress warnings about outdated SDK versions." + } + ] + }, + "type": { + "type": "literal", + "value": "'APIFY_DISABLE_OUTDATED_WARNING'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 187, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L187" + } + ] + }, + { + "id": 1812, + "name": "FACT", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Fun fact about the Apify platform displayed during Actor startup." + } + ] + }, + "type": { + "type": "literal", + "value": "'APIFY_FACT'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 190, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L190" + } + ] + }, + { + "id": 1813, + "name": "HEADLESS", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set to '1' to run browsers in headless mode without graphical interface." + } + ] + }, + "type": { + "type": "literal", + "value": "'APIFY_HEADLESS'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 193, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L193" + } + ] + }, + { + "id": 1814, + "name": "INPUT_SECRETS_PRIVATE_KEY_FILE", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Path to the private key file used for decrypting secret input values." + } + ] + }, + "type": { + "type": "literal", + "value": "'APIFY_INPUT_SECRETS_PRIVATE_KEY_FILE'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 196, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L196" + } + ] + }, + { + "id": 1815, + "name": "INPUT_SECRETS_PRIVATE_KEY_PASSPHRASE", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Passphrase for unlocking the private key file used for secret decryption." + } + ] + }, + "type": { + "type": "literal", + "value": "'APIFY_INPUT_SECRETS_PRIVATE_KEY_PASSPHRASE'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 199, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L199" + } + ] + }, + { + "id": 1816, + "name": "IS_AT_HOME", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set to '1' when the Actor is running on official Apify platform infrastructure." + } + ] + }, + "type": { + "type": "literal", + "value": "'APIFY_IS_AT_HOME'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 202, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L202" + } + ] + }, + { + "id": 1817, + "name": "LOCAL_STORAGE_DIR", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Local file system directory path where Actor data and storage is persisted." + } + ] + }, + "type": { + "type": "literal", + "value": "'APIFY_LOCAL_STORAGE_DIR'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 205, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L205" + } + ] + }, + { + "id": 1818, + "name": "LOG_FORMAT", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Logging output format: 'pretty' for human-readable, 'json' for structured logs." + } + ] + }, + "type": { + "type": "literal", + "value": "'APIFY_LOG_FORMAT'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 208, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L208" + } + ] + }, + { + "id": 1819, + "name": "LOG_LEVEL", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Minimum logging level: 'DEBUG', 'INFO', 'WARNING', 'ERROR' in ascending order." + } + ] + }, + "type": { + "type": "literal", + "value": "'APIFY_LOG_LEVEL'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 211, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L211" + } + ] + }, + { + "id": 1820, + "name": "MAX_USED_CPU_RATIO", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum CPU utilization ratio (0.0-1.0) that the Actor should not exceed." + } + ] + }, + "type": { + "type": "literal", + "value": "'APIFY_MAX_USED_CPU_RATIO'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 214, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L214" + } + ] + }, + { + "id": 1821, + "name": "META_ORIGIN", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "How the Actor run was initiated: 'WEB', 'API', 'SCHEDULER', 'TEST', etc." + } + ] + }, + "type": { + "type": "literal", + "value": "'APIFY_META_ORIGIN'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 217, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L217" + } + ] + }, + { + "id": 1822, + "name": "METAMORPH_AFTER_SLEEP_MILLIS", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Milliseconds to wait before Actor metamorphosis (transformation) occurs." + } + ] + }, + "type": { + "type": "literal", + "value": "'APIFY_METAMORPH_AFTER_SLEEP_MILLIS'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 220, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L220" + } + ] + }, + { + "id": 1823, + "name": "PERSIST_STATE_INTERVAL_MILLIS", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Interval in milliseconds for automatic state persistence (default: 60000ms)." + } + ] + }, + "type": { + "type": "literal", + "value": "'APIFY_PERSIST_STATE_INTERVAL_MILLIS'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 223, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L223" + } + ] + }, + { + "id": 1824, + "name": "PERSIST_STORAGE", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set to '1' to persist Actor storage data after run completion." + } + ] + }, + "type": { + "type": "literal", + "value": "'APIFY_PERSIST_STORAGE'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 226, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L226" + } + ] + }, + { + "id": 1825, + "name": "PROXY_HOSTNAME", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Hostname for Apify Proxy service (typically 'proxy.apify.com')." + } + ] + }, + "type": { + "type": "literal", + "value": "'APIFY_PROXY_HOSTNAME'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 229, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L229" + } + ] + }, + { + "id": 1826, + "name": "PROXY_PASSWORD", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Authentication password for accessing Apify Proxy services." + } + ] + }, + "type": { + "type": "literal", + "value": "'APIFY_PROXY_PASSWORD'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 232, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L232" + } + ] + }, + { + "id": 1827, + "name": "PROXY_PORT", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "TCP port number for connecting to Apify Proxy (typically 8000)." + } + ] + }, + "type": { + "type": "literal", + "value": "'APIFY_PROXY_PORT'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 235, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L235" + } + ] + }, + { + "id": 1828, + "name": "PROXY_STATUS_URL", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "URL endpoint for retrieving Apify Proxy status and connection information." + } + ] + }, + "type": { + "type": "literal", + "value": "'APIFY_PROXY_STATUS_URL'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 238, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L238" + } + ] + }, + { + "id": 1829, + "name": "PURGE_ON_START", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set to '1' to clear all local storage before Actor execution begins." + } + ] + }, + "type": { + "type": "literal", + "value": "'APIFY_PURGE_ON_START'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 241, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L241" + } + ] + }, + { + "id": 1830, + "name": "SDK_LATEST_VERSION", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Latest available version of the Apify SDK for update notifications." + } + ] + }, + "type": { + "type": "literal", + "value": "'APIFY_SDK_LATEST_VERSION'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 244, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L244" + } + ] + }, + { + "id": 1831, + "name": "SYSTEM_INFO_INTERVAL_MILLIS", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Interval in milliseconds for sending system resource usage information." + } + ] + }, + "type": { + "type": "literal", + "value": "'APIFY_SYSTEM_INFO_INTERVAL_MILLIS'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 247, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L247" + } + ] + }, + { + "id": 1832, + "name": "TOKEN", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "API authentication token of the user who initiated the Actor run." + } + ] + }, + "type": { + "type": "literal", + "value": "'APIFY_TOKEN'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 250, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L250" + } + ] + }, + { + "id": 1833, + "name": "USER_ID", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Unique identifier of the user who started the Actor (may differ from Actor owner)." + } + ] + }, + "type": { + "type": "literal", + "value": "'APIFY_USER_ID'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 253, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L253" + } + ] + }, + { + "id": 1834, + "name": "USER_IS_PAYING", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set to '1' if the user who started the Actor has an active paid subscription." + } + ] + }, + "type": { + "type": "literal", + "value": "'APIFY_USER_IS_PAYING'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 256, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L256" + } + ] + }, + { + "id": 1835, + "name": "WORKFLOW_KEY", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Unique identifier for grouping related Actor runs and API operations together." + } + ] + }, + "type": { + "type": "literal", + "value": "'APIFY_WORKFLOW_KEY'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 259, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L259" + } + ] + } + ], + "groups": [ + { + "title": "Enumeration Members", + "children": [ + 1806, + 1807, + 1808, + 1809, + 1810, + 1811, + 1812, + 1813, + 1814, + 1815, + 1816, + 1817, + 1818, + 1819, + 1820, + 1821, + 1822, + 1823, + 1824, + 1825, + 1826, + 1827, + 1828, + 1829, + 1830, + 1831, + 1832, + 1833, + 1834, + 1835 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 164, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L164" + } + ] + }, + { + "id": 1836, + "name": "ActorExitCodes", + "module": "apify_shared.consts", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Standard exit codes used by Actors to indicate run completion status.\n\nThese codes follow Unix conventions where 0 indicates success\nand non-zero values indicate various types of failures." + } + ] + }, + "children": [ + { + "id": 1837, + "name": "SUCCESS", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor completed successfully without any errors." + } + ] + }, + "type": { + "type": "literal", + "value": "0" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 270, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L270" + } + ] + }, + { + "id": 1838, + "name": "ERROR_USER_FUNCTION_THREW", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor failed because the main function threw an unhandled exception." + } + ] + }, + "type": { + "type": "literal", + "value": "91" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 273, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L273" + } + ] + } + ], + "groups": [ + { + "title": "Errors", + "children": [ + 1838 + ] + }, + { + "title": "Enumeration Members", + "children": [ + 1837 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 263, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L263" + } + ] + }, + { + "id": 1839, + "name": "WebhookEventType", + "module": "apify_shared.consts", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Event types that can trigger webhook notifications.\n\nThese events are sent to configured webhook URLs when specific\nActor run or build lifecycle events occur, enabling integration\nwith external systems and automated workflows." + } + ] + }, + "children": [ + { + "id": 1840, + "name": "ACTOR_RUN_CREATED", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Triggered when a new Actor run is created and initialized." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR.RUN.CREATED'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 285, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L285" + } + ] + }, + { + "id": 1841, + "name": "ACTOR_RUN_SUCCEEDED", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Triggered when an Actor run completes successfully." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR.RUN.SUCCEEDED'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 288, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L288" + } + ] + }, + { + "id": 1842, + "name": "ACTOR_RUN_FAILED", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Triggered when an Actor run fails due to an error." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR.RUN.FAILED'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 291, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L291" + } + ] + }, + { + "id": 1843, + "name": "ACTOR_RUN_TIMED_OUT", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Triggered when an Actor run is terminated due to timeout." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR.RUN.TIMED_OUT'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 294, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L294" + } + ] + }, + { + "id": 1844, + "name": "ACTOR_RUN_ABORTED", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Triggered when an Actor run is manually aborted by user." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR.RUN.ABORTED'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 297, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L297" + } + ] + }, + { + "id": 1845, + "name": "ACTOR_RUN_RESURRECTED", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Triggered when a previously failed Actor run is automatically resurrected." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR.RUN.RESURRECTED'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 300, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L300" + } + ] + }, + { + "id": 1846, + "name": "ACTOR_BUILD_CREATED", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Triggered when a new Actor build process is initiated." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR.BUILD.CREATED'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 303, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L303" + } + ] + }, + { + "id": 1847, + "name": "ACTOR_BUILD_SUCCEEDED", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Triggered when an Actor build completes successfully." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR.BUILD.SUCCEEDED'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 306, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L306" + } + ] + }, + { + "id": 1848, + "name": "ACTOR_BUILD_FAILED", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Triggered when an Actor build fails due to compilation or setup errors." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR.BUILD.FAILED'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 309, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L309" + } + ] + }, + { + "id": 1849, + "name": "ACTOR_BUILD_TIMED_OUT", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Triggered when an Actor build process exceeds the time limit." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR.BUILD.TIMED_OUT'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 312, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L312" + } + ] + }, + { + "id": 1850, + "name": "ACTOR_BUILD_ABORTED", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Triggered when an Actor build is manually cancelled by user." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR.BUILD.ABORTED'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 315, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L315" + } + ] + } + ], + "groups": [ + { + "title": "Enumeration Members", + "children": [ + 1850, + 1846, + 1848, + 1847, + 1849, + 1844, + 1840, + 1842, + 1845, + 1841, + 1843 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 277, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L277" + } + ] + }, + { + "id": 1851, + "name": "MetaOrigin", + "module": "apify_shared.consts", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Origins indicating how Actor runs were initiated.\n\nThis information helps track and analyze how Actors are being used\nacross different interfaces and automation systems on the platform." + } + ] + }, + "children": [ + { + "id": 1852, + "name": "DEVELOPMENT", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor run started from the Developer Console source code section." + } + ] + }, + "type": { + "type": "literal", + "value": "'DEVELOPMENT'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 326, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L326" + } + ] + }, + { + "id": 1853, + "name": "WEB", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor run initiated through the Apify Console web interface." + } + ] + }, + "type": { + "type": "literal", + "value": "'WEB'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 329, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L329" + } + ] + }, + { + "id": 1854, + "name": "API", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor run started programmatically via the Apify API." + } + ] + }, + "type": { + "type": "literal", + "value": "'API'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 332, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L332" + } + ] + }, + { + "id": 1855, + "name": "SCHEDULER", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor run triggered automatically by a scheduled task." + } + ] + }, + "type": { + "type": "literal", + "value": "'SCHEDULER'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 335, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L335" + } + ] + }, + { + "id": 1856, + "name": "TEST", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor run initiated from the test/try functionality in Console." + } + ] + }, + "type": { + "type": "literal", + "value": "'TEST'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 338, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L338" + } + ] + }, + { + "id": 1857, + "name": "WEBHOOK", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor run triggered by an incoming webhook request." + } + ] + }, + "type": { + "type": "literal", + "value": "'WEBHOOK'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 341, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L341" + } + ] + }, + { + "id": 1858, + "name": "ACTOR", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor run started by another Actor during its execution." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 344, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L344" + } + ] + }, + { + "id": 1859, + "name": "STANDBY", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor run initiated through the Actor Standby mode." + } + ] + }, + "type": { + "type": "literal", + "value": "'STANDBY'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 347, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L347" + } + ] + }, + { + "id": 1860, + "name": "CLI", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor run started using the Apify command-line interface." + } + ] + }, + "type": { + "type": "literal", + "value": "'CLI'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 350, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L350" + } + ] + } + ], + "groups": [ + { + "title": "Enumeration Members", + "children": [ + 1858, + 1854, + 1860, + 1852, + 1855, + 1859, + 1856, + 1853, + 1857 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 319, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L319" + } + ] + }, + { + "id": 1861, + "name": "StorageGeneralAccess", + "module": "apify_shared.consts", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Storage setting determining how others can access the storage.\n\nThis setting overrides the user setting of the storage owner." + } + ] + }, + "children": [ + { + "id": 1862, + "name": "FOLLOW_USER_SETTING", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Respect the user setting of the storage owner (default behavior)." + } + ] + }, + "type": { + "type": "literal", + "value": "'FOLLOW_USER_SETTING'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 360, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L360" + } + ] + }, + { + "id": 1863, + "name": "RESTRICTED", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Only signed-in users with explicit access can read this storage." + } + ] + }, + "type": { + "type": "literal", + "value": "'RESTRICTED'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 363, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L363" + } + ] + }, + { + "id": 1864, + "name": "ANYONE_WITH_ID_CAN_READ", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Anyone with a link or the unique storage ID can read this storage." + } + ] + }, + "type": { + "type": "literal", + "value": "'ANYONE_WITH_ID_CAN_READ'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 366, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L366" + } + ] + }, + { + "id": 1865, + "name": "ANYONE_WITH_NAME_CAN_READ", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Anyone with a link, ID, or storage name can read this storage." + } + ] + }, + "type": { + "type": "literal", + "value": "'ANYONE_WITH_NAME_CAN_READ'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 369, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L369" + } + ] + } + ], + "groups": [ + { + "title": "Enumeration Members", + "children": [ + 1864, + 1865, + 1862, + 1863 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 354, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L354" + } + ] + }, + { + "id": 1866, + "name": "RunGeneralAccess", + "module": "apify_shared.consts", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Run setting determining how others can access the run.\n\nThis setting overrides the user setting of the run owner." + } + ] + }, + "children": [ + { + "id": 1867, + "name": "FOLLOW_USER_SETTING", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Respect the user setting of the storage owner (default behavior)." + } + ] + }, + "type": { + "type": "literal", + "value": "'FOLLOW_USER_SETTING'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 379, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L379" + } + ] + }, + { + "id": 1868, + "name": "RESTRICTED", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Only signed-in users with explicit access can read this run." + } + ] + }, + "type": { + "type": "literal", + "value": "'RESTRICTED'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 382, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L382" + } + ] + }, + { + "id": 1869, + "name": "ANYONE_WITH_ID_CAN_READ", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Anyone with a link or the unique run ID can read this run." + } + ] + }, + "type": { + "type": "literal", + "value": "'ANYONE_WITH_ID_CAN_READ'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 385, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L385" + } + ] + } + ], + "groups": [ + { + "title": "Enumeration Members", + "children": [ + 1869, + 1867, + 1868 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 373, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L373" + } + ] + }, + { + "id": 1870, + "name": "ActorPermissionLevel", + "module": "apify_shared.consts", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Determines permissions that the Actor is granted when running.\n\nBased on this value, the Apify platform generates a scoped run token with a corresponding permission scope and\ninjects it into the Actor runtime.\n\nWarning: Make sure you know what you are doing when changing this value!" + } + ] + }, + "children": [ + { + "id": 1871, + "name": "FULL_PERMISSIONS", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Full permission Actors have access to all user data in the account." + } + ] + }, + "type": { + "type": "literal", + "value": "'FULL_PERMISSIONS'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 398, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L398" + } + ] + }, + { + "id": 1872, + "name": "LIMITED_PERMISSIONS", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limited permission Actors have access only to specific resources:\n - default storages\n - storages provided via input\n - the current run\n - ...\n\nBroadly speaking, limited permission Actors cannot access any account data not related to the current run.\nFor details refer to the Apify documentation." + } + ] + }, + "type": { + "type": "literal", + "value": "'LIMITED_PERMISSIONS'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 401, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L401" + } + ] + } + ], + "groups": [ + { + "title": "Enumeration Members", + "children": [ + 1871, + 1872 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 389, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L389" + } + ] + } + ], + "groups": [ + { + "title": "Main Clients", + "children": [ + 1551, + 1620 + ] + }, + { + "title": "Resource Clients", + "children": [ + 1337, + 1242, + 1222, + 1201, + 1549, + 1161, + 1133, + 1531, + 1105, + 1093, + 892, + 870, + 772, + 750, + 662, + 542, + 521, + 1529, + 1527, + 415, + 397, + 363, + 331, + 311, + 205, + 145, + 123, + 81, + 30, + 24, + 12 + ] + }, + { + "title": "Async Resource Clients", + "children": [ + 1427, + 1275, + 1232, + 1209, + 1550, + 1181, + 1147, + 1540, + 1119, + 1099, + 1002, + 881, + 821, + 761, + 672, + 602, + 531, + 1530, + 1528, + 468, + 406, + 380, + 347, + 716, + 321, + 699, + 258, + 167, + 134, + 102, + 49, + 27, + 18 + ] + }, + { + "title": "Helper Classes", + "children": [ + 541, + 1517, + 1725, + 1745, + 1735, + 711, + 733, + 682, + 687 + ] + }, + { + "title": "Errors", + "children": [ + 2, + 1, + 8, + 1721 + ] + }, + { + "title": "Methods", + "children": [ + 1752, + 1742, + 1756, + 1749, + 1718, + 1689, + 1692, + 1217, + 1308, + 189, + 68, + 1700, + 1706, + 1703, + 1709, + 1712, + 1715, + 1696 + ] + }, + { + "title": "Properties", + "children": [ + 1724 + ] + }, + { + "title": "Constants", + "children": [ + 1782, + 1777, + 1836, + 1762, + 1870, + 1772, + 1805, + 1851, + 1866, + 1861, + 1839 + ] + } + ], + "sources": [ + { + "fileName": "src/index.ts", + "line": 1, + "character": 0, + "url": "http://example.com/blob/123456/src/dummy.py" + } + ] +} \ No newline at end of file diff --git a/website/versioned_sidebars/version-2.5-sidebars.json b/website/versioned_sidebars/version-2.5-sidebars.json new file mode 100644 index 00000000..194b6082 --- /dev/null +++ b/website/versioned_sidebars/version-2.5-sidebars.json @@ -0,0 +1,49 @@ +{ + "sidebar": [ + { + "type": "doc", + "id": "introduction/introduction" + }, + { + "type": "doc", + "id": "introduction/quick-start" + }, + { + "type": "category", + "label": "Concepts", + "collapsed": true, + "items": [ + { + "type": "autogenerated", + "dirName": "02_concepts" + } + ] + }, + { + "type": "category", + "label": "Guides", + "collapsed": true, + "items": [ + { + "type": "autogenerated", + "dirName": "03_guides" + } + ] + }, + { + "type": "category", + "label": "Upgrading", + "collapsed": true, + "items": [ + { + "type": "autogenerated", + "dirName": "04_upgrading" + } + ] + }, + { + "type": "doc", + "id": "changelog" + } + ] +} diff --git a/website/versions.json b/website/versions.json new file mode 100644 index 00000000..695e00a6 --- /dev/null +++ b/website/versions.json @@ -0,0 +1 @@ +["2.5"]