org.jclouds.googlecomputeengine.features
Interface ZoneApi


public interface ZoneApi

Provides access to Zones via their REST API.

Author:
David Alves
See Also:

Method Summary
 Zone get(String zoneName)
          Returns the specified zone resource
 org.jclouds.collect.PagedIterable<Zone> list()
           
 org.jclouds.collect.PagedIterable<Zone> list(ListOptions listOptions)
          A paged version of ZoneApi#listFirstPage()
 ListPage<Zone> listAtMarker(String marker)
           
 ListPage<Zone> listAtMarker(String marker, ListOptions listOptions)
          Retrieves the listFirstPage of zone resources available to the specified project.
 ListPage<Zone> listFirstPage()
           
 

Method Detail

get

@Named(value="Zones:get")
Zone get(String zoneName)
Returns the specified zone resource

Parameters:
zoneName - name of the zone resource to return.
Returns:
If successful, this method returns a Zone resource

listFirstPage

@Named(value="Zones:list")
ListPage<Zone> listFirstPage()
See Also:
listAtMarker(String, org.jclouds.googlecomputeengine.options.ListOptions)

listAtMarker

@Named(value="Zones:list")
ListPage<Zone> listAtMarker(String marker)
See Also:
listAtMarker(String, org.jclouds.googlecomputeengine.options.ListOptions)

listAtMarker

@Named(value="Zones:list")
ListPage<Zone> listAtMarker(String marker,
                                  ListOptions listOptions)
Retrieves the listFirstPage of zone 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="Zones:list")
org.jclouds.collect.PagedIterable<Zone> list()
See Also:
list(org.jclouds.googlecomputeengine.options.ListOptions)

list

@Named(value="Zones:list")
org.jclouds.collect.PagedIterable<Zone> list(ListOptions listOptions)
A paged version of ZoneApi#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


Copyright © 2009-2013 The Apache Software Foundation. All Rights Reserved.