.. _auto_cloud_remote_fetch:

*CLOUD — FETCH REMOTE FILE (DEPRECATED; USE {ONEDRIVE,DROPBOX,SHAREPOINT}_REMOTE_FETCH)*
========================================================================================

DEPRECATED — use onedrive_remote_fetch, dropbox_remote_fetch, or sharepoint_remote_fetch instead. Parametric worker kept for one release as a migration buffer. Pulls a file from the connected cloud-storage provider using the calling user's stored OAuth token and stages it on the d3VIEW server.

When to use
-----------

Tagged: ``cloud``, ``storage``, ``onedrive``, ``dropbox``, ``sharepoint``, ``oauth``, ``download``, ``fetch``.

Inputs
------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20 20 20

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Provider
     - provider
     - string
     - —
     - ✓
     - Provider key: onedrive, dropbox, or sharepoint. Must match a row in cloud_storage_providers.
   * - File ID
     - file_id
     - string
     - —
     - ✓
     - Provider-specific file identifier. For OneDrive: Graph item id. For Dropbox: path or id:... Dropbox token. For SharePoint: item:<driveId>:<itemId>.
   * - Target name
     - target_name
     - string
     - —
     - 
     - Optional filename for the staged copy. Defaults to a synthesised name based on job id.

Outputs
-------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20

   * - Label
     - ID
     - Type
     - Description
   * - Status
     - status
     - string
     - ok on success, or Error: <message> on failure.
   * - Target path
     - target_path
     - string
     - Absolute server path of the staged file (under d3VIEW tmp dir, scoped per user).
   * - File name
     - file_name
     - string
     - Sanitised filename used on disk.
   * - Job ID
     - job_id
     - string
     - Token used to address the saved file via /api/cloud/get_blob.
   * - Bytes read
     - bytes
     - integer
     - Bytes successfully downloaded from the provider.
   * - Total bytes
     - total_bytes
     - integer
     - Total file size in bytes (when reported by the provider; 0 if unknown).
   * - Provider
     - provider
     - string
     - Echo of the provider input.

Disciplines
-----------

- data.io.file
- platform.integration

.. raw:: html

   <hr style="margin-top:2em">
   <p style="font-size:11px;color:#888">
   Auto-generated from <code>platform</code> schema. Worker id: <code>cloud_remote_fetch</code>. Schema hash: <code>44ce8e87186e</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>