org.jclouds.googlecomputeengine.features

Interface NetworkApi

public interface NetworkApi

Provides access to Networks via their REST API.

Author:

David Alves

See Also:

Method Summary

Methods

Modifier and Type	Method and Description
Operation	createInIPv4Range(String networkName, String IPv4Range) Creates a persistent network resource in the specified project with the specified range.
Operation	createInIPv4RangeWithGateway(String networkName, String IPv4Range, String gatewayIPv4) Creates a persistent network resource in the specified project with the specified range and specified gateway.
Operation	delete(String networkName) Deletes the specified persistent network resource.
Network	get(String networkName) Returns the specified persistent network resource.
org.jclouds.collect.PagedIterable<Network>	list()
org.jclouds.collect.PagedIterable<Network>	list(ListOptions options) A paged version of NetworkApi#list()
ListPage<Network>	listAtMarker(String marker)
ListPage<Network>	listAtMarker(String marker, ListOptions options) Retrieves the list of persistent network resources contained within the specified project.
ListPage<Network>	listFirstPage()

Method Detail

get

@Named(value="Networks:get")
Network get(String networkName)

Returns the specified persistent network resource.

Parameters:

networkName - name of the persistent network resource to return.

Returns:

a Network resource.

createInIPv4Range

@Named(value="Networks:insert")
Operation createInIPv4Range(String networkName,
                                String IPv4Range)

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

Parameters:

networkName - the network name

IPv4Range - the range of the network to be inserted.

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.

createInIPv4RangeWithGateway

@Named(value="Networks:insert")
Operation createInIPv4RangeWithGateway(String networkName,
                                           String IPv4Range,
                                           String gatewayIPv4)

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

Parameters:

networkName - the network name

IPv4Range - the range of the network to be inserted.

gatewayIPv4 - the range of the network to be inserted.

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(value="Networks:delete")
Operation delete(String networkName)

Deletes the specified persistent network resource.

Parameters:

networkName - name of the persistent network 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="Networks:list")
ListPage<Network> listFirstPage()

See Also:

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

listAtMarker

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

See Also:

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

listAtMarker

@Named(value="Networks:list")
ListPage<Network> listAtMarker(@Nullable
                                   String marker,
                                   ListOptions options)

Retrieves the list of persistent network resources contained within 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="Networks:list")
org.jclouds.collect.PagedIterable<Network> list()

See Also:

list(org.jclouds.googlecomputeengine.options.ListOptions)

list

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

A paged version of NetworkApi#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)