- 1.57.0 (latest)
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
GitHub Repository | Product Reference |
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().
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.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
AggregatedList | Retrieves the list of all SecurityPolicy resources, regional and global, available to the specified project. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
Delete | Deletes the specified policy. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return 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:
// 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.
Static Methods
create()
public static final SecurityPoliciesClient create()
Constructs an instance of SecurityPoliciesClient with default settings.
Returns | |
---|---|
Type | Description |
SecurityPoliciesClient |
Exceptions | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
settings | SecurityPoliciesSettings |
Returns | |
---|---|
Type | Description |
SecurityPoliciesClient |
Exceptions | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
stub | SecurityPoliciesStub |
Returns | |
---|---|
Type | Description |
SecurityPoliciesClient |
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 | |
---|---|
Name | Description |
settings | SecurityPoliciesSettings |
SecurityPoliciesClient(SecurityPoliciesStub stub)
protected SecurityPoliciesClient(SecurityPoliciesStub stub)
Parameter | |
---|---|
Name | Description |
stub | SecurityPoliciesStub |
Methods
addRuleAsync(AddRuleSecurityPolicyRequest request)
public final 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();
}
Parameter | |
---|---|
Name | Description |
request | AddRuleSecurityPolicyRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
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:
// 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 | |
---|---|
Name | Description |
project | String Project ID for this request. |
securityPolicy | String Name of the security policy to update. |
securityPolicyRuleResource | SecurityPolicyRule The body resource for this request |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
addRuleCallable()
public final 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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<AddRuleSecurityPolicyRequest,Operation> |
addRuleOperationCallable()
public final 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();
}
Returns | |
---|---|
Type | Description |
OperationCallable<AddRuleSecurityPolicyRequest,Operation,Operation> |
aggregatedList(AggregatedListSecurityPoliciesRequest request)
public final SecurityPoliciesClient.AggregatedListPagedResponse aggregatedList(AggregatedListSecurityPoliciesRequest request)
Retrieves the list of all SecurityPolicy resources, regional and global, available to the specified project.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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);
}
}
Parameter | |
---|---|
Name | Description |
request | AggregatedListSecurityPoliciesRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
SecurityPoliciesClient.AggregatedListPagedResponse |
aggregatedList(String project)
public final SecurityPoliciesClient.AggregatedListPagedResponse aggregatedList(String project)
Retrieves the list of all SecurityPolicy resources, regional and global, available to the specified project.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (SecurityPoliciesClient securityPoliciesClient = SecurityPoliciesClient.create()) {
String project = "project-309310695";
for (Map.Entry<String, SecurityPoliciesScopedList> element :
securityPoliciesClient.aggregatedList(project).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
project | String Name of the project scoping this request. |
Returns | |
---|---|
Type | Description |
SecurityPoliciesClient.AggregatedListPagedResponse |
aggregatedListCallable()
public final UnaryCallable<AggregatedListSecurityPoliciesRequest,SecurityPoliciesAggregatedList> aggregatedListCallable()
Retrieves the list of all SecurityPolicy resources, regional and global, available to the specified project.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<AggregatedListSecurityPoliciesRequest,SecurityPoliciesAggregatedList> |
aggregatedListPagedCallable()
public final UnaryCallable<AggregatedListSecurityPoliciesRequest,SecurityPoliciesClient.AggregatedListPagedResponse> aggregatedListPagedCallable()
Retrieves the list of all SecurityPolicy resources, regional and global, available to the specified project.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<AggregatedListSecurityPoliciesRequest,AggregatedListPagedResponse> |
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Parameters | |
---|---|
Name | Description |
duration | long |
unit | TimeUnit |
Returns | |
---|---|
Type | Description |
boolean |
Exceptions | |
---|---|
Type | Description |
InterruptedException |
close()
public final void close()
deleteAsync(DeleteSecurityPolicyRequest request)
public final 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();
}
Parameter | |
---|---|
Name | Description |
request | DeleteSecurityPolicyRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
deleteAsync(String project, String securityPolicy)
public final 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 | |
---|---|
Name | Description |
project | String Project ID for this request. |
securityPolicy | String Name of the security policy to delete. |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
deleteCallable()
public final 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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteSecurityPolicyRequest,Operation> |
deleteOperationCallable()
public final 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();
}
Returns | |
---|---|
Type | Description |
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:
// 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);
}
Parameter | |
---|---|
Name | Description |
request | GetSecurityPolicyRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
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:
// 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 | |
---|---|
Name | Description |
project | String Project ID for this request. |
securityPolicy | String Name of the security policy to get. |
Returns | |
---|---|
Type | Description |
SecurityPolicy |
getCallable()
public final 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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetSecurityPolicyRequest,SecurityPolicy> |
getRule(GetRuleSecurityPolicyRequest request)
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);
}
Parameter | |
---|---|
Name | Description |
request | GetRuleSecurityPolicyRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
SecurityPolicyRule |
getRule(String project, String securityPolicy)
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 | |
---|---|
Name | Description |
project | String Project ID for this request. |
securityPolicy | String Name of the security policy to which the queried rule belongs. |
Returns | |
---|---|
Type | Description |
SecurityPolicyRule |
getRuleCallable()
public final 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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetRuleSecurityPolicyRequest,SecurityPolicyRule> |
getSettings()
public final SecurityPoliciesSettings getSettings()
Returns | |
---|---|
Type | Description |
SecurityPoliciesSettings |
getStub()
public SecurityPoliciesStub getStub()
Returns | |
---|---|
Type | Description |
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:
// 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();
}
Parameter | |
---|---|
Name | Description |
request | InsertSecurityPolicyRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
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:
// 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 | |
---|---|
Name | Description |
project | String Project ID for this request. |
securityPolicyResource | SecurityPolicy The body resource for this request |
Returns | |
---|---|
Type | Description |
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:
// 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();
}
Returns | |
---|---|
Type | Description |
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:
// 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();
}
Returns | |
---|---|
Type | Description |
OperationCallable<InsertSecurityPolicyRequest,Operation,Operation> |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
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:
// 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);
}
}
Parameter | |
---|---|
Name | Description |
request | ListSecurityPoliciesRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
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:
// 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);
}
}
Parameter | |
---|---|
Name | Description |
project | String Project ID for this request. |
Returns | |
---|---|
Type | Description |
SecurityPoliciesClient.ListPagedResponse |
listCallable()
public final 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;
}
}
}
Returns | |
---|---|
Type | Description |
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:
// 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);
}
}
Returns | |
---|---|
Type | Description |
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:
// 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);
}
Parameter | |
---|---|
Name | Description |
request | ListPreconfiguredExpressionSetsSecurityPoliciesRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
SecurityPoliciesListPreconfiguredExpressionSetsResponse |
listPreconfiguredExpressionSets(String project)
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);
}
Parameter | |
---|---|
Name | Description |
project | String Project ID for this request. |
Returns | |
---|---|
Type | Description |
SecurityPoliciesListPreconfiguredExpressionSetsResponse |
listPreconfiguredExpressionSetsCallable()
public final 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();
}
Returns | |
---|---|
Type | Description |
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. 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()) {
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();
}
Parameter | |
---|---|
Name | Description |
request | PatchSecurityPolicyRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
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. 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 | |
---|---|
Name | Description |
project | String Project ID for this request. |
securityPolicy | String Name of the security policy to update. |
securityPolicyResource | SecurityPolicy The body resource for this request |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
patchCallable()
public final UnaryCallable<PatchSecurityPolicyRequest,Operation> patchCallable()
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()) {
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<PatchSecurityPolicyRequest,Operation> |
patchOperationCallable()
public final OperationCallable<PatchSecurityPolicyRequest,Operation,Operation> patchOperationCallable()
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()) {
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();
}
Returns | |
---|---|
Type | Description |
OperationCallable<PatchSecurityPolicyRequest,Operation,Operation> |
patchRuleAsync(PatchRuleSecurityPolicyRequest request)
public final 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();
}
Parameter | |
---|---|
Name | Description |
request | PatchRuleSecurityPolicyRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
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. 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 | |
---|---|
Name | Description |
project | String Project ID for this request. |
securityPolicy | String Name of the security policy to update. |
securityPolicyRuleResource | SecurityPolicyRule The body resource for this request |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
patchRuleCallable()
public final 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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<PatchRuleSecurityPolicyRequest,Operation> |
patchRuleOperationCallable()
public final 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();
}
Returns | |
---|---|
Type | Description |
OperationCallable<PatchRuleSecurityPolicyRequest,Operation,Operation> |
removeRuleAsync(RemoveRuleSecurityPolicyRequest request)
public final 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();
}
Parameter | |
---|---|
Name | Description |
request | RemoveRuleSecurityPolicyRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
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:
// 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 | |
---|---|
Name | Description |
project | String Project ID for this request. |
securityPolicy | String Name of the security policy to update. |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
removeRuleCallable()
public final 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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<RemoveRuleSecurityPolicyRequest,Operation> |
removeRuleOperationCallable()
public final 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();
}
Returns | |
---|---|
Type | Description |
OperationCallable<RemoveRuleSecurityPolicyRequest,Operation,Operation> |
setLabelsAsync(SetLabelsSecurityPolicyRequest request)
public final 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();
}
Parameter | |
---|---|
Name | Description |
request | SetLabelsSecurityPolicyRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
setLabelsAsync(String project, String resource, GlobalSetLabelsRequest globalSetLabelsRequestResource)
public final 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 | |
---|---|
Name | Description |
project | String Project ID for this request. |
resource | String Name or id of the resource for this request. |
globalSetLabelsRequestResource | GlobalSetLabelsRequest The body resource for this request |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
setLabelsCallable()
public final 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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<SetLabelsSecurityPolicyRequest,Operation> |
setLabelsOperationCallable()
public final 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();
}
Returns | |
---|---|
Type | Description |
OperationCallable<SetLabelsSecurityPolicyRequest,Operation,Operation> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()