Interface ObjectStorageClient

Client to store and retrieve Objects

interface ObjectStorageClient {
    delete(
        objectMeta: ObjectStorageObjectMeta,
        options?: ObjectStorageOptions,
    ): Promise<void>;
    destroy(): void;
    getBlob(
        objectMeta: ObjectStorageObjectMeta,
        options?: ObjectStorageGetBlobOptions,
    ): Promise<Blob>;
    getBlob(
        objectMeta: ({ outputDir?: string } & ObjectStorageObjectMeta)[],
        options?: ObjectStorageGetBlobOptions,
    ): Promise<Blob>;
    getList(options?: ObjectStorageOptions): Promise<ObjectStorageListResponse>;
    store(
        object: Blob,
        options?: ObjectStorageStoreOptions,
    ): Promise<ObjectStorageResponse>;
    update(
        objectMeta: ObjectStorageObjectMeta,
        options: ObjectStorageStoreOptions,
    ): Promise<void>;
}

Index

Methods

delete destroy getBlob getList store update

Methods

delete

delete(
objectMeta: ObjectStorageObjectMeta,
options?: ObjectStorageOptions,
): Promise<void>
Delete an object
Parameters
- objectMeta: ObjectStorageObjectMeta
  Object meta information
- Optionaloptions: ObjectStorageOptions
  Request options
Returns Promise<void>

destroy

destroy(): void
Destroy the client. Always call this when the client is not used anymore. When the context is destroyed, this is called automatically

Returns void

getBlob

getBlob(
objectMeta: ObjectStorageObjectMeta,
options?: ObjectStorageGetBlobOptions,
): Promise<Blob>
Get an Object
Parameters
- objectMeta: ObjectStorageObjectMeta
  Object meta information
- Optionaloptions: ObjectStorageGetBlobOptions
  Request options
Returns Promise<Blob>
getBlob(
objectMeta: ({ outputDir?: string } & ObjectStorageObjectMeta)[],
options?: ObjectStorageGetBlobOptions,
): Promise<Blob>
Get a ZIP file with multiple objects
Parameters
- objectMeta: ({ outputDir?: string } & ObjectStorageObjectMeta)[]
  An array of object metadata, where each object can optionally specify an outputDir within the ZIP.
- Optionaloptions: ObjectStorageGetBlobOptions
  Request options
Returns Promise<Blob>

getList

getList(options?: ObjectStorageOptions): Promise<ObjectStorageListResponse>
Get a list of object in the store
Parameters
- Optionaloptions: ObjectStorageOptions
  Request options
Returns Promise<ObjectStorageListResponse>

store

store(
object: Blob,
options?: ObjectStorageStoreOptions,
): Promise<ObjectStorageResponse>
Store an object in storage
Parameters
- object: Blob
  The contents of the object to store
- Optionaloptions: ObjectStorageStoreOptions
  Request options
Returns Promise<ObjectStorageResponse>

update

update(
objectMeta: ObjectStorageObjectMeta,
options: ObjectStorageStoreOptions,
): Promise<void>
Update the tags of an object.
Parameters
- objectMeta: ObjectStorageObjectMeta
  Object meta information
- options: ObjectStorageStoreOptions
Returns Promise<void>