Back to Prefect

collections

docs/v3/api-ref/python/prefect-client-collections.mdx

3.6.30.dev31.1 KB
Original Source

prefect.client.collections

Functions

get_collections_metadata_client <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/collections.py#L17" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
get_collections_metadata_client(httpx_settings: Optional[Dict[str, Any]] = None) -> 'CollectionsMetadataClient'

Creates a client that can be used to fetch metadata for Prefect collections.

Will return a CloudClient if profile is set to connect to Prefect Cloud, otherwise will return an OrchestrationClient.

Classes

CollectionsMetadataClient <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/collections.py#L9" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

Methods:

read_worker_metadata <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/collections.py#L10" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
read_worker_metadata(self) -> Dict[str, Any]