Class CloudstoragesApi

CloudstoragesApi - object-oriented interface

Export

Hierarchy

BaseAPI
- CloudstoragesApi

Index

Constructors

constructor

new CloudstoragesApi(configuration?, basePath?, axios?): CloudstoragesApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns CloudstoragesApi
Inherited from BaseAPI.constructor
- Defined in base.ts:53

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

cloudstoragesCreate

cloudstoragesCreate(requestParameters, options?): Promise<AxiosResponse<CloudStorageRead, any>>
Parameters
- requestParameters: CloudstoragesApiCloudstoragesCreateRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<CloudStorageRead, any>>

Summary
Method creates a cloud storage with a specified characteristics

Throws

Memberof
CloudstoragesApi
- Defined in api-client/cloudstorages-api.ts:1090

cloudstoragesDestroy

cloudstoragesDestroy(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: CloudstoragesApiCloudstoragesDestroyRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
Method deletes a specific cloud storage

Throws

Memberof
CloudstoragesApi
- Defined in api-client/cloudstorages-api.ts:1102

cloudstoragesList

cloudstoragesList(requestParameters?, options?): Promise<AxiosResponse<PaginatedCloudStorageReadList, any>>
Parameters
- requestParameters: CloudstoragesApiCloudstoragesListRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<PaginatedCloudStorageReadList, any>>

Summary
Returns a paginated list of storages

Throws

Memberof
CloudstoragesApi
- Defined in api-client/cloudstorages-api.ts:1114

cloudstoragesPartialUpdate

cloudstoragesPartialUpdate(requestParameters, options?): Promise<AxiosResponse<CloudStorageRead, any>>
Parameters
- requestParameters: CloudstoragesApiCloudstoragesPartialUpdateRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<CloudStorageRead, any>>

Summary
Methods does a partial update of chosen fields in a cloud storage instance

Throws

Memberof
CloudstoragesApi
- Defined in api-client/cloudstorages-api.ts:1126

cloudstoragesRetrieve

cloudstoragesRetrieve(requestParameters, options?): Promise<AxiosResponse<CloudStorageRead, any>>
Parameters
- requestParameters: CloudstoragesApiCloudstoragesRetrieveRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<CloudStorageRead, any>>

Summary
Method returns details of a specific cloud storage

Throws

Memberof
CloudstoragesApi
- Defined in api-client/cloudstorages-api.ts:1138

cloudstoragesRetrieveActions

cloudstoragesRetrieveActions(requestParameters, options?): Promise<AxiosResponse<string, any>>
Method return allowed actions for cloud storage. It's required for reading/writing
Parameters
- requestParameters: CloudstoragesApiCloudstoragesRetrieveActionsRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<string, any>>

Summary
Method returns allowed actions for the cloud storage

Throws

Memberof
CloudstoragesApi
- Defined in api-client/cloudstorages-api.ts:1150

cloudstoragesRetrieveContentV2

cloudstoragesRetrieveContentV2(requestParameters, options?): Promise<AxiosResponse<CloudStorageContent, any>>
Parameters
- requestParameters: CloudstoragesApiCloudstoragesRetrieveContentV2Request
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<CloudStorageContent, any>>

Summary
Method returns the content of the cloud storage

Throws

Memberof
CloudstoragesApi
- Defined in api-client/cloudstorages-api.ts:1162

cloudstoragesRetrievePreview

cloudstoragesRetrievePreview(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: CloudstoragesApiCloudstoragesRetrievePreviewRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
Method returns a preview image from a cloud storage

Throws

Memberof
CloudstoragesApi
- Defined in api-client/cloudstorages-api.ts:1174

cloudstoragesRetrieveStatus

cloudstoragesRetrieveStatus(requestParameters, options?): Promise<AxiosResponse<string, any>>
Parameters
- requestParameters: CloudstoragesApiCloudstoragesRetrieveStatusRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<string, any>>

Summary
Method returns a cloud storage status

Throws

Memberof
CloudstoragesApi
- Defined in api-client/cloudstorages-api.ts:1186

Class CloudstoragesApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional configuration: Configuration

basePath: string = BASE_PATH

axios: AxiosInstance = globalAxios

Returns CloudstoragesApi

Properties

Protected axios

Protected basePath

Protected configuration

Methods

cloudstoragesCreate

Parameters

requestParameters: CloudstoragesApiCloudstoragesCreateRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<CloudStorageRead, any>>

Summary

Throws

Memberof

cloudstoragesDestroy

Parameters

requestParameters: CloudstoragesApiCloudstoragesDestroyRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

cloudstoragesList

Parameters

requestParameters: CloudstoragesApiCloudstoragesListRequest = {}

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<PaginatedCloudStorageReadList, any>>

Summary

Throws

Memberof

cloudstoragesPartialUpdate

Parameters

requestParameters: CloudstoragesApiCloudstoragesPartialUpdateRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<CloudStorageRead, any>>

Summary

Throws

Memberof

cloudstoragesRetrieve

Parameters

requestParameters: CloudstoragesApiCloudstoragesRetrieveRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<CloudStorageRead, any>>

Summary

Throws

Memberof

cloudstoragesRetrieveActions

Parameters

requestParameters: CloudstoragesApiCloudstoragesRetrieveActionsRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<string, any>>

Summary

Throws

Memberof

cloudstoragesRetrieveContentV2

Parameters

requestParameters: CloudstoragesApiCloudstoragesRetrieveContentV2Request

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<CloudStorageContent, any>>

Summary

Throws

Memberof

cloudstoragesRetrievePreview

Parameters

requestParameters: CloudstoragesApiCloudstoragesRetrievePreviewRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<void, any>>

`Optional` configuration: Configuration

`Protected` axios

`Protected` basePath

`Protected` configuration

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>