Class MigrationsClient

Application storage migration orchestration (see module doc).

Index

Constructors

Methods

cancel create get list

Constructors

constructor

new MigrationsClient(call: Caller): MigrationsClient
Parameters
- call: Caller
Returns MigrationsClient
- Defined in src/resources/migrations.ts:32

Methods

cancel

cancel(migrationId: string, opts?: RequestOptions): Promise<MigrationRecord>
Cancel a pre-cutover migration. 409s once the migration passed cutover.
Parameters
- migrationId: string
- Optionalopts: RequestOptions
Returns Promise<MigrationRecord>
- Defined in src/resources/migrations.ts:70

create

create(
req: CreateMigrationRequest,
opts?: RequestOptions,
): Promise<MigrationRecord>
Start a migration of an application's storage to another device.
Parameters
- req: CreateMigrationRequest
- Optionalopts: RequestOptions
Returns Promise<MigrationRecord>
- Defined in src/resources/migrations.ts:35

get

get(migrationId: string, opts?: RequestOptions): Promise<MigrationRecord>
Get a migration record. Throws NotFoundError if it does not exist.
Parameters
- migrationId: string
- Optionalopts: RequestOptions
Returns Promise<MigrationRecord>
- Defined in src/resources/migrations.ts:52

list

list(
params: { applicationId: string },
opts?: RequestOptions,
): Promise<MigrationRecord[]>
List migrations for an application.
Parameters
- params: { applicationId: string }
- Optionalopts: RequestOptions
Returns Promise<MigrationRecord[]>
- Defined in src/resources/migrations.ts:61