UploadOptions | @here/olp-sdk-ts
Interface UploadOptions
Hierarchy
- UploadOptions
Index
Properties
Optional billing
An optional free-form tag used for grouping billing records together.
blob
The version of the blob storage.
Supports Blob API v1 and v2.
catalog
The HRN string of the catalog to upload.
Optional chunk
The size of each chunk.
The minimum size is 5 MB, maximum – 5 GB. The default value is 5 MB. When an out-of-range value is provided, it is trimmed to the default value of 5 MB.
Optional content
The content encoding of the object being uploaded.
Must be equal to the layer content encoding.
content
The content type of the object being uploaded.
Must be equal to the layer content type.
handle
The data key to use for uploading.
If you use Blob API v1, the key is the data handle.
layer
The ID of the layer to upload.
Optional parallel
Specifies how many parallel requests should be used for uploading chunks.
Default value: 6.
Methods
Optional on
Callback, triggered on multipart upload process starts.
Parameters
status: StartUploadStatus
Returns void
Optional on
Callback, triggered on each successfully uploaded chunk of data.
Parameters
status: UploadStatus
Returns void
Generated using TypeDoc
The options for uploading.