ObjectStoreApi | @here/olp-sdk-ts
Namespace ObjectStoreApi
Index
Interfaces
Functions
Functions
cancel
Parameters
builder: RequestBuilder
params: { layerId: string; multipartToken: string }
layer
Id: string multipart
Token: string
Returns Promise<Response>
check
Checks if a blob exists for the requested key.
Parameters
builder: RequestBuilder
params: { key: string; layerId: string }
key: string
layer
Id: string
Returns Promise<Response>
complete
Call this API when all parts have been uploaded.
Parameters
builder: RequestBuilder
params: { body?: ObjectStoreApi.MultipartCompleteRequest; layerId: string; multipartToken: string }
Optional body?: ObjectStoreApi.MultipartCompleteRequest
layer
Id: string multipart
Token: string
Returns Promise<Response>
delete
Deletes a data blob.
Parameters
builder: RequestBuilder
params: { key: string; layerId: string }
key: string
layer
Id: string
Returns Promise<Response>
get
Retrieves a blob from storage.
Parameters
builder: RequestBuilder
params: { key: string; layerId: string; range?: string }
key: string
layer
Id: string Optional range?: string
Returns Promise<Response>
get
Gets the status of a multipart upload. The status can be received only when the upload has been completed.
Parameters
builder: RequestBuilder
params: { layerId: string; multipartToken: string }
layer
Id: string multipart
Token: string
Returns Promise<MultipartKeyUploadStatus>
list
List virtual directory-like structure created from keys in the storage where '/' is used as a separator.
Parameters
builder: RequestBuilder
params: { deep?: "true" | "false"; layerId: string; limit?: number; pageToken?: string; parent?: string }
Optional deep?: "true" | "false"
layer
Id: string Optional limit?: number
Optional page
Token?: string Optional parent?: string
Returns Promise<KeysListResponseObj>
put
Persists the data blob up to 192 MB. When the operation completes successfully, there is no guarantee that the data blob will be immediately available, although in most cases, it will be. To check if the data blob is available, use the ´HEAD´ method. The maximum key length is 450 characters.
Parameters
builder: RequestBuilder
params: { body?: string; contentLength: number; key: string; layerId: string; source?: string }
Optional body?: string
content
Length: number key: string
layer
Id: string Optional source?: string
Returns Promise<Response>
start
Publishes large data blobs where the data payload needs to be split into multiple parts. The multipart upload start is to be followed by the individual parts upload and completed with a call to complete the upload. The limit of the blob uploaded this way is 50GB. Max key length is 450 characters.
Parameters
builder: RequestBuilder
params: { body: MultipartUploadByKeyMetadata; key: string; layerId: string }
body: MultipartUploadByKeyMetadata
key: string
layer
Id: string
Returns Promise<MultipartInitResponse>
upload
Upload or copy a single part of a multipart upload or multipart copy for the blob. Every part except the last one must have a minimum 5 MB of data and maximum of 96 MB. The length of every part except the last one must be multiple of 1MB (1024KB). The maximum number of parts is 10,000.
Parameters
builder: RequestBuilder
params: { body: string | ArrayBuffer | SharedArrayBuffer; contentLength?: number; contentType?: string; layerId: string; multipartToken: string; partNumber: number; range?: string; source?: string }
body: string | ArrayBuffer | SharedArrayBuffer
Optional content
Length?: number Optional content
Type?: string layer
Id: string multipart
Token: string part
Number: number Optional range?: string
Optional source?: string
Returns Promise<PartId>
Generated using TypeDoc
Cancels an entire multipart upload operation. You can only cancel a multipart upload before it has been completed.
Cancels a multipart upload.