Package org.jclouds.googlecomputeengine.features

Interface SubnetworkApi

@Path("/subnetworks")
@Consumes("application/json")
public interface SubnetworkApi

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SubnetworkApi.SubnetworkPages

Method Summary

Modifier and Type	Method	Description
Operation	createInNetwork(SubnetworkCreationOptions newSubnetwork)	Creates a persistent network resource in the specified project with the specified range and specified gateway.
Operation	delete(String subnetworkName)	Deletes a network by name and returns the operation in progress, or null if not found.
Subnetwork	get(String subnetworkName)	Returns a network by name or null if not found.
Iterator<ListPage<Subnetwork>>	list()
Iterator<ListPage<Subnetwork>>	list(ListOptions options)
ListPage<Subnetwork>	listPage(String pageToken, ListOptions listOptions)	Retrieves the list of network resources available to the specified project.

Method Detail

get

@Named("Subnetworks:get")
@GET
@Path("/{subnetwork}")
Subnetwork get(@PathParam("subnetwork")
               String subnetworkName)

Returns a network by name or null if not found.

createInNetwork

@Named("Subnetworks:insert")
@POST
@Produces("application/json")
Operation createInNetwork(SubnetworkCreationOptions newSubnetwork)

Creates a persistent network resource in the specified project with the specified range and specified gateway.

Parameters:

newSubnetwork - definition of the subnetwork.

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("Subnetworks:delete")
@DELETE
@Path("/{subnetwork}")
Operation delete(@PathParam("subnetwork")
                 String subnetworkName)

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

listPage

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

Retrieves the list of network 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("Subnetworks:list")
@GET
Iterator<ListPage<Subnetwork>> list()

See Also:

listPage(String, ListOptions)

list

@Named("Subnetworks:list")
@GET
Iterator<ListPage<Subnetwork>> list(ListOptions options)

See Also:

listPage(String, ListOptions)