Package com.softlayer.api.service.scale

Interface LoadBalancer.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

LoadBalancer

@ApiService("SoftLayer_Scale_LoadBalancer")
public static interface LoadBalancer.Service
extends Service

A scale load balancer is a configuration for a load balancer virtual server that autoscaled members will be automatically configured for.

See Also:

SoftLayer_Scale_LoadBalancer

Method Summary

Modifier and Type	Method	Description
LoadBalancer.ServiceAsync	asAsync()	Get an async version of this service
LoadBalancer	createObject(LoadBalancer templateObject)	Create a load balancer for a scale group.
Boolean	deleteObject()	Delete this load balancer configuration.
Boolean	editObject(LoadBalancer templateObject)	Edit this load balancer configuration.
Long	getAllocationPercent()	The percentage of connections allocated to this virtual server.
Check	getHealthCheck()	The health check for this configuration.
LoadBalancer	getObject()
Method	getRoutingMethod()	The routing method.
Type	getRoutingType()	The routing type.
Group	getScaleGroup()	The group this load balancer configuration is for.
Long	getVirtualIpAddressId()	The ID of the virtual IP address.
VirtualServer	getVirtualServer()	The virtual server for this configuration.
Long	getVirtualServerPort()	The port on the virtual server.
void	setMask(LoadBalancer.Mask mask)
LoadBalancer.Mask	withMask()	Use the existing mask on this service or create it if not present
LoadBalancer.Mask	withNewMask()	Overwrite the existing mask on this service with a new one and return it

Methods inherited from interface com.softlayer.api.Maskable

clearMask, setMask, setMask

Methods inherited from interface com.softlayer.api.ResultLimitable

getLastResponseTotalItemCount, getResultLimit, setResultLimit

Method Detail

asAsync

LoadBalancer.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

LoadBalancer.Mask withNewMask()

Description copied from interface: Maskable

Overwrite the existing mask on this service with a new one and return it

Specified by:

withNewMask in interface Maskable

withMask

LoadBalancer.Mask withMask()

Description copied from interface: Maskable

Use the existing mask on this service or create it if not present

Specified by:

withMask in interface Maskable

setMask

void setMask(LoadBalancer.Mask mask)

createObject

@ApiMethod
LoadBalancer createObject(LoadBalancer templateObject)

Create a load balancer for a scale group. Once created, the configuration will be used to configure the load balancers for autoscaled members.

If the given virtual server port exists for the given virtual IP address, it is reused here if all the other values match. Otherwise, the virtual server port will be created.

See Also:

SoftLayer_Scale_LoadBalancer::createObject

deleteObject

@ApiMethod(instanceRequired=true)
Boolean deleteObject()

Delete this load balancer configuration. Note, this does not affect existing scaled members. Once deleted however, future scaled members will not be load balanced with this configuration.

See Also:

SoftLayer_Scale_LoadBalancer::deleteObject

editObject

@ApiMethod(instanceRequired=true)
Boolean editObject(LoadBalancer templateObject)

Edit this load balancer configuration. Note, this does not affect existing scaled members. Once edited however, future scaled members will be load balanced with this configuration.

See Also:

SoftLayer_Scale_LoadBalancer::editObject

getObject

@ApiMethod(instanceRequired=true)
LoadBalancer getObject()

See Also:

SoftLayer_Scale_LoadBalancer::getObject

getAllocationPercent

@ApiMethod(instanceRequired=true)
Long getAllocationPercent()

The percentage of connections allocated to this virtual server.

See Also:

SoftLayer_Scale_LoadBalancer::getAllocationPercent

getHealthCheck

@ApiMethod(instanceRequired=true)
Check getHealthCheck()

The health check for this configuration.

See Also:

SoftLayer_Scale_LoadBalancer::getHealthCheck

getRoutingMethod

@ApiMethod(instanceRequired=true)
Method getRoutingMethod()

The routing method.

See Also:

SoftLayer_Scale_LoadBalancer::getRoutingMethod

getRoutingType

@ApiMethod(instanceRequired=true)
Type getRoutingType()

The routing type.

See Also:

SoftLayer_Scale_LoadBalancer::getRoutingType

getScaleGroup

@ApiMethod(instanceRequired=true)
Group getScaleGroup()

The group this load balancer configuration is for.

See Also:

SoftLayer_Scale_LoadBalancer::getScaleGroup

getVirtualIpAddressId

@ApiMethod(instanceRequired=true)
Long getVirtualIpAddressId()

The ID of the virtual IP address.

See Also:

SoftLayer_Scale_LoadBalancer::getVirtualIpAddressId

getVirtualServer

@ApiMethod(instanceRequired=true)
VirtualServer getVirtualServer()

The virtual server for this configuration.

See Also:

SoftLayer_Scale_LoadBalancer::getVirtualServer

getVirtualServerPort

@ApiMethod(instanceRequired=true)
Long getVirtualServerPort()

The port on the virtual server.

See Also:

SoftLayer_Scale_LoadBalancer::getVirtualServerPort