Downloads a file from H2O Drive to the sandbox filesystem.

Retrieves a file from the remote storage and writes it to the specified path in the sandbox filesystem. The caller must have read permissions for the specified workspace.

Authorization: Only the creator of the parent SandboxEngine is allowed to call this method.

post/v1/{name}/h2oDrive:downloadFile

Request

Base URL
https://docs.h2o.ai (the document declares no server; this is the origin it was published from)
Auth
none declared
TypeScript
https://skmtc.dev/h2o/apis/ai-h2o-engine-sandbox-v1-filesystem-proto/docs/v1/:name/h2oDrive:downloadFile/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

namestring required

Required. The name of the sandbox engine. Format: workspaces/{workspace}/sandboxEngines/{sandbox_engine}

Request body

workspacestring

Optional. The workspace resource name. Format: workspaces/{workspace} If not specified, the default workspace in which the sandbox engine is running will be used.

remotePathstring required

localPathstring required

Required. The absolute path in the sandbox filesystem where the file should be written. Must start with a forward slash (e.g., "/home/sandbox/data/input.csv"). If the file doesn't exist, it will be created with 0644 permissions (rw-r--r--).

createParentDirectoriesboolean

Optional. If true, creates parent directories if they don't exist. If false or unspecified, the operation will fail if parent directories don't exist.

overwriteboolean nullable

Optional. Controls overwrite behavior for existing files. If true or unspecified, overwrites the file if it already exists. If explicitly set to false, the operation will fail if the file exists.

Response

A successful response.

Changes

No recorded changes to this operation across all 1 revision of this API.