Class WeightedBackends

A Weighted Backend balances traffic among the referenced backends. Traffic is assigned proportionally to each based on its weight. The percentage of traffic is calculated by dividing a backend's weight by the sum of all weights.

Hierarchy

WeightedBackends

Index

Constructors

constructor

Methods

Constructors

constructor

new WeightedBackends(httpClient: Wretcher): WeightedBackends

- Defined in services.ts:827
Do not construct this object directly, use the weightedBackends property of an Ngrok client object instead.

Parameters
- httpClient: Wretcher
Returns WeightedBackends

Methods

create

create(arg: WeightedBackendCreate): Promise<WeightedBackend>

- Defined in services.ts:833
Create a new Weighted backend

Parameters
- arg: WeightedBackendCreate
Returns Promise<WeightedBackend>

delete

delete(id: any): Promise<void>

- Defined in services.ts:845
Delete a Weighted backend by ID.

Parameters
- id: any
Returns Promise<void>

get

get(id: any): Promise<WeightedBackend>

- Defined in services.ts:855
Get detailed information about a Weighted backend by ID

Parameters
- id: any
Returns Promise<WeightedBackend>

list

list(beforeId?: string, limit?: string): Promise<WeightedBackend[]>

- Defined in services.ts:865
List all Weighted backends on this account

Parameters
- Optional beforeId: string
- Optional limit: string
Returns Promise<WeightedBackend[]>

update

update(arg: WeightedBackendUpdate): Promise<WeightedBackend>

- Defined in services.ts:915
Update Weighted backend by ID

Parameters
- arg: WeightedBackendUpdate
Returns Promise<WeightedBackend>

Generated using TypeDoc