Retrieve an extraction pipeline by ID

async AsyncCogniteClient.extraction_pipelines.retrieve(
id: int | None = None,
external_id: str | None = None,
) → ExtractionPipeline | None

Retrieve a single extraction pipeline by id.

Parameters:

  • id (int | None) – ID

  • external_id (str | None) – External ID

Returns:

Requested extraction pipeline or None if it does not exist.

Return type:

ExtractionPipeline | None

Examples

Get extraction pipeline by id:

>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> res = client.extraction_pipelines.retrieve(id=1)

Get extraction pipeline by external id:

>>> res = client.extraction_pipelines.retrieve(external_id="1")