Package org.jclouds.googlecomputeengine.features

Interface FirewallApi

@Path("/firewalls")
@Consumes("application/json")
public interface FirewallApi

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	FirewallApi.FirewallPages

Method Summary

Modifier and Type	Method	Description
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 firewall)	Deletes a firewall by name and returns the operation in progress, or null if not found.
Firewall	get(String firewall)	Returns a firewall by name or null if not found.
Iterator<ListPage<Firewall>>	list()
Iterator<ListPage<Firewall>>	list(ListOptions options)
ListPage<Firewall>	listPage(String pageToken, ListOptions listOptions)	Retrieves the list of firewall resources available to the specified project.
Operation	patch(String firewall, FirewallOptions firewallOptions)	Updates the specified firewall resource, with patch semantics, with the data included in the request.
Operation	update(String firewall, FirewallOptions firewallOptions)	Updates the specified firewall resource with the data included in the request.

Method Detail

get

@Named("Firewalls:get")
@GET
@Path("/{firewall}")
@Nullable
Firewall get(@PathParam("firewall")
             String firewall)

Returns a firewall by name or null if not found.

createInNetwork

@Named("Firewalls:insert")
@POST
@Produces("application/json")
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("Firewalls:update")
@PUT
@Produces("application/json")
@Path("/{firewall}")
Operation update(@PathParam("firewall")
                 String firewall,
                 FirewallOptions firewallOptions)

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

Parameters:

firewall - 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("Firewalls:patch")
@Produces("application/json")
@Path("/{firewall}")
Operation patch(@PathParam("firewall")
                String firewall,
                FirewallOptions firewallOptions)

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

Parameters:

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

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

listPage

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

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:

pageToken - marks the beginning of the next list page

listOptions - listing options

Returns:

a page of the list

list

@Named("Firewalls:list")
@GET
Iterator<ListPage<Firewall>> list()

See Also:

listPage(String, ListOptions)

list

@Named("Firewalls:list")
@GET
Iterator<ListPage<Firewall>> list(ListOptions options)

See Also:

listPage(String, ListOptions)