Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ObjectStoreApi

Index

Interfaces

Functions

Functions

cancelMultipartUploadByKey

  • cancelMultipartUploadByKey(builder: RequestBuilder, params: { layerId: string; multipartToken: string }): Promise<Response>

  • Cancels an entire multipart upload operation. You can only cancel a multipart upload before it has been completed.

    summary

    Cancels a multipart upload.

    Parameters

    • builder: RequestBuilder
    • params: { layerId: string; multipartToken: string }
      • layerId: string
      • multipartToken: string

    Returns Promise<Response>

checkKeyExists

  • checkKeyExists(builder: RequestBuilder, params: { key: string; layerId: string }): Promise<Response>

completeMultipartUploadByKey

deleteBlobByKey

  • deleteBlobByKey(builder: RequestBuilder, params: { key: string; layerId: string }): Promise<Response>

getBlobByKey

  • getBlobByKey(builder: RequestBuilder, params: { key: string; layerId: string; range?: string }): Promise<Response>

getMultipartUploadStatusByKey

listKeys

  • listKeys(builder: RequestBuilder, params: { deep?: "true" | "false"; layerId: string; limit?: number; pageToken?: string; parent?: string }): Promise<KeysListResponseObj>

  • List virtual directory-like structure created from keys in the storage where '/' is used as a separator.

    summary

    List keys.

    Parameters

    • builder: RequestBuilder
    • params: { deep?: "true" | "false"; layerId: string; limit?: number; pageToken?: string; parent?: string }
      • Optional deep?: "true" | "false"
      • layerId: string
      • Optional limit?: number
      • Optional pageToken?: string
      • Optional parent?: string

    Returns Promise<KeysListResponseObj>

putBlobByKey

  • putBlobByKey(builder: RequestBuilder, params: { body?: string; contentLength: number; key: string; layerId: string; source?: string }): Promise<Response>

  • 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.

    summary

    Publishes a data blob or copies an existing blob.

    Parameters

    • builder: RequestBuilder
    • params: { body?: string; contentLength: number; key: string; layerId: string; source?: string }
      • Optional body?: string
      • contentLength: number
      • key: string
      • layerId: string
      • Optional source?: string

    Returns Promise<Response>

startMultipartUploadByKey

uploadPartByKey

  • uploadPartByKey(builder: RequestBuilder, params: { body: string | ArrayBuffer | SharedArrayBuffer; contentLength?: number; contentType?: string; layerId: string; multipartToken: string; partNumber: number; range?: string; source?: string }): Promise<PartId>

  • 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.

    summary

    Uploads a part or creates a new part from part of an existing blob.

    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 contentLength?: number
      • Optional contentType?: string
      • layerId: string
      • multipartToken: string
      • partNumber: number
      • Optional range?: string
      • Optional source?: string

    Returns Promise<PartId>

Generated using TypeDoc