Package org.jclouds.googlecomputeengine.features

Interface RouteApi

@Path("/routes")
@Consumes("application/json")
public interface RouteApi

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	RouteApi.RoutePages

Method Summary

Modifier and Type	Method	Description
Operation	createInNetwork(String name, URI network, RouteOptions routeOptions)	Creates a route resource in the specified project using the data included in the request.
Operation	delete(String routeName)	Deletes a route by name and returns the operation in progress, or null if not found.
Route	get(String routeName)	Returns a route type by name or null if not found.
Iterator<ListPage<Route>>	list()
Iterator<ListPage<Route>>	list(ListOptions options)
ListPage<Route>	listPage(String pageToken, ListOptions listOptions)	Retrieves the list of route resources available to the specified project.

Method Detail

get

@Named("Routes:get")
@GET
@Path("/{route}")
Route get(@PathParam("route")
          String routeName)

Returns a route type by name or null if not found.

delete

@Named("Routes:delete")
@DELETE
@Path("/{route}")
@Nullable
Operation delete(@PathParam("route")
                 String routeName)

Deletes a route by name and returns the operation in progress, or null if not found.

createInNetwork

@Named("Routes:insert")
@POST
@Produces("application/json")
Operation createInNetwork(String name,
                          URI network,
                          RouteOptions routeOptions)

Creates a route resource in the specified project using the data included in the request.

Parameters:

name - the name of the route to be inserted.

network - the network to which to add the route

routeOptions - the options of the route to add

Returns:

an Operation resource. To check on the status of an operation, poll the Operations resource returned to you, and look for the status field.

listPage

@Named("Routes:list")
@GET
ListPage<Route> listPage(@Nullable @QueryParam("pageToken")
                         String pageToken,
                         ListOptions listOptions)

Retrieves the list of route resources available to the specified project. By default the list as a maximum size of 100, if no options are provided or ListOptions#getMaxResults() has not been set.

Parameters:

pageToken - marks the beginning of the next list page

listOptions - listing options

Returns:

a page of the list

list

@Named("Routes:list")
@GET
Iterator<ListPage<Route>> list()

See Also:

listPage(String, ListOptions)

list

@Named("Routes:list")
@GET
Iterator<ListPage<Route>> list(ListOptions options)

See Also:

listPage(String, ListOptions)