org.jclouds.googlecomputeengine.features

Interface SnapshotApi

public interface SnapshotApi

Provides access to Snapshots via their REST API.

Author:

Andrew Bayer

See Also:

Method Summary

Methods

Modifier and Type	Method and Description
Operation	delete(String snapshotName) Deletes the specified snapshot resource.
Snapshot	get(String snapshotName) Returns the specified snapshot resource.
org.jclouds.collect.PagedIterable<Snapshot>	list() A paged version of SnapshotApi#listPage(String)
org.jclouds.collect.PagedIterable<Snapshot>	list(ListOptions options)
ListPage<Snapshot>	listAtMarker(String marker)
ListPage<Snapshot>	listAtMarker(String marker, ListOptions listOptions) Retrieves the listPage of persistent disk resources contained within the specified project and zone.
ListPage<Snapshot>	listFirstPage()

Method Detail

get

@Named(value="Snapshots:get")
@Nullable
Snapshot get(String snapshotName)

Returns the specified snapshot resource.

Parameters:

snapshotName - name of the snapshot resource to return.

Returns:

a Snapshot resource.

delete

@Named(value="Snapshots:delete")
@Nullable
Operation delete(String snapshotName)

Deletes the specified snapshot resource.

Parameters:

snapshotName - name of the snapshot 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.

listFirstPage

@Named(value="Snapshots:list")
ListPage<Snapshot> listFirstPage()

See Also:

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

listAtMarker

@Named(value="Snapshots:list")
ListPage<Snapshot> listAtMarker(@Nullable
                                    String marker)

See Also:

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

listAtMarker

@Named(value="Snapshots:list")
ListPage<Snapshot> listAtMarker(@Nullable
                                    String marker,
                                    ListOptions listOptions)

Retrieves the listPage of persistent disk resources contained within the specified project and zone. By default the listPage 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 listPage

See Also:

ListOptions, ListPage

list

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

A paged version of SnapshotApi#listPage(String)

Returns:

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

See Also:

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

list

@Named(value="Snapshots:list")
org.jclouds.collect.PagedIterable<Snapshot> list(ListOptions options)