FloatingIPApi (Apache jclouds 2.1.0 API)

```
@Beta
@Consumes(value="application/json")
public interface FloatingIPApi
```
Provides access to the OpenStack Compute (Nova) Floating IP extension API.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addToServer(String address, String serverId)` Adds a Floating IP address to a Server
`FloatingIP`	`allocateFromPool(String pool)` Allocates a Floating IP address from a pool
`FloatingIP`	`create()` Allocates a Floating IP address
`void`	`delete(String id)` Deletes a Floating IP address
`FloatingIP`	`get(String id)` Gets a specific Floating IP address
`com.google.common.collect.FluentIterable<FloatingIP>`	`list()` Lists all Floating IP addresses
`void`	`removeFromServer(String address, String serverId)` Removes a Floating IP address from a Server

Method Detail

list

@Named(value="floatingIP:list")
@GET
@Path(value="/os-floating-ips")
com.google.common.collect.FluentIterable<FloatingIP> list()

Lists all Floating IP addresses

Returns:: all Floating IPs

get

@Named(value="floatingIP:get")
@GET
@Path(value="/os-floating-ips/{id}")
@Nullable
FloatingIP get(@PathParam(value="id")
                                     String id)

Gets a specific Floating IP address

Returns:: all Floating IPs

create

@Named(value="floatingIP:create")
@POST
@Path(value="/os-floating-ips")
@Produces(value="application/json")
@Nullable
FloatingIP create()

Allocates a Floating IP address

Returns:: a newly created FloatingIP

allocateFromPool

@Named(value="floatingIP:allocateFromPool")
@POST
@Path(value="/os-floating-ips")
@Produces(value="application/json")
@Nullable
FloatingIP allocateFromPool(String pool)

Allocates a Floating IP address from a pool

Parameters:: pool - Pool to allocate IP address from
Returns:: a newly created FloatingIP

delete

@Named(value="floatingIP:delete")
@DELETE
@Path(value="/os-floating-ips/{id}")
void delete(@PathParam(value="id")
                            String id)

Deletes a Floating IP address

Parameters:: id - the Floating IP id

addToServer

@Named(value="floatingIP:add")
@POST
@Path(value="/servers/{id}/action")
@Produces(value="application/json")
void addToServer(String address,
                                        @PathParam(value="id")
                                        String serverId)

Adds a Floating IP address to a Server

Parameters:: serverId - the server id; address - the IP address to add NOTE: Possibly move this to ServerApi?

removeFromServer

@Named(value="floatingIP:remove")
@POST
@Path(value="/servers/{id}/action")
@Produces(value="application/json")
void removeFromServer(String address,
                                             @PathParam(value="id")
                                             String serverId)

Removes a Floating IP address from a Server

Parameters:: serverId - the server id; address - the IP address to remove NOTE: Possibly move this to ServerApi?

Interface FloatingIPApi