Class FirewallsClient (1.9.1)

Version 1.9.1

• 1.64.0 (latest)
• 1.63.0
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

public class FirewallsClient implements BackgroundResource

Service Description: The Firewalls API.

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 (FirewallsClient firewallsClient = FirewallsClient.create()) {
   String project = "project-309310695";
   String firewall = "firewall-562725632";
   Firewall response = firewallsClient.get(project, firewall);
 }
 

Note: close() needs to be called on the FirewallsClient 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 FirewallsSettings to create(). For example:

To customize credentials:

 FirewallsSettings firewallsSettings =
     FirewallsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 FirewallsClient firewallsClient = FirewallsClient.create(firewallsSettings);
 

To customize the endpoint:

 FirewallsSettings firewallsSettings =
     FirewallsSettings.newBuilder().setEndpoint(myEndpoint).build();
 FirewallsClient firewallsClient = FirewallsClient.create(firewallsSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > FirewallsClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final FirewallsClient create()

Constructs an instance of FirewallsClient with default settings.

Returns

Type	Description
FirewallsClient

Exceptions

Type	Description
IOException

create(FirewallsSettings settings)

public static final FirewallsClient create(FirewallsSettings settings)

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

Parameter

Name	Description
settings	FirewallsSettings

Returns

Type	Description
FirewallsClient

Exceptions

Type	Description
IOException

create(FirewallsStub stub)

public static final FirewallsClient create(FirewallsStub stub)

Constructs an instance of FirewallsClient, using the given stub for making calls. This is for advanced usage - prefer using create(FirewallsSettings).

Parameter

Name	Description
stub	FirewallsStub

Returns

Type	Description
FirewallsClient

Constructors

FirewallsClient(FirewallsSettings settings)

protected FirewallsClient(FirewallsSettings settings)

Constructs an instance of FirewallsClient, 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.

Parameter

Name	Description
settings	FirewallsSettings

FirewallsClient(FirewallsStub stub)

protected FirewallsClient(FirewallsStub stub)

Parameter

Name	Description
stub	FirewallsStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters

Name	Description
duration	long
unit	TimeUnit

Returns

Type	Description
boolean

Exceptions

Type	Description
InterruptedException

close()

public final void close()

deleteAsync(DeleteFirewallRequest request)

public final OperationFuture<Operation,Operation> deleteAsync(DeleteFirewallRequest request)

Deletes the specified firewall.

Sample code:

 try (FirewallsClient firewallsClient = FirewallsClient.create()) {
   DeleteFirewallRequest request =
       DeleteFirewallRequest.newBuilder()
           .setFirewall("firewall-562725632")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   Operation response = firewallsClient.deleteAsync(request).get();
 }
 

Parameter

Name	Description
request	DeleteFirewallRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String firewall)

public final OperationFuture<Operation,Operation> deleteAsync(String project, String firewall)

Deletes the specified firewall.

Sample code:

 try (FirewallsClient firewallsClient = FirewallsClient.create()) {
   String project = "project-309310695";
   String firewall = "firewall-562725632";
   Operation response = firewallsClient.deleteAsync(project, firewall).get();
 }
 

Parameters

Name	Description
project	String Project ID for this request.
firewall	String Name of the firewall rule to delete.

Returns

Type	Description
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteFirewallRequest,Operation> deleteCallable()

Deletes the specified firewall.

Sample code:

 try (FirewallsClient firewallsClient = FirewallsClient.create()) {
   DeleteFirewallRequest request =
       DeleteFirewallRequest.newBuilder()
           .setFirewall("firewall-562725632")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = firewallsClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<DeleteFirewallRequest,Operation>

deleteOperationCallable()

public final OperationCallable<DeleteFirewallRequest,Operation,Operation> deleteOperationCallable()

Deletes the specified firewall.

Sample code:

 try (FirewallsClient firewallsClient = FirewallsClient.create()) {
   DeleteFirewallRequest request =
       DeleteFirewallRequest.newBuilder()
           .setFirewall("firewall-562725632")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       firewallsClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
OperationCallable<DeleteFirewallRequest,Operation,Operation>

get(GetFirewallRequest request)

public final Firewall get(GetFirewallRequest request)

Returns the specified firewall.

Sample code:

 try (FirewallsClient firewallsClient = FirewallsClient.create()) {
   GetFirewallRequest request =
       GetFirewallRequest.newBuilder()
           .setFirewall("firewall-562725632")
           .setProject("project-309310695")
           .build();
   Firewall response = firewallsClient.get(request);
 }
 

Parameter

Name	Description
request	GetFirewallRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Firewall

get(String project, String firewall)

public final Firewall get(String project, String firewall)

Returns the specified firewall.

Sample code:

 try (FirewallsClient firewallsClient = FirewallsClient.create()) {
   String project = "project-309310695";
   String firewall = "firewall-562725632";
   Firewall response = firewallsClient.get(project, firewall);
 }
 

Parameters

Name	Description
project	String Project ID for this request.
firewall	String Name of the firewall rule to return.

Returns

Type	Description
Firewall

getCallable()

public final UnaryCallable<GetFirewallRequest,Firewall> getCallable()

Returns the specified firewall.

Sample code:

 try (FirewallsClient firewallsClient = FirewallsClient.create()) {
   GetFirewallRequest request =
       GetFirewallRequest.newBuilder()
           .setFirewall("firewall-562725632")
           .setProject("project-309310695")
           .build();
   ApiFuture<Firewall> future = firewallsClient.getCallable().futureCall(request);
   // Do something.
   Firewall response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<GetFirewallRequest,Firewall>

getSettings()

public final FirewallsSettings getSettings()

Returns

Type	Description
FirewallsSettings

getStub()

public FirewallsStub getStub()

Returns

Type	Description
FirewallsStub

insertAsync(InsertFirewallRequest request)

public final OperationFuture<Operation,Operation> insertAsync(InsertFirewallRequest request)

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

Sample code:

 try (FirewallsClient firewallsClient = FirewallsClient.create()) {
   InsertFirewallRequest request =
       InsertFirewallRequest.newBuilder()
           .setFirewallResource(Firewall.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   Operation response = firewallsClient.insertAsync(request).get();
 }
 

Parameter

Name	Description
request	InsertFirewallRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Operation,Operation>

insertAsync(String project, Firewall firewallResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, Firewall firewallResource)

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

Sample code:

 try (FirewallsClient firewallsClient = FirewallsClient.create()) {
   String project = "project-309310695";
   Firewall firewallResource = Firewall.newBuilder().build();
   Operation response = firewallsClient.insertAsync(project, firewallResource).get();
 }
 

Parameters

Name	Description
project	String Project ID for this request.
firewallResource	Firewall The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertFirewallRequest,Operation> insertCallable()

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

Sample code:

 try (FirewallsClient firewallsClient = FirewallsClient.create()) {
   InsertFirewallRequest request =
       InsertFirewallRequest.newBuilder()
           .setFirewallResource(Firewall.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = firewallsClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<InsertFirewallRequest,Operation>

insertOperationCallable()

public final OperationCallable<InsertFirewallRequest,Operation,Operation> insertOperationCallable()

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

Sample code:

 try (FirewallsClient firewallsClient = FirewallsClient.create()) {
   InsertFirewallRequest request =
       InsertFirewallRequest.newBuilder()
           .setFirewallResource(Firewall.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       firewallsClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
OperationCallable<InsertFirewallRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

list(ListFirewallsRequest request)

public final FirewallsClient.ListPagedResponse list(ListFirewallsRequest request)

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

Sample code:

 try (FirewallsClient firewallsClient = FirewallsClient.create()) {
   ListFirewallsRequest request =
       ListFirewallsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (Firewall element : firewallsClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListFirewallsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
FirewallsClient.ListPagedResponse

list(String project)

public final FirewallsClient.ListPagedResponse list(String project)

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

Sample code:

 try (FirewallsClient firewallsClient = FirewallsClient.create()) {
   String project = "project-309310695";
   for (Firewall element : firewallsClient.list(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
project	String Project ID for this request.

Returns

Type	Description
FirewallsClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListFirewallsRequest,FirewallList> listCallable()

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

Sample code:

 try (FirewallsClient firewallsClient = FirewallsClient.create()) {
   ListFirewallsRequest request =
       ListFirewallsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     FirewallList response = firewallsClient.listCallable().call(request);
     for (Firewall element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListFirewallsRequest,FirewallList>

listPagedCallable()

public final UnaryCallable<ListFirewallsRequest,FirewallsClient.ListPagedResponse> listPagedCallable()

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

Sample code:

 try (FirewallsClient firewallsClient = FirewallsClient.create()) {
   ListFirewallsRequest request =
       ListFirewallsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<Firewall> future = firewallsClient.listPagedCallable().futureCall(request);
   // Do something.
   for (Firewall element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListFirewallsRequest,ListPagedResponse>

patchAsync(PatchFirewallRequest request)

public final OperationFuture<Operation,Operation> patchAsync(PatchFirewallRequest 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 (FirewallsClient firewallsClient = FirewallsClient.create()) {
   PatchFirewallRequest request =
       PatchFirewallRequest.newBuilder()
           .setFirewall("firewall-562725632")
           .setFirewallResource(Firewall.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   Operation response = firewallsClient.patchAsync(request).get();
 }
 

Parameter

Name	Description
request	PatchFirewallRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Operation,Operation>

patchAsync(String project, String firewall, Firewall firewallResource)

public final OperationFuture<Operation,Operation> patchAsync(String project, String firewall, Firewall firewallResource)

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 (FirewallsClient firewallsClient = FirewallsClient.create()) {
   String project = "project-309310695";
   String firewall = "firewall-562725632";
   Firewall firewallResource = Firewall.newBuilder().build();
   Operation response = firewallsClient.patchAsync(project, firewall, firewallResource).get();
 }
 

Parameters

Name	Description
project	String Project ID for this request.
firewall	String Name of the firewall rule to patch.
firewallResource	Firewall The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

patchCallable()

public final UnaryCallable<PatchFirewallRequest,Operation> patchCallable()

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 (FirewallsClient firewallsClient = FirewallsClient.create()) {
   PatchFirewallRequest request =
       PatchFirewallRequest.newBuilder()
           .setFirewall("firewall-562725632")
           .setFirewallResource(Firewall.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = firewallsClient.patchCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<PatchFirewallRequest,Operation>

patchOperationCallable()

public final OperationCallable<PatchFirewallRequest,Operation,Operation> patchOperationCallable()

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 (FirewallsClient firewallsClient = FirewallsClient.create()) {
   PatchFirewallRequest request =
       PatchFirewallRequest.newBuilder()
           .setFirewall("firewall-562725632")
           .setFirewallResource(Firewall.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       firewallsClient.patchOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
OperationCallable<PatchFirewallRequest,Operation,Operation>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateAsync(UpdateFirewallRequest request)

public final OperationFuture<Operation,Operation> updateAsync(UpdateFirewallRequest request)

Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead.

Sample code:

 try (FirewallsClient firewallsClient = FirewallsClient.create()) {
   UpdateFirewallRequest request =
       UpdateFirewallRequest.newBuilder()
           .setFirewall("firewall-562725632")
           .setFirewallResource(Firewall.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   Operation response = firewallsClient.updateAsync(request).get();
 }
 

Parameter

Name	Description
request	UpdateFirewallRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Operation,Operation>

updateAsync(String project, String firewall, Firewall firewallResource)

public final OperationFuture<Operation,Operation> updateAsync(String project, String firewall, Firewall firewallResource)

Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead.

Sample code:

 try (FirewallsClient firewallsClient = FirewallsClient.create()) {
   String project = "project-309310695";
   String firewall = "firewall-562725632";
   Firewall firewallResource = Firewall.newBuilder().build();
   Operation response = firewallsClient.updateAsync(project, firewall, firewallResource).get();
 }
 

Parameters

Name	Description
project	String Project ID for this request.
firewall	String Name of the firewall rule to update.
firewallResource	Firewall The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

updateCallable()

public final UnaryCallable<UpdateFirewallRequest,Operation> updateCallable()

Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead.

Sample code:

 try (FirewallsClient firewallsClient = FirewallsClient.create()) {
   UpdateFirewallRequest request =
       UpdateFirewallRequest.newBuilder()
           .setFirewall("firewall-562725632")
           .setFirewallResource(Firewall.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = firewallsClient.updateCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<UpdateFirewallRequest,Operation>

updateOperationCallable()

public final OperationCallable<UpdateFirewallRequest,Operation,Operation> updateOperationCallable()

Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead.

Sample code:

 try (FirewallsClient firewallsClient = FirewallsClient.create()) {
   UpdateFirewallRequest request =
       UpdateFirewallRequest.newBuilder()
           .setFirewall("firewall-562725632")
           .setFirewallResource(Firewall.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       firewallsClient.updateOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
OperationCallable<UpdateFirewallRequest,Operation,Operation>