org.jclouds.googlecomputeengine.features

Interface ImageApi

public interface ImageApi

Provides access to Images via their REST API.

Author:

David Alves

See Also:

Method Summary

Methods

Modifier and Type	Method and Description
Operation	delete(String imageName) Deletes the specified image resource.
Image	get(String imageName) Returns the specified image resource.
org.jclouds.collect.PagedIterable<Image>	list() A paged version of ImageApi#list()
org.jclouds.collect.PagedIterable<Image>	list(ListOptions options) A paged version of ImageApi#list()
ListPage<Image>	listAtMarker(String marker)
ListPage<Image>	listAtMarker(String marker, ListOptions listOptions) Retrieves the list of image resources available to the specified project.
ListPage<Image>	listFirstPage()

Method Detail

get

@Named(value="Images:get")
@Nullable
Image get(String imageName)

Returns the specified image resource.

Parameters:

imageName - name of the image resource to return.

Returns:

an Image resource

delete

@Named(value="Images:delete")
@Nullable
Operation delete(String imageName)

Deletes the specified image resource.

Parameters:

imageName - name of the image 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 image did not exist the result is null.

listFirstPage

@Named(value="Images:list")
ListPage<Image> listFirstPage()

See Also:

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

listAtMarker

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

See Also:

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

listAtMarker

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

Retrieves the list of image 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:

marker - marks the beginning of the next list page

listOptions - listing options

Returns:

a page of the list

See Also:

ListOptions, ListPage

list

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

A paged version of ImageApi#list()

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="Images:list")
org.jclouds.collect.PagedIterable<Image> list(ListOptions options)

A paged version of ImageApi#list()

Returns:

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

See Also:

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