Package com.softlayer.api.service.network.loadbalancer.global

Interface Host.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

Host

@ApiService("SoftLayer_Network_LoadBalancer_Global_Host")
public static interface Host.Service
extends Service

Every global load balancer account contains hosts that make up the load balancing pool. The global load balancers select hosts from this pool and return the destination IP in the DNS response. The SoftLayer_Network_LoadBalancer_Global_Host service represent these hosts.

Hosts can only be created or modified by using the [[SoftLayer_Network_LoadBalancer_Global_Account::editObject]] method.

Each account has a limited number of hosts that can be added to the load balancing pool, which is defined by the allowedNumberOfHosts property on a global load balancer account.

See Also:

SoftLayer_Network_LoadBalancer_Global_Host

Method Summary

Modifier and Type	Method	Description
Host.ServiceAsync	asAsync()	Get an async version of this service
Boolean	deleteObject()	Remove a host from the load balancing pool of a global load balancer account.
Account	getLoadBalancerAccount()	The global load balancer account a host belongs to.
Host	getObject()	getObject retrieves the SoftLayer_Network_LoadBalancer_Global_Host object whose ID number corresponds to the ID number of the init paramater passed to the SoftLayer_Network_LoadBalancer_Global_Host service.
void	setMask(Host.Mask mask)
Host.Mask	withMask()	Use the existing mask on this service or create it if not present
Host.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

Host.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

Host.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

Host.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(Host.Mask mask)

deleteObject

@ApiMethod(instanceRequired=true)
Boolean deleteObject()

Remove a host from the load balancing pool of a global load balancer account.

See Also:

SoftLayer_Network_LoadBalancer_Global_Host::deleteObject

getObject

@ApiMethod(instanceRequired=true)
Host getObject()

getObject retrieves the SoftLayer_Network_LoadBalancer_Global_Host object whose ID number corresponds to the ID number of the init paramater passed to the SoftLayer_Network_LoadBalancer_Global_Host service. You can only retrieve a global load balancer host that is assigned to your SoftLayer global load balancer account.

See Also:

SoftLayer_Network_LoadBalancer_Global_Host::getObject

getLoadBalancerAccount

@ApiMethod(instanceRequired=true)
Account getLoadBalancerAccount()

The global load balancer account a host belongs to.

See Also:

SoftLayer_Network_LoadBalancer_Global_Host::getLoadBalancerAccount