Class DisasterRecoveryClient

Index

Constructors

Methods

createFailoverGroup createStableUrl deleteFailoverGroup deleteStableUrl failoverFailoverGroup getFailoverGroup getStableUrl listFailoverGroups listFailoverGroupsIter listStableUrls listStableUrlsIter updateFailoverGroup

Constructors

constructor

new DisasterRecoveryClient(options: ClientOptions): DisasterRecoveryClient
Parameters
- options: ClientOptions
Returns DisasterRecoveryClient
- Defined in client.ts:63

Methods

createFailoverGroup

createFailoverGroup(
req: CreateFailoverGroupRequest,
options?: CallOptions,
): Promise<FailoverGroup>
Create a new failover group.
Parameters
- req: CreateFailoverGroupRequest
- Optionaloptions: CallOptions
Returns Promise<FailoverGroup>
- Defined in client.ts:79

createStableUrl

createStableUrl(
req: CreateStableUrlRequest,
options?: CallOptions,
): Promise<StableUrl>
Create a new stable URL.
Parameters
- req: CreateStableUrlRequest
- Optionaloptions: CallOptions
Returns Promise<StableUrl>
- Defined in client.ts:124

deleteFailoverGroup

deleteFailoverGroup(
req: DeleteFailoverGroupRequest,
options?: CallOptions,
): Promise<void>
Delete a failover group.
Parameters
- req: DeleteFailoverGroupRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:169

deleteStableUrl

deleteStableUrl(
req: DeleteStableUrlRequest,
options?: CallOptions,
): Promise<void>
Delete a stable URL.
Parameters
- req: DeleteStableUrlRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:198

failoverFailoverGroup

failoverFailoverGroup(
req: FailoverFailoverGroupRequest,
options?: CallOptions,
): Promise<FailoverGroup>
Initiate a failover to a new primary region.
Parameters
- req: FailoverFailoverGroupRequest
- Optionaloptions: CallOptions
Returns Promise<FailoverGroup>
- Defined in client.ts:221

getFailoverGroup

getFailoverGroup(
req: GetFailoverGroupRequest,
options?: CallOptions,
): Promise<FailoverGroup>
Get a failover group.
Parameters
- req: GetFailoverGroupRequest
- Optionaloptions: CallOptions
Returns Promise<FailoverGroup>
- Defined in client.ts:251

getStableUrl

getStableUrl(
req: GetStableUrlRequest,
options?: CallOptions,
): Promise<StableUrl>
Get a stable URL.
Parameters
- req: GetStableUrlRequest
- Optionaloptions: CallOptions
Returns Promise<StableUrl>
- Defined in client.ts:280

listFailoverGroups

listFailoverGroups(
req: ListFailoverGroupsRequest,
options?: CallOptions,
): Promise<ListFailoverGroupsResponse>
List failover groups.

List entries are abbreviated: state and replication_point are not populated. Call GetFailoverGroup to retrieve the full resource.
Parameters
- req: ListFailoverGroupsRequest
- Optionaloptions: CallOptions
Returns Promise<ListFailoverGroupsResponse>
- Defined in client.ts:314

listFailoverGroupsIter

listFailoverGroupsIter(
req: ListFailoverGroupsRequest,
options?: CallOptions,
): AsyncGenerator<FailoverGroup>
Parameters
- req: ListFailoverGroupsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<FailoverGroup>
- Defined in client.ts:351

listStableUrls

listStableUrls(
req: ListStableUrlsRequest,
options?: CallOptions,
): Promise<ListStableUrlsResponse>
List stable URLs for an account.
Parameters
- req: ListStableUrlsRequest
- Optionaloptions: CallOptions
Returns Promise<ListStableUrlsResponse>
- Defined in client.ts:369

listStableUrlsIter

listStableUrlsIter(
req: ListStableUrlsRequest,
options?: CallOptions,
): AsyncGenerator<StableUrl>
Parameters
- req: ListStableUrlsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<StableUrl>
- Defined in client.ts:406

updateFailoverGroup

updateFailoverGroup(
req: UpdateFailoverGroupRequest,
options?: CallOptions,
): Promise<FailoverGroup>
Update a failover group.
Parameters
- req: UpdateFailoverGroupRequest
- Optionaloptions: CallOptions
Returns Promise<FailoverGroup>
- Defined in client.ts:424