Package org.jclouds.googlecomputeengine.features

Interface TargetInstanceApi

@Path("/targetInstances")
@Consumes("application/json")
public interface TargetInstanceApi

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	TargetInstanceApi.TargetInstancePages

Method Summary

Modifier and Type	Method	Description
Operation	create(NewTargetInstance targetInstance)	Creates a instance resource in the specified project using the data included in the request.
Operation	delete(String targetInstance)	Deletes a targetInstance by name and returns the operation in progress, or null if not found.
TargetInstance	get(String targetInstance)	Returns a targetInstance by name or null if not found.
Iterator<ListPage<TargetInstance>>	list()
Iterator<ListPage<TargetInstance>>	list(ListOptions options)
ListPage<TargetInstance>	listPage(String pageToken, ListOptions listOptions)	Retrieves the list of targetInstance resources available to the specified project.

Method Detail

get

@Named("TargetInstances:get")
@GET
@Path("/{targetInstance}")
@Nullable
TargetInstance get(@PathParam("targetInstance")
                   String targetInstance)

Returns a targetInstance by name or null if not found.

create

@Named("TargetInstances:insert")
@POST
@Produces("application/json")
Operation create(NewTargetInstance targetInstance)

Creates a instance resource in the specified project using the data included in the request.

Parameters:

template - the instance template

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.

delete

@Named("TargetInstances:delete")
@DELETE
@Path("/{targetInstance}")
@Nullable
Operation delete(@PathParam("targetInstance")
                 String targetInstance)

Deletes a targetInstance by name and returns the operation in progress, or null if not found.

listPage

@Named("TargetInstances:list")
@GET
ListPage<TargetInstance> listPage(@Nullable @QueryParam("pageToken")
                                  String pageToken,
                                  ListOptions listOptions)

Retrieves the list of targetInstance 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("TargetInstances:list")
@GET
Iterator<ListPage<TargetInstance>> list()

See Also:

listPage(String, ListOptions)

list

@Named("TargetInstances:list")
@GET
Iterator<ListPage<TargetInstance>> list(ListOptions options)

See Also:

listPage(String, ListOptions)