org.jclouds.rackspace.cloudloadbalancers.features

Interface NodeApi

public interface NodeApi

Provides synchronous access to CloudLoadBalancers Node features.

Author:

Everett Toews

See Also:

NodeAsyncApi

Method Summary

Methods

Modifier and Type	Method and Description
Set<Node>	add(Iterable<NodeRequest> nodes) Create a new node with the configuration defined by the request.
Node	get(int id)
PagedIterable<Node>	list()
IterableWithMarker<Node>	list(PaginationOptions options)
void	remove(int id) Remove a node from the account.
void	remove(Iterable<Integer> ids) Batch-remove nodes from the account.
void	update(int id, NodeAttributes attrs) Update the properties of a node.

Method Detail

add

Set<Node> add(Iterable<NodeRequest> nodes)

Create a new node with the configuration defined by the request.

When a node is added, it is assigned a unique identifier that can be used for mutating operations such as changing the condition or removing it. Every load balancer is dual-homed on both the public Internet and ServiceNet; as a result, nodes can either be internal ServiceNet addresses or addresses on the public Internet.

Parameters:

nodes - configurations to create

Returns:

created nodes

Throws:

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

update

void update(int id,
          NodeAttributes attrs)

Update the properties of a node.

This operation asynchronously updates the attributes of the specified node. 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 - node to get

attrs - what to change

See Also:

LoadBalancerAttributes.fromLoadBalancer(T)

list

PagedIterable<Node> list()

Returns:

all nodes for a given loadbalancer, or empty set if none available

list

IterableWithMarker<Node> list(PaginationOptions options)

get

Node get(int id)

Parameters:

id - node to get

Returns:

details of the specified node, or null if not found

remove

void remove(int id)

Remove a node 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 - node to remove

remove

void remove(Iterable<Integer> ids)

Batch-remove nodes from the account.

The current default limit is ten ids per request. Any and all configuration data is immediately purged and is not recoverable. By chance one of the items in the list cannot be removed due to its current status a 400:BadRequest is returned along with the ids of the ones the system identified as potential failures for this request

Parameters:

ids - nodes to remove