com.google.cloud.compute.v1

Class FirewallClient

java.lang.Object

com.google.cloud.compute.v1.FirewallClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
public class FirewallClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Creates and runs virtual machines on Google Cloud Platform.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 
 try (FirewallClient firewallClient = FirewallClient.create()) {
   ProjectGlobalFirewallName firewall = ProjectGlobalFirewallName.of("[PROJECT]", "[FIREWALL]");
   Operation response = firewallClient.deleteFirewall(firewall);
 }
 
 

Note: close() needs to be called on the firewallClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of FirewallSettings to create(). For example:

To customize credentials:

 
 FirewallSettings firewallSettings =
     FirewallSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 FirewallClient firewallClient =
     FirewallClient.create(firewallSettings);
 
 

To customize the endpoint:

 
 FirewallSettings firewallSettings =
     FirewallSettings.newBuilder().setEndpoint(myEndpoint).build();
 FirewallClient firewallClient =
     FirewallClient.create(firewallSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FirewallClient.ListFirewallsFixedSizeCollection
static class	FirewallClient.ListFirewallsPage
static class	FirewallClient.ListFirewallsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FirewallClient(FirewallSettings settings) Constructs an instance of FirewallClient, using the given settings.
protected	FirewallClient(FirewallStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static FirewallClient	create() Constructs an instance of FirewallClient with default settings.
static FirewallClient	create(FirewallSettings settings) Constructs an instance of FirewallClient, using the given settings.
static FirewallClient	create(FirewallStub stub) Constructs an instance of FirewallClient, using the given stub for making calls.
Operation	deleteFirewall(DeleteFirewallHttpRequest request) Deletes the specified firewall.
Operation	deleteFirewall(ProjectGlobalFirewallName firewall) Deletes the specified firewall.
Operation	deleteFirewall(String firewall) Deletes the specified firewall.
com.google.api.gax.rpc.UnaryCallable<DeleteFirewallHttpRequest,Operation>	deleteFirewallCallable() Deletes the specified firewall.
Firewall	getFirewall(GetFirewallHttpRequest request) Returns the specified firewall.
Firewall	getFirewall(ProjectGlobalFirewallName firewall) Returns the specified firewall.
Firewall	getFirewall(String firewall) Returns the specified firewall.
com.google.api.gax.rpc.UnaryCallable<GetFirewallHttpRequest,Firewall>	getFirewallCallable() Returns the specified firewall.
FirewallSettings	getSettings()
FirewallStub	getStub()
Operation	insertFirewall(InsertFirewallHttpRequest request) Creates a firewall rule in the specified project using the data included in the request.
Operation	insertFirewall(ProjectName project, Firewall firewallResource) Creates a firewall rule in the specified project using the data included in the request.
Operation	insertFirewall(String project, Firewall firewallResource) Creates a firewall rule in the specified project using the data included in the request.
com.google.api.gax.rpc.UnaryCallable<InsertFirewallHttpRequest,Operation>	insertFirewallCallable() Creates a firewall rule in the specified project using the data included in the request.
boolean	isShutdown()
boolean	isTerminated()
FirewallClient.ListFirewallsPagedResponse	listFirewalls(ListFirewallsHttpRequest request) Retrieves the list of firewall rules available to the specified project.
FirewallClient.ListFirewallsPagedResponse	listFirewalls(ProjectName project) Retrieves the list of firewall rules available to the specified project.
FirewallClient.ListFirewallsPagedResponse	listFirewalls(String project) Retrieves the list of firewall rules available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListFirewallsHttpRequest,FirewallList>	listFirewallsCallable() Retrieves the list of firewall rules available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListFirewallsHttpRequest,FirewallClient.ListFirewallsPagedResponse>	listFirewallsPagedCallable() Retrieves the list of firewall rules available to the specified project.
Operation	patchFirewall(PatchFirewallHttpRequest request) Updates the specified firewall rule with the data included in the request.
Operation	patchFirewall(ProjectGlobalFirewallName firewall, Firewall firewallResource, List<String> fieldMask) Updates the specified firewall rule with the data included in the request.
Operation	patchFirewall(String firewall, Firewall firewallResource, List<String> fieldMask) Updates the specified firewall rule with the data included in the request.
com.google.api.gax.rpc.UnaryCallable<PatchFirewallHttpRequest,Operation>	patchFirewallCallable() Updates the specified firewall rule with the data included in the request.
void	shutdown()
void	shutdownNow()
Operation	updateFirewall(ProjectGlobalFirewallName firewall, Firewall firewallResource, List<String> fieldMask) Updates the specified firewall rule with the data included in the request.
Operation	updateFirewall(String firewall, Firewall firewallResource, List<String> fieldMask) Updates the specified firewall rule with the data included in the request.
Operation	updateFirewall(UpdateFirewallHttpRequest request) Updates the specified firewall rule with the data included in the request.
com.google.api.gax.rpc.UnaryCallable<UpdateFirewallHttpRequest,Operation>	updateFirewallCallable() Updates the specified firewall rule with the data included in the request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FirewallClient

protected FirewallClient(FirewallSettings settings)
                  throws IOException

Constructs an instance of FirewallClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

FirewallClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected FirewallClient(FirewallStub stub)

Method Detail

create

public static final FirewallClient create()
                                   throws IOException

Constructs an instance of FirewallClient with default settings.

Throws:

IOException

create

public static final FirewallClient create(FirewallSettings settings)
                                   throws IOException

Constructs an instance of FirewallClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final FirewallClient create(FirewallStub stub)

Constructs an instance of FirewallClient, using the given stub for making calls. This is for advanced usage - prefer to use FirewallSettings}.

getSettings

public final FirewallSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public FirewallStub getStub()

deleteFirewall

@BetaApi
public final Operation deleteFirewall(ProjectGlobalFirewallName firewall)

Deletes the specified firewall.

Sample code:

 try (FirewallClient firewallClient = FirewallClient.create()) {
   ProjectGlobalFirewallName firewall = ProjectGlobalFirewallName.of("[PROJECT]", "[FIREWALL]");
   Operation response = firewallClient.deleteFirewall(firewall);
 }
 

Parameters:

firewall - Name of the firewall rule to delete.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteFirewall

@BetaApi
public final Operation deleteFirewall(String firewall)

Deletes the specified firewall.

Sample code:

 try (FirewallClient firewallClient = FirewallClient.create()) {
   ProjectGlobalFirewallName firewall = ProjectGlobalFirewallName.of("[PROJECT]", "[FIREWALL]");
   Operation response = firewallClient.deleteFirewall(firewall.toString());
 }
 

Parameters:

firewall - Name of the firewall rule to delete.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteFirewall

@BetaApi
public final Operation deleteFirewall(DeleteFirewallHttpRequest request)

Deletes the specified firewall.

Sample code:

 try (FirewallClient firewallClient = FirewallClient.create()) {
   String formattedFirewall = ProjectGlobalFirewallName.format("[PROJECT]", "[FIREWALL]");
   DeleteFirewallHttpRequest request = DeleteFirewallHttpRequest.newBuilder()
     .setFirewall(formattedFirewall)
     .build();
   Operation response = firewallClient.deleteFirewall(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteFirewallCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<DeleteFirewallHttpRequest,Operation> deleteFirewallCallable()

Deletes the specified firewall.

Sample code:

 try (FirewallClient firewallClient = FirewallClient.create()) {
   String formattedFirewall = ProjectGlobalFirewallName.format("[PROJECT]", "[FIREWALL]");
   DeleteFirewallHttpRequest request = DeleteFirewallHttpRequest.newBuilder()
     .setFirewall(formattedFirewall)
     .build();
   ApiFuture<Operation> future = firewallClient.deleteFirewallCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

getFirewall

@BetaApi
public final Firewall getFirewall(ProjectGlobalFirewallName firewall)

Returns the specified firewall.

Sample code:

 try (FirewallClient firewallClient = FirewallClient.create()) {
   ProjectGlobalFirewallName firewall = ProjectGlobalFirewallName.of("[PROJECT]", "[FIREWALL]");
   Firewall response = firewallClient.getFirewall(firewall);
 }
 

Parameters:

firewall - Name of the firewall rule to return.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getFirewall

@BetaApi
public final Firewall getFirewall(String firewall)

Returns the specified firewall.

Sample code:

 try (FirewallClient firewallClient = FirewallClient.create()) {
   ProjectGlobalFirewallName firewall = ProjectGlobalFirewallName.of("[PROJECT]", "[FIREWALL]");
   Firewall response = firewallClient.getFirewall(firewall.toString());
 }
 

Parameters:

firewall - Name of the firewall rule to return.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getFirewall

@BetaApi
public final Firewall getFirewall(GetFirewallHttpRequest request)

Returns the specified firewall.

Sample code:

 try (FirewallClient firewallClient = FirewallClient.create()) {
   String formattedFirewall = ProjectGlobalFirewallName.format("[PROJECT]", "[FIREWALL]");
   GetFirewallHttpRequest request = GetFirewallHttpRequest.newBuilder()
     .setFirewall(formattedFirewall)
     .build();
   Firewall response = firewallClient.getFirewall(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getFirewallCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetFirewallHttpRequest,Firewall> getFirewallCallable()

Returns the specified firewall.

Sample code:

 try (FirewallClient firewallClient = FirewallClient.create()) {
   String formattedFirewall = ProjectGlobalFirewallName.format("[PROJECT]", "[FIREWALL]");
   GetFirewallHttpRequest request = GetFirewallHttpRequest.newBuilder()
     .setFirewall(formattedFirewall)
     .build();
   ApiFuture<Firewall> future = firewallClient.getFirewallCallable().futureCall(request);
   // Do something
   Firewall response = future.get();
 }
 

insertFirewall

@BetaApi
public final Operation insertFirewall(ProjectName project,
                                               Firewall firewallResource)

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

Sample code:

 try (FirewallClient firewallClient = FirewallClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   Firewall firewallResource = Firewall.newBuilder().build();
   Operation response = firewallClient.insertFirewall(project, firewallResource);
 }
 

Parameters:

project - Project ID for this request.

firewallResource - Represents a Firewall Rule resource.

Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

insertFirewall

@BetaApi
public final Operation insertFirewall(String project,
                                               Firewall firewallResource)

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

Sample code:

 try (FirewallClient firewallClient = FirewallClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   Firewall firewallResource = Firewall.newBuilder().build();
   Operation response = firewallClient.insertFirewall(project.toString(), firewallResource);
 }
 

Parameters:

project - Project ID for this request.

firewallResource - Represents a Firewall Rule resource.

Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

insertFirewall

@BetaApi
public final Operation insertFirewall(InsertFirewallHttpRequest request)

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

Sample code:

 try (FirewallClient firewallClient = FirewallClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   Firewall firewallResource = Firewall.newBuilder().build();
   InsertFirewallHttpRequest request = InsertFirewallHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setFirewallResource(firewallResource)
     .build();
   Operation response = firewallClient.insertFirewall(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

insertFirewallCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<InsertFirewallHttpRequest,Operation> insertFirewallCallable()

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

Sample code:

 try (FirewallClient firewallClient = FirewallClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   Firewall firewallResource = Firewall.newBuilder().build();
   InsertFirewallHttpRequest request = InsertFirewallHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setFirewallResource(firewallResource)
     .build();
   ApiFuture<Operation> future = firewallClient.insertFirewallCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

listFirewalls

@BetaApi
public final FirewallClient.ListFirewallsPagedResponse listFirewalls(ProjectName project)

Retrieves the list of firewall rules available to the specified project.

Sample code:

 try (FirewallClient firewallClient = FirewallClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (Firewall element : firewallClient.listFirewalls(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listFirewalls

@BetaApi
public final FirewallClient.ListFirewallsPagedResponse listFirewalls(String project)

Retrieves the list of firewall rules available to the specified project.

Sample code:

 try (FirewallClient firewallClient = FirewallClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (Firewall element : firewallClient.listFirewalls(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listFirewalls

@BetaApi
public final FirewallClient.ListFirewallsPagedResponse listFirewalls(ListFirewallsHttpRequest request)

Retrieves the list of firewall rules available to the specified project.

Sample code:

 try (FirewallClient firewallClient = FirewallClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListFirewallsHttpRequest request = ListFirewallsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (Firewall element : firewallClient.listFirewalls(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listFirewallsPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListFirewallsHttpRequest,FirewallClient.ListFirewallsPagedResponse> listFirewallsPagedCallable()

Retrieves the list of firewall rules available to the specified project.

Sample code:

 try (FirewallClient firewallClient = FirewallClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListFirewallsHttpRequest request = ListFirewallsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<ListFirewallsPagedResponse> future = firewallClient.listFirewallsPagedCallable().futureCall(request);
   // Do something
   for (Firewall element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listFirewallsCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListFirewallsHttpRequest,FirewallList> listFirewallsCallable()

Retrieves the list of firewall rules available to the specified project.

Sample code:

 try (FirewallClient firewallClient = FirewallClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListFirewallsHttpRequest request = ListFirewallsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     FirewallList response = firewallClient.listFirewallsCallable().call(request);
     for (Firewall element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

patchFirewall

@BetaApi
public final Operation patchFirewall(ProjectGlobalFirewallName firewall,
                                              Firewall firewallResource,
                                              List<String> fieldMask)

Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Sample code:

 try (FirewallClient firewallClient = FirewallClient.create()) {
   ProjectGlobalFirewallName firewall = ProjectGlobalFirewallName.of("[PROJECT]", "[FIREWALL]");
   Firewall firewallResource = Firewall.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = firewallClient.patchFirewall(firewall, firewallResource, fieldMask);
 }
 

Parameters:

firewall - Name of the firewall rule to patch.

firewallResource - Represents a Firewall Rule resource.

Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.

fieldMask - The fields that should be serialized (even if they have empty values). If the containing message object has a non-null fieldmask, then all the fields in the field mask (and only those fields in the field mask) will be serialized. If the containing object does not have a fieldmask, then only non-empty fields will be serialized.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

patchFirewall

@BetaApi
public final Operation patchFirewall(String firewall,
                                              Firewall firewallResource,
                                              List<String> fieldMask)

Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Sample code:

 try (FirewallClient firewallClient = FirewallClient.create()) {
   ProjectGlobalFirewallName firewall = ProjectGlobalFirewallName.of("[PROJECT]", "[FIREWALL]");
   Firewall firewallResource = Firewall.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = firewallClient.patchFirewall(firewall.toString(), firewallResource, fieldMask);
 }
 

Parameters:

firewall - Name of the firewall rule to patch.

firewallResource - Represents a Firewall Rule resource.

Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.

fieldMask - The fields that should be serialized (even if they have empty values). If the containing message object has a non-null fieldmask, then all the fields in the field mask (and only those fields in the field mask) will be serialized. If the containing object does not have a fieldmask, then only non-empty fields will be serialized.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

patchFirewall

@BetaApi
public final Operation patchFirewall(PatchFirewallHttpRequest request)

Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Sample code:

 try (FirewallClient firewallClient = FirewallClient.create()) {
   String formattedFirewall = ProjectGlobalFirewallName.format("[PROJECT]", "[FIREWALL]");
   Firewall firewallResource = Firewall.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   PatchFirewallHttpRequest request = PatchFirewallHttpRequest.newBuilder()
     .setFirewall(formattedFirewall)
     .setFirewallResource(firewallResource)
     .addAllFieldMask(fieldMask)
     .build();
   Operation response = firewallClient.patchFirewall(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

patchFirewallCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<PatchFirewallHttpRequest,Operation> patchFirewallCallable()

Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Sample code:

 try (FirewallClient firewallClient = FirewallClient.create()) {
   String formattedFirewall = ProjectGlobalFirewallName.format("[PROJECT]", "[FIREWALL]");
   Firewall firewallResource = Firewall.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   PatchFirewallHttpRequest request = PatchFirewallHttpRequest.newBuilder()
     .setFirewall(formattedFirewall)
     .setFirewallResource(firewallResource)
     .addAllFieldMask(fieldMask)
     .build();
   ApiFuture<Operation> future = firewallClient.patchFirewallCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

updateFirewall

@BetaApi
public final Operation updateFirewall(ProjectGlobalFirewallName firewall,
                                               Firewall firewallResource,
                                               List<String> fieldMask)

Updates the specified firewall rule with the data included in the request. The PUT method can only update the following fields of firewall rule: allowed, description, sourceRanges, sourceTags, targetTags.

Sample code:

 try (FirewallClient firewallClient = FirewallClient.create()) {
   ProjectGlobalFirewallName firewall = ProjectGlobalFirewallName.of("[PROJECT]", "[FIREWALL]");
   Firewall firewallResource = Firewall.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = firewallClient.updateFirewall(firewall, firewallResource, fieldMask);
 }
 

Parameters:

firewall - Name of the firewall rule to update.

firewallResource - Represents a Firewall Rule resource.

Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.

fieldMask - The fields that should be serialized (even if they have empty values). If the containing message object has a non-null fieldmask, then all the fields in the field mask (and only those fields in the field mask) will be serialized. If the containing object does not have a fieldmask, then only non-empty fields will be serialized.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateFirewall

@BetaApi
public final Operation updateFirewall(String firewall,
                                               Firewall firewallResource,
                                               List<String> fieldMask)

Updates the specified firewall rule with the data included in the request. The PUT method can only update the following fields of firewall rule: allowed, description, sourceRanges, sourceTags, targetTags.

Sample code:

 try (FirewallClient firewallClient = FirewallClient.create()) {
   ProjectGlobalFirewallName firewall = ProjectGlobalFirewallName.of("[PROJECT]", "[FIREWALL]");
   Firewall firewallResource = Firewall.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = firewallClient.updateFirewall(firewall.toString(), firewallResource, fieldMask);
 }
 

Parameters:

firewall - Name of the firewall rule to update.

firewallResource - Represents a Firewall Rule resource.

Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.

fieldMask - The fields that should be serialized (even if they have empty values). If the containing message object has a non-null fieldmask, then all the fields in the field mask (and only those fields in the field mask) will be serialized. If the containing object does not have a fieldmask, then only non-empty fields will be serialized.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateFirewall

@BetaApi
public final Operation updateFirewall(UpdateFirewallHttpRequest request)

Updates the specified firewall rule with the data included in the request. The PUT method can only update the following fields of firewall rule: allowed, description, sourceRanges, sourceTags, targetTags.

Sample code:

 try (FirewallClient firewallClient = FirewallClient.create()) {
   String formattedFirewall = ProjectGlobalFirewallName.format("[PROJECT]", "[FIREWALL]");
   Firewall firewallResource = Firewall.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   UpdateFirewallHttpRequest request = UpdateFirewallHttpRequest.newBuilder()
     .setFirewall(formattedFirewall)
     .setFirewallResource(firewallResource)
     .addAllFieldMask(fieldMask)
     .build();
   Operation response = firewallClient.updateFirewall(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateFirewallCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<UpdateFirewallHttpRequest,Operation> updateFirewallCallable()

Updates the specified firewall rule with the data included in the request. The PUT method can only update the following fields of firewall rule: allowed, description, sourceRanges, sourceTags, targetTags.

Sample code:

 try (FirewallClient firewallClient = FirewallClient.create()) {
   String formattedFirewall = ProjectGlobalFirewallName.format("[PROJECT]", "[FIREWALL]");
   Firewall firewallResource = Firewall.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   UpdateFirewallHttpRequest request = UpdateFirewallHttpRequest.newBuilder()
     .setFirewall(formattedFirewall)
     .setFirewallResource(firewallResource)
     .addAllFieldMask(fieldMask)
     .build();
   ApiFuture<Operation> future = firewallClient.updateFirewallCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException