org.jclouds.googlecomputeengine.features

Interface RouteApi

public interface RouteApi

Provides access to Routes via their REST API.

Author:

Andrew Bayer

See Also:

Method Summary

Methods

Modifier and Type	Method and 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 the specified route resource.
Route	get(String routeName) Returns the specified route resource
org.jclouds.collect.PagedIterable<Route>	list()
org.jclouds.collect.PagedIterable<Route>	list(ListOptions listOptions) A paged version of RegionApi#listFirstPage()
ListPage<Route>	listAtMarker(String marker)
ListPage<Route>	listAtMarker(String marker, ListOptions listOptions) Retrieves the listFirstPage of route resources available to the specified project.
ListPage<Route>	listFirstPage()

Method Detail

get

@Named(value="Routes:get")
Route get(String routeName)

Returns the specified route resource

Parameters:

routeName - name of the region resource to return.

Returns:

If successful, this method returns a Route resource

listFirstPage

@Named(value="Routes:list")
ListPage<Route> listFirstPage()

See Also:

listAtMarker(String, org.jclouds.googlecomputeengine.options.ListOptions)

listAtMarker

@Named(value="Routes:list")
ListPage<Route> listAtMarker(String marker)

See Also:

listAtMarker(String, org.jclouds.googlecomputeengine.options.ListOptions)

listAtMarker

@Named(value="Routes:list")
ListPage<Route> listAtMarker(String marker,
                                 ListOptions listOptions)

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

Parameters:

marker - marks the beginning of the next list page

listOptions - listing options

Returns:

a page of the listFirstPage

See Also:

ListOptions, ListPage

list

@Named(value="Routes:list")
org.jclouds.collect.PagedIterable<Route> list()

See Also:

list(org.jclouds.googlecomputeengine.options.ListOptions)

list

@Named(value="Routes:list")
org.jclouds.collect.PagedIterable<Route> list(ListOptions listOptions)

A paged version of RegionApi#listFirstPage()

Returns:

a Paged, Fluent Iterable that is able to fetch additional pages when required

See Also:

listAtMarker(String, org.jclouds.googlecomputeengine.options.ListOptions), PagedIterable

delete

@Named(value="Routes:delete")
@Nullable
Operation delete(String routeName)

Deletes the specified route resource.

Parameters:

routeName - name of the route resource to delete.

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. If the route did not exist the result is null.

createInNetwork

@Named(value="Routes:insert")
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.