SecurityPoliciesClient (Google Compute Engine 1.59.0 API)

java.lang.Object
- com.google.cloud.compute.v1.SecurityPoliciesClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

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

Service Description: The SecurityPolicies 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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   String project = "project-309310695";
   String securityPolicy = "securityPolicy-788621166";
   SecurityPolicy response = securityPoliciesClient.get(project, securityPolicy);
 }

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

Methods
Method	Description	Method Variants
AddRule	Inserts a rule into a security policy.	Request object method variants only take one parameter, a request object, which must be constructed before the call. addRuleAsync(AddRuleSecurityPolicyRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. addRuleAsync(String project, String securityPolicy, SecurityPolicyRule securityPolicyRuleResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. addRuleOperationCallable() addRuleCallable()
AggregatedList	Retrieves the list of all SecurityPolicy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.	Request object method variants only take one parameter, a request object, which must be constructed before the call. aggregatedList(AggregatedListSecurityPoliciesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. aggregatedList(String project) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. aggregatedListPagedCallable() aggregatedListCallable()
Delete	Deletes the specified policy.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteAsync(DeleteSecurityPolicyRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteAsync(String project, String securityPolicy) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteOperationCallable() deleteCallable()
Get	List all of the ordered rules present in a single specified policy.	Request object method variants only take one parameter, a request object, which must be constructed before the call. get(GetSecurityPolicyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. get(String project, String securityPolicy) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getCallable()
GetRule	Gets a rule at the specified priority.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getRule(GetRuleSecurityPolicyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getRule(String project, String securityPolicy) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getRuleCallable()
Insert	Creates a new policy in the specified project using the data included in the request.	Request object method variants only take one parameter, a request object, which must be constructed before the call. insertAsync(InsertSecurityPolicyRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. insertAsync(String project, SecurityPolicy securityPolicyResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. insertOperationCallable() insertCallable()
List	List all the policies that have been configured for the specified project.	Request object method variants only take one parameter, a request object, which must be constructed before the call. list(ListSecurityPoliciesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. list(String project) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listPagedCallable() listCallable()
ListPreconfiguredExpressionSets	Gets the current list of preconfigured Web Application Firewall (WAF) expressions.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listPreconfiguredExpressionSets(ListPreconfiguredExpressionSetsSecurityPoliciesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listPreconfiguredExpressionSets(String project) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listPreconfiguredExpressionSetsCallable()
Patch	Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.	Request object method variants only take one parameter, a request object, which must be constructed before the call. patchAsync(PatchSecurityPolicyRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. patchAsync(String project, String securityPolicy, SecurityPolicy securityPolicyResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. patchOperationCallable() patchCallable()
PatchRule	Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.	Request object method variants only take one parameter, a request object, which must be constructed before the call. patchRuleAsync(PatchRuleSecurityPolicyRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. patchRuleAsync(String project, String securityPolicy, SecurityPolicyRule securityPolicyRuleResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. patchRuleOperationCallable() patchRuleCallable()
RemoveRule	Deletes a rule at the specified priority.	Request object method variants only take one parameter, a request object, which must be constructed before the call. removeRuleAsync(RemoveRuleSecurityPolicyRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. removeRuleAsync(String project, String securityPolicy) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. removeRuleOperationCallable() removeRuleCallable()
SetLabels	Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation.	Request object method variants only take one parameter, a request object, which must be constructed before the call. setLabelsAsync(SetLabelsSecurityPolicyRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. setLabelsAsync(String project, String resource, GlobalSetLabelsRequest globalSetLabelsRequestResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setLabelsOperationCallable() setLabelsCallable()

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 SecurityPoliciesSettings 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
 SecurityPoliciesSettings securityPoliciesSettings =
     SecurityPoliciesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SecurityPoliciesClient securityPoliciesClient =
     SecurityPoliciesClient.create(securityPoliciesSettings);

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
 SecurityPoliciesSettings securityPoliciesSettings =
     SecurityPoliciesSettings.newBuilder().setEndpoint(myEndpoint).build();
 SecurityPoliciesClient securityPoliciesClient =
     SecurityPoliciesClient.create(securityPoliciesSettings);

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SecurityPoliciesClient.AggregatedListFixedSizeCollection`
`static class`	`SecurityPoliciesClient.AggregatedListPage`
`static class`	`SecurityPoliciesClient.AggregatedListPagedResponse`
`static class`	`SecurityPoliciesClient.ListFixedSizeCollection`
`static class`	`SecurityPoliciesClient.ListPage`
`static class`	`SecurityPoliciesClient.ListPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`SecurityPoliciesClient(SecurityPoliciesSettings settings)` Constructs an instance of SecurityPoliciesClient, using the given settings.
`protected`	`SecurityPoliciesClient(SecurityPoliciesStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`addRuleAsync(AddRuleSecurityPolicyRequest request)` Inserts a rule into a security policy.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`addRuleAsync(String project, String securityPolicy, SecurityPolicyRule securityPolicyRuleResource)` Inserts a rule into a security policy.
`com.google.api.gax.rpc.UnaryCallable<AddRuleSecurityPolicyRequest,Operation>`	`addRuleCallable()` Inserts a rule into a security policy.
`com.google.api.gax.rpc.OperationCallable<AddRuleSecurityPolicyRequest,Operation,Operation>`	`addRuleOperationCallable()` Inserts a rule into a security policy.
`SecurityPoliciesClient.AggregatedListPagedResponse`	`aggregatedList(AggregatedListSecurityPoliciesRequest request)` Retrieves the list of all SecurityPolicy resources, regional and global, available to the specified project.
`SecurityPoliciesClient.AggregatedListPagedResponse`	`aggregatedList(String project)` Retrieves the list of all SecurityPolicy resources, regional and global, available to the specified project.
`com.google.api.gax.rpc.UnaryCallable<AggregatedListSecurityPoliciesRequest,SecurityPoliciesAggregatedList>`	`aggregatedListCallable()` Retrieves the list of all SecurityPolicy resources, regional and global, available to the specified project.
`com.google.api.gax.rpc.UnaryCallable<AggregatedListSecurityPoliciesRequest,SecurityPoliciesClient.AggregatedListPagedResponse>`	`aggregatedListPagedCallable()` Retrieves the list of all SecurityPolicy resources, regional and global, available to the specified project.
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static SecurityPoliciesClient`	`create()` Constructs an instance of SecurityPoliciesClient with default settings.
`static SecurityPoliciesClient`	`create(SecurityPoliciesSettings settings)` Constructs an instance of SecurityPoliciesClient, using the given settings.
`static SecurityPoliciesClient`	`create(SecurityPoliciesStub stub)` Constructs an instance of SecurityPoliciesClient, using the given stub for making calls.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`deleteAsync(DeleteSecurityPolicyRequest request)` Deletes the specified policy.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`deleteAsync(String project, String securityPolicy)` Deletes the specified policy.
`com.google.api.gax.rpc.UnaryCallable<DeleteSecurityPolicyRequest,Operation>`	`deleteCallable()` Deletes the specified policy.
`com.google.api.gax.rpc.OperationCallable<DeleteSecurityPolicyRequest,Operation,Operation>`	`deleteOperationCallable()` Deletes the specified policy.
`SecurityPolicy`	`get(GetSecurityPolicyRequest request)` List all of the ordered rules present in a single specified policy.
`SecurityPolicy`	`get(String project, String securityPolicy)` List all of the ordered rules present in a single specified policy.
`com.google.api.gax.rpc.UnaryCallable<GetSecurityPolicyRequest,SecurityPolicy>`	`getCallable()` List all of the ordered rules present in a single specified policy.
`SecurityPolicyRule`	`getRule(GetRuleSecurityPolicyRequest request)` Gets a rule at the specified priority.
`SecurityPolicyRule`	`getRule(String project, String securityPolicy)` Gets a rule at the specified priority.
`com.google.api.gax.rpc.UnaryCallable<GetRuleSecurityPolicyRequest,SecurityPolicyRule>`	`getRuleCallable()` Gets a rule at the specified priority.
`SecurityPoliciesSettings`	`getSettings()`
`SecurityPoliciesStub`	`getStub()`
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`insertAsync(InsertSecurityPolicyRequest request)` Creates a new policy in the specified project using the data included in the request.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`insertAsync(String project, SecurityPolicy securityPolicyResource)` Creates a new policy in the specified project using the data included in the request.
`com.google.api.gax.rpc.UnaryCallable<InsertSecurityPolicyRequest,Operation>`	`insertCallable()` Creates a new policy in the specified project using the data included in the request.
`com.google.api.gax.rpc.OperationCallable<InsertSecurityPolicyRequest,Operation,Operation>`	`insertOperationCallable()` Creates a new policy in the specified project using the data included in the request.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`SecurityPoliciesClient.ListPagedResponse`	`list(ListSecurityPoliciesRequest request)` List all the policies that have been configured for the specified project.
`SecurityPoliciesClient.ListPagedResponse`	`list(String project)` List all the policies that have been configured for the specified project.
`com.google.api.gax.rpc.UnaryCallable<ListSecurityPoliciesRequest,SecurityPolicyList>`	`listCallable()` List all the policies that have been configured for the specified project.
`com.google.api.gax.rpc.UnaryCallable<ListSecurityPoliciesRequest,SecurityPoliciesClient.ListPagedResponse>`	`listPagedCallable()` List all the policies that have been configured for the specified project.
`SecurityPoliciesListPreconfiguredExpressionSetsResponse`	`listPreconfiguredExpressionSets(ListPreconfiguredExpressionSetsSecurityPoliciesRequest request)` Gets the current list of preconfigured Web Application Firewall (WAF) expressions.
`SecurityPoliciesListPreconfiguredExpressionSetsResponse`	`listPreconfiguredExpressionSets(String project)` Gets the current list of preconfigured Web Application Firewall (WAF) expressions.
`com.google.api.gax.rpc.UnaryCallable<ListPreconfiguredExpressionSetsSecurityPoliciesRequest,SecurityPoliciesListPreconfiguredExpressionSetsResponse>`	`listPreconfiguredExpressionSetsCallable()` Gets the current list of preconfigured Web Application Firewall (WAF) expressions.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`patchAsync(PatchSecurityPolicyRequest request)` Patches the specified policy with the data included in the request.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`patchAsync(String project, String securityPolicy, SecurityPolicy securityPolicyResource)` Patches the specified policy with the data included in the request.
`com.google.api.gax.rpc.UnaryCallable<PatchSecurityPolicyRequest,Operation>`	`patchCallable()` Patches the specified policy with the data included in the request.
`com.google.api.gax.rpc.OperationCallable<PatchSecurityPolicyRequest,Operation,Operation>`	`patchOperationCallable()` Patches the specified policy with the data included in the request.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`patchRuleAsync(PatchRuleSecurityPolicyRequest request)` Patches a rule at the specified priority.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`patchRuleAsync(String project, String securityPolicy, SecurityPolicyRule securityPolicyRuleResource)` Patches a rule at the specified priority.
`com.google.api.gax.rpc.UnaryCallable<PatchRuleSecurityPolicyRequest,Operation>`	`patchRuleCallable()` Patches a rule at the specified priority.
`com.google.api.gax.rpc.OperationCallable<PatchRuleSecurityPolicyRequest,Operation,Operation>`	`patchRuleOperationCallable()` Patches a rule at the specified priority.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`removeRuleAsync(RemoveRuleSecurityPolicyRequest request)` Deletes a rule at the specified priority.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`removeRuleAsync(String project, String securityPolicy)` Deletes a rule at the specified priority.
`com.google.api.gax.rpc.UnaryCallable<RemoveRuleSecurityPolicyRequest,Operation>`	`removeRuleCallable()` Deletes a rule at the specified priority.
`com.google.api.gax.rpc.OperationCallable<RemoveRuleSecurityPolicyRequest,Operation,Operation>`	`removeRuleOperationCallable()` Deletes a rule at the specified priority.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`setLabelsAsync(SetLabelsSecurityPolicyRequest request)` Sets the labels on a security policy.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`setLabelsAsync(String project, String resource, GlobalSetLabelsRequest globalSetLabelsRequestResource)` Sets the labels on a security policy.
`com.google.api.gax.rpc.UnaryCallable<SetLabelsSecurityPolicyRequest,Operation>`	`setLabelsCallable()` Sets the labels on a security policy.
`com.google.api.gax.rpc.OperationCallable<SetLabelsSecurityPolicyRequest,Operation,Operation>`	`setLabelsOperationCallable()` Sets the labels on a security policy.
`void`	`shutdown()`
`void`	`shutdownNow()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- SecurityPoliciesClient
```
protected SecurityPoliciesClient(SecurityPoliciesSettings settings)
                          throws IOException
```
  Constructs an instance of SecurityPoliciesClient, 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
- SecurityPoliciesClient
```
protected SecurityPoliciesClient(SecurityPoliciesStub stub)
```

Method Detail

create

public static final SecurityPoliciesClient create()
                                           throws IOException

Constructs an instance of SecurityPoliciesClient with default settings.

Throws:: IOException

create
```
public static final SecurityPoliciesClient create(SecurityPoliciesSettings settings)
                                           throws IOException
```
Constructs an instance of SecurityPoliciesClient, 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 SecurityPoliciesClient create(SecurityPoliciesStub stub)
```
Constructs an instance of SecurityPoliciesClient, using the given stub for making calls. This is for advanced usage - prefer using create(SecurityPoliciesSettings).

getSettings

public final SecurityPoliciesSettings getSettings()

getStub
```
public SecurityPoliciesStub getStub()
```

addRuleAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> addRuleAsync(String project,
                                                                                              String securityPolicy,
                                                                                              SecurityPolicyRule securityPolicyRuleResource)

Inserts a rule into a security policy.

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   String project = "project-309310695";
   String securityPolicy = "securityPolicy-788621166";
   SecurityPolicyRule securityPolicyRuleResource = SecurityPolicyRule.newBuilder().build();
   Operation response =
       securityPoliciesClient
           .addRuleAsync(project, securityPolicy, securityPolicyRuleResource)
           .get();
 }

Parameters:: project - Project ID for this request.; securityPolicy - Name of the security policy to update.; securityPolicyRuleResource - The body resource for this request
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

addRuleAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> addRuleAsync(AddRuleSecurityPolicyRequest request)

Inserts a rule into a security policy.

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   AddRuleSecurityPolicyRequest request =
       AddRuleSecurityPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setSecurityPolicy("securityPolicy-788621166")
           .setSecurityPolicyRuleResource(SecurityPolicyRule.newBuilder().build())
           .setValidateOnly(true)
           .build();
   Operation response = securityPoliciesClient.addRuleAsync(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

addRuleOperationCallable

public final com.google.api.gax.rpc.OperationCallable<AddRuleSecurityPolicyRequest,Operation,Operation> addRuleOperationCallable()

Inserts a rule into a security policy.

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   AddRuleSecurityPolicyRequest request =
       AddRuleSecurityPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setSecurityPolicy("securityPolicy-788621166")
           .setSecurityPolicyRuleResource(SecurityPolicyRule.newBuilder().build())
           .setValidateOnly(true)
           .build();
   OperationFuture<Operation, Operation> future =
       securityPoliciesClient.addRuleOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

addRuleCallable

public final com.google.api.gax.rpc.UnaryCallable<AddRuleSecurityPolicyRequest,Operation> addRuleCallable()

Inserts a rule into a security policy.

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   AddRuleSecurityPolicyRequest request =
       AddRuleSecurityPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setSecurityPolicy("securityPolicy-788621166")
           .setSecurityPolicyRuleResource(SecurityPolicyRule.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future = securityPoliciesClient.addRuleCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

aggregatedList

public final SecurityPoliciesClient.AggregatedListPagedResponse aggregatedList(String project)

Retrieves the list of all SecurityPolicy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   String project = "project-309310695";
   for (Map.Entry<String, SecurityPoliciesScopedList> element :
       securityPoliciesClient.aggregatedList(project).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: project - Name of the project scoping this request.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

aggregatedList

public final SecurityPoliciesClient.AggregatedListPagedResponse aggregatedList(AggregatedListSecurityPoliciesRequest 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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   AggregatedListSecurityPoliciesRequest request =
       AggregatedListSecurityPoliciesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   for (Map.Entry<String, SecurityPoliciesScopedList> element :
       securityPoliciesClient.aggregatedList(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

aggregatedListPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<AggregatedListSecurityPoliciesRequest,SecurityPoliciesClient.AggregatedListPagedResponse> aggregatedListPagedCallable()

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   AggregatedListSecurityPoliciesRequest request =
       AggregatedListSecurityPoliciesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   ApiFuture<Map.Entry<String, SecurityPoliciesScopedList>> future =
       securityPoliciesClient.aggregatedListPagedCallable().futureCall(request);
   // Do something.
   for (Map.Entry<String, SecurityPoliciesScopedList> element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

aggregatedListCallable

public final com.google.api.gax.rpc.UnaryCallable<AggregatedListSecurityPoliciesRequest,SecurityPoliciesAggregatedList> aggregatedListCallable()

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   AggregatedListSecurityPoliciesRequest request =
       AggregatedListSecurityPoliciesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   while (true) {
     SecurityPoliciesAggregatedList response =
         securityPoliciesClient.aggregatedListCallable().call(request);
     for (Map.Entry<String, SecurityPoliciesScopedList> element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

deleteAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> deleteAsync(String project,
                                                                                             String securityPolicy)

Deletes the specified policy.

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   String project = "project-309310695";
   String securityPolicy = "securityPolicy-788621166";
   Operation response = securityPoliciesClient.deleteAsync(project, securityPolicy).get();
 }

Parameters:: project - Project ID for this request.; securityPolicy - Name of the security policy to delete.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> deleteAsync(DeleteSecurityPolicyRequest request)

Deletes the specified policy.

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   DeleteSecurityPolicyRequest request =
       DeleteSecurityPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSecurityPolicy("securityPolicy-788621166")
           .build();
   Operation response = securityPoliciesClient.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<DeleteSecurityPolicyRequest,Operation,Operation> deleteOperationCallable()

Deletes the specified policy.

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   DeleteSecurityPolicyRequest request =
       DeleteSecurityPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSecurityPolicy("securityPolicy-788621166")
           .build();
   OperationFuture<Operation, Operation> future =
       securityPoliciesClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

deleteCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteSecurityPolicyRequest,Operation> deleteCallable()

Deletes the specified policy.

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   DeleteSecurityPolicyRequest request =
       DeleteSecurityPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSecurityPolicy("securityPolicy-788621166")
           .build();
   ApiFuture<Operation> future = securityPoliciesClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

get

public final SecurityPolicy get(String project,
                                String securityPolicy)

List all of the ordered rules present in a single specified policy.

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   String project = "project-309310695";
   String securityPolicy = "securityPolicy-788621166";
   SecurityPolicy response = securityPoliciesClient.get(project, securityPolicy);
 }

Parameters:: project - Project ID for this request.; securityPolicy - Name of the security policy to get.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

get

public final SecurityPolicy get(GetSecurityPolicyRequest request)

List all of the ordered rules present in a single specified policy.

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   GetSecurityPolicyRequest request =
       GetSecurityPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setSecurityPolicy("securityPolicy-788621166")
           .build();
   SecurityPolicy response = securityPoliciesClient.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<GetSecurityPolicyRequest,SecurityPolicy> getCallable()

List all of the ordered rules present in a single specified policy.

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   GetSecurityPolicyRequest request =
       GetSecurityPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setSecurityPolicy("securityPolicy-788621166")
           .build();
   ApiFuture<SecurityPolicy> future = securityPoliciesClient.getCallable().futureCall(request);
   // Do something.
   SecurityPolicy response = future.get();
 }

getRule

public final SecurityPolicyRule getRule(String project,
                                        String securityPolicy)

Gets a rule at the specified priority.

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   String project = "project-309310695";
   String securityPolicy = "securityPolicy-788621166";
   SecurityPolicyRule response = securityPoliciesClient.getRule(project, securityPolicy);
 }

Parameters:: project - Project ID for this request.; securityPolicy - Name of the security policy to which the queried rule belongs.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getRule

public final SecurityPolicyRule getRule(GetRuleSecurityPolicyRequest request)

Gets a rule at the specified priority.

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   GetRuleSecurityPolicyRequest request =
       GetRuleSecurityPolicyRequest.newBuilder()
           .setPriority(-1165461084)
           .setProject("project-309310695")
           .setSecurityPolicy("securityPolicy-788621166")
           .build();
   SecurityPolicyRule response = securityPoliciesClient.getRule(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

getRuleCallable

public final com.google.api.gax.rpc.UnaryCallable<GetRuleSecurityPolicyRequest,SecurityPolicyRule> getRuleCallable()

Gets a rule at the specified priority.

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   GetRuleSecurityPolicyRequest request =
       GetRuleSecurityPolicyRequest.newBuilder()
           .setPriority(-1165461084)
           .setProject("project-309310695")
           .setSecurityPolicy("securityPolicy-788621166")
           .build();
   ApiFuture<SecurityPolicyRule> future =
       securityPoliciesClient.getRuleCallable().futureCall(request);
   // Do something.
   SecurityPolicyRule response = future.get();
 }

insertAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> insertAsync(String project,
                                                                                             SecurityPolicy securityPolicyResource)

Creates a new policy 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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   String project = "project-309310695";
   SecurityPolicy securityPolicyResource = SecurityPolicy.newBuilder().build();
   Operation response =
       securityPoliciesClient.insertAsync(project, securityPolicyResource).get();
 }

Parameters:: project - Project ID for this request.; securityPolicyResource - The body resource for this request
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

insertAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> insertAsync(InsertSecurityPolicyRequest request)

Creates a new policy 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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   InsertSecurityPolicyRequest request =
       InsertSecurityPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSecurityPolicyResource(SecurityPolicy.newBuilder().build())
           .setValidateOnly(true)
           .build();
   Operation response = securityPoliciesClient.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<InsertSecurityPolicyRequest,Operation,Operation> insertOperationCallable()

Creates a new policy 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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   InsertSecurityPolicyRequest request =
       InsertSecurityPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSecurityPolicyResource(SecurityPolicy.newBuilder().build())
           .setValidateOnly(true)
           .build();
   OperationFuture<Operation, Operation> future =
       securityPoliciesClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

insertCallable

public final com.google.api.gax.rpc.UnaryCallable<InsertSecurityPolicyRequest,Operation> insertCallable()

Creates a new policy 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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   InsertSecurityPolicyRequest request =
       InsertSecurityPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSecurityPolicyResource(SecurityPolicy.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future = securityPoliciesClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

list

public final SecurityPoliciesClient.ListPagedResponse list(String project)

List all the policies that have been configured for 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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   String project = "project-309310695";
   for (SecurityPolicy element : securityPoliciesClient.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 SecurityPoliciesClient.ListPagedResponse list(ListSecurityPoliciesRequest request)

List all the policies that have been configured for 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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   ListSecurityPoliciesRequest request =
       ListSecurityPoliciesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (SecurityPolicy element : securityPoliciesClient.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<ListSecurityPoliciesRequest,SecurityPoliciesClient.ListPagedResponse> listPagedCallable()

List all the policies that have been configured for 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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   ListSecurityPoliciesRequest request =
       ListSecurityPoliciesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<SecurityPolicy> future =
       securityPoliciesClient.listPagedCallable().futureCall(request);
   // Do something.
   for (SecurityPolicy element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listCallable

public final com.google.api.gax.rpc.UnaryCallable<ListSecurityPoliciesRequest,SecurityPolicyList> listCallable()

List all the policies that have been configured for 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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   ListSecurityPoliciesRequest request =
       ListSecurityPoliciesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     SecurityPolicyList response = securityPoliciesClient.listCallable().call(request);
     for (SecurityPolicy element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

listPreconfiguredExpressionSets

public final SecurityPoliciesListPreconfiguredExpressionSetsResponse listPreconfiguredExpressionSets(String project)

Gets the current list of preconfigured Web Application Firewall (WAF) expressions.

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   String project = "project-309310695";
   SecurityPoliciesListPreconfiguredExpressionSetsResponse response =
       securityPoliciesClient.listPreconfiguredExpressionSets(project);
 }

Parameters:: project - Project ID for this request.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listPreconfiguredExpressionSets

public final SecurityPoliciesListPreconfiguredExpressionSetsResponse listPreconfiguredExpressionSets(ListPreconfiguredExpressionSetsSecurityPoliciesRequest request)

Gets the current list of preconfigured Web Application Firewall (WAF) expressions.

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   ListPreconfiguredExpressionSetsSecurityPoliciesRequest request =
       ListPreconfiguredExpressionSetsSecurityPoliciesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   SecurityPoliciesListPreconfiguredExpressionSetsResponse response =
       securityPoliciesClient.listPreconfiguredExpressionSets(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

listPreconfiguredExpressionSetsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListPreconfiguredExpressionSetsSecurityPoliciesRequest,SecurityPoliciesListPreconfiguredExpressionSetsResponse> listPreconfiguredExpressionSetsCallable()

Gets the current list of preconfigured Web Application Firewall (WAF) expressions.

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   ListPreconfiguredExpressionSetsSecurityPoliciesRequest request =
       ListPreconfiguredExpressionSetsSecurityPoliciesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<SecurityPoliciesListPreconfiguredExpressionSetsResponse> future =
       securityPoliciesClient.listPreconfiguredExpressionSetsCallable().futureCall(request);
   // Do something.
   SecurityPoliciesListPreconfiguredExpressionSetsResponse response = future.get();
 }

patchAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> patchAsync(String project,
                                                                                            String securityPolicy,
                                                                                            SecurityPolicy securityPolicyResource)

Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule 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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   String project = "project-309310695";
   String securityPolicy = "securityPolicy-788621166";
   SecurityPolicy securityPolicyResource = SecurityPolicy.newBuilder().build();
   Operation response =
       securityPoliciesClient.patchAsync(project, securityPolicy, securityPolicyResource).get();
 }

Parameters:: project - Project ID for this request.; securityPolicy - Name of the security policy to update.; securityPolicyResource - The body resource for this request
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

patchAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> patchAsync(PatchSecurityPolicyRequest 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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   PatchSecurityPolicyRequest request =
       PatchSecurityPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSecurityPolicy("securityPolicy-788621166")
           .setSecurityPolicyResource(SecurityPolicy.newBuilder().build())
           .setUpdateMask("updateMask-296147115")
           .build();
   Operation response = securityPoliciesClient.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<PatchSecurityPolicyRequest,Operation,Operation> patchOperationCallable()

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   PatchSecurityPolicyRequest request =
       PatchSecurityPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSecurityPolicy("securityPolicy-788621166")
           .setSecurityPolicyResource(SecurityPolicy.newBuilder().build())
           .setUpdateMask("updateMask-296147115")
           .build();
   OperationFuture<Operation, Operation> future =
       securityPoliciesClient.patchOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

patchCallable

public final com.google.api.gax.rpc.UnaryCallable<PatchSecurityPolicyRequest,Operation> patchCallable()

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   PatchSecurityPolicyRequest request =
       PatchSecurityPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSecurityPolicy("securityPolicy-788621166")
           .setSecurityPolicyResource(SecurityPolicy.newBuilder().build())
           .setUpdateMask("updateMask-296147115")
           .build();
   ApiFuture<Operation> future = securityPoliciesClient.patchCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

patchRuleAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> patchRuleAsync(String project,
                                                                                                String securityPolicy,
                                                                                                SecurityPolicyRule securityPolicyRuleResource)

Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   String project = "project-309310695";
   String securityPolicy = "securityPolicy-788621166";
   SecurityPolicyRule securityPolicyRuleResource = SecurityPolicyRule.newBuilder().build();
   Operation response =
       securityPoliciesClient
           .patchRuleAsync(project, securityPolicy, securityPolicyRuleResource)
           .get();
 }

Parameters:: project - Project ID for this request.; securityPolicy - Name of the security policy to update.; securityPolicyRuleResource - The body resource for this request
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

patchRuleAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> patchRuleAsync(PatchRuleSecurityPolicyRequest request)

Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   PatchRuleSecurityPolicyRequest request =
       PatchRuleSecurityPolicyRequest.newBuilder()
           .setPriority(-1165461084)
           .setProject("project-309310695")
           .setSecurityPolicy("securityPolicy-788621166")
           .setSecurityPolicyRuleResource(SecurityPolicyRule.newBuilder().build())
           .setUpdateMask("updateMask-296147115")
           .setValidateOnly(true)
           .build();
   Operation response = securityPoliciesClient.patchRuleAsync(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

patchRuleOperationCallable

public final com.google.api.gax.rpc.OperationCallable<PatchRuleSecurityPolicyRequest,Operation,Operation> patchRuleOperationCallable()

Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   PatchRuleSecurityPolicyRequest request =
       PatchRuleSecurityPolicyRequest.newBuilder()
           .setPriority(-1165461084)
           .setProject("project-309310695")
           .setSecurityPolicy("securityPolicy-788621166")
           .setSecurityPolicyRuleResource(SecurityPolicyRule.newBuilder().build())
           .setUpdateMask("updateMask-296147115")
           .setValidateOnly(true)
           .build();
   OperationFuture<Operation, Operation> future =
       securityPoliciesClient.patchRuleOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

patchRuleCallable

public final com.google.api.gax.rpc.UnaryCallable<PatchRuleSecurityPolicyRequest,Operation> patchRuleCallable()

Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   PatchRuleSecurityPolicyRequest request =
       PatchRuleSecurityPolicyRequest.newBuilder()
           .setPriority(-1165461084)
           .setProject("project-309310695")
           .setSecurityPolicy("securityPolicy-788621166")
           .setSecurityPolicyRuleResource(SecurityPolicyRule.newBuilder().build())
           .setUpdateMask("updateMask-296147115")
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future = securityPoliciesClient.patchRuleCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

removeRuleAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> removeRuleAsync(String project,
                                                                                                 String securityPolicy)

Deletes a rule at the specified priority.

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   String project = "project-309310695";
   String securityPolicy = "securityPolicy-788621166";
   Operation response = securityPoliciesClient.removeRuleAsync(project, securityPolicy).get();
 }

Parameters:: project - Project ID for this request.; securityPolicy - Name of the security policy to update.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

removeRuleAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> removeRuleAsync(RemoveRuleSecurityPolicyRequest request)

Deletes a rule at the specified priority.

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   RemoveRuleSecurityPolicyRequest request =
       RemoveRuleSecurityPolicyRequest.newBuilder()
           .setPriority(-1165461084)
           .setProject("project-309310695")
           .setSecurityPolicy("securityPolicy-788621166")
           .build();
   Operation response = securityPoliciesClient.removeRuleAsync(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

removeRuleOperationCallable

public final com.google.api.gax.rpc.OperationCallable<RemoveRuleSecurityPolicyRequest,Operation,Operation> removeRuleOperationCallable()

Deletes a rule at the specified priority.

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   RemoveRuleSecurityPolicyRequest request =
       RemoveRuleSecurityPolicyRequest.newBuilder()
           .setPriority(-1165461084)
           .setProject("project-309310695")
           .setSecurityPolicy("securityPolicy-788621166")
           .build();
   OperationFuture<Operation, Operation> future =
       securityPoliciesClient.removeRuleOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

removeRuleCallable

public final com.google.api.gax.rpc.UnaryCallable<RemoveRuleSecurityPolicyRequest,Operation> removeRuleCallable()

Deletes a rule at the specified priority.

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   RemoveRuleSecurityPolicyRequest request =
       RemoveRuleSecurityPolicyRequest.newBuilder()
           .setPriority(-1165461084)
           .setProject("project-309310695")
           .setSecurityPolicy("securityPolicy-788621166")
           .build();
   ApiFuture<Operation> future = securityPoliciesClient.removeRuleCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

setLabelsAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> setLabelsAsync(String project,
                                                                                                String resource,
                                                                                                GlobalSetLabelsRequest globalSetLabelsRequestResource)

Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation.

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   String project = "project-309310695";
   String resource = "resource-341064690";
   GlobalSetLabelsRequest globalSetLabelsRequestResource =
       GlobalSetLabelsRequest.newBuilder().build();
   Operation response =
       securityPoliciesClient
           .setLabelsAsync(project, resource, globalSetLabelsRequestResource)
           .get();
 }

Parameters:: project - Project ID for this request.; resource - Name or id of the resource for this request.; globalSetLabelsRequestResource - The body resource for this request
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

setLabelsAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> setLabelsAsync(SetLabelsSecurityPolicyRequest request)

Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation.

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   SetLabelsSecurityPolicyRequest request =
       SetLabelsSecurityPolicyRequest.newBuilder()
           .setGlobalSetLabelsRequestResource(GlobalSetLabelsRequest.newBuilder().build())
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .build();
   Operation response = securityPoliciesClient.setLabelsAsync(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

setLabelsOperationCallable

public final com.google.api.gax.rpc.OperationCallable<SetLabelsSecurityPolicyRequest,Operation,Operation> setLabelsOperationCallable()

Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation.

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   SetLabelsSecurityPolicyRequest request =
       SetLabelsSecurityPolicyRequest.newBuilder()
           .setGlobalSetLabelsRequestResource(GlobalSetLabelsRequest.newBuilder().build())
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .build();
   OperationFuture<Operation, Operation> future =
       securityPoliciesClient.setLabelsOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

setLabelsCallable

public final com.google.api.gax.rpc.UnaryCallable<SetLabelsSecurityPolicyRequest,Operation> setLabelsCallable()

Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation.

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 (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   SetLabelsSecurityPolicyRequest request =
       SetLabelsSecurityPolicyRequest.newBuilder()
           .setGlobalSetLabelsRequestResource(GlobalSetLabelsRequest.newBuilder().build())
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .build();
   ApiFuture<Operation> future = securityPoliciesClient.setLabelsCallable().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

Class SecurityPoliciesClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SecurityPoliciesClient

SecurityPoliciesClient

Method Detail

create

create

create

getSettings

getStub

addRuleAsync

addRuleAsync

addRuleOperationCallable

addRuleCallable

aggregatedList

aggregatedList

aggregatedListPagedCallable

aggregatedListCallable

deleteAsync

deleteAsync

deleteOperationCallable

deleteCallable

get

get

getCallable

getRule

getRule

getRuleCallable

insertAsync

insertAsync

insertOperationCallable

insertCallable

list

list

listPagedCallable

listCallable

listPreconfiguredExpressionSets

listPreconfiguredExpressionSets

listPreconfiguredExpressionSetsCallable

patchAsync

patchAsync

patchOperationCallable

patchCallable

patchRuleAsync

patchRuleAsync

patchRuleOperationCallable

patchRuleCallable

removeRuleAsync

removeRuleAsync

removeRuleOperationCallable

removeRuleCallable

setLabelsAsync

setLabelsAsync

setLabelsOperationCallable

setLabelsCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination