Class SecurityPoliciesClient (1.6.0-beta)

public class SecurityPoliciesClient implements 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:


 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().

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

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

See the individual methods for example code.

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

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

To customize credentials:


 SecurityPoliciesSettings securityPoliciesSettings =
     SecurityPoliciesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SecurityPoliciesClient securityPoliciesClient =
     SecurityPoliciesClient.create(securityPoliciesSettings);
 

To customize the endpoint:


 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.

Inheritance

java.lang.Object > SecurityPoliciesClient

Implements

BackgroundResource

Constructors

SecurityPoliciesClient(SecurityPoliciesSettings settings)

protected SecurityPoliciesClient(SecurityPoliciesSettings settings)

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.

Parameter
NameDescription
settingsSecurityPoliciesSettings

SecurityPoliciesClient(SecurityPoliciesStub stub)

protected SecurityPoliciesClient(SecurityPoliciesStub stub)
Parameter
NameDescription
stubSecurityPoliciesStub

Methods

addRuleAsync(AddRuleSecurityPolicyRequest request)

public final OperationFuture<Operation,Operation> addRuleAsync(AddRuleSecurityPolicyRequest request)

Inserts a rule into a security policy.

Sample code:


 try (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   AddRuleSecurityPolicyRequest request =
       AddRuleSecurityPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setSecurityPolicy("securityPolicy-788621166")
           .setSecurityPolicyRuleResource(SecurityPolicyRule.newBuilder().build())
           .build();
   Operation response = securityPoliciesClient.addRuleAsync(request).get();
 }
 
Parameter
NameDescription
requestAddRuleSecurityPolicyRequest

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

Returns
TypeDescription
OperationFuture<Operation,Operation>

addRuleAsync(String project, String securityPolicy, SecurityPolicyRule securityPolicyRuleResource)

public final OperationFuture<Operation,Operation> addRuleAsync(String project, String securityPolicy, SecurityPolicyRule securityPolicyRuleResource)

Inserts a rule into a security policy.

Sample code:


 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
NameDescription
projectString

Project ID for this request.

securityPolicyString

Name of the security policy to update.

securityPolicyRuleResourceSecurityPolicyRule

The body resource for this request

Returns
TypeDescription
OperationFuture<Operation,Operation>

addRuleCallable()

public final UnaryCallable<AddRuleSecurityPolicyRequest,Operation> addRuleCallable()

Inserts a rule into a security policy.

Sample code:


 try (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   AddRuleSecurityPolicyRequest request =
       AddRuleSecurityPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setSecurityPolicy("securityPolicy-788621166")
           .setSecurityPolicyRuleResource(SecurityPolicyRule.newBuilder().build())
           .build();
   ApiFuture
Returns
TypeDescription
UnaryCallable<AddRuleSecurityPolicyRequest,Operation>

addRuleOperationCallable()

public final OperationCallable<AddRuleSecurityPolicyRequest,Operation,Operation> addRuleOperationCallable()

Inserts a rule into a security policy.

Sample code:


 try (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   AddRuleSecurityPolicyRequest request =
       AddRuleSecurityPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setSecurityPolicy("securityPolicy-788621166")
           .setSecurityPolicyRuleResource(SecurityPolicyRule.newBuilder().build())
           .build();
   OperationFuture
Returns
TypeDescription
OperationCallable<AddRuleSecurityPolicyRequest,Operation,Operation>

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

close()

public final void close()

create()

public static final SecurityPoliciesClient create()

Constructs an instance of SecurityPoliciesClient with default settings.

Returns
TypeDescription
SecurityPoliciesClient
Exceptions
TypeDescription
IOException

create(SecurityPoliciesSettings settings)

public static final SecurityPoliciesClient create(SecurityPoliciesSettings settings)

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.

Parameter
NameDescription
settingsSecurityPoliciesSettings
Returns
TypeDescription
SecurityPoliciesClient
Exceptions
TypeDescription
IOException

create(SecurityPoliciesStub stub)

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).

Parameter
NameDescription
stubSecurityPoliciesStub
Returns
TypeDescription
SecurityPoliciesClient

deleteAsync(DeleteSecurityPolicyRequest request)

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

Deletes the specified policy.

Sample code:


 try (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   DeleteSecurityPolicyRequest request =
       DeleteSecurityPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSecurityPolicy("securityPolicy-788621166")
           .build();
   Operation response = securityPoliciesClient.deleteAsync(request).get();
 }
 
Parameter
NameDescription
requestDeleteSecurityPolicyRequest

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

Returns
TypeDescription
OperationFuture<Operation,Operation>

deleteAsync(String project, String securityPolicy)

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

Deletes the specified policy.

Sample code:


 try (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   String project = "project-309310695";
   String securityPolicy = "securityPolicy-788621166";
   Operation response = securityPoliciesClient.deleteAsync(project, securityPolicy).get();
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

securityPolicyString

Name of the security policy to delete.

Returns
TypeDescription
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteSecurityPolicyRequest,Operation> deleteCallable()

Deletes the specified policy.

Sample code:


 try (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   DeleteSecurityPolicyRequest request =
       DeleteSecurityPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSecurityPolicy("securityPolicy-788621166")
           .build();
   ApiFuture
Returns
TypeDescription
UnaryCallable<DeleteSecurityPolicyRequest,Operation>

deleteOperationCallable()

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

Deletes the specified policy.

Sample code:


 try (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   DeleteSecurityPolicyRequest request =
       DeleteSecurityPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSecurityPolicy("securityPolicy-788621166")
           .build();
   OperationFuture
Returns
TypeDescription
OperationCallable<DeleteSecurityPolicyRequest,Operation,Operation>

get(GetSecurityPolicyRequest request)

public final SecurityPolicy get(GetSecurityPolicyRequest request)

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

Sample code:


 try (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   GetSecurityPolicyRequest request =
       GetSecurityPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setSecurityPolicy("securityPolicy-788621166")
           .build();
   SecurityPolicy response = securityPoliciesClient.get(request);
 }
 
Parameter
NameDescription
requestGetSecurityPolicyRequest

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

Returns
TypeDescription
SecurityPolicy

get(String project, String securityPolicy)

public final SecurityPolicy get(String project, String securityPolicy)

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

Sample code:


 try (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   String project = "project-309310695";
   String securityPolicy = "securityPolicy-788621166";
   SecurityPolicy response = securityPoliciesClient.get(project, securityPolicy);
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

securityPolicyString

Name of the security policy to get.

Returns
TypeDescription
SecurityPolicy

getCallable()

public final UnaryCallable<GetSecurityPolicyRequest,SecurityPolicy> getCallable()

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

Sample code:


 try (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   GetSecurityPolicyRequest request =
       GetSecurityPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setSecurityPolicy("securityPolicy-788621166")
           .build();
   ApiFuture
Returns
TypeDescription
UnaryCallable<GetSecurityPolicyRequest,SecurityPolicy>

getRule(GetRuleSecurityPolicyRequest request)

public final SecurityPolicyRule getRule(GetRuleSecurityPolicyRequest request)

Gets a rule at the specified priority.

Sample code:


 try (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   GetRuleSecurityPolicyRequest request =
       GetRuleSecurityPolicyRequest.newBuilder()
           .setPriority(-1165461084)
           .setProject("project-309310695")
           .setSecurityPolicy("securityPolicy-788621166")
           .build();
   SecurityPolicyRule response = securityPoliciesClient.getRule(request);
 }
 
Parameter
NameDescription
requestGetRuleSecurityPolicyRequest

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

Returns
TypeDescription
SecurityPolicyRule

getRule(String project, String securityPolicy)

public final SecurityPolicyRule getRule(String project, String securityPolicy)

Gets a rule at the specified priority.

Sample code:


 try (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   String project = "project-309310695";
   String securityPolicy = "securityPolicy-788621166";
   SecurityPolicyRule response = securityPoliciesClient.getRule(project, securityPolicy);
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

securityPolicyString

Name of the security policy to which the queried rule belongs.

Returns
TypeDescription
SecurityPolicyRule

getRuleCallable()

public final UnaryCallable<GetRuleSecurityPolicyRequest,SecurityPolicyRule> getRuleCallable()

Gets a rule at the specified priority.

Sample code:


 try (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   GetRuleSecurityPolicyRequest request =
       GetRuleSecurityPolicyRequest.newBuilder()
           .setPriority(-1165461084)
           .setProject("project-309310695")
           .setSecurityPolicy("securityPolicy-788621166")
           .build();
   ApiFuture
Returns
TypeDescription
UnaryCallable<GetRuleSecurityPolicyRequest,SecurityPolicyRule>

getSettings()

public final SecurityPoliciesSettings getSettings()
Returns
TypeDescription
SecurityPoliciesSettings

getStub()

public SecurityPoliciesStub getStub()
Returns
TypeDescription
SecurityPoliciesStub

insertAsync(InsertSecurityPolicyRequest request)

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

Creates a new policy in the specified project using the data included in the request.

Sample code:


 try (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   InsertSecurityPolicyRequest request =
       InsertSecurityPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSecurityPolicyResource(SecurityPolicy.newBuilder().build())
           .build();
   Operation response = securityPoliciesClient.insertAsync(request).get();
 }
 
Parameter
NameDescription
requestInsertSecurityPolicyRequest

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

Returns
TypeDescription
OperationFuture<Operation,Operation>

insertAsync(String project, SecurityPolicy securityPolicyResource)

public final 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:


 try (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   String project = "project-309310695";
   SecurityPolicy securityPolicyResource = SecurityPolicy.newBuilder().build();
   Operation response =
       securityPoliciesClient.insertAsync(project, securityPolicyResource).get();
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

securityPolicyResourceSecurityPolicy

The body resource for this request

Returns
TypeDescription
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertSecurityPolicyRequest,Operation> insertCallable()

Creates a new policy in the specified project using the data included in the request.

Sample code:


 try (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   InsertSecurityPolicyRequest request =
       InsertSecurityPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSecurityPolicyResource(SecurityPolicy.newBuilder().build())
           .build();
   ApiFuture
Returns
TypeDescription
UnaryCallable<InsertSecurityPolicyRequest,Operation>

insertOperationCallable()

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

Creates a new policy in the specified project using the data included in the request.

Sample code:


 try (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   InsertSecurityPolicyRequest request =
       InsertSecurityPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSecurityPolicyResource(SecurityPolicy.newBuilder().build())
           .build();
   OperationFuture
Returns
TypeDescription
OperationCallable<InsertSecurityPolicyRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

list(ListSecurityPoliciesRequest request)

public final SecurityPoliciesClient.ListPagedResponse list(ListSecurityPoliciesRequest request)

List all the policies that have been configured for the specified project.

Sample code:


 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);
   }
 }
 
Parameter
NameDescription
requestListSecurityPoliciesRequest

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

Returns
TypeDescription
SecurityPoliciesClient.ListPagedResponse

list(String project)

public final SecurityPoliciesClient.ListPagedResponse list(String project)

List all the policies that have been configured for the specified project.

Sample code:


 try (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   String project = "project-309310695";
   for (SecurityPolicy element : securityPoliciesClient.list(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
projectString

Project ID for this request.

Returns
TypeDescription
SecurityPoliciesClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListSecurityPoliciesRequest,SecurityPolicyList> listCallable()

List all the policies that have been configured for the specified project.

Sample code:


 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.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListSecurityPoliciesRequest,SecurityPolicyList>

listPagedCallable()

public final UnaryCallable<ListSecurityPoliciesRequest,SecurityPoliciesClient.ListPagedResponse> listPagedCallable()

List all the policies that have been configured for the specified project.

Sample code:


 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
Returns
TypeDescription
UnaryCallable<ListSecurityPoliciesRequest,ListPagedResponse>

listPreconfiguredExpressionSets(ListPreconfiguredExpressionSetsSecurityPoliciesRequest request)

public final SecurityPoliciesListPreconfiguredExpressionSetsResponse listPreconfiguredExpressionSets(ListPreconfiguredExpressionSetsSecurityPoliciesRequest request)

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

Sample code:


 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);
 }
 
Parameter
NameDescription
requestListPreconfiguredExpressionSetsSecurityPoliciesRequest

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

Returns
TypeDescription
SecurityPoliciesListPreconfiguredExpressionSetsResponse

listPreconfiguredExpressionSets(String project)

public final SecurityPoliciesListPreconfiguredExpressionSetsResponse listPreconfiguredExpressionSets(String project)

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

Sample code:


 try (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   String project = "project-309310695";
   SecurityPoliciesListPreconfiguredExpressionSetsResponse response =
       securityPoliciesClient.listPreconfiguredExpressionSets(project);
 }
 
Parameter
NameDescription
projectString

Project ID for this request.

Returns
TypeDescription
SecurityPoliciesListPreconfiguredExpressionSetsResponse

listPreconfiguredExpressionSetsCallable()

public final UnaryCallable<ListPreconfiguredExpressionSetsSecurityPoliciesRequest,SecurityPoliciesListPreconfiguredExpressionSetsResponse> listPreconfiguredExpressionSetsCallable()

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

Sample code:


 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
Returns
TypeDescription
UnaryCallable<ListPreconfiguredExpressionSetsSecurityPoliciesRequest,SecurityPoliciesListPreconfiguredExpressionSetsResponse>

patchAsync(PatchSecurityPolicyRequest request)

public final OperationFuture<Operation,Operation> patchAsync(PatchSecurityPolicyRequest request)

Patches the specified policy with the data included in the request. 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:


 try (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   PatchSecurityPolicyRequest request =
       PatchSecurityPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSecurityPolicy("securityPolicy-788621166")
           .setSecurityPolicyResource(SecurityPolicy.newBuilder().build())
           .build();
   Operation response = securityPoliciesClient.patchAsync(request).get();
 }
 
Parameter
NameDescription
requestPatchSecurityPolicyRequest

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

Returns
TypeDescription
OperationFuture<Operation,Operation>

patchAsync(String project, String securityPolicy, SecurityPolicy securityPolicyResource)

public final OperationFuture<Operation,Operation> patchAsync(String project, String securityPolicy, SecurityPolicy securityPolicyResource)

Patches the specified policy with the data included in the request. 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:


 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
NameDescription
projectString

Project ID for this request.

securityPolicyString

Name of the security policy to update.

securityPolicyResourceSecurityPolicy

The body resource for this request

Returns
TypeDescription
OperationFuture<Operation,Operation>

patchCallable()

public final UnaryCallable<PatchSecurityPolicyRequest,Operation> patchCallable()

Patches the specified policy with the data included in the request. 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:


 try (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   PatchSecurityPolicyRequest request =
       PatchSecurityPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSecurityPolicy("securityPolicy-788621166")
           .setSecurityPolicyResource(SecurityPolicy.newBuilder().build())
           .build();
   ApiFuture
Returns
TypeDescription
UnaryCallable<PatchSecurityPolicyRequest,Operation>

patchOperationCallable()

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

Patches the specified policy with the data included in the request. 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:


 try (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   PatchSecurityPolicyRequest request =
       PatchSecurityPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSecurityPolicy("securityPolicy-788621166")
           .setSecurityPolicyResource(SecurityPolicy.newBuilder().build())
           .build();
   OperationFuture
Returns
TypeDescription
OperationCallable<PatchSecurityPolicyRequest,Operation,Operation>

patchRuleAsync(PatchRuleSecurityPolicyRequest request)

public final OperationFuture<Operation,Operation> patchRuleAsync(PatchRuleSecurityPolicyRequest request)

Patches a rule at the specified priority.

Sample code:


 try (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   PatchRuleSecurityPolicyRequest request =
       PatchRuleSecurityPolicyRequest.newBuilder()
           .setPriority(-1165461084)
           .setProject("project-309310695")
           .setSecurityPolicy("securityPolicy-788621166")
           .setSecurityPolicyRuleResource(SecurityPolicyRule.newBuilder().build())
           .build();
   Operation response = securityPoliciesClient.patchRuleAsync(request).get();
 }
 
Parameter
NameDescription
requestPatchRuleSecurityPolicyRequest

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

Returns
TypeDescription
OperationFuture<Operation,Operation>

patchRuleAsync(String project, String securityPolicy, SecurityPolicyRule securityPolicyRuleResource)

public final OperationFuture<Operation,Operation> patchRuleAsync(String project, String securityPolicy, SecurityPolicyRule securityPolicyRuleResource)

Patches a rule at the specified priority.

Sample code:


 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
NameDescription
projectString

Project ID for this request.

securityPolicyString

Name of the security policy to update.

securityPolicyRuleResourceSecurityPolicyRule

The body resource for this request

Returns
TypeDescription
OperationFuture<Operation,Operation>

patchRuleCallable()

public final UnaryCallable<PatchRuleSecurityPolicyRequest,Operation> patchRuleCallable()

Patches a rule at the specified priority.

Sample code:


 try (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   PatchRuleSecurityPolicyRequest request =
       PatchRuleSecurityPolicyRequest.newBuilder()
           .setPriority(-1165461084)
           .setProject("project-309310695")
           .setSecurityPolicy("securityPolicy-788621166")
           .setSecurityPolicyRuleResource(SecurityPolicyRule.newBuilder().build())
           .build();
   ApiFuture
Returns
TypeDescription
UnaryCallable<PatchRuleSecurityPolicyRequest,Operation>

patchRuleOperationCallable()

public final OperationCallable<PatchRuleSecurityPolicyRequest,Operation,Operation> patchRuleOperationCallable()

Patches a rule at the specified priority.

Sample code:


 try (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   PatchRuleSecurityPolicyRequest request =
       PatchRuleSecurityPolicyRequest.newBuilder()
           .setPriority(-1165461084)
           .setProject("project-309310695")
           .setSecurityPolicy("securityPolicy-788621166")
           .setSecurityPolicyRuleResource(SecurityPolicyRule.newBuilder().build())
           .build();
   OperationFuture
Returns
TypeDescription
OperationCallable<PatchRuleSecurityPolicyRequest,Operation,Operation>

removeRuleAsync(RemoveRuleSecurityPolicyRequest request)

public final OperationFuture<Operation,Operation> removeRuleAsync(RemoveRuleSecurityPolicyRequest request)

Deletes a rule at the specified priority.

Sample code:


 try (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   RemoveRuleSecurityPolicyRequest request =
       RemoveRuleSecurityPolicyRequest.newBuilder()
           .setPriority(-1165461084)
           .setProject("project-309310695")
           .setSecurityPolicy("securityPolicy-788621166")
           .build();
   Operation response = securityPoliciesClient.removeRuleAsync(request).get();
 }
 
Parameter
NameDescription
requestRemoveRuleSecurityPolicyRequest

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

Returns
TypeDescription
OperationFuture<Operation,Operation>

removeRuleAsync(String project, String securityPolicy)

public final OperationFuture<Operation,Operation> removeRuleAsync(String project, String securityPolicy)

Deletes a rule at the specified priority.

Sample code:


 try (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   String project = "project-309310695";
   String securityPolicy = "securityPolicy-788621166";
   Operation response = securityPoliciesClient.removeRuleAsync(project, securityPolicy).get();
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

securityPolicyString

Name of the security policy to update.

Returns
TypeDescription
OperationFuture<Operation,Operation>

removeRuleCallable()

public final UnaryCallable<RemoveRuleSecurityPolicyRequest,Operation> removeRuleCallable()

Deletes a rule at the specified priority.

Sample code:


 try (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   RemoveRuleSecurityPolicyRequest request =
       RemoveRuleSecurityPolicyRequest.newBuilder()
           .setPriority(-1165461084)
           .setProject("project-309310695")
           .setSecurityPolicy("securityPolicy-788621166")
           .build();
   ApiFuture
Returns
TypeDescription
UnaryCallable<RemoveRuleSecurityPolicyRequest,Operation>

removeRuleOperationCallable()

public final OperationCallable<RemoveRuleSecurityPolicyRequest,Operation,Operation> removeRuleOperationCallable()

Deletes a rule at the specified priority.

Sample code:


 try (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
   RemoveRuleSecurityPolicyRequest request =
       RemoveRuleSecurityPolicyRequest.newBuilder()
           .setPriority(-1165461084)
           .setProject("project-309310695")
           .setSecurityPolicy("securityPolicy-788621166")
           .build();
   OperationFuture
Returns
TypeDescription
OperationCallable<RemoveRuleSecurityPolicyRequest,Operation,Operation>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()