org.jclouds.googlecomputeengine.features
Interface FirewallApi

public interface FirewallApi

Provides access to Firewalls via their REST API.

Author:

David Alves

See Also:

Method Summary

Operation	createInNetwork(String name, URI network, FirewallOptions firewallOptions) Creates a firewall resource in the specified project using the data included in the request.
Operation	delete(String firewallName) Deletes the specified image resource.
Firewall	get(String firewallName) Returns the specified image resource.
org.jclouds.collect.PagedIterable<Firewall>	list()
org.jclouds.collect.PagedIterable<Firewall>	list(ListOptions options) A paged version of FirewallApi#list()
ListPage<Firewall>	listAtMarker(String marker)
ListPage<Firewall>	listAtMarker(String marker, ListOptions options) Retrieves the list of firewall resources available to the specified project.
ListPage<Firewall>	listFirstPage()
Operation	patch(String firewallName, FirewallOptions firewallOptions) Updates the specified firewall resource, with patch semantics, with the data included in the request.
Operation	update(String firewallName, FirewallOptions firewallOptions) Updates the specified firewall resource with the data included in the request.

Method Detail

get

@Named(value="Firewalls:get")
@Nullable
Firewall get(String firewallName)

Returns the specified image resource.

Parameters:

firewallName - name of the firewall resource to return.

Returns:

an Firewall resource

createInNetwork

@Named(value="Firewalls:insert")
Operation createInNetwork(String name,
                                URI network,
                                FirewallOptions firewallOptions)

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

Parameters:

name - the name of the firewall to be inserted.

network - the network to which to add the firewall

firewallOptions - the options of the firewall to add

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.

update

@Named(value="Firewalls:update")
Operation update(String firewallName,
                       FirewallOptions firewallOptions)

Updates the specified firewall resource with the data included in the request.

Parameters:

firewallName - the name firewall to be updated.

firewallOptions - the new firewall.

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.

patch

@Named(value="Firewalls:patch")
Operation patch(String firewallName,
                      FirewallOptions firewallOptions)

Updates the specified firewall resource, with patch semantics, with the data included in the request.

Parameters:

firewallName - the name firewall to be updated.

firewallOptions - the new firewall.

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="Firewalls:delete")
Operation delete(String firewallName)

Deletes the specified image resource.

Parameters:

firewallName - name of the firewall 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="Firewalls:list")
ListPage<Firewall> listFirstPage()

See Also:

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

listAtMarker

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

See Also:

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

listAtMarker

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

Retrieves the list of firewall 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="Firewalls:list")
org.jclouds.collect.PagedIterable<Firewall> list()

See Also:

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

list

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

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