org.jclouds.googlecomputeengine.features

Interface RegionApi

public interface RegionApi

Provides access to Regions via their REST API.

Author:

David Alves

See Also:

Method Summary

Methods

Modifier and Type	Method and Description
Region	get(String regionName) Returns the specified region resource
org.jclouds.collect.PagedIterable<Region>	list()
org.jclouds.collect.PagedIterable<Region>	list(ListOptions listOptions) A paged version of RegionApi#listFirstPage()
ListPage<Region>	listAtMarker(String marker)
ListPage<Region>	listAtMarker(String marker, ListOptions listOptions) Retrieves the listFirstPage of region resources available to the specified project.
ListPage<Region>	listFirstPage()

Method Detail

get

@Named(value="Regions:get")
Region get(String regionName)

Returns the specified region resource

Parameters:

regionName - name of the region resource to return.

Returns:

If successful, this method returns a Region resource

listFirstPage

@Named(value="Regions:list")
ListPage<Region> listFirstPage()

See Also:

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

listAtMarker

@Named(value="Regions:list")
ListPage<Region> listAtMarker(String marker)

See Also:

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

listAtMarker

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

Retrieves the listFirstPage of region 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="Regions:list")
org.jclouds.collect.PagedIterable<Region> list()

See Also:

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

list

@Named(value="Regions:list")
org.jclouds.collect.PagedIterable<Region> 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