org.jclouds.gogrid.features

Interface GridIpApi

public interface GridIpApi

Method Summary

Modifier and Type	Method and Description
Set<Ip>	getAssignedIpList() Returns the list of assigned IPs NOTE: this returns both public and private IPs!
Set<Option>	getDatacenters() Retrieves the list of supported Datacenters to retrieve ips from.
Set<Ip>	getIpList(GetIpListOptions... options) Returns all IPs in the system that match the options
Set<Ip>	getUnassignedIpList() Returns the list of unassigned IPs.
Set<Ip>	getUnassignedPublicIpList() Returns the list of unassigned public IPs.

Method Detail

getIpList

@GET
 @Path(value="/grid/ip/list")
Set<Ip> getIpList(GetIpListOptions... options)

Returns all IPs in the system that match the options

Parameters:

options - options to narrow the search down

Returns:

IPs found by the search

getUnassignedIpList

@GET
 @Path(value="/grid/ip/list")
Set<Ip> getUnassignedIpList()

Returns the list of unassigned IPs. NOTE: this returns both public and private IPs!

Returns:

unassigned IPs

getUnassignedPublicIpList

@GET
 @Path(value="/grid/ip/list")
Set<Ip> getUnassignedPublicIpList()

Returns the list of unassigned public IPs.

Returns:

unassigned public IPs

getAssignedIpList

@GET
 @Path(value="/grid/ip/list")
Set<Ip> getAssignedIpList()

Returns the list of assigned IPs NOTE: this returns both public and private IPs!

Returns:

assigned IPs

getDatacenters

@GET
 @Path(value="/common/lookup/list")
Set<Option> getDatacenters()

Retrieves the list of supported Datacenters to retrieve ips from. The objects will have datacenter ID, name and description. In most cases, id or name will be used for #addServer.

Returns:

supported datacenters