org.jclouds.rackspace.cloudloadbalancers.features

Interface LoadBalancerApi

public interface LoadBalancerApi

Provides synchronous access to CloudLoadBalancers LoadBalancer features.

Author:

Everett Toews

See Also:

LoadBalancerAsyncApi

Method Summary

Methods

Modifier and Type	Method and Description
LoadBalancer	create(LoadBalancerRequest lb) Create a new load balancer with the configuration defined by the request.
LoadBalancer	get(int id)
PagedIterable<LoadBalancer>	list()
IterableWithMarker<LoadBalancer>	list(PaginationOptions options)
void	remove(int id) Remove a load balancer from the account.
void	update(int id, LoadBalancerAttributes attrs) Update the properties of a load balancer.

Method Detail

create

LoadBalancer create(LoadBalancerRequest lb)

Create a new load balancer with the configuration defined by the request.

This operation asynchronously provisions a new load balancer based on the configuration defined in the request object. Once the request is validated and progress has started on the provisioning process, a response object will be returned.

Parameters:

lb - configuration to create

Returns:

The object will contain a unique identifier and status of the request. Using the identifier, the caller can check on the progress of the operation by performing a LoadBalancerApi#getLoadBalancer.

Throws:

HttpResponseException - If the corresponding request cannot be fulfilled due to insufficient or invalid data

update

void update(int id,
          LoadBalancerAttributes attrs)

Update the properties of a load balancer.

This operation asynchronously updates the attributes of the specified load balancer. Upon successful validation of the request, the service will return a 202 (Accepted) response code. A caller can poll the load balancer with its ID to wait for the changes to be applied and the load balancer to return to an ACTIVE status.

Parameters:

id - id of the loadbalancer to change

attrs - what to change

See Also:

LoadBalancerAttributes.fromLoadBalancer(T)

list

PagedIterable<LoadBalancer> list()

Returns:

all load balancers configured for the account, or empty set if none available

list

IterableWithMarker<LoadBalancer> list(PaginationOptions options)

get

LoadBalancer get(int id)

Parameters:

id - id of the loadbalancer to retrieve

Returns:

details of the specified load balancer, or null if not found

remove

void remove(int id)

Remove a load balancer from the account.

The remove load balancer function removes the specified load balancer and its associated configuration from the account. Any and all configuration data is immediately purged and is not recoverable.

Parameters:

id - to remove