com.google.cloud.compute.v1

Class SecurityPolicyClient

java.lang.Object

com.google.cloud.compute.v1.SecurityPolicyClient

All Implemented Interfaces:

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

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

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

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

 
 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   ProjectGlobalSecurityPolicyName securityPolicy = ProjectGlobalSecurityPolicyName.of("[PROJECT]", "[SECURITY_POLICY]");
   SecurityPolicyRule securityPolicyRuleResource = SecurityPolicyRule.newBuilder().build();
   Operation response = securityPolicyClient.addRuleSecurityPolicy(securityPolicy, securityPolicyRuleResource);
 }
 
 

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

To customize credentials:

 
 SecurityPolicySettings securityPolicySettings =
     SecurityPolicySettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SecurityPolicyClient securityPolicyClient =
     SecurityPolicyClient.create(securityPolicySettings);
 
 

To customize the endpoint:

 
 SecurityPolicySettings securityPolicySettings =
     SecurityPolicySettings.newBuilder().setEndpoint(myEndpoint).build();
 SecurityPolicyClient securityPolicyClient =
     SecurityPolicyClient.create(securityPolicySettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SecurityPolicyClient.ListSecurityPoliciesFixedSizeCollection
static class	SecurityPolicyClient.ListSecurityPoliciesPage
static class	SecurityPolicyClient.ListSecurityPoliciesPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SecurityPolicyClient(SecurityPolicySettings settings) Constructs an instance of SecurityPolicyClient, using the given settings.
protected	SecurityPolicyClient(SecurityPolicyStub stub)

Method Summary

Modifier and Type	Method and Description
Operation	addRuleSecurityPolicy(AddRuleSecurityPolicyHttpRequest request) Inserts a rule into a security policy.
Operation	addRuleSecurityPolicy(ProjectGlobalSecurityPolicyName securityPolicy, SecurityPolicyRule securityPolicyRuleResource) Inserts a rule into a security policy.
Operation	addRuleSecurityPolicy(String securityPolicy, SecurityPolicyRule securityPolicyRuleResource) Inserts a rule into a security policy.
com.google.api.gax.rpc.UnaryCallable<AddRuleSecurityPolicyHttpRequest,Operation>	addRuleSecurityPolicyCallable() Inserts a rule into a security policy.
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static SecurityPolicyClient	create() Constructs an instance of SecurityPolicyClient with default settings.
static SecurityPolicyClient	create(SecurityPolicySettings settings) Constructs an instance of SecurityPolicyClient, using the given settings.
static SecurityPolicyClient	create(SecurityPolicyStub stub) Constructs an instance of SecurityPolicyClient, using the given stub for making calls.
Operation	deleteSecurityPolicy(DeleteSecurityPolicyHttpRequest request) Deletes the specified policy.
Operation	deleteSecurityPolicy(ProjectGlobalSecurityPolicyName securityPolicy) Deletes the specified policy.
Operation	deleteSecurityPolicy(String securityPolicy) Deletes the specified policy.
com.google.api.gax.rpc.UnaryCallable<DeleteSecurityPolicyHttpRequest,Operation>	deleteSecurityPolicyCallable() Deletes the specified policy.
SecurityPolicyRule	getRuleSecurityPolicy(GetRuleSecurityPolicyHttpRequest request) Gets a rule at the specified priority.
SecurityPolicyRule	getRuleSecurityPolicy(Integer priority, ProjectGlobalSecurityPolicyName securityPolicy) Gets a rule at the specified priority.
SecurityPolicyRule	getRuleSecurityPolicy(Integer priority, String securityPolicy) Gets a rule at the specified priority.
com.google.api.gax.rpc.UnaryCallable<GetRuleSecurityPolicyHttpRequest,SecurityPolicyRule>	getRuleSecurityPolicyCallable() Gets a rule at the specified priority.
SecurityPolicy	getSecurityPolicy(GetSecurityPolicyHttpRequest request) List all of the ordered rules present in a single specified policy.
SecurityPolicy	getSecurityPolicy(ProjectGlobalSecurityPolicyName securityPolicy) List all of the ordered rules present in a single specified policy.
SecurityPolicy	getSecurityPolicy(String securityPolicy) List all of the ordered rules present in a single specified policy.
com.google.api.gax.rpc.UnaryCallable<GetSecurityPolicyHttpRequest,SecurityPolicy>	getSecurityPolicyCallable() List all of the ordered rules present in a single specified policy.
SecurityPolicySettings	getSettings()
SecurityPolicyStub	getStub()
Operation	insertSecurityPolicy(InsertSecurityPolicyHttpRequest request) Creates a new policy in the specified project using the data included in the request.
Operation	insertSecurityPolicy(ProjectName project, SecurityPolicy securityPolicyResource) Creates a new policy in the specified project using the data included in the request.
Operation	insertSecurityPolicy(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<InsertSecurityPolicyHttpRequest,Operation>	insertSecurityPolicyCallable() Creates a new policy in the specified project using the data included in the request.
boolean	isShutdown()
boolean	isTerminated()
SecurityPolicyClient.ListSecurityPoliciesPagedResponse	listSecurityPolicies(ListSecurityPoliciesHttpRequest request) List all the policies that have been configured for the specified project.
SecurityPolicyClient.ListSecurityPoliciesPagedResponse	listSecurityPolicies(ProjectName project) List all the policies that have been configured for the specified project.
SecurityPolicyClient.ListSecurityPoliciesPagedResponse	listSecurityPolicies(String project) List all the policies that have been configured for the specified project.
com.google.api.gax.rpc.UnaryCallable<ListSecurityPoliciesHttpRequest,SecurityPolicyList>	listSecurityPoliciesCallable() List all the policies that have been configured for the specified project.
com.google.api.gax.rpc.UnaryCallable<ListSecurityPoliciesHttpRequest,SecurityPolicyClient.ListSecurityPoliciesPagedResponse>	listSecurityPoliciesPagedCallable() List all the policies that have been configured for the specified project.
Operation	patchRuleSecurityPolicy(Integer priority, ProjectGlobalSecurityPolicyName securityPolicy, SecurityPolicyRule securityPolicyRuleResource) Patches a rule at the specified priority.
Operation	patchRuleSecurityPolicy(Integer priority, String securityPolicy, SecurityPolicyRule securityPolicyRuleResource) Patches a rule at the specified priority.
Operation	patchRuleSecurityPolicy(PatchRuleSecurityPolicyHttpRequest request) Patches a rule at the specified priority.
com.google.api.gax.rpc.UnaryCallable<PatchRuleSecurityPolicyHttpRequest,Operation>	patchRuleSecurityPolicyCallable() Patches a rule at the specified priority.
Operation	patchSecurityPolicy(PatchSecurityPolicyHttpRequest request) Patches the specified policy with the data included in the request.
Operation	patchSecurityPolicy(ProjectGlobalSecurityPolicyName securityPolicy, SecurityPolicy securityPolicyResource, List<String> fieldMask) Patches the specified policy with the data included in the request.
Operation	patchSecurityPolicy(String securityPolicy, SecurityPolicy securityPolicyResource, List<String> fieldMask) Patches the specified policy with the data included in the request.
com.google.api.gax.rpc.UnaryCallable<PatchSecurityPolicyHttpRequest,Operation>	patchSecurityPolicyCallable() Patches the specified policy with the data included in the request.
Operation	removeRuleSecurityPolicy(Integer priority, ProjectGlobalSecurityPolicyName securityPolicy) Deletes a rule at the specified priority.
Operation	removeRuleSecurityPolicy(Integer priority, String securityPolicy) Deletes a rule at the specified priority.
Operation	removeRuleSecurityPolicy(RemoveRuleSecurityPolicyHttpRequest request) Deletes a rule at the specified priority.
com.google.api.gax.rpc.UnaryCallable<RemoveRuleSecurityPolicyHttpRequest,Operation>	removeRuleSecurityPolicyCallable() Deletes a rule at the specified priority.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityPolicyClient

protected SecurityPolicyClient(SecurityPolicySettings settings)
                        throws IOException

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

SecurityPolicyClient

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

Method Detail

create

public static final SecurityPolicyClient create()
                                         throws IOException

Constructs an instance of SecurityPolicyClient with default settings.

Throws:

IOException

create

public static final SecurityPolicyClient create(SecurityPolicySettings settings)
                                         throws IOException

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

Throws:

IOException

create

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

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

getSettings

public final SecurityPolicySettings getSettings()

getStub

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

addRuleSecurityPolicy

@BetaApi
public final Operation addRuleSecurityPolicy(ProjectGlobalSecurityPolicyName securityPolicy,
                                                      SecurityPolicyRule securityPolicyRuleResource)

Inserts a rule into a security policy.

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   ProjectGlobalSecurityPolicyName securityPolicy = ProjectGlobalSecurityPolicyName.of("[PROJECT]", "[SECURITY_POLICY]");
   SecurityPolicyRule securityPolicyRuleResource = SecurityPolicyRule.newBuilder().build();
   Operation response = securityPolicyClient.addRuleSecurityPolicy(securityPolicy, securityPolicyRuleResource);
 }
 

Parameters:

securityPolicy - Name of the security policy to update.

securityPolicyRuleResource - Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).

Throws:

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

addRuleSecurityPolicy

@BetaApi
public final Operation addRuleSecurityPolicy(String securityPolicy,
                                                      SecurityPolicyRule securityPolicyRuleResource)

Inserts a rule into a security policy.

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   ProjectGlobalSecurityPolicyName securityPolicy = ProjectGlobalSecurityPolicyName.of("[PROJECT]", "[SECURITY_POLICY]");
   SecurityPolicyRule securityPolicyRuleResource = SecurityPolicyRule.newBuilder().build();
   Operation response = securityPolicyClient.addRuleSecurityPolicy(securityPolicy.toString(), securityPolicyRuleResource);
 }
 

Parameters:

securityPolicy - Name of the security policy to update.

securityPolicyRuleResource - Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).

Throws:

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

addRuleSecurityPolicy

@BetaApi
public final Operation addRuleSecurityPolicy(AddRuleSecurityPolicyHttpRequest request)

Inserts a rule into a security policy.

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   String formattedSecurityPolicy = ProjectGlobalSecurityPolicyName.format("[PROJECT]", "[SECURITY_POLICY]");
   SecurityPolicyRule securityPolicyRuleResource = SecurityPolicyRule.newBuilder().build();
   AddRuleSecurityPolicyHttpRequest request = AddRuleSecurityPolicyHttpRequest.newBuilder()
     .setSecurityPolicy(formattedSecurityPolicy)
     .setSecurityPolicyRuleResource(securityPolicyRuleResource)
     .build();
   Operation response = securityPolicyClient.addRuleSecurityPolicy(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

addRuleSecurityPolicyCallable

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

Inserts a rule into a security policy.

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   String formattedSecurityPolicy = ProjectGlobalSecurityPolicyName.format("[PROJECT]", "[SECURITY_POLICY]");
   SecurityPolicyRule securityPolicyRuleResource = SecurityPolicyRule.newBuilder().build();
   AddRuleSecurityPolicyHttpRequest request = AddRuleSecurityPolicyHttpRequest.newBuilder()
     .setSecurityPolicy(formattedSecurityPolicy)
     .setSecurityPolicyRuleResource(securityPolicyRuleResource)
     .build();
   ApiFuture<Operation> future = securityPolicyClient.addRuleSecurityPolicyCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

deleteSecurityPolicy

@BetaApi
public final Operation deleteSecurityPolicy(ProjectGlobalSecurityPolicyName securityPolicy)

Deletes the specified policy.

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   ProjectGlobalSecurityPolicyName securityPolicy = ProjectGlobalSecurityPolicyName.of("[PROJECT]", "[SECURITY_POLICY]");
   Operation response = securityPolicyClient.deleteSecurityPolicy(securityPolicy);
 }
 

Parameters:

securityPolicy - Name of the security policy to delete.

Throws:

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

deleteSecurityPolicy

@BetaApi
public final Operation deleteSecurityPolicy(String securityPolicy)

Deletes the specified policy.

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   ProjectGlobalSecurityPolicyName securityPolicy = ProjectGlobalSecurityPolicyName.of("[PROJECT]", "[SECURITY_POLICY]");
   Operation response = securityPolicyClient.deleteSecurityPolicy(securityPolicy.toString());
 }
 

Parameters:

securityPolicy - Name of the security policy to delete.

Throws:

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

deleteSecurityPolicy

@BetaApi
public final Operation deleteSecurityPolicy(DeleteSecurityPolicyHttpRequest request)

Deletes the specified policy.

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   String formattedSecurityPolicy = ProjectGlobalSecurityPolicyName.format("[PROJECT]", "[SECURITY_POLICY]");
   DeleteSecurityPolicyHttpRequest request = DeleteSecurityPolicyHttpRequest.newBuilder()
     .setSecurityPolicy(formattedSecurityPolicy)
     .build();
   Operation response = securityPolicyClient.deleteSecurityPolicy(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

deleteSecurityPolicyCallable

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

Deletes the specified policy.

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   String formattedSecurityPolicy = ProjectGlobalSecurityPolicyName.format("[PROJECT]", "[SECURITY_POLICY]");
   DeleteSecurityPolicyHttpRequest request = DeleteSecurityPolicyHttpRequest.newBuilder()
     .setSecurityPolicy(formattedSecurityPolicy)
     .build();
   ApiFuture<Operation> future = securityPolicyClient.deleteSecurityPolicyCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

getSecurityPolicy

@BetaApi
public final SecurityPolicy getSecurityPolicy(ProjectGlobalSecurityPolicyName securityPolicy)

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

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   ProjectGlobalSecurityPolicyName securityPolicy = ProjectGlobalSecurityPolicyName.of("[PROJECT]", "[SECURITY_POLICY]");
   SecurityPolicy response = securityPolicyClient.getSecurityPolicy(securityPolicy);
 }
 

Parameters:

securityPolicy - Name of the security policy to get.

Throws:

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

getSecurityPolicy

@BetaApi
public final SecurityPolicy getSecurityPolicy(String securityPolicy)

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

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   ProjectGlobalSecurityPolicyName securityPolicy = ProjectGlobalSecurityPolicyName.of("[PROJECT]", "[SECURITY_POLICY]");
   SecurityPolicy response = securityPolicyClient.getSecurityPolicy(securityPolicy.toString());
 }
 

Parameters:

securityPolicy - Name of the security policy to get.

Throws:

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

getSecurityPolicy

@BetaApi
public final SecurityPolicy getSecurityPolicy(GetSecurityPolicyHttpRequest request)

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

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   String formattedSecurityPolicy = ProjectGlobalSecurityPolicyName.format("[PROJECT]", "[SECURITY_POLICY]");
   GetSecurityPolicyHttpRequest request = GetSecurityPolicyHttpRequest.newBuilder()
     .setSecurityPolicy(formattedSecurityPolicy)
     .build();
   SecurityPolicy response = securityPolicyClient.getSecurityPolicy(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

getSecurityPolicyCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetSecurityPolicyHttpRequest,SecurityPolicy> getSecurityPolicyCallable()

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

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   String formattedSecurityPolicy = ProjectGlobalSecurityPolicyName.format("[PROJECT]", "[SECURITY_POLICY]");
   GetSecurityPolicyHttpRequest request = GetSecurityPolicyHttpRequest.newBuilder()
     .setSecurityPolicy(formattedSecurityPolicy)
     .build();
   ApiFuture<SecurityPolicy> future = securityPolicyClient.getSecurityPolicyCallable().futureCall(request);
   // Do something
   SecurityPolicy response = future.get();
 }
 

getRuleSecurityPolicy

@BetaApi
public final SecurityPolicyRule getRuleSecurityPolicy(Integer priority,
                                                               ProjectGlobalSecurityPolicyName securityPolicy)

Gets a rule at the specified priority.

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   Integer priority = 0;
   ProjectGlobalSecurityPolicyName securityPolicy = ProjectGlobalSecurityPolicyName.of("[PROJECT]", "[SECURITY_POLICY]");
   SecurityPolicyRule response = securityPolicyClient.getRuleSecurityPolicy(priority, securityPolicy);
 }
 

Parameters:

priority - The priority of the rule to get from the security policy.

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

Throws:

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

getRuleSecurityPolicy

@BetaApi
public final SecurityPolicyRule getRuleSecurityPolicy(Integer priority,
                                                               String securityPolicy)

Gets a rule at the specified priority.

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   Integer priority = 0;
   ProjectGlobalSecurityPolicyName securityPolicy = ProjectGlobalSecurityPolicyName.of("[PROJECT]", "[SECURITY_POLICY]");
   SecurityPolicyRule response = securityPolicyClient.getRuleSecurityPolicy(priority, securityPolicy.toString());
 }
 

Parameters:

priority - The priority of the rule to get from the security policy.

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

Throws:

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

getRuleSecurityPolicy

@BetaApi
public final SecurityPolicyRule getRuleSecurityPolicy(GetRuleSecurityPolicyHttpRequest request)

Gets a rule at the specified priority.

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   Integer priority = 0;
   String formattedSecurityPolicy = ProjectGlobalSecurityPolicyName.format("[PROJECT]", "[SECURITY_POLICY]");
   GetRuleSecurityPolicyHttpRequest request = GetRuleSecurityPolicyHttpRequest.newBuilder()
     .setPriority(priority)
     .setSecurityPolicy(formattedSecurityPolicy)
     .build();
   SecurityPolicyRule response = securityPolicyClient.getRuleSecurityPolicy(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

getRuleSecurityPolicyCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetRuleSecurityPolicyHttpRequest,SecurityPolicyRule> getRuleSecurityPolicyCallable()

Gets a rule at the specified priority.

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   Integer priority = 0;
   String formattedSecurityPolicy = ProjectGlobalSecurityPolicyName.format("[PROJECT]", "[SECURITY_POLICY]");
   GetRuleSecurityPolicyHttpRequest request = GetRuleSecurityPolicyHttpRequest.newBuilder()
     .setPriority(priority)
     .setSecurityPolicy(formattedSecurityPolicy)
     .build();
   ApiFuture<SecurityPolicyRule> future = securityPolicyClient.getRuleSecurityPolicyCallable().futureCall(request);
   // Do something
   SecurityPolicyRule response = future.get();
 }
 

insertSecurityPolicy

@BetaApi
public final Operation insertSecurityPolicy(ProjectName project,
                                                     SecurityPolicy securityPolicyResource)

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

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   SecurityPolicy securityPolicyResource = SecurityPolicy.newBuilder().build();
   Operation response = securityPolicyClient.insertSecurityPolicy(project, securityPolicyResource);
 }
 

Parameters:

project - Project ID for this request.

securityPolicyResource - Represents a Cloud Armor Security Policy resource.

Only external backend services that use load balancers can reference a Security Policy. For more information, read Cloud Armor Security Policy Concepts. (== resource_for v1.securityPolicies ==) (== resource_for beta.securityPolicies ==)

Throws:

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

insertSecurityPolicy

@BetaApi
public final Operation insertSecurityPolicy(String project,
                                                     SecurityPolicy securityPolicyResource)

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

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   SecurityPolicy securityPolicyResource = SecurityPolicy.newBuilder().build();
   Operation response = securityPolicyClient.insertSecurityPolicy(project.toString(), securityPolicyResource);
 }
 

Parameters:

project - Project ID for this request.

securityPolicyResource - Represents a Cloud Armor Security Policy resource.

Only external backend services that use load balancers can reference a Security Policy. For more information, read Cloud Armor Security Policy Concepts. (== resource_for v1.securityPolicies ==) (== resource_for beta.securityPolicies ==)

Throws:

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

insertSecurityPolicy

@BetaApi
public final Operation insertSecurityPolicy(InsertSecurityPolicyHttpRequest request)

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

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   SecurityPolicy securityPolicyResource = SecurityPolicy.newBuilder().build();
   InsertSecurityPolicyHttpRequest request = InsertSecurityPolicyHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setSecurityPolicyResource(securityPolicyResource)
     .build();
   Operation response = securityPolicyClient.insertSecurityPolicy(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

insertSecurityPolicyCallable

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

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

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   SecurityPolicy securityPolicyResource = SecurityPolicy.newBuilder().build();
   InsertSecurityPolicyHttpRequest request = InsertSecurityPolicyHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setSecurityPolicyResource(securityPolicyResource)
     .build();
   ApiFuture<Operation> future = securityPolicyClient.insertSecurityPolicyCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

listSecurityPolicies

@BetaApi
public final SecurityPolicyClient.ListSecurityPoliciesPagedResponse listSecurityPolicies(ProjectName project)

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

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (SecurityPolicy element : securityPolicyClient.listSecurityPolicies(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

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

listSecurityPolicies

@BetaApi
public final SecurityPolicyClient.ListSecurityPoliciesPagedResponse listSecurityPolicies(String project)

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

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (SecurityPolicy element : securityPolicyClient.listSecurityPolicies(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

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

listSecurityPolicies

@BetaApi
public final SecurityPolicyClient.ListSecurityPoliciesPagedResponse listSecurityPolicies(ListSecurityPoliciesHttpRequest request)

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

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListSecurityPoliciesHttpRequest request = ListSecurityPoliciesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (SecurityPolicy element : securityPolicyClient.listSecurityPolicies(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

listSecurityPoliciesPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListSecurityPoliciesHttpRequest,SecurityPolicyClient.ListSecurityPoliciesPagedResponse> listSecurityPoliciesPagedCallable()

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

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListSecurityPoliciesHttpRequest request = ListSecurityPoliciesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<ListSecurityPoliciesPagedResponse> future = securityPolicyClient.listSecurityPoliciesPagedCallable().futureCall(request);
   // Do something
   for (SecurityPolicy element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listSecurityPoliciesCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListSecurityPoliciesHttpRequest,SecurityPolicyList> listSecurityPoliciesCallable()

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

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListSecurityPoliciesHttpRequest request = ListSecurityPoliciesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     SecurityPolicyList response = securityPolicyClient.listSecurityPoliciesCallable().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;
     }
   }
 }
 

patchSecurityPolicy

@BetaApi
public final Operation patchSecurityPolicy(ProjectGlobalSecurityPolicyName securityPolicy,
                                                    SecurityPolicy securityPolicyResource,
                                                    List<String> fieldMask)

Patches the specified policy with the data included in the request.

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   ProjectGlobalSecurityPolicyName securityPolicy = ProjectGlobalSecurityPolicyName.of("[PROJECT]", "[SECURITY_POLICY]");
   SecurityPolicy securityPolicyResource = SecurityPolicy.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = securityPolicyClient.patchSecurityPolicy(securityPolicy, securityPolicyResource, fieldMask);
 }
 

Parameters:

securityPolicy - Name of the security policy to update.

securityPolicyResource - Represents a Cloud Armor Security Policy resource.

Only external backend services that use load balancers can reference a Security Policy. For more information, read Cloud Armor Security Policy Concepts. (== resource_for v1.securityPolicies ==) (== resource_for beta.securityPolicies ==)

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

Throws:

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

patchSecurityPolicy

@BetaApi
public final Operation patchSecurityPolicy(String securityPolicy,
                                                    SecurityPolicy securityPolicyResource,
                                                    List<String> fieldMask)

Patches the specified policy with the data included in the request.

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   ProjectGlobalSecurityPolicyName securityPolicy = ProjectGlobalSecurityPolicyName.of("[PROJECT]", "[SECURITY_POLICY]");
   SecurityPolicy securityPolicyResource = SecurityPolicy.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = securityPolicyClient.patchSecurityPolicy(securityPolicy.toString(), securityPolicyResource, fieldMask);
 }
 

Parameters:

securityPolicy - Name of the security policy to update.

securityPolicyResource - Represents a Cloud Armor Security Policy resource.

Only external backend services that use load balancers can reference a Security Policy. For more information, read Cloud Armor Security Policy Concepts. (== resource_for v1.securityPolicies ==) (== resource_for beta.securityPolicies ==)

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

Throws:

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

patchSecurityPolicy

@BetaApi
public final Operation patchSecurityPolicy(PatchSecurityPolicyHttpRequest request)

Patches the specified policy with the data included in the request.

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   String formattedSecurityPolicy = ProjectGlobalSecurityPolicyName.format("[PROJECT]", "[SECURITY_POLICY]");
   SecurityPolicy securityPolicyResource = SecurityPolicy.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   PatchSecurityPolicyHttpRequest request = PatchSecurityPolicyHttpRequest.newBuilder()
     .setSecurityPolicy(formattedSecurityPolicy)
     .setSecurityPolicyResource(securityPolicyResource)
     .addAllFieldMask(fieldMask)
     .build();
   Operation response = securityPolicyClient.patchSecurityPolicy(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

patchSecurityPolicyCallable

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

Patches the specified policy with the data included in the request.

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   String formattedSecurityPolicy = ProjectGlobalSecurityPolicyName.format("[PROJECT]", "[SECURITY_POLICY]");
   SecurityPolicy securityPolicyResource = SecurityPolicy.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   PatchSecurityPolicyHttpRequest request = PatchSecurityPolicyHttpRequest.newBuilder()
     .setSecurityPolicy(formattedSecurityPolicy)
     .setSecurityPolicyResource(securityPolicyResource)
     .addAllFieldMask(fieldMask)
     .build();
   ApiFuture<Operation> future = securityPolicyClient.patchSecurityPolicyCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

patchRuleSecurityPolicy

@BetaApi
public final Operation patchRuleSecurityPolicy(Integer priority,
                                                        ProjectGlobalSecurityPolicyName securityPolicy,
                                                        SecurityPolicyRule securityPolicyRuleResource)

Patches a rule at the specified priority.

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   Integer priority = 0;
   ProjectGlobalSecurityPolicyName securityPolicy = ProjectGlobalSecurityPolicyName.of("[PROJECT]", "[SECURITY_POLICY]");
   SecurityPolicyRule securityPolicyRuleResource = SecurityPolicyRule.newBuilder().build();
   Operation response = securityPolicyClient.patchRuleSecurityPolicy(priority, securityPolicy, securityPolicyRuleResource);
 }
 

Parameters:

priority - The priority of the rule to patch.

securityPolicy - Name of the security policy to update.

securityPolicyRuleResource - Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).

Throws:

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

patchRuleSecurityPolicy

@BetaApi
public final Operation patchRuleSecurityPolicy(Integer priority,
                                                        String securityPolicy,
                                                        SecurityPolicyRule securityPolicyRuleResource)

Patches a rule at the specified priority.

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   Integer priority = 0;
   ProjectGlobalSecurityPolicyName securityPolicy = ProjectGlobalSecurityPolicyName.of("[PROJECT]", "[SECURITY_POLICY]");
   SecurityPolicyRule securityPolicyRuleResource = SecurityPolicyRule.newBuilder().build();
   Operation response = securityPolicyClient.patchRuleSecurityPolicy(priority, securityPolicy.toString(), securityPolicyRuleResource);
 }
 

Parameters:

priority - The priority of the rule to patch.

securityPolicy - Name of the security policy to update.

securityPolicyRuleResource - Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).

Throws:

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

patchRuleSecurityPolicy

@BetaApi
public final Operation patchRuleSecurityPolicy(PatchRuleSecurityPolicyHttpRequest request)

Patches a rule at the specified priority.

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   Integer priority = 0;
   String formattedSecurityPolicy = ProjectGlobalSecurityPolicyName.format("[PROJECT]", "[SECURITY_POLICY]");
   SecurityPolicyRule securityPolicyRuleResource = SecurityPolicyRule.newBuilder().build();
   PatchRuleSecurityPolicyHttpRequest request = PatchRuleSecurityPolicyHttpRequest.newBuilder()
     .setPriority(priority)
     .setSecurityPolicy(formattedSecurityPolicy)
     .setSecurityPolicyRuleResource(securityPolicyRuleResource)
     .build();
   Operation response = securityPolicyClient.patchRuleSecurityPolicy(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

patchRuleSecurityPolicyCallable

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

Patches a rule at the specified priority.

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   Integer priority = 0;
   String formattedSecurityPolicy = ProjectGlobalSecurityPolicyName.format("[PROJECT]", "[SECURITY_POLICY]");
   SecurityPolicyRule securityPolicyRuleResource = SecurityPolicyRule.newBuilder().build();
   PatchRuleSecurityPolicyHttpRequest request = PatchRuleSecurityPolicyHttpRequest.newBuilder()
     .setPriority(priority)
     .setSecurityPolicy(formattedSecurityPolicy)
     .setSecurityPolicyRuleResource(securityPolicyRuleResource)
     .build();
   ApiFuture<Operation> future = securityPolicyClient.patchRuleSecurityPolicyCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

removeRuleSecurityPolicy

@BetaApi
public final Operation removeRuleSecurityPolicy(Integer priority,
                                                         ProjectGlobalSecurityPolicyName securityPolicy)

Deletes a rule at the specified priority.

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   Integer priority = 0;
   ProjectGlobalSecurityPolicyName securityPolicy = ProjectGlobalSecurityPolicyName.of("[PROJECT]", "[SECURITY_POLICY]");
   Operation response = securityPolicyClient.removeRuleSecurityPolicy(priority, securityPolicy);
 }
 

Parameters:

priority - The priority of the rule to remove from the security policy.

securityPolicy - Name of the security policy to update.

Throws:

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

removeRuleSecurityPolicy

@BetaApi
public final Operation removeRuleSecurityPolicy(Integer priority,
                                                         String securityPolicy)

Deletes a rule at the specified priority.

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   Integer priority = 0;
   ProjectGlobalSecurityPolicyName securityPolicy = ProjectGlobalSecurityPolicyName.of("[PROJECT]", "[SECURITY_POLICY]");
   Operation response = securityPolicyClient.removeRuleSecurityPolicy(priority, securityPolicy.toString());
 }
 

Parameters:

priority - The priority of the rule to remove from the security policy.

securityPolicy - Name of the security policy to update.

Throws:

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

removeRuleSecurityPolicy

@BetaApi
public final Operation removeRuleSecurityPolicy(RemoveRuleSecurityPolicyHttpRequest request)

Deletes a rule at the specified priority.

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   Integer priority = 0;
   String formattedSecurityPolicy = ProjectGlobalSecurityPolicyName.format("[PROJECT]", "[SECURITY_POLICY]");
   RemoveRuleSecurityPolicyHttpRequest request = RemoveRuleSecurityPolicyHttpRequest.newBuilder()
     .setPriority(priority)
     .setSecurityPolicy(formattedSecurityPolicy)
     .build();
   Operation response = securityPolicyClient.removeRuleSecurityPolicy(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

removeRuleSecurityPolicyCallable

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

Deletes a rule at the specified priority.

Sample code:

 try (SecurityPolicyClient securityPolicyClient = SecurityPolicyClient.create()) {
   Integer priority = 0;
   String formattedSecurityPolicy = ProjectGlobalSecurityPolicyName.format("[PROJECT]", "[SECURITY_POLICY]");
   RemoveRuleSecurityPolicyHttpRequest request = RemoveRuleSecurityPolicyHttpRequest.newBuilder()
     .setPriority(priority)
     .setSecurityPolicy(formattedSecurityPolicy)
     .build();
   ApiFuture<Operation> future = securityPolicyClient.removeRuleSecurityPolicyCallable().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