IRPCObjectOperations.KeepUploadSessionAlive

View as Markdown

Vault API / core write session or assertion idempotent

Keeps an upload from being removed for inactivity.

ServiceObjects, versions, properties and files MFiles.IRPCObjectOperations
gRPC method/MFiles.IRPCObjectOperations/KeepUploadSessionAlive
HTTP (mf-http-grpc)POST /grpc/v1/keep-upload-session-alive
RequestKeepUploadSessionAliveRequest
ResponseKeepUploadSessionAliveResponse
Book and levelVault API, core
Kindwrite
SessionRequired: a session (mfiles-session-id-bin metadata) or a session assertion (x-mf-session-assertion metadata).
Idempotentyes
Returns metadata structure versionno
Streamingnone (unary)

Remarks

Supported when ServerVaultCapabilities keep_upload_session_alive_supported is true; otherwise the call fails with "Not implemented.". Call it at the interval given in SessionData.keep_upload_session_alive_interval_in_seconds of the login response while you hold an upload that you have not used yet. A removed or consumed upload gives "Not found. (The specified upload session <id> does not exist.)".

Request: KeepUploadSessionAliveRequest

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

FieldTypeDescription
upload_idint32The upload session ID to keep alive.

Response: KeepUploadSessionAliveResponse

No fields.