Class RpnAPI

Dedibox Phoenix RPN API.

Hierarchy

API
- RpnAPI

Index

Constructors

constructor

Methods

getRpnStatus listRpnServerCapabilities

Constructors

constructor

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

Methods

getRpnStatus

getRpnStatus(
request?: Readonly<RpnApiGetRpnStatusRequest>,
): Promise<GetRpnStatusResponse>
Parameters
- request: Readonly<RpnApiGetRpnStatusRequest> = {}
Returns Promise<GetRpnStatusResponse>
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1453

listRpnServerCapabilities

listRpnServerCapabilities(
    request?: Readonly<Dedibox.v1.RpnApiListRpnServerCapabilitiesRequest>,
): Promise<ListRpnServerCapabilitiesResponse> & {
    "[asyncIterator]": () => AsyncGenerator<
        RpnServerCapability[],
        void,
        void,
    >;
    all: () => Promise<RpnServerCapability[]>;
}
Parameters
- request: Readonly<Dedibox.v1.RpnApiListRpnServerCapabilitiesRequest> = {}
Returns Promise<ListRpnServerCapabilitiesResponse> & {
    "[asyncIterator]": () => AsyncGenerator<
        RpnServerCapability[],
        void,
        void,
    >;
    all: () => Promise<RpnServerCapability[]>;
}
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1444

Class RpnAPI

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns RpnAPI

Methods

getRpnStatus

Parameters

Returns Promise<GetRpnStatusResponse>

listRpnServerCapabilities

Parameters

Returns Promise<ListRpnServerCapabilitiesResponse> & {
    "[asyncIterator]": () => AsyncGenerator<
        RpnServerCapability[],
        void,
        void,
    >;
    all: () => Promise<RpnServerCapability[]>;
}

Settings

On This Page

Class RpnAPI

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns RpnAPI

Methods

getRpnStatus

Parameters

Returns Promise<GetRpnStatusResponse>

listRpnServerCapabilities

Parameters

Returns Promise<ListRpnServerCapabilitiesResponse> & { "[asyncIterator]": () => AsyncGenerator< RpnServerCapability[], void, void, >; all: () => Promise<RpnServerCapability[]>;}

Settings

On This Page

Returns Promise<ListRpnServerCapabilitiesResponse> & {
"[asyncIterator]": () => AsyncGenerator<
RpnServerCapability[],
void,
void,
>;
all: () => Promise<RpnServerCapability[]>;
}