RegionBackendServicesClient (Google Compute Engine 1.59.0 API)

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

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

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

Service Description: The RegionBackendServices 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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String backendService = "backendService-1884714623";
   BackendService response = regionBackendServicesClient.get(project, region, backendService);
 }

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

Methods
Method	Description	Method Variants
Delete	Deletes the specified regional BackendService resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteAsync(DeleteRegionBackendServiceRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteAsync(String project, String region, String backendService) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteOperationCallable() deleteCallable()
Get	Returns the specified regional BackendService resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. get(GetRegionBackendServiceRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. get(String project, String region, String backendService) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getCallable()
GetHealth	Gets the most recent health check results for this regional BackendService.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getHealth(GetHealthRegionBackendServiceRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getHealth(String project, String region, String backendService, ResourceGroupReference resourceGroupReferenceResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getHealthCallable()
GetIamPolicy	Gets the access control policy for a resource. May be empty if no such policy or resource exists.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getIamPolicy(GetIamPolicyRegionBackendServiceRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getIamPolicy(String project, String region, String resource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getIamPolicyCallable()
Insert	Creates a regional BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview.	Request object method variants only take one parameter, a request object, which must be constructed before the call. insertAsync(InsertRegionBackendServiceRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. insertAsync(String project, String region, BackendService backendServiceResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. insertOperationCallable() insertCallable()
List	Retrieves the list of regional BackendService resources available to the specified project in the given region.	Request object method variants only take one parameter, a request object, which must be constructed before the call. list(ListRegionBackendServicesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. list(String project, String region) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listPagedCallable() listCallable()
ListUsable	Retrieves an aggregated list of all usable backend services in the specified project in the given region.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listUsable(ListUsableRegionBackendServicesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listUsable(String project, String region) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listUsablePagedCallable() listUsableCallable()
Patch	Updates the specified regional BackendService resource with the data included in the request. For more information, see Understanding backend services This method supports PATCH semantics and uses the JSON merge patch format and processing rules.	Request object method variants only take one parameter, a request object, which must be constructed before the call. patchAsync(PatchRegionBackendServiceRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. patchAsync(String project, String region, String backendService, BackendService backendServiceResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. patchOperationCallable() patchCallable()
SetIamPolicy	Sets the access control policy on the specified resource. Replaces any existing policy.	Request object method variants only take one parameter, a request object, which must be constructed before the call. setIamPolicy(SetIamPolicyRegionBackendServiceRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. setIamPolicy(String project, String region, String resource, RegionSetPolicyRequest regionSetPolicyRequestResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setIamPolicyCallable()
SetSecurityPolicy	Sets the Google Cloud Armor security policy for the specified backend service. For more information, see Google Cloud Armor Overview	Request object method variants only take one parameter, a request object, which must be constructed before the call. setSecurityPolicyAsync(SetSecurityPolicyRegionBackendServiceRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. setSecurityPolicyAsync(String project, String region, String backendService, SecurityPolicyReference securityPolicyReferenceResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setSecurityPolicyOperationCallable() setSecurityPolicyCallable()
TestIamPermissions	Returns permissions that a caller has on the specified resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. testIamPermissions(TestIamPermissionsRegionBackendServiceRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. testIamPermissions(String project, String region, String resource, TestPermissionsRequest testPermissionsRequestResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. testIamPermissionsCallable()
Update	Updates the specified regional BackendService resource with the data included in the request. For more information, see Backend services overview .	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateAsync(UpdateRegionBackendServiceRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. updateAsync(String project, String region, String backendService, BackendService backendServiceResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateOperationCallable() updateCallable()

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 RegionBackendServicesSettings 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
 RegionBackendServicesSettings regionBackendServicesSettings =
     RegionBackendServicesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create(regionBackendServicesSettings);

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
 RegionBackendServicesSettings regionBackendServicesSettings =
     RegionBackendServicesSettings.newBuilder().setEndpoint(myEndpoint).build();
 RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create(regionBackendServicesSettings);

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RegionBackendServicesClient.ListFixedSizeCollection`
`static class`	`RegionBackendServicesClient.ListPage`
`static class`	`RegionBackendServicesClient.ListPagedResponse`
`static class`	`RegionBackendServicesClient.ListUsableFixedSizeCollection`
`static class`	`RegionBackendServicesClient.ListUsablePage`
`static class`	`RegionBackendServicesClient.ListUsablePagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`RegionBackendServicesClient(RegionBackendServicesSettings settings)` Constructs an instance of RegionBackendServicesClient, using the given settings.
`protected`	`RegionBackendServicesClient(RegionBackendServicesStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static RegionBackendServicesClient`	`create()` Constructs an instance of RegionBackendServicesClient with default settings.
`static RegionBackendServicesClient`	`create(RegionBackendServicesSettings settings)` Constructs an instance of RegionBackendServicesClient, using the given settings.
`static RegionBackendServicesClient`	`create(RegionBackendServicesStub stub)` Constructs an instance of RegionBackendServicesClient, using the given stub for making calls.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`deleteAsync(DeleteRegionBackendServiceRequest request)` Deletes the specified regional BackendService resource.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`deleteAsync(String project, String region, String backendService)` Deletes the specified regional BackendService resource.
`com.google.api.gax.rpc.UnaryCallable<DeleteRegionBackendServiceRequest,Operation>`	`deleteCallable()` Deletes the specified regional BackendService resource.
`com.google.api.gax.rpc.OperationCallable<DeleteRegionBackendServiceRequest,Operation,Operation>`	`deleteOperationCallable()` Deletes the specified regional BackendService resource.
`BackendService`	`get(GetRegionBackendServiceRequest request)` Returns the specified regional BackendService resource.
`BackendService`	`get(String project, String region, String backendService)` Returns the specified regional BackendService resource.
`com.google.api.gax.rpc.UnaryCallable<GetRegionBackendServiceRequest,BackendService>`	`getCallable()` Returns the specified regional BackendService resource.
`BackendServiceGroupHealth`	`getHealth(GetHealthRegionBackendServiceRequest request)` Gets the most recent health check results for this regional BackendService.
`BackendServiceGroupHealth`	`getHealth(String project, String region, String backendService, ResourceGroupReference resourceGroupReferenceResource)` Gets the most recent health check results for this regional BackendService.
`com.google.api.gax.rpc.UnaryCallable<GetHealthRegionBackendServiceRequest,BackendServiceGroupHealth>`	`getHealthCallable()` Gets the most recent health check results for this regional BackendService.
`Policy`	`getIamPolicy(GetIamPolicyRegionBackendServiceRequest request)` Gets the access control policy for a resource.
`Policy`	`getIamPolicy(String project, String region, String resource)` Gets the access control policy for a resource.
`com.google.api.gax.rpc.UnaryCallable<GetIamPolicyRegionBackendServiceRequest,Policy>`	`getIamPolicyCallable()` Gets the access control policy for a resource.
`RegionBackendServicesSettings`	`getSettings()`
`RegionBackendServicesStub`	`getStub()`
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`insertAsync(InsertRegionBackendServiceRequest request)` Creates a regional BackendService resource in the specified project using the data included in the request.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`insertAsync(String project, String region, BackendService backendServiceResource)` Creates a regional BackendService resource in the specified project using the data included in the request.
`com.google.api.gax.rpc.UnaryCallable<InsertRegionBackendServiceRequest,Operation>`	`insertCallable()` Creates a regional BackendService resource in the specified project using the data included in the request.
`com.google.api.gax.rpc.OperationCallable<InsertRegionBackendServiceRequest,Operation,Operation>`	`insertOperationCallable()` Creates a regional BackendService resource in the specified project using the data included in the request.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`RegionBackendServicesClient.ListPagedResponse`	`list(ListRegionBackendServicesRequest request)` Retrieves the list of regional BackendService resources available to the specified project in the given region.
`RegionBackendServicesClient.ListPagedResponse`	`list(String project, String region)` Retrieves the list of regional BackendService resources available to the specified project in the given region.
`com.google.api.gax.rpc.UnaryCallable<ListRegionBackendServicesRequest,BackendServiceList>`	`listCallable()` Retrieves the list of regional BackendService resources available to the specified project in the given region.
`com.google.api.gax.rpc.UnaryCallable<ListRegionBackendServicesRequest,RegionBackendServicesClient.ListPagedResponse>`	`listPagedCallable()` Retrieves the list of regional BackendService resources available to the specified project in the given region.
`RegionBackendServicesClient.ListUsablePagedResponse`	`listUsable(ListUsableRegionBackendServicesRequest request)` Retrieves an aggregated list of all usable backend services in the specified project in the given region.
`RegionBackendServicesClient.ListUsablePagedResponse`	`listUsable(String project, String region)` Retrieves an aggregated list of all usable backend services in the specified project in the given region.
`com.google.api.gax.rpc.UnaryCallable<ListUsableRegionBackendServicesRequest,BackendServiceListUsable>`	`listUsableCallable()` Retrieves an aggregated list of all usable backend services in the specified project in the given region.
`com.google.api.gax.rpc.UnaryCallable<ListUsableRegionBackendServicesRequest,RegionBackendServicesClient.ListUsablePagedResponse>`	`listUsablePagedCallable()` Retrieves an aggregated list of all usable backend services in the specified project in the given region.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`patchAsync(PatchRegionBackendServiceRequest request)` Updates the specified regional BackendService resource with the data included in the request.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`patchAsync(String project, String region, String backendService, BackendService backendServiceResource)` Updates the specified regional BackendService resource with the data included in the request.
`com.google.api.gax.rpc.UnaryCallable<PatchRegionBackendServiceRequest,Operation>`	`patchCallable()` Updates the specified regional BackendService resource with the data included in the request.
`com.google.api.gax.rpc.OperationCallable<PatchRegionBackendServiceRequest,Operation,Operation>`	`patchOperationCallable()` Updates the specified regional BackendService resource with the data included in the request.
`Policy`	`setIamPolicy(SetIamPolicyRegionBackendServiceRequest request)` Sets the access control policy on the specified resource.
`Policy`	`setIamPolicy(String project, String region, String resource, RegionSetPolicyRequest regionSetPolicyRequestResource)` Sets the access control policy on the specified resource.
`com.google.api.gax.rpc.UnaryCallable<SetIamPolicyRegionBackendServiceRequest,Policy>`	`setIamPolicyCallable()` Sets the access control policy on the specified resource.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`setSecurityPolicyAsync(SetSecurityPolicyRegionBackendServiceRequest request)` Sets the Google Cloud Armor security policy for the specified backend service.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`setSecurityPolicyAsync(String project, String region, String backendService, SecurityPolicyReference securityPolicyReferenceResource)` Sets the Google Cloud Armor security policy for the specified backend service.
`com.google.api.gax.rpc.UnaryCallable<SetSecurityPolicyRegionBackendServiceRequest,Operation>`	`setSecurityPolicyCallable()` Sets the Google Cloud Armor security policy for the specified backend service.
`com.google.api.gax.rpc.OperationCallable<SetSecurityPolicyRegionBackendServiceRequest,Operation,Operation>`	`setSecurityPolicyOperationCallable()` Sets the Google Cloud Armor security policy for the specified backend service.
`void`	`shutdown()`
`void`	`shutdownNow()`
`TestPermissionsResponse`	`testIamPermissions(String project, String region, String resource, TestPermissionsRequest testPermissionsRequestResource)` Returns permissions that a caller has on the specified resource.
`TestPermissionsResponse`	`testIamPermissions(TestIamPermissionsRegionBackendServiceRequest request)` Returns permissions that a caller has on the specified resource.
`com.google.api.gax.rpc.UnaryCallable<TestIamPermissionsRegionBackendServiceRequest,TestPermissionsResponse>`	`testIamPermissionsCallable()` Returns permissions that a caller has on the specified resource.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`updateAsync(String project, String region, String backendService, BackendService backendServiceResource)` Updates the specified regional BackendService resource with the data included in the request.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`updateAsync(UpdateRegionBackendServiceRequest request)` Updates the specified regional BackendService resource with the data included in the request.
`com.google.api.gax.rpc.UnaryCallable<UpdateRegionBackendServiceRequest,Operation>`	`updateCallable()` Updates the specified regional BackendService resource with the data included in the request.
`com.google.api.gax.rpc.OperationCallable<UpdateRegionBackendServiceRequest,Operation,Operation>`	`updateOperationCallable()` Updates the specified regional BackendService resource with the data included in the request.

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

Constructor Detail
- RegionBackendServicesClient
```
protected RegionBackendServicesClient(RegionBackendServicesSettings settings)
                               throws IOException
```
  Constructs an instance of RegionBackendServicesClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
  
  Throws:
  
  IOException
- RegionBackendServicesClient
```
protected RegionBackendServicesClient(RegionBackendServicesStub stub)
```

Method Detail

create

public static final RegionBackendServicesClient create()
                                                throws IOException

Constructs an instance of RegionBackendServicesClient with default settings.

Throws:: IOException

create
```
public static final RegionBackendServicesClient create(RegionBackendServicesSettings settings)
                                                throws IOException
```
Constructs an instance of RegionBackendServicesClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create
```
public static final RegionBackendServicesClient create(RegionBackendServicesStub stub)
```
Constructs an instance of RegionBackendServicesClient, using the given stub for making calls. This is for advanced usage - prefer using create(RegionBackendServicesSettings).

getSettings

public final RegionBackendServicesSettings getSettings()

getStub

public RegionBackendServicesStub getStub()

deleteAsync

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

Deletes the specified regional BackendService resource.

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String backendService = "backendService-1884714623";
   Operation response =
       regionBackendServicesClient.deleteAsync(project, region, backendService).get();
 }

Parameters:: project - Project ID for this request.; region - Name of the region scoping this request.; backendService - Name of the BackendService resource to delete.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteAsync

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

Deletes the specified regional BackendService resource.

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   DeleteRegionBackendServiceRequest request =
       DeleteRegionBackendServiceRequest.newBuilder()
           .setBackendService("backendService-1884714623")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = regionBackendServicesClient.deleteAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteOperationCallable

public final com.google.api.gax.rpc.OperationCallable<DeleteRegionBackendServiceRequest,Operation,Operation> deleteOperationCallable()

Deletes the specified regional BackendService resource.

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   DeleteRegionBackendServiceRequest request =
       DeleteRegionBackendServiceRequest.newBuilder()
           .setBackendService("backendService-1884714623")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       regionBackendServicesClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

deleteCallable

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

Deletes the specified regional BackendService resource.

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   DeleteRegionBackendServiceRequest request =
       DeleteRegionBackendServiceRequest.newBuilder()
           .setBackendService("backendService-1884714623")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       regionBackendServicesClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

get

public final BackendService get(String project,
                                String region,
                                String backendService)

Returns the specified regional BackendService resource.

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String backendService = "backendService-1884714623";
   BackendService response = regionBackendServicesClient.get(project, region, backendService);
 }

Parameters:: project - Project ID for this request.; region - Name of the region scoping this request.; backendService - Name of the BackendService resource to return.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

get

public final BackendService get(GetRegionBackendServiceRequest request)

Returns the specified regional BackendService resource.

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   GetRegionBackendServiceRequest request =
       GetRegionBackendServiceRequest.newBuilder()
           .setBackendService("backendService-1884714623")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   BackendService response = regionBackendServicesClient.get(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getCallable

public final com.google.api.gax.rpc.UnaryCallable<GetRegionBackendServiceRequest,BackendService> getCallable()

Returns the specified regional BackendService resource.

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   GetRegionBackendServiceRequest request =
       GetRegionBackendServiceRequest.newBuilder()
           .setBackendService("backendService-1884714623")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   ApiFuture<BackendService> future =
       regionBackendServicesClient.getCallable().futureCall(request);
   // Do something.
   BackendService response = future.get();
 }

getHealth

public final BackendServiceGroupHealth getHealth(String project,
                                                 String region,
                                                 String backendService,
                                                 ResourceGroupReference resourceGroupReferenceResource)

Gets the most recent health check results for this regional BackendService.

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String backendService = "backendService-1884714623";
   ResourceGroupReference resourceGroupReferenceResource =
       ResourceGroupReference.newBuilder().build();
   BackendServiceGroupHealth response =
       regionBackendServicesClient.getHealth(
           project, region, backendService, resourceGroupReferenceResource);
 }

Parameters:: project -; region - Name of the region scoping this request.; backendService - Name of the BackendService resource for which to get health.; resourceGroupReferenceResource - The body resource for this request
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getHealth

public final BackendServiceGroupHealth getHealth(GetHealthRegionBackendServiceRequest request)

Gets the most recent health check results for this regional BackendService.

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   GetHealthRegionBackendServiceRequest request =
       GetHealthRegionBackendServiceRequest.newBuilder()
           .setBackendService("backendService-1884714623")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setResourceGroupReferenceResource(ResourceGroupReference.newBuilder().build())
           .build();
   BackendServiceGroupHealth response = regionBackendServicesClient.getHealth(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getHealthCallable

public final com.google.api.gax.rpc.UnaryCallable<GetHealthRegionBackendServiceRequest,BackendServiceGroupHealth> getHealthCallable()

Gets the most recent health check results for this regional BackendService.

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   GetHealthRegionBackendServiceRequest request =
       GetHealthRegionBackendServiceRequest.newBuilder()
           .setBackendService("backendService-1884714623")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setResourceGroupReferenceResource(ResourceGroupReference.newBuilder().build())
           .build();
   ApiFuture<BackendServiceGroupHealth> future =
       regionBackendServicesClient.getHealthCallable().futureCall(request);
   // Do something.
   BackendServiceGroupHealth response = future.get();
 }

getIamPolicy

public final Policy getIamPolicy(String project,
                                 String region,
                                 String resource)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String resource = "resource-341064690";
   Policy response = regionBackendServicesClient.getIamPolicy(project, region, resource);
 }

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

getIamPolicy

public final Policy getIamPolicy(GetIamPolicyRegionBackendServiceRequest request)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   GetIamPolicyRegionBackendServiceRequest request =
       GetIamPolicyRegionBackendServiceRequest.newBuilder()
           .setOptionsRequestedPolicyVersion(-574521795)
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setResource("resource-341064690")
           .build();
   Policy response = regionBackendServicesClient.getIamPolicy(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getIamPolicyCallable

public final com.google.api.gax.rpc.UnaryCallable<GetIamPolicyRegionBackendServiceRequest,Policy> getIamPolicyCallable()

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   GetIamPolicyRegionBackendServiceRequest request =
       GetIamPolicyRegionBackendServiceRequest.newBuilder()
           .setOptionsRequestedPolicyVersion(-574521795)
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setResource("resource-341064690")
           .build();
   ApiFuture<Policy> future =
       regionBackendServicesClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

insertAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> insertAsync(String project,
                                                                                             String region,
                                                                                             BackendService backendServiceResource)

Creates a regional BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview.

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   BackendService backendServiceResource = BackendService.newBuilder().build();
   Operation response =
       regionBackendServicesClient.insertAsync(project, region, backendServiceResource).get();
 }

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

insertAsync

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

Creates a regional BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview.

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   InsertRegionBackendServiceRequest request =
       InsertRegionBackendServiceRequest.newBuilder()
           .setBackendServiceResource(BackendService.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = regionBackendServicesClient.insertAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

insertOperationCallable

public final com.google.api.gax.rpc.OperationCallable<InsertRegionBackendServiceRequest,Operation,Operation> insertOperationCallable()

Creates a regional BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview.

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   InsertRegionBackendServiceRequest request =
       InsertRegionBackendServiceRequest.newBuilder()
           .setBackendServiceResource(BackendService.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       regionBackendServicesClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

insertCallable

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

Creates a regional BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview.

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   InsertRegionBackendServiceRequest request =
       InsertRegionBackendServiceRequest.newBuilder()
           .setBackendServiceResource(BackendService.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       regionBackendServicesClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

list

public final RegionBackendServicesClient.ListPagedResponse list(String project,
                                                                String region)

Retrieves the list of regional BackendService resources available to the specified project in the given region.

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (BackendService element :
       regionBackendServicesClient.list(project, region).iterateAll()) {
     // doThingsWith(element);
   }
 }

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

list

public final RegionBackendServicesClient.ListPagedResponse list(ListRegionBackendServicesRequest request)

Retrieves the list of regional BackendService resources available to the specified project in the given region.

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   ListRegionBackendServicesRequest request =
       ListRegionBackendServicesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   for (BackendService element : regionBackendServicesClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListRegionBackendServicesRequest,RegionBackendServicesClient.ListPagedResponse> listPagedCallable()

Retrieves the list of regional BackendService resources available to the specified project in the given region.

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   ListRegionBackendServicesRequest request =
       ListRegionBackendServicesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<BackendService> future =
       regionBackendServicesClient.listPagedCallable().futureCall(request);
   // Do something.
   for (BackendService element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listCallable

public final com.google.api.gax.rpc.UnaryCallable<ListRegionBackendServicesRequest,BackendServiceList> listCallable()

Retrieves the list of regional BackendService resources available to the specified project in the given region.

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   ListRegionBackendServicesRequest request =
       ListRegionBackendServicesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     BackendServiceList response = regionBackendServicesClient.listCallable().call(request);
     for (BackendService element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

listUsable

public final RegionBackendServicesClient.ListUsablePagedResponse listUsable(String project,
                                                                            String region)

Retrieves an aggregated list of all usable backend services in the specified project in the given region.

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (BackendService element :
       regionBackendServicesClient.listUsable(project, region).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: project - Project ID for this request.; region - Name of the region scoping this request. It must be a string that meets the requirements in RFC1035.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listUsable

public final RegionBackendServicesClient.ListUsablePagedResponse listUsable(ListUsableRegionBackendServicesRequest request)

Retrieves an aggregated list of all usable backend services in the specified project in the given region.

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   ListUsableRegionBackendServicesRequest request =
       ListUsableRegionBackendServicesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   for (BackendService element : regionBackendServicesClient.listUsable(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listUsablePagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListUsableRegionBackendServicesRequest,RegionBackendServicesClient.ListUsablePagedResponse> listUsablePagedCallable()

Retrieves an aggregated list of all usable backend services in the specified project in the given region.

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   ListUsableRegionBackendServicesRequest request =
       ListUsableRegionBackendServicesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<BackendService> future =
       regionBackendServicesClient.listUsablePagedCallable().futureCall(request);
   // Do something.
   for (BackendService element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listUsableCallable

public final com.google.api.gax.rpc.UnaryCallable<ListUsableRegionBackendServicesRequest,BackendServiceListUsable> listUsableCallable()

Retrieves an aggregated list of all usable backend services in the specified project in the given region.

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   ListUsableRegionBackendServicesRequest request =
       ListUsableRegionBackendServicesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     BackendServiceListUsable response =
         regionBackendServicesClient.listUsableCallable().call(request);
     for (BackendService element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

patchAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> patchAsync(String project,
                                                                                            String region,
                                                                                            String backendService,
                                                                                            BackendService backendServiceResource)

Updates the specified regional BackendService resource with the data included in the request. For more information, see Understanding backend services This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String backendService = "backendService-1884714623";
   BackendService backendServiceResource = BackendService.newBuilder().build();
   Operation response =
       regionBackendServicesClient
           .patchAsync(project, region, backendService, backendServiceResource)
           .get();
 }

Parameters:: project - Project ID for this request.; region - Name of the region scoping this request.; backendService - Name of the BackendService resource to patch.; backendServiceResource - The body resource for this request
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

patchAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> patchAsync(PatchRegionBackendServiceRequest 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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   PatchRegionBackendServiceRequest request =
       PatchRegionBackendServiceRequest.newBuilder()
           .setBackendService("backendService-1884714623")
           .setBackendServiceResource(BackendService.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = regionBackendServicesClient.patchAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

patchOperationCallable

public final com.google.api.gax.rpc.OperationCallable<PatchRegionBackendServiceRequest,Operation,Operation> patchOperationCallable()

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   PatchRegionBackendServiceRequest request =
       PatchRegionBackendServiceRequest.newBuilder()
           .setBackendService("backendService-1884714623")
           .setBackendServiceResource(BackendService.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       regionBackendServicesClient.patchOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

patchCallable

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   PatchRegionBackendServiceRequest request =
       PatchRegionBackendServiceRequest.newBuilder()
           .setBackendService("backendService-1884714623")
           .setBackendServiceResource(BackendService.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = regionBackendServicesClient.patchCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

setIamPolicy

public final Policy setIamPolicy(String project,
                                 String region,
                                 String resource,
                                 RegionSetPolicyRequest regionSetPolicyRequestResource)

Sets the access control policy on the specified resource. Replaces any existing 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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String resource = "resource-341064690";
   RegionSetPolicyRequest regionSetPolicyRequestResource =
       RegionSetPolicyRequest.newBuilder().build();
   Policy response =
       regionBackendServicesClient.setIamPolicy(
           project, region, resource, regionSetPolicyRequestResource);
 }

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

setIamPolicy

public final Policy setIamPolicy(SetIamPolicyRegionBackendServiceRequest request)

Sets the access control policy on the specified resource. Replaces any existing 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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   SetIamPolicyRegionBackendServiceRequest request =
       SetIamPolicyRegionBackendServiceRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionSetPolicyRequestResource(RegionSetPolicyRequest.newBuilder().build())
           .setResource("resource-341064690")
           .build();
   Policy response = regionBackendServicesClient.setIamPolicy(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

setIamPolicyCallable

public final com.google.api.gax.rpc.UnaryCallable<SetIamPolicyRegionBackendServiceRequest,Policy> setIamPolicyCallable()

Sets the access control policy on the specified resource. Replaces any existing 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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   SetIamPolicyRegionBackendServiceRequest request =
       SetIamPolicyRegionBackendServiceRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionSetPolicyRequestResource(RegionSetPolicyRequest.newBuilder().build())
           .setResource("resource-341064690")
           .build();
   ApiFuture<Policy> future =
       regionBackendServicesClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

setSecurityPolicyAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> setSecurityPolicyAsync(String project,
                                                                                                        String region,
                                                                                                        String backendService,
                                                                                                        SecurityPolicyReference securityPolicyReferenceResource)

Sets the Google Cloud Armor security policy for the specified backend service. For more information, see Google Cloud Armor Overview

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String backendService = "backendService-1884714623";
   SecurityPolicyReference securityPolicyReferenceResource =
       SecurityPolicyReference.newBuilder().build();
   Operation response =
       regionBackendServicesClient
           .setSecurityPolicyAsync(
               project, region, backendService, securityPolicyReferenceResource)
           .get();
 }

Parameters:: project - Project ID for this request.; region - Name of the region scoping this request.; backendService - Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035.; securityPolicyReferenceResource - The body resource for this request
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

setSecurityPolicyAsync

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

Sets the Google Cloud Armor security policy for the specified backend service. For more information, see Google Cloud Armor Overview

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   SetSecurityPolicyRegionBackendServiceRequest request =
       SetSecurityPolicyRegionBackendServiceRequest.newBuilder()
           .setBackendService("backendService-1884714623")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setSecurityPolicyReferenceResource(SecurityPolicyReference.newBuilder().build())
           .build();
   Operation response = regionBackendServicesClient.setSecurityPolicyAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

setSecurityPolicyOperationCallable

public final com.google.api.gax.rpc.OperationCallable<SetSecurityPolicyRegionBackendServiceRequest,Operation,Operation> setSecurityPolicyOperationCallable()

Sets the Google Cloud Armor security policy for the specified backend service. For more information, see Google Cloud Armor Overview

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   SetSecurityPolicyRegionBackendServiceRequest request =
       SetSecurityPolicyRegionBackendServiceRequest.newBuilder()
           .setBackendService("backendService-1884714623")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setSecurityPolicyReferenceResource(SecurityPolicyReference.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       regionBackendServicesClient.setSecurityPolicyOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

setSecurityPolicyCallable

public final com.google.api.gax.rpc.UnaryCallable<SetSecurityPolicyRegionBackendServiceRequest,Operation> setSecurityPolicyCallable()

Sets the Google Cloud Armor security policy for the specified backend service. For more information, see Google Cloud Armor Overview

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   SetSecurityPolicyRegionBackendServiceRequest request =
       SetSecurityPolicyRegionBackendServiceRequest.newBuilder()
           .setBackendService("backendService-1884714623")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setSecurityPolicyReferenceResource(SecurityPolicyReference.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       regionBackendServicesClient.setSecurityPolicyCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

testIamPermissions

public final TestPermissionsResponse testIamPermissions(String project,
                                                        String region,
                                                        String resource,
                                                        TestPermissionsRequest testPermissionsRequestResource)

Returns permissions that a caller has on the specified resource.

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String resource = "resource-341064690";
   TestPermissionsRequest testPermissionsRequestResource =
       TestPermissionsRequest.newBuilder().build();
   TestPermissionsResponse response =
       regionBackendServicesClient.testIamPermissions(
           project, region, resource, testPermissionsRequestResource);
 }

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

testIamPermissions

public final TestPermissionsResponse testIamPermissions(TestIamPermissionsRegionBackendServiceRequest request)

Returns permissions that a caller has on the specified resource.

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   TestIamPermissionsRegionBackendServiceRequest request =
       TestIamPermissionsRegionBackendServiceRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setResource("resource-341064690")
           .setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build())
           .build();
   TestPermissionsResponse response = regionBackendServicesClient.testIamPermissions(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

testIamPermissionsCallable

public final com.google.api.gax.rpc.UnaryCallable<TestIamPermissionsRegionBackendServiceRequest,TestPermissionsResponse> testIamPermissionsCallable()

Returns permissions that a caller has on the specified resource.

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   TestIamPermissionsRegionBackendServiceRequest request =
       TestIamPermissionsRegionBackendServiceRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setResource("resource-341064690")
           .setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build())
           .build();
   ApiFuture<TestPermissionsResponse> future =
       regionBackendServicesClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestPermissionsResponse response = future.get();
 }

updateAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> updateAsync(String project,
                                                                                             String region,
                                                                                             String backendService,
                                                                                             BackendService backendServiceResource)

Updates the specified regional BackendService resource with the data included in the request. For more information, see Backend services overview .

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String backendService = "backendService-1884714623";
   BackendService backendServiceResource = BackendService.newBuilder().build();
   Operation response =
       regionBackendServicesClient
           .updateAsync(project, region, backendService, backendServiceResource)
           .get();
 }

Parameters:: project - Project ID for this request.; region - Name of the region scoping this request.; backendService - Name of the BackendService resource to update.; backendServiceResource - The body resource for this request
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateAsync

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

Updates the specified regional BackendService resource with the data included in the request. For more information, see Backend services overview .

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   UpdateRegionBackendServiceRequest request =
       UpdateRegionBackendServiceRequest.newBuilder()
           .setBackendService("backendService-1884714623")
           .setBackendServiceResource(BackendService.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = regionBackendServicesClient.updateAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateOperationCallable

public final com.google.api.gax.rpc.OperationCallable<UpdateRegionBackendServiceRequest,Operation,Operation> updateOperationCallable()

Updates the specified regional BackendService resource with the data included in the request. For more information, see Backend services overview .

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   UpdateRegionBackendServiceRequest request =
       UpdateRegionBackendServiceRequest.newBuilder()
           .setBackendService("backendService-1884714623")
           .setBackendServiceResource(BackendService.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       regionBackendServicesClient.updateOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

updateCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateRegionBackendServiceRequest,Operation> updateCallable()

Updates the specified regional BackendService resource with the data included in the request. For more information, see Backend services overview .

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 (RegionBackendServicesClient regionBackendServicesClient =
     RegionBackendServicesClient.create()) {
   UpdateRegionBackendServiceRequest request =
       UpdateRegionBackendServiceRequest.newBuilder()
           .setBackendService("backendService-1884714623")
           .setBackendServiceResource(BackendService.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       regionBackendServicesClient.updateCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:: awaitTermination in interface com.google.api.gax.core.BackgroundResource
Throws:: InterruptedException

Class RegionBackendServicesClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RegionBackendServicesClient

RegionBackendServicesClient

Method Detail

create

create

create

getSettings

getStub

deleteAsync

deleteAsync

deleteOperationCallable

deleteCallable

get

get

getCallable

getHealth

getHealth

getHealthCallable

getIamPolicy

getIamPolicy

getIamPolicyCallable

insertAsync

insertAsync

insertOperationCallable

insertCallable

list

list

listPagedCallable

listCallable

listUsable

listUsable

listUsablePagedCallable

listUsableCallable

patchAsync

patchAsync

patchOperationCallable

patchCallable

setIamPolicy

setIamPolicy

setIamPolicyCallable

setSecurityPolicyAsync

setSecurityPolicyAsync

setSecurityPolicyOperationCallable

setSecurityPolicyCallable

testIamPermissions

testIamPermissions

testIamPermissionsCallable

updateAsync

updateAsync

updateOperationCallable

updateCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination