Package com.ngrok.services

Class WeightedBackends

java.lang.Object

com.ngrok.services.WeightedBackends

public class WeightedBackends
extends Object

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. See also https://ngrok.com/docs/api#api-weighted-backends.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	WeightedBackends.CreateCallBuilder	A builder object encapsulating state for an unsent Create API call.
class	WeightedBackends.DeleteCallBuilder	A builder object encapsulating state for an unsent Delete API call.
class	WeightedBackends.GetCallBuilder	A builder object encapsulating state for an unsent Get API call.
class	WeightedBackends.ListCallBuilder	A builder object encapsulating state for an unsent List API call.
class	WeightedBackends.UpdateCallBuilder	A builder object encapsulating state for an unsent Update API call.

Constructor Summary

Constructors

Constructor	Description
WeightedBackends(NgrokApiClient apiClient)	Creates a new sub-client for WeightedBackends.

Method Summary

Modifier and Type	Method	Description
WeightedBackends.CreateCallBuilder	create()	Create a new Weighted backend See also https://ngrok.com/docs/api#api-weighted-backends-create.
WeightedBackends.DeleteCallBuilder	delete(String id)	Delete a Weighted backend by ID.
WeightedBackends.GetCallBuilder	get(String id)	Get detailed information about a Weighted backend by ID See also https://ngrok.com/docs/api#api-weighted-backends-get.
WeightedBackends.ListCallBuilder	list()	List all Weighted backends on this account See also https://ngrok.com/docs/api#api-weighted-backends-list.
WeightedBackends.UpdateCallBuilder	update(String id)	Update Weighted backend by ID See also https://ngrok.com/docs/api#api-weighted-backends-update.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WeightedBackends

public WeightedBackends(NgrokApiClient apiClient)

Creates a new sub-client for WeightedBackends.

Parameters:

apiClient - an instance of NgrokApiClient

Method Details

create

public WeightedBackends.CreateCallBuilder create()

Create a new Weighted backend See also https://ngrok.com/docs/api#api-weighted-backends-create.

Returns:

a call builder for this API call

delete

public WeightedBackends.DeleteCallBuilder delete(String id)

Delete a Weighted backend by ID. See also https://ngrok.com/docs/api#api-weighted-backends-delete.

Parameters:

id - a resource identifier

Returns:

a call builder for this API call

get

public WeightedBackends.GetCallBuilder get(String id)

Get detailed information about a Weighted backend by ID See also https://ngrok.com/docs/api#api-weighted-backends-get.

Parameters:

id - a resource identifier

Returns:

a call builder for this API call

list

public WeightedBackends.ListCallBuilder list()

List all Weighted backends on this account See also https://ngrok.com/docs/api#api-weighted-backends-list.

Returns:

a call builder for this API call

update

public WeightedBackends.UpdateCallBuilder update(String id)

Update Weighted backend by ID See also https://ngrok.com/docs/api#api-weighted-backends-update.

Parameters:

id - the value of the id parameter as a String

Returns:

a call builder for this API call