Manifest StructureΒΆ
A Manifest structure is returned from createManifest()
, getManifest()
and getManifests()
.
- errorMessage
- If unsuccessful, this contains a description of the error that occurred. See
status
. - manifestId
- A manifest ID. Manifest IDs are returned from
createManifest()
, and used in other methods to refer to a specific manifest. - owner
- The owner of this manifest. A manifest may be monitored or modified only by its owner, or by a superuser.
- ownerToken
- The owner of this manifest, if this manifest was created by a token. A manifest is only visible to its token, owner, or a superuser.
- ownerTokenSession
- The token session of this token that created this manifest.
- processing
- If
True
, the JetStream server is still processing this item. Use thegetManifest()
orwaitForManifest()
method to monitor its progress. - status
The status may be one of the following values:
- complete
- The manifest is complete, and eligible for use with
createTransfer()
. - error
- The creation of the manifest failed. The reason for the failure is written to the
errorMessage
field. - pending
- The manifest is still being processed by the server, and is not yet eligible for use with
createTransfer()
.
- totalFiles
- The total number of files in a manifest.
- totalSize
- The total size, in bytes, of a manifest.
- userData
- Key-value map of user attached metadata. Use
updateObjectUserData()
anddeleteObjectUserData()
to manipulate object user data.
Changed in version 2.4.0: Added ownerToken, ownerTokenSession keys.