Class RpnSanAPI

Dedibox Phoenix RPN SAN API.

Hierarchy

API
- RpnSanAPI

Index

Constructors

constructor

Methods

addIp createRpnSan deleteRpnSan getRpnSan listAvailableIps listIps listRpnSans removeIp waitForRpnSan

Constructors

constructor

new RpnSanAPI(client): RpnSanAPI
Parameters
- client: Client
Returns RpnSanAPI
Inherited from ParentAPI.constructor
- Defined in packages/clients/src/scw/api.ts:9

Methods

addIp

addIp(request): Promise<void>
Parameters
- request: Readonly<Dedibox.v1.RpnSanApiAddIpRequest>
Returns Promise<void>
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1551

createRpnSan

createRpnSan(request): Promise<Service>
Parameters
- request: Readonly<RpnSanApiCreateRpnSanRequest>
Returns Promise<Service>
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1528

deleteRpnSan

deleteRpnSan(request): Promise<void>
Parameters
- request: Readonly<Dedibox.v1.RpnSanApiDeleteRpnSanRequest>
Returns Promise<void>
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1522

listRpnSans

listRpnSans(request?): Promise<ListRpnSansResponse> & {
[asyncIterator]: (() => AsyncGenerator<RpnSanSummary[], void, void>);
all: (() => Promise<RpnSanSummary[]>);
}
Parameters
- request: Readonly<Dedibox.v1.RpnSanApiListRpnSansRequest> = {}
Returns Promise<ListRpnSansResponse> & {
[asyncIterator]: (() => AsyncGenerator<RpnSanSummary[], void, void>);
all: (() => Promise<RpnSanSummary[]>);
}
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1490

removeIp

removeIp(request): Promise<void>
Parameters
- request: Readonly<Dedibox.v1.RpnSanApiRemoveIpRequest>
Returns Promise<void>
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1561

waitForRpnSan

waitForRpnSan(request, options?): Promise<RpnSan>
Waits for RpnSan to be in a final state.
Parameters
- request: Readonly<Dedibox.v1.RpnSanApiGetRpnSanRequest>
  The request RpnSanApiGetRpnSanRequest
- Optionaloptions: Readonly<WaitForOptions<RpnSan>>
  The waiting options
Returns Promise<RpnSan>
A Promise of RpnSan
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1509

Class RpnSanAPI

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns RpnSanAPI

Methods

addIp

Parameters

Returns Promise<void>

createRpnSan

Parameters

Returns Promise<Service>

deleteRpnSan

Parameters

Returns Promise<void>

getRpnSan

Parameters

Returns Promise<RpnSan>

listAvailableIps

Parameters

Returns Promise<Dedibox.v1.ListIpsResponse>

listIps

Parameters

Returns Promise<Dedibox.v1.ListIpsResponse>

listRpnSans

Parameters

Returns Promise<ListRpnSansResponse> & {
[asyncIterator]: (() => AsyncGenerator<RpnSanSummary[], void, void>);
all: (() => Promise<RpnSanSummary[]>);
}

removeIp

Parameters

Returns Promise<void>

waitForRpnSan

Parameters

Returns Promise<RpnSan>

Settings

On This Page

Class RpnSanAPI

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns RpnSanAPI

Methods

addIp

Parameters

Returns Promise<void>

createRpnSan

Parameters

Returns Promise<Service>

deleteRpnSan

Parameters

Returns Promise<void>

getRpnSan

Parameters

Returns Promise<RpnSan>

listAvailableIps

Parameters

Returns Promise<Dedibox.v1.ListIpsResponse>

listIps

Parameters

Returns Promise<Dedibox.v1.ListIpsResponse>

listRpnSans

Parameters

Returns Promise<ListRpnSansResponse> & { [asyncIterator]: (() => AsyncGenerator<RpnSanSummary[], void, void>); all: (() => Promise<RpnSanSummary[]>); }

removeIp

Parameters

Returns Promise<void>

waitForRpnSan

Parameters

Returns Promise<RpnSan>

Settings

On This Page

Returns Promise<ListRpnSansResponse> & {
[asyncIterator]: (() => AsyncGenerator<RpnSanSummary[], void, void>);
all: (() => Promise<RpnSanSummary[]>);
}