Class BlobApi

Hierarchy (view full)

BaseAPI
- BlobApi

Index

Constructors

Properties

Methods

deleteBlobsWithBlobId deleteBlobsWithBlobIdRaw getBlobs getBlobsRaw getBlobsWithBlobId getBlobsWithBlobIdRaw patchBlobsWithBlobId patchBlobsWithBlobIdRaw postBlobs postBlobsRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new BlobApi(configuration?): BlobApi
Parameters
- configuration: Configuration = ...
Returns BlobApi
Inherited from BaseAPI.constructor
- Defined in cwmsjs/src/runtime.ts:27

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

deleteBlobsWithBlobId

deleteBlobsWithBlobId(requestParameters, initOverrides?): Promise<void>
Deletes requested blob Delete blobs with blobId
Parameters
- requestParameters: DeleteBlobsWithBlobIdRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/BlobApi.ts:111

deleteBlobsWithBlobIdRaw

deleteBlobsWithBlobIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Deletes requested blob Delete blobs with blobId
Parameters
- requestParameters: DeleteBlobsWithBlobIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/BlobApi.ts:68

getBlobs

getBlobs(requestParameters?, initOverrides?): Promise<Blobs>
Get blobs
Parameters
- requestParameters: GetBlobsRequest = {}
- Optional initOverrides: RequestInit
Returns Promise<Blobs>
- Defined in cwmsjs/src/apis/BlobApi.ts:156

getBlobsRaw

getBlobsRaw(requestParameters, initOverrides?): Promise<ApiResponse<Blobs>>
Get blobs
Parameters
- requestParameters: GetBlobsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<Blobs>>
- Defined in cwmsjs/src/apis/BlobApi.ts:118

getBlobsWithBlobId

getBlobsWithBlobId(requestParameters, initOverrides?): Promise<object>
Returns the binary value of the requested blob as a seekable stream with the appropriate media type. Get blobs with blobId
Parameters
- requestParameters: GetBlobsWithBlobIdRequest
- Optional initOverrides: RequestInit
Returns Promise<object>
- Defined in cwmsjs/src/apis/BlobApi.ts:200

getBlobsWithBlobIdRaw

getBlobsWithBlobIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<object>>
Returns the binary value of the requested blob as a seekable stream with the appropriate media type. Get blobs with blobId
Parameters
- requestParameters: GetBlobsWithBlobIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<object>>
- Defined in cwmsjs/src/apis/BlobApi.ts:165

patchBlobsWithBlobId

patchBlobsWithBlobId(requestParameters, initOverrides?): Promise<void>
Update an existing Blob Patch blobs with blobId
Parameters
- requestParameters: PatchBlobsWithBlobIdRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/BlobApi.ts:251

patchBlobsWithBlobIdRaw

patchBlobsWithBlobIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Update an existing Blob Patch blobs with blobId
Parameters
- requestParameters: PatchBlobsWithBlobIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/BlobApi.ts:209

postBlobs

postBlobs(requestParameters, initOverrides?): Promise<void>
Create new Blob Post blobs
Parameters
- requestParameters: PostBlobsRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/BlobApi.ts:293

postBlobsRaw

postBlobsRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Create new Blob Post blobs
Parameters
- requestParameters: PostBlobsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/BlobApi.ts:259

`Protected` request

request(context, initOverrides?): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in cwmsjs/src/runtime.ts:47

withMiddleware

withMiddleware<T>(this, ...middlewares): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in cwmsjs/src/runtime.ts:31

withPostMiddleware

withPostMiddleware<T>(this, ...postMiddlewares): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context) => Promise<void | Response>)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in cwmsjs/src/runtime.ts:42

withPreMiddleware

withPreMiddleware<T>(this, ...preMiddlewares): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context) => Promise<void | FetchParams>)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in cwmsjs/src/runtime.ts:37