Class FirewallsClient
- java.lang.Object
-
- com.google.cloud.compute.v1.FirewallsClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@Generated("by gapic-generator-java") public class FirewallsClient extends Object implements com.google.api.gax.core.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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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:
- 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.
- 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.
- 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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library FirewallsSettings firewallsSettings = FirewallsSettings.newBuilder() .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials)) .build(); FirewallsClient firewallsClient = FirewallsClient.create(firewallsSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
FirewallsClient.ListFixedSizeCollection
static class
FirewallsClient.ListPage
static class
FirewallsClient.ListPagedResponse
-
Constructor Summary
Constructors Modifier Constructor Description protected
FirewallsClient(FirewallsSettings settings)
Constructs an instance of FirewallsClient, using the given settings.protected
FirewallsClient(FirewallsStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
awaitTermination(long duration, TimeUnit unit)
void
close()
static FirewallsClient
create()
Constructs an instance of FirewallsClient with default settings.static FirewallsClient
create(FirewallsSettings settings)
Constructs an instance of FirewallsClient, using the given settings.static FirewallsClient
create(FirewallsStub stub)
Constructs an instance of FirewallsClient, using the given stub for making calls.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
deleteAsync(DeleteFirewallRequest request)
Deletes the specified firewall.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
deleteAsync(String project, String firewall)
Deletes the specified firewall.com.google.api.gax.rpc.UnaryCallable<DeleteFirewallRequest,Operation>
deleteCallable()
Deletes the specified firewall.com.google.api.gax.rpc.OperationCallable<DeleteFirewallRequest,Operation,Operation>
deleteOperationCallable()
Deletes the specified firewall.Firewall
get(GetFirewallRequest request)
Returns the specified firewall.Firewall
get(String project, String firewall)
Returns the specified firewall.com.google.api.gax.rpc.UnaryCallable<GetFirewallRequest,Firewall>
getCallable()
Returns the specified firewall.FirewallsSettings
getSettings()
FirewallsStub
getStub()
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
insertAsync(InsertFirewallRequest request)
Creates a firewall rule in the specified project using the data included in the request.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
insertAsync(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<InsertFirewallRequest,Operation>
insertCallable()
Creates a firewall rule in the specified project using the data included in the request.com.google.api.gax.rpc.OperationCallable<InsertFirewallRequest,Operation,Operation>
insertOperationCallable()
Creates a firewall rule in the specified project using the data included in the request.boolean
isShutdown()
boolean
isTerminated()
FirewallsClient.ListPagedResponse
list(ListFirewallsRequest request)
Retrieves the list of firewall rules available to the specified project.FirewallsClient.ListPagedResponse
list(String project)
Retrieves the list of firewall rules available to the specified project.com.google.api.gax.rpc.UnaryCallable<ListFirewallsRequest,FirewallList>
listCallable()
Retrieves the list of firewall rules available to the specified project.com.google.api.gax.rpc.UnaryCallable<ListFirewallsRequest,FirewallsClient.ListPagedResponse>
listPagedCallable()
Retrieves the list of firewall rules available to the specified project.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
patchAsync(PatchFirewallRequest request)
Updates the specified firewall rule with the data included in the request.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
patchAsync(String project, String firewall, Firewall firewallResource)
Updates the specified firewall rule with the data included in the request.com.google.api.gax.rpc.UnaryCallable<PatchFirewallRequest,Operation>
patchCallable()
Updates the specified firewall rule with the data included in the request.com.google.api.gax.rpc.OperationCallable<PatchFirewallRequest,Operation,Operation>
patchOperationCallable()
Updates the specified firewall rule with the data included in the request.void
shutdown()
void
shutdownNow()
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
updateAsync(UpdateFirewallRequest request)
Updates the specified firewall rule with the data included in the request.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
updateAsync(String project, String firewall, Firewall firewallResource)
Updates the specified firewall rule with the data included in the request.com.google.api.gax.rpc.UnaryCallable<UpdateFirewallRequest,Operation>
updateCallable()
Updates the specified firewall rule with the data included in the request.com.google.api.gax.rpc.OperationCallable<UpdateFirewallRequest,Operation,Operation>
updateOperationCallable()
Updates the specified firewall rule with the data included in the request.
-
-
-
Constructor Detail
-
FirewallsClient
protected FirewallsClient(FirewallsSettings settings) throws IOException
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.- Throws:
IOException
-
FirewallsClient
protected FirewallsClient(FirewallsStub stub)
-
-
Method Detail
-
create
public static final FirewallsClient create() throws IOException
Constructs an instance of FirewallsClient with default settings.- Throws:
IOException
-
create
public static final FirewallsClient create(FirewallsSettings settings) throws IOException
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.- Throws:
IOException
-
create
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).
-
getSettings
public final FirewallsSettings getSettings()
-
getStub
public FirewallsStub getStub()
-
deleteAsync
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> deleteAsync(String project, String firewall)
Deletes the specified firewall.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (FirewallsClient firewallsClient = FirewallsClient.create()) { String project = "project-309310695"; String firewall = "firewall-562725632"; Operation response = firewallsClient.deleteAsync(project, firewall).get(); }
- Parameters:
project
- Project ID for this request.firewall
- Name of the firewall rule to delete.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> deleteAsync(DeleteFirewallRequest request)
Deletes the specified firewall.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (FirewallsClient firewallsClient = FirewallsClient.create()) { DeleteFirewallRequest request = DeleteFirewallRequest.newBuilder() .setFirewall("firewall-562725632") .setProject("project-309310695") .setRequestId("requestId693933066") .build(); Operation response = firewallsClient.deleteAsync(request).get(); }
- 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
-
deleteOperationCallable
public final com.google.api.gax.rpc.OperationCallable<DeleteFirewallRequest,Operation,Operation> deleteOperationCallable()
Deletes the specified firewall.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
-
deleteCallable
public final com.google.api.gax.rpc.UnaryCallable<DeleteFirewallRequest,Operation> deleteCallable()
Deletes the specified firewall.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
-
get
public final Firewall get(String project, String firewall)
Returns the specified firewall.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (FirewallsClient firewallsClient = FirewallsClient.create()) { String project = "project-309310695"; String firewall = "firewall-562725632"; Firewall response = firewallsClient.get(project, firewall); }
- Parameters:
project
- Project ID for this request.firewall
- Name of the firewall rule to return.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
get
public final Firewall get(GetFirewallRequest request)
Returns the specified firewall.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (FirewallsClient firewallsClient = FirewallsClient.create()) { GetFirewallRequest request = GetFirewallRequest.newBuilder() .setFirewall("firewall-562725632") .setProject("project-309310695") .build(); Firewall response = firewallsClient.get(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
-
getCallable
public final com.google.api.gax.rpc.UnaryCallable<GetFirewallRequest,Firewall> getCallable()
Returns the specified firewall.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
-
insertAsync
public final com.google.api.gax.longrunning.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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (FirewallsClient firewallsClient = FirewallsClient.create()) { String project = "project-309310695"; Firewall firewallResource = Firewall.newBuilder().build(); Operation response = firewallsClient.insertAsync(project, firewallResource).get(); }
- Parameters:
project
- Project ID for this request.firewallResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
insertAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> insertAsync(InsertFirewallRequest request)
Creates a firewall rule in the specified project using the data included in the request.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
- 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
-
insertOperationCallable
public final com.google.api.gax.rpc.OperationCallable<InsertFirewallRequest,Operation,Operation> insertOperationCallable()
Creates a firewall rule in the specified project using the data included in the request.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
-
insertCallable
public final com.google.api.gax.rpc.UnaryCallable<InsertFirewallRequest,Operation> insertCallable()
Creates a firewall rule in the specified project using the data included in the request.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
-
list
public final FirewallsClient.ListPagedResponse list(String project)
Retrieves the list of firewall rules available to the specified project.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (FirewallsClient firewallsClient = FirewallsClient.create()) { String project = "project-309310695"; for (Firewall element : firewallsClient.list(project).iterateAll()) { // doThingsWith(element); } }
- Parameters:
project
- Project ID for this request.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
list
public final FirewallsClient.ListPagedResponse list(ListFirewallsRequest request)
Retrieves the list of firewall rules available to the specified project.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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); } }
- 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
-
listPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListFirewallsRequest,FirewallsClient.ListPagedResponse> listPagedCallable()
Retrieves the list of firewall rules available to the specified project.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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); } }
-
listCallable
public final com.google.api.gax.rpc.UnaryCallable<ListFirewallsRequest,FirewallList> listCallable()
Retrieves the list of firewall rules available to the specified project.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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.getItemsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
patchAsync
public final com.google.api.gax.longrunning.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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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:
project
- Project ID for this request.firewall
- Name of the firewall rule to patch.firewallResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
patchAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
- 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
-
patchOperationCallable
public final com.google.api.gax.rpc.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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
-
patchCallable
public final com.google.api.gax.rpc.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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
-
updateAsync
public final com.google.api.gax.longrunning.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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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:
project
- Project ID for this request.firewall
- Name of the firewall rule to update.firewallResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
- 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
-
updateOperationCallable
public final com.google.api.gax.rpc.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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
-
updateCallable
public final com.google.api.gax.rpc.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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
InterruptedException
-
-