Class RpnV2API

Dedibox Phoenix RPN v2 API.

Hierarchy

API
- RpnV2API

Index

Constructors

Methods

addRpnV2Members createRpnV2Group deleteRpnV2Group deleteRpnV2Members disableRpnV2GroupCompatibility enableRpnV2GroupCompatibility getRpnV2Group listRpnV2CapableResources listRpnV2GroupLogs listRpnV2Groups listRpnV2Members updateRpnV2GroupName updateRpnV2VlanForMembers waitForRpnV2Group

Constructors

constructor

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

Methods

addRpnV2Members

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

createRpnV2Group

createRpnV2Group(request): Promise<RpnV2Group>
Parameters
- request: Readonly<RpnV2ApiCreateRpnV2GroupRequest>
Returns Promise<RpnV2Group>
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1900

deleteRpnV2Group

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

deleteRpnV2Members

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

disableRpnV2GroupCompatibility

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

enableRpnV2GroupCompatibility

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

getRpnV2Group

getRpnV2Group(request): Promise<RpnV2Group>
Parameters
- request: Readonly<Dedibox.v1.RpnV2ApiGetRpnV2GroupRequest>
Returns Promise<RpnV2Group>
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1869

listRpnV2CapableResources

listRpnV2CapableResources(request?): Promise<ListRpnV2CapableResourcesResponse> & {
[asyncIterator]: (() => AsyncGenerator<Dedibox.v1.Server[], void, void>);
all: (() => Promise<Dedibox.v1.Server[]>);
}
Parameters
- request: Readonly<Dedibox.v1.RpnV2ApiListRpnV2CapableResourcesRequest> = {}
Returns Promise<ListRpnV2CapableResourcesResponse> & {
[asyncIterator]: (() => AsyncGenerator<Dedibox.v1.Server[], void, void>);
all: (() => Promise<Dedibox.v1.Server[]>);
}
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1977

listRpnV2GroupLogs

listRpnV2GroupLogs(request): Promise<ListRpnV2GroupLogsResponse> & {
[asyncIterator]: (() => AsyncGenerator<Dedibox.v1.Log[], void, void>);
all: (() => Promise<Dedibox.v1.Log[]>);
}
Parameters
- request: Readonly<Dedibox.v1.RpnV2ApiListRpnV2GroupLogsRequest>
Returns Promise<ListRpnV2GroupLogsResponse> & {
[asyncIterator]: (() => AsyncGenerator<Dedibox.v1.Log[], void, void>);
all: (() => Promise<Dedibox.v1.Log[]>);
}
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:2005

listRpnV2Groups

listRpnV2Groups(request?): Promise<ListRpnV2GroupsResponse> & {
[asyncIterator]: (() => AsyncGenerator<RpnV2Group[], void, void>);
all: (() => Promise<RpnV2Group[]>);
}
Parameters
- request: Readonly<Dedibox.v1.RpnV2ApiListRpnV2GroupsRequest> = {}
Returns Promise<ListRpnV2GroupsResponse> & {
[asyncIterator]: (() => AsyncGenerator<RpnV2Group[], void, void>);
all: (() => Promise<RpnV2Group[]>);
}
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1843

listRpnV2Members

listRpnV2Members(request): Promise<ListRpnV2MembersResponse> & {
[asyncIterator]: (() => AsyncGenerator<RpnV2Member[], void, void>);
all: (() => Promise<RpnV2Member[]>);
}
Parameters
- request: Readonly<Dedibox.v1.RpnV2ApiListRpnV2MembersRequest>
Returns Promise<ListRpnV2MembersResponse> & {
[asyncIterator]: (() => AsyncGenerator<RpnV2Member[], void, void>);
all: (() => Promise<RpnV2Member[]>);
}
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1866

updateRpnV2GroupName

updateRpnV2GroupName(request): Promise<RpnV2Group>
Parameters
- request: Readonly<Dedibox.v1.RpnV2ApiUpdateRpnV2GroupNameRequest>
Returns Promise<RpnV2Group>
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1919

updateRpnV2VlanForMembers

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

waitForRpnV2Group

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

Class RpnV2API

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns RpnV2API

Methods

addRpnV2Members

Parameters

Returns Promise<void>

createRpnV2Group

Parameters

Returns Promise<RpnV2Group>

deleteRpnV2Group

Parameters

Returns Promise<void>

deleteRpnV2Members

Parameters

Returns Promise<void>

disableRpnV2GroupCompatibility

Parameters

Returns Promise<void>

enableRpnV2GroupCompatibility

Parameters

Returns Promise<void>

getRpnV2Group

Parameters

Returns Promise<RpnV2Group>

listRpnV2CapableResources

Parameters

Returns Promise<ListRpnV2CapableResourcesResponse> & { [asyncIterator]: (() => AsyncGenerator<Dedibox.v1.Server[], void, void>); all: (() => Promise<Dedibox.v1.Server[]>); }

listRpnV2GroupLogs

Parameters

Returns Promise<ListRpnV2GroupLogsResponse> & { [asyncIterator]: (() => AsyncGenerator<Dedibox.v1.Log[], void, void>); all: (() => Promise<Dedibox.v1.Log[]>); }

listRpnV2Groups

Parameters

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

listRpnV2Members

Parameters

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

updateRpnV2GroupName

Parameters

Returns Promise<RpnV2Group>

updateRpnV2VlanForMembers

Parameters

Returns Promise<void>

waitForRpnV2Group

Parameters

Returns Promise<RpnV2Group>

Settings

On This Page

Returns Promise<ListRpnV2CapableResourcesResponse> & {
[asyncIterator]: (() => AsyncGenerator<Dedibox.v1.Server[], void, void>);
all: (() => Promise<Dedibox.v1.Server[]>);
}

Returns Promise<ListRpnV2GroupLogsResponse> & {
[asyncIterator]: (() => AsyncGenerator<Dedibox.v1.Log[], void, void>);
all: (() => Promise<Dedibox.v1.Log[]>);
}

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

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