FloatingIPApi (Apache jclouds 2.1.0 API)

```
@Beta
@Path(value="/floatingips")
@Consumes(value="application/json")
public interface FloatingIPApi
```
Provides access to Floating IP operations for the OpenStack Networking (Neutron) v2 API.
A floating IP is an IP address on an external network, which is associated with a specific port, and optionally a specific IP address, on a private OpenStack Networking network. Therefore a floating IP allows access to an instance on a private network from an external network. Floating IPs can only be defined on networks for which the attribute floatingip:external (by the external network extension) has been set to True.

Method Summary

Methods
Modifier and Type	Method and Description
`FloatingIP`	`create(FloatingIP.CreateFloatingIP createFloatingIP)` Creates a floating IP.
`boolean`	`delete(String id)` Deletes the specified floatingIP
`FloatingIP`	`get(String id)` Returns the details for a specific floating IP.
`PagedIterable<FloatingIP>`	`list()` Returns a list of floating IPs to which the tenant has access.
`FloatingIPs`	`list(PaginationOptions options)`
`FloatingIP`	`update(String id, FloatingIP.UpdateFloatingIP updateFloatingIP)` Update a Floating IP

- Method Detail
  - list
```
@Named(value="floatingip:list")
@GET
PagedIterable<FloatingIP> list()
```
    Returns a list of floating IPs to which the tenant has access. Default policy settings return only those floating IPs that are owned by the tenant who submits the request, unless the request is submitted by an user with administrative rights.
    
    Returns:
    the list of all floatingIP references configured for the tenant.
  - list
```
@Named(value="floatingip:list")
@GET
FloatingIPs list(PaginationOptions options)
```
    Returns:
    the list of all floatingIP references configured for the tenant.
  - get
```
@Named(value="floatingip:get")
@GET
@Path(value="/{id}")
@Nullable
FloatingIP get(@PathParam(value="id")
                                     String id)
```
    Returns the details for a specific floating IP.
    
    Parameters:
    id - the id of the floatingIP to return
    
    Returns:
    FloatingIPs collection or empty if not found
  - create
```
@Named(value="floatingip:create")
@POST
FloatingIP create(FloatingIP.CreateFloatingIP createFloatingIP)
```
    Creates a floating IP.
    
    Parameters:
    createFloatingIP - Options for creating a Floating IP
    
    Returns:
    the newly created Floating IP
  - update
```
@Named(value="floatingip:update")
@PUT
@Path(value="/{id}")
FloatingIP update(@PathParam(value="id")
                               String id,
                               FloatingIP.UpdateFloatingIP updateFloatingIP)
```
    Update a Floating IP
    
    Parameters:
    id - the id of the Floating IP to update
    updateFloatingIP - Contains only the attributes to update
    
    Returns:
    The modified Floating IP
  - delete
```
@Named(value="floatingip:delete")
@DELETE
@Path(value="/{id}")
boolean delete(@PathParam(value="id")
                               String id)
```
    Deletes the specified floatingIP
    
    Parameters:
    id - the id of the floatingIP to delete
    
    Returns:
    true if delete successful, false if not

Interface FloatingIPApi

Method Summary

Method Detail

list

list

get

create

update

delete