Interface LoadBalancingRule

All Superinterfaces:

ChildResource<LoadBalancer>, HasBackendPort, HasFloatingIP, HasFrontend, HasFrontendPort, HasInnerModel<LoadBalancingRuleInner>, HasName, HasParent<LoadBalancer>, HasProtocol<TransportProtocol>, Indexable

public interface LoadBalancingRule
extends HasInnerModel<LoadBalancingRuleInner>, ChildResource<LoadBalancer>, HasBackendPort, HasFrontend, HasFloatingIP, HasProtocol<TransportProtocol>, HasFrontendPort

A client-side representation of an HTTP load balancing rule.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	LoadBalancingRule.Definition<ReturnT>	The entirety of a load balancing rule definition.
static interface	LoadBalancingRule.DefinitionStages	Grouping of load balancing rule definition stages.
static interface	LoadBalancingRule.Update	The entirety of a load balancing rule update as part of a load balancer update.
static interface	LoadBalancingRule.UpdateDefinition<ReturnT>	The entirety of a load balancing rule definition as part of a load balancer update.
static interface	LoadBalancingRule.UpdateDefinitionStages	Grouping of load balancing rule definition stages applicable as part of a load balancer update.
static interface	LoadBalancingRule.UpdateStages	Grouping of load balancing rule update stages.

Method Summary

Modifier and Type	Method	Description
LoadBalancerBackend	backend()	Gets the backend associated with the load balancing rule.
List<LoadBalancerBackend>	backends()	Gets the list of backends associated with the load balancing rule.
int	idleTimeoutInMinutes()	Gets the number of minutes before an inactive connection is closed.
LoadDistribution	loadDistribution()	Gets the method of load distribution.
LoadBalancerProbe	probe()	Gets the probe associated with the load balancing rule.

Methods inherited from interface HasBackendPort

backendPort

Methods inherited from interface HasFloatingIP

floatingIPEnabled

Methods inherited from interface HasFrontend

frontend

Methods inherited from interface HasFrontendPort

frontendPort

Methods inherited from interface HasInnerModel

innerModel

Methods inherited from interface HasName

name

Methods inherited from interface HasParent

parent

Methods inherited from interface HasProtocol

protocol

Methods inherited from interface Indexable

key

Method Details

loadDistribution

LoadDistribution loadDistribution()

Gets the method of load distribution.

Returns:

the method of load distribution

idleTimeoutInMinutes

int idleTimeoutInMinutes()

Gets the number of minutes before an inactive connection is closed.

Returns:

the number of minutes before an inactive connection is closed

backend

LoadBalancerBackend backend()

Gets the backend associated with the load balancing rule.

If there are multiple backends associated with the rule, this API only returns the first backend. Use backends() for the case of multiple backends associated with the rule.

Returns:

the backend associated with the load balancing rule

probe

LoadBalancerProbe probe()

Gets the probe associated with the load balancing rule.

Returns:

the probe associated with the load balancing rule

backends

List<LoadBalancerBackend> backends()

Gets the list of backends associated with the load balancing rule.

Returns:

the list of backends associated with the load balancing rule