Class RegionBackendServicesClient (1.42.0)

Version 1.42.0

• 1.63.0 (latest)
• 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

GitHub Repository

Product Reference

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

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

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

See the individual methods for example code.

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

This class can be customized by passing in a custom instance of 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.

Inheritance

java.lang.Object > RegionBackendServicesClient

Static Methods

create()

public static final RegionBackendServicesClient create()

Constructs an instance of RegionBackendServicesClient with default settings.

Returns
Type	Description
RegionBackendServicesClient

Exceptions
Type	Description
IOException

create(RegionBackendServicesSettings settings)

public static final RegionBackendServicesClient create(RegionBackendServicesSettings settings)

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.

Parameter
Name	Description
settings	RegionBackendServicesSettings

Returns
Type	Description
RegionBackendServicesClient

Exceptions
Type	Description
IOException

create(RegionBackendServicesStub stub)

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

Parameter
Name	Description
stub	RegionBackendServicesStub

Returns
Type	Description
RegionBackendServicesClient

Constructors

RegionBackendServicesClient(RegionBackendServicesSettings settings)

protected RegionBackendServicesClient(RegionBackendServicesSettings settings)

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.

Parameter
Name	Description
settings	RegionBackendServicesSettings

RegionBackendServicesClient(RegionBackendServicesStub stub)

protected RegionBackendServicesClient(RegionBackendServicesStub stub)

Parameter
Name	Description
stub	RegionBackendServicesStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
duration	long
unit	TimeUnit

Returns
Type	Description
boolean

Exceptions
Type	Description
InterruptedException

close()

public final void close()

deleteAsync(DeleteRegionBackendServiceRequest request)

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

Beta

The surface for long-running operations is not stable yet and may change in the future.

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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();
 }
 

Parameter
Name	Description
request	DeleteRegionBackendServiceRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String region, String backendService)

public final 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
Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
backendService	String Name of the BackendService resource to delete.

Returns
Type	Description
OperationFuture<Operation,Operation>

deleteCallable()

public final 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();
 }
 

Returns
Type	Description
UnaryCallable<DeleteRegionBackendServiceRequest,Operation>

deleteOperationCallable()

public final 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();
 }
 

Returns
Type	Description
OperationCallable<DeleteRegionBackendServiceRequest,Operation,Operation>

get(GetRegionBackendServiceRequest request)

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);
 }
 

Parameter
Name	Description
request	GetRegionBackendServiceRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
BackendService

get(String project, String region, String backendService)

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
Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
backendService	String Name of the BackendService resource to return.

Returns
Type	Description
BackendService

getCallable()

public final 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();
 }
 

Returns
Type	Description
UnaryCallable<GetRegionBackendServiceRequest,BackendService>

getHealth(GetHealthRegionBackendServiceRequest request)

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);
 }
 

Parameter
Name	Description
request	GetHealthRegionBackendServiceRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
BackendServiceGroupHealth

getHealth(String project, String region, String backendService, ResourceGroupReference resourceGroupReferenceResource)

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
Name	Description
project	String
region	String Name of the region scoping this request.
backendService	String Name of the BackendService resource for which to get health.
resourceGroupReferenceResource	ResourceGroupReference The body resource for this request

Returns
Type	Description
BackendServiceGroupHealth

getHealthCallable()

public final 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();
 }
 

Returns
Type	Description
UnaryCallable<GetHealthRegionBackendServiceRequest,BackendServiceGroupHealth>

getIamPolicy(GetIamPolicyRegionBackendServiceRequest request)

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);
 }
 

Parameter
Name	Description
request	GetIamPolicyRegionBackendServiceRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
Policy

getIamPolicy(String project, String region, String resource)

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
Name	Description
project	String Project ID for this request.
region	String The name of the region for this request.
resource	String Name or id of the resource for this request.

Returns
Type	Description
Policy

getIamPolicyCallable()

public final 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();
 }
 

Returns
Type	Description
UnaryCallable<GetIamPolicyRegionBackendServiceRequest,Policy>

getSettings()

public final RegionBackendServicesSettings getSettings()

Returns
Type	Description
RegionBackendServicesSettings

getStub()

public RegionBackendServicesStub getStub()

Returns
Type	Description
RegionBackendServicesStub

insertAsync(InsertRegionBackendServiceRequest request)

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

Beta

The surface for long-running operations is not stable yet and may change in the future.

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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();
 }
 

Parameter
Name	Description
request	InsertRegionBackendServiceRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
OperationFuture<Operation,Operation>

insertAsync(String project, String region, BackendService backendServiceResource)

public final 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
Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
backendServiceResource	BackendService The body resource for this request

Returns
Type	Description
OperationFuture<Operation,Operation>

insertCallable()

public final 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();
 }
 

Returns
Type	Description
UnaryCallable<InsertRegionBackendServiceRequest,Operation>

insertOperationCallable()

public final 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();
 }
 

Returns
Type	Description
OperationCallable<InsertRegionBackendServiceRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

list(ListRegionBackendServicesRequest request)

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);
   }
 }
 

Parameter
Name	Description
request	ListRegionBackendServicesRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
RegionBackendServicesClient.ListPagedResponse

list(String project, String region)

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
Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.

Returns
Type	Description
RegionBackendServicesClient.ListPagedResponse

listCallable()

public final 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;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<ListRegionBackendServicesRequest,BackendServiceList>

listPagedCallable()

public final 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);
   }
 }
 

Returns
Type	Description
UnaryCallable<ListRegionBackendServicesRequest,ListPagedResponse>

patchAsync(PatchRegionBackendServiceRequest request)

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

Beta

The surface for long-running operations is not stable yet and may change in the future.

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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()) {
   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();
 }
 

Parameter
Name	Description
request	PatchRegionBackendServiceRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
OperationFuture<Operation,Operation>

patchAsync(String project, String region, String backendService, BackendService backendServiceResource)

public final 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
Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
backendService	String Name of the BackendService resource to patch.
backendServiceResource	BackendService The body resource for this request

Returns
Type	Description
OperationFuture<Operation,Operation>

patchCallable()

public final UnaryCallable<PatchRegionBackendServiceRequest,Operation> patchCallable()

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()) {
   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();
 }
 

Returns
Type	Description
UnaryCallable<PatchRegionBackendServiceRequest,Operation>

patchOperationCallable()

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

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()) {
   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();
 }
 

Returns
Type	Description
OperationCallable<PatchRegionBackendServiceRequest,Operation,Operation>

setIamPolicy(SetIamPolicyRegionBackendServiceRequest request)

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);
 }
 

Parameter
Name	Description
request	SetIamPolicyRegionBackendServiceRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
Policy

setIamPolicy(String project, String region, String resource, RegionSetPolicyRequest regionSetPolicyRequestResource)

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
Name	Description
project	String Project ID for this request.
region	String The name of the region for this request.
resource	String Name or id of the resource for this request.
regionSetPolicyRequestResource	RegionSetPolicyRequest The body resource for this request

Returns
Type	Description
Policy

setIamPolicyCallable()

public final 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();
 }
 

Returns
Type	Description
UnaryCallable<SetIamPolicyRegionBackendServiceRequest,Policy>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateAsync(UpdateRegionBackendServiceRequest request)

public final OperationFuture<Operation,Operation> updateAsync(UpdateRegionBackendServiceRequest request)

Beta

The surface for long-running operations is not stable yet and may change in the future.

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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();
 }
 

Parameter
Name	Description
request	UpdateRegionBackendServiceRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
OperationFuture<Operation,Operation>

updateAsync(String project, String region, String backendService, BackendService backendServiceResource)

public final 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
Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
backendService	String Name of the BackendService resource to update.
backendServiceResource	BackendService The body resource for this request

Returns
Type	Description
OperationFuture<Operation,Operation>

updateCallable()

public final 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();
 }
 

Returns
Type	Description
UnaryCallable<UpdateRegionBackendServiceRequest,Operation>

updateOperationCallable()

public final 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();
 }
 

Returns
Type	Description
OperationCallable<UpdateRegionBackendServiceRequest,Operation,Operation>