Package org.jclouds.googlecomputeengine.features

Interface OperationApi

@Consumes("application/json")
public interface OperationApi

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	OperationApi.OperationPages
static final class	OperationApi.OperationPagesInRegion
static final class	OperationApi.OperationPagesInZone

Method Summary

Modifier and Type	Method	Description
void	delete(URI operation)	Deletes an operation by name.
Operation	get(URI operation)	Returns an operation by self-link or null if not found.
Iterator<ListPage<Operation>>	list()
Iterator<ListPage<Operation>>	list(ListOptions options)
Iterator<ListPage<Operation>>	listInRegion(String region)
Iterator<ListPage<Operation>>	listInRegion(String region, ListOptions options)
Iterator<ListPage<Operation>>	listInZone(String zone)
Iterator<ListPage<Operation>>	listInZone(String zone, ListOptions options)
ListPage<Operation>	listPage(String pageToken, ListOptions listOptions)	Retrieves the list of operation resources available to the specified project.
ListPage<Operation>	listPageInRegion(String region, String pageToken, ListOptions listOptions)	Retrieves the list of operation resources available in the specified region.
ListPage<Operation>	listPageInZone(String zone, String pageToken, ListOptions listOptions)	Retrieves the list of operation resources available in the specified zone.

Method Details

get

@Named("Operations:get")
@GET
@Nullable
Operation get(URI operation)

Returns an operation by self-link or null if not found.

delete

@Named("Operations:delete")
@DELETE
void delete(URI operation)

Deletes an operation by name.

listPage

@Named("GlobalOperations:list")
@GET
@Path("/global/operations")
ListPage<Operation> listPage(@Nullable @QueryParam("pageToken")
 String pageToken,
 ListOptions listOptions)

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

pageToken - marks the beginning of the next list page

listOptions - listing options

Returns:

a page of the list

list

@Named("GlobalOperations:list")
@GET
@Path("/global/operations")
Iterator<ListPage<Operation>> list()

See Also:

• listPage(String, ListOptions)

list

@Named("GlobalOperations:list")
@GET
@Path("/global/operations")
Iterator<ListPage<Operation>> list(ListOptions options)

See Also:

• listPage(String, ListOptions)

listPageInRegion

@Named("RegionOperations:list")
@GET
@Path("/regions/{region}/operations")
ListPage<Operation> listPageInRegion(@PathParam("region")
 String region,
 @Nullable @QueryParam("pageToken")
 String pageToken,
 ListOptions listOptions)

Retrieves the list of operation resources available in the specified region. By default the list as a maximum size of 100, if no options are provided or ListOptions#getMaxResults() has not been set.

Parameters:

pageToken - marks the beginning of the next list page

listOptions - listing options

Returns:

a page of the list

listInRegion

@Named("RegionOperations:list")
@GET
@Path("/regions/{region}/operations")
Iterator<ListPage<Operation>> listInRegion(@PathParam("region")
 String region)

See Also:

• listInRegion(String, org.jclouds.googlecomputeengine.options.ListOptions)

listInRegion

@Named("RegionOperations:list")
@GET
@Path("/regions/{region}/operations")
Iterator<ListPage<Operation>> listInRegion(@PathParam("region")
 String region,
 ListOptions options)

See Also:

• listInRegion(String, org.jclouds.googlecomputeengine.options.ListOptions)

listPageInZone

@Named("ZoneOperations:list")
@GET
@Path("/zones/{zone}/operations")
ListPage<Operation> listPageInZone(@PathParam("zone")
 String zone,
 @Nullable @QueryParam("pageToken")
 String pageToken,
 ListOptions listOptions)

Retrieves the list of operation resources available in the specified zone. By default the list as a maximum size of 100, if no options are provided or ListOptions#getMaxResults() has not been set.

Parameters:

pageToken - marks the beginning of the next list page

listOptions - listing options

Returns:

a page of the list

listInZone

@Named("ZoneOperations:list")
@GET
@Path("/zones/{zone}/operations")
Iterator<ListPage<Operation>> listInZone(@PathParam("zone")
 String zone)

See Also:

• listInZone(String, org.jclouds.googlecomputeengine.options.ListOptions)

listInZone

@Named("ZoneOperations:list")
@GET
@Path("/zones/{zone}/operations")
Iterator<ListPage<Operation>> listInZone(@PathParam("zone")
 String zone,
 ListOptions options)

See Also:

• listInZone(String, org.jclouds.googlecomputeengine.options.ListOptions)