- 1.65.0 (latest)
- 1.64.0
- 1.63.0
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 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
public class RegionSecurityPoliciesClient implements BackgroundResource
Service Description: The RegionSecurityPolicies 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 for illustrative purposes only.
// It may require modifications to work in your environment.
try (RegionSecurityPoliciesClient regionSecurityPoliciesClient =
RegionSecurityPoliciesClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String securityPolicy = "securityPolicy-788621166";
SecurityPolicy response = regionSecurityPoliciesClient.get(project, region, securityPolicy);
}
Note: close() needs to be called on the RegionSecurityPoliciesClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of RegionSecurityPoliciesSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
RegionSecurityPoliciesSettings regionSecurityPoliciesSettings =
RegionSecurityPoliciesSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
RegionSecurityPoliciesClient regionSecurityPoliciesClient =
RegionSecurityPoliciesClient.create(regionSecurityPoliciesSettings);
To customize the endpoint:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
RegionSecurityPoliciesSettings regionSecurityPoliciesSettings =
RegionSecurityPoliciesSettings.newBuilder().setEndpoint(myEndpoint).build();
RegionSecurityPoliciesClient regionSecurityPoliciesClient =
RegionSecurityPoliciesClient.create(regionSecurityPoliciesSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final RegionSecurityPoliciesClient create()
Constructs an instance of RegionSecurityPoliciesClient with default settings.
Type | Description |
RegionSecurityPoliciesClient |
Type | Description |
IOException |
create(RegionSecurityPoliciesSettings settings)
public static final RegionSecurityPoliciesClient create(RegionSecurityPoliciesSettings settings)
Constructs an instance of RegionSecurityPoliciesClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
Name | Description |
settings | RegionSecurityPoliciesSettings |
Type | Description |
RegionSecurityPoliciesClient |
Type | Description |
IOException |
create(RegionSecurityPoliciesStub stub)
public static final RegionSecurityPoliciesClient create(RegionSecurityPoliciesStub stub)
Constructs an instance of RegionSecurityPoliciesClient, using the given stub for making calls. This is for advanced usage - prefer using create(RegionSecurityPoliciesSettings).
Name | Description |
stub | RegionSecurityPoliciesStub |
Type | Description |
RegionSecurityPoliciesClient |
Constructors
RegionSecurityPoliciesClient(RegionSecurityPoliciesSettings settings)
protected RegionSecurityPoliciesClient(RegionSecurityPoliciesSettings settings)
Constructs an instance of RegionSecurityPoliciesClient, 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.
Name | Description |
settings | RegionSecurityPoliciesSettings |
RegionSecurityPoliciesClient(RegionSecurityPoliciesStub stub)
protected RegionSecurityPoliciesClient(RegionSecurityPoliciesStub stub)
Name | Description |
stub | RegionSecurityPoliciesStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Name | Description |
duration | long |
unit | TimeUnit |
Type | Description |
boolean |
Type | Description |
InterruptedException |
close()
public final void close()
deleteAsync(DeleteRegionSecurityPolicyRequest request)
public final OperationFuture<Operation,Operation> deleteAsync(DeleteRegionSecurityPolicyRequest request)
Deletes the specified policy.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (RegionSecurityPoliciesClient regionSecurityPoliciesClient =
RegionSecurityPoliciesClient.create()) {
DeleteRegionSecurityPolicyRequest request =
DeleteRegionSecurityPolicyRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.setSecurityPolicy("securityPolicy-788621166")
.build();
Operation response = regionSecurityPoliciesClient.deleteAsync(request).get();
}
Name | Description |
request | DeleteRegionSecurityPolicyRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Operation,Operation> |
deleteAsync(String project, String region, String securityPolicy)
public final OperationFuture<Operation,Operation> deleteAsync(String project, String region, String securityPolicy)
Deletes the specified policy.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (RegionSecurityPoliciesClient regionSecurityPoliciesClient =
RegionSecurityPoliciesClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String securityPolicy = "securityPolicy-788621166";
Operation response =
regionSecurityPoliciesClient.deleteAsync(project, region, securityPolicy).get();
}
Name | Description |
project | String Project ID for this request. |
region | String Name of the region scoping this request. |
securityPolicy | String Name of the security policy to delete. |
Type | Description |
OperationFuture<Operation,Operation> |
deleteCallable()
public final UnaryCallable<DeleteRegionSecurityPolicyRequest,Operation> deleteCallable()
Deletes the specified policy.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (RegionSecurityPoliciesClient regionSecurityPoliciesClient =
RegionSecurityPoliciesClient.create()) {
DeleteRegionSecurityPolicyRequest request =
DeleteRegionSecurityPolicyRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.setSecurityPolicy("securityPolicy-788621166")
.build();
ApiFuture<Operation> future =
regionSecurityPoliciesClient.deleteCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<DeleteRegionSecurityPolicyRequest,Operation> |
deleteOperationCallable()
public final OperationCallable<DeleteRegionSecurityPolicyRequest,Operation,Operation> deleteOperationCallable()
Deletes the specified policy.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (RegionSecurityPoliciesClient regionSecurityPoliciesClient =
RegionSecurityPoliciesClient.create()) {
DeleteRegionSecurityPolicyRequest request =
DeleteRegionSecurityPolicyRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.setSecurityPolicy("securityPolicy-788621166")
.build();
OperationFuture<Operation, Operation> future =
regionSecurityPoliciesClient.deleteOperationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
OperationCallable<DeleteRegionSecurityPolicyRequest,Operation,Operation> |
get(GetRegionSecurityPolicyRequest request)
public final SecurityPolicy get(GetRegionSecurityPolicyRequest request)
List all of the ordered rules present in a single specified policy.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (RegionSecurityPoliciesClient regionSecurityPoliciesClient =
RegionSecurityPoliciesClient.create()) {
GetRegionSecurityPolicyRequest request =
GetRegionSecurityPolicyRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setSecurityPolicy("securityPolicy-788621166")
.build();
SecurityPolicy response = regionSecurityPoliciesClient.get(request);
}
Name | Description |
request | GetRegionSecurityPolicyRequest The request object containing all of the parameters for the API call. |
Type | Description |
SecurityPolicy |
get(String project, String region, String securityPolicy)
public final SecurityPolicy get(String project, String region, String securityPolicy)
List all of the ordered rules present in a single specified policy.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (RegionSecurityPoliciesClient regionSecurityPoliciesClient =
RegionSecurityPoliciesClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String securityPolicy = "securityPolicy-788621166";
SecurityPolicy response = regionSecurityPoliciesClient.get(project, region, securityPolicy);
}
Name | Description |
project | String Project ID for this request. |
region | String Name of the region scoping this request. |
securityPolicy | String Name of the security policy to get. |
Type | Description |
SecurityPolicy |
getCallable()
public final UnaryCallable<GetRegionSecurityPolicyRequest,SecurityPolicy> getCallable()
List all of the ordered rules present in a single specified policy.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (RegionSecurityPoliciesClient regionSecurityPoliciesClient =
RegionSecurityPoliciesClient.create()) {
GetRegionSecurityPolicyRequest request =
GetRegionSecurityPolicyRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setSecurityPolicy("securityPolicy-788621166")
.build();
ApiFuture<SecurityPolicy> future =
regionSecurityPoliciesClient.getCallable().futureCall(request);
// Do something.
SecurityPolicy response = future.get();
}
Type | Description |
UnaryCallable<GetRegionSecurityPolicyRequest,SecurityPolicy> |
getSettings()
public final RegionSecurityPoliciesSettings getSettings()
Type | Description |
RegionSecurityPoliciesSettings |
getStub()
public RegionSecurityPoliciesStub getStub()
Type | Description |
RegionSecurityPoliciesStub |
insertAsync(InsertRegionSecurityPolicyRequest request)
public final OperationFuture<Operation,Operation> insertAsync(InsertRegionSecurityPolicyRequest request)
Creates a new policy in the specified project using the data included in the request.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (RegionSecurityPoliciesClient regionSecurityPoliciesClient =
RegionSecurityPoliciesClient.create()) {
InsertRegionSecurityPolicyRequest request =
InsertRegionSecurityPolicyRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.setSecurityPolicyResource(SecurityPolicy.newBuilder().build())
.setValidateOnly(true)
.build();
Operation response = regionSecurityPoliciesClient.insertAsync(request).get();
}
Name | Description |
request | InsertRegionSecurityPolicyRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Operation,Operation> |
insertAsync(String project, String region, SecurityPolicy securityPolicyResource)
public final OperationFuture<Operation,Operation> insertAsync(String project, String region, 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 for illustrative purposes only.
// It may require modifications to work in your environment.
try (RegionSecurityPoliciesClient regionSecurityPoliciesClient =
RegionSecurityPoliciesClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
SecurityPolicy securityPolicyResource = SecurityPolicy.newBuilder().build();
Operation response =
regionSecurityPoliciesClient.insertAsync(project, region, securityPolicyResource).get();
}
Name | Description |
project | String Project ID for this request. |
region | String Name of the region scoping this request. |
securityPolicyResource | SecurityPolicy The body resource for this request |
Type | Description |
OperationFuture<Operation,Operation> |
insertCallable()
public final UnaryCallable<InsertRegionSecurityPolicyRequest,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 for illustrative purposes only.
// It may require modifications to work in your environment.
try (RegionSecurityPoliciesClient regionSecurityPoliciesClient =
RegionSecurityPoliciesClient.create()) {
InsertRegionSecurityPolicyRequest request =
InsertRegionSecurityPolicyRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.setSecurityPolicyResource(SecurityPolicy.newBuilder().build())
.setValidateOnly(true)
.build();
ApiFuture<Operation> future =
regionSecurityPoliciesClient.insertCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<InsertRegionSecurityPolicyRequest,Operation> |
insertOperationCallable()
public final OperationCallable<InsertRegionSecurityPolicyRequest,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 for illustrative purposes only.
// It may require modifications to work in your environment.
try (RegionSecurityPoliciesClient regionSecurityPoliciesClient =
RegionSecurityPoliciesClient.create()) {
InsertRegionSecurityPolicyRequest request =
InsertRegionSecurityPolicyRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.setSecurityPolicyResource(SecurityPolicy.newBuilder().build())
.setValidateOnly(true)
.build();
OperationFuture<Operation, Operation> future =
regionSecurityPoliciesClient.insertOperationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
OperationCallable<InsertRegionSecurityPolicyRequest,Operation,Operation> |
isShutdown()
public boolean isShutdown()
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Type | Description |
boolean |
list(ListRegionSecurityPoliciesRequest request)
public final RegionSecurityPoliciesClient.ListPagedResponse list(ListRegionSecurityPoliciesRequest request)
List all the policies that have been configured for the specified project and region.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (RegionSecurityPoliciesClient regionSecurityPoliciesClient =
RegionSecurityPoliciesClient.create()) {
ListRegionSecurityPoliciesRequest request =
ListRegionSecurityPoliciesRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setRegion("region-934795532")
.setReturnPartialSuccess(true)
.build();
for (SecurityPolicy element : regionSecurityPoliciesClient.list(request).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
request | ListRegionSecurityPoliciesRequest The request object containing all of the parameters for the API call. |
Type | Description |
RegionSecurityPoliciesClient.ListPagedResponse |
list(String project, String region)
public final RegionSecurityPoliciesClient.ListPagedResponse list(String project, String region)
List all the policies that have been configured for the specified project and region.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (RegionSecurityPoliciesClient regionSecurityPoliciesClient =
RegionSecurityPoliciesClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
for (SecurityPolicy element :
regionSecurityPoliciesClient.list(project, region).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
project | String Project ID for this request. |
region | String Name of the region scoping this request. |
Type | Description |
RegionSecurityPoliciesClient.ListPagedResponse |
listCallable()
public final UnaryCallable<ListRegionSecurityPoliciesRequest,SecurityPolicyList> listCallable()
List all the policies that have been configured for the specified project and region.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (RegionSecurityPoliciesClient regionSecurityPoliciesClient =
RegionSecurityPoliciesClient.create()) {
ListRegionSecurityPoliciesRequest request =
ListRegionSecurityPoliciesRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setRegion("region-934795532")
.setReturnPartialSuccess(true)
.build();
while (true) {
SecurityPolicyList response = regionSecurityPoliciesClient.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;
}
}
}
Type | Description |
UnaryCallable<ListRegionSecurityPoliciesRequest,SecurityPolicyList> |
listPagedCallable()
public final UnaryCallable<ListRegionSecurityPoliciesRequest,RegionSecurityPoliciesClient.ListPagedResponse> listPagedCallable()
List all the policies that have been configured for the specified project and region.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (RegionSecurityPoliciesClient regionSecurityPoliciesClient =
RegionSecurityPoliciesClient.create()) {
ListRegionSecurityPoliciesRequest request =
ListRegionSecurityPoliciesRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setRegion("region-934795532")
.setReturnPartialSuccess(true)
.build();
ApiFuture<SecurityPolicy> future =
regionSecurityPoliciesClient.listPagedCallable().futureCall(request);
// Do something.
for (SecurityPolicy element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Type | Description |
UnaryCallable<ListRegionSecurityPoliciesRequest,ListPagedResponse> |
patchAsync(PatchRegionSecurityPolicyRequest request)
public final OperationFuture<Operation,Operation> patchAsync(PatchRegionSecurityPolicyRequest request)
Patches the specified policy with the data included in the request.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (RegionSecurityPoliciesClient regionSecurityPoliciesClient =
RegionSecurityPoliciesClient.create()) {
PatchRegionSecurityPolicyRequest request =
PatchRegionSecurityPolicyRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.setSecurityPolicy("securityPolicy-788621166")
.setSecurityPolicyResource(SecurityPolicy.newBuilder().build())
.build();
Operation response = regionSecurityPoliciesClient.patchAsync(request).get();
}
Name | Description |
request | PatchRegionSecurityPolicyRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Operation,Operation> |
patchAsync(String project, String region, String securityPolicy, SecurityPolicy securityPolicyResource)
public final OperationFuture<Operation,Operation> patchAsync(String project, String region, String securityPolicy, SecurityPolicy securityPolicyResource)
Patches the specified policy with the data included in the request.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (RegionSecurityPoliciesClient regionSecurityPoliciesClient =
RegionSecurityPoliciesClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String securityPolicy = "securityPolicy-788621166";
SecurityPolicy securityPolicyResource = SecurityPolicy.newBuilder().build();
Operation response =
regionSecurityPoliciesClient
.patchAsync(project, region, securityPolicy, securityPolicyResource)
.get();
}
Name | Description |
project | String Project ID for this request. |
region | String Name of the region scoping this request. |
securityPolicy | String Name of the security policy to update. |
securityPolicyResource | SecurityPolicy The body resource for this request |
Type | Description |
OperationFuture<Operation,Operation> |
patchCallable()
public final UnaryCallable<PatchRegionSecurityPolicyRequest,Operation> patchCallable()
Patches the specified policy with the data included in the request.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (RegionSecurityPoliciesClient regionSecurityPoliciesClient =
RegionSecurityPoliciesClient.create()) {
PatchRegionSecurityPolicyRequest request =
PatchRegionSecurityPolicyRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.setSecurityPolicy("securityPolicy-788621166")
.setSecurityPolicyResource(SecurityPolicy.newBuilder().build())
.build();
ApiFuture<Operation> future =
regionSecurityPoliciesClient.patchCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<PatchRegionSecurityPolicyRequest,Operation> |
patchOperationCallable()
public final OperationCallable<PatchRegionSecurityPolicyRequest,Operation,Operation> patchOperationCallable()
Patches the specified policy with the data included in the request.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (RegionSecurityPoliciesClient regionSecurityPoliciesClient =
RegionSecurityPoliciesClient.create()) {
PatchRegionSecurityPolicyRequest request =
PatchRegionSecurityPolicyRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.setSecurityPolicy("securityPolicy-788621166")
.setSecurityPolicyResource(SecurityPolicy.newBuilder().build())
.build();
OperationFuture<Operation, Operation> future =
regionSecurityPoliciesClient.patchOperationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
OperationCallable<PatchRegionSecurityPolicyRequest,Operation,Operation> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()