Class BackupService

IQMESH Backup API service

Hierarchy

BaseIqmeshService
- BackupService

Index

Constructors

Methods

backup buildOptionsWithRequest restore

Constructors

constructor

new BackupService(): BackupService
Returns BackupService
Inherited from BaseIqmeshService.constructor

Methods

`Static`backup

backup(
    shared: IqmeshSharedParams,
    params: IqmeshBackupParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Perform backup
Parameters
- shared: IqmeshSharedParams
  Shared IQMESH request parameters
- params: IqmeshBackupParams
  IQMESH Backup request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/iqmesh/BackupService.ts:25

`Protected` `Static`buildOptionsWithRequest

buildOptionsWithRequest(
    mType: string,
    shared: IqmeshSharedParams,
    params: null | IqmeshRequestParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Construct IQMESH service request object
Parameters
- mType: string
  Message type
- shared: IqmeshSharedParams
  Shared request parameters
- params: null | IqmeshRequestParams
  Request specific parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
Inherited from BaseIqmeshService.buildOptionsWithRequest
- Defined in services/iqmesh/BaseIqmeshService.ts:17

`Static`restore

restore(
    shared: IqmeshSharedParams,
    params: IqmeshRestoreParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Perform restore
Parameters
- shared: IqmeshSharedParams
  Shared IQMESH request parameters
- params: IqmeshRestoreParams
  IQMESH Restore request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/iqmesh/BackupService.ts:41