diff --git a/cognite/client/_api/files.py b/cognite/client/_api/files.py index 532c8c0242..39cc92fbd9 100644 --- a/cognite/client/_api/files.py +++ b/cognite/client/_api/files.py @@ -270,6 +270,9 @@ async def retrieve( Returns: FileMetadata | None: Requested file metadata or None if it does not exist. + Tip: + If you are working with Data Modeling, consider using :py:meth:`client.data_modeling.files.retrieve ` instead. + Examples: Get file metadata by instance id: @@ -307,6 +310,9 @@ async def retrieve_multiple( Returns: FileMetadataList: The requested file metadatas. + Tip: + If you are working with Data Modeling, consider using :py:meth:`client.data_modeling.files.retrieve ` instead. + Examples: Get file metadatas by instance id: @@ -509,6 +515,9 @@ async def upload_content( Returns: FileMetadata: No description. + Tip: + If you are working with Data Modeling, consider using :py:meth:`client.data_modeling.files.upload_content ` instead. + Examples: Upload file content using instance_id: @@ -750,6 +759,9 @@ async def upload_content_bytes( Returns: FileMetadata: No description. + Tip: + If you are working with Data Modeling, consider using :py:meth:`client.data_modeling.files.upload_content_bytes ` instead. + Examples: Finish a file creation by uploading the content using instance_id: @@ -1178,6 +1190,9 @@ async def retrieve_download_urls( Returns: dict[int, str] | dict[str, str] | dict[NodeId, str] | dict[int | str | NodeId, str]: Dictionary containing download urls. + Tip: + If you are working with Data Modeling, consider using :py:meth:`client.data_modeling.files.retrieve_download_urls ` instead. + Examples: Get download URLs by instance id: diff --git a/cognite/client/_sync_api/files.py b/cognite/client/_sync_api/files.py index a5037bc76b..ede905e59d 100644 --- a/cognite/client/_sync_api/files.py +++ b/cognite/client/_sync_api/files.py @@ -1,6 +1,6 @@ """ =============================================================================== -6cfa53b9447f702dc542f27bb112a22f +df9a1461a02c08513af8aefd928b3e1e This file is auto-generated from the Async API modules, - do not edit manually! =============================================================================== """ @@ -218,6 +218,9 @@ def retrieve( Returns: FileMetadata | None: Requested file metadata or None if it does not exist. + Tip: + If you are working with Data Modeling, consider using :py:meth:`client.data_modeling.files.retrieve ` instead. + Examples: Get file metadata by instance id: @@ -253,6 +256,9 @@ def retrieve_multiple( Returns: FileMetadataList: The requested file metadatas. + Tip: + If you are working with Data Modeling, consider using :py:meth:`client.data_modeling.files.retrieve ` instead. + Examples: Get file metadatas by instance id: @@ -446,6 +452,9 @@ def upload_content( Returns: FileMetadata: No description. + Tip: + If you are working with Data Modeling, consider using :py:meth:`client.data_modeling.files.upload_content ` instead. + Examples: Upload file content using instance_id: @@ -592,6 +601,9 @@ def upload_content_bytes( Returns: FileMetadata: No description. + Tip: + If you are working with Data Modeling, consider using :py:meth:`client.data_modeling.files.upload_content_bytes ` instead. + Examples: Finish a file creation by uploading the content using instance_id: @@ -873,6 +885,9 @@ def retrieve_download_urls( Returns: dict[int, str] | dict[str, str] | dict[NodeId, str] | dict[int | str | NodeId, str]: Dictionary containing download urls. + Tip: + If you are working with Data Modeling, consider using :py:meth:`client.data_modeling.files.retrieve_download_urls ` instead. + Examples: Get download URLs by instance id: