Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions cognite/client/_api/files.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 <cognite.client.AsyncCogniteClient.data_modeling.files.retrieve>` instead.

Examples:

Get file metadata by instance id:
Expand Down Expand Up @@ -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 <cognite.client.AsyncCogniteClient.data_modeling.files.retrieve>` instead.

Examples:

Get file metadatas by instance id:
Expand Down Expand Up @@ -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 <cognite.client.AsyncCogniteClient.data_modeling.files.upload_content>` instead.

Examples:

Upload file content using instance_id:
Expand Down Expand Up @@ -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 <cognite.client.AsyncCogniteClient.data_modeling.files.upload_content_bytes>` instead.

Examples:

Finish a file creation by uploading the content using instance_id:
Expand Down Expand Up @@ -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 <cognite.client.AsyncCogniteClient.data_modeling.files.retrieve_download_urls>` instead.

Examples:

Get download URLs by instance id:
Expand Down
17 changes: 16 additions & 1 deletion cognite/client/_sync_api/files.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading