com.google.cloud.compute.v1

Class RegionBackendServiceClient

java.lang.Object

com.google.cloud.compute.v1.RegionBackendServiceClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
public class RegionBackendServiceClient
extends Object
implements BackgroundResource

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

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

 
 try (RegionBackendServiceClient regionBackendServiceClient = RegionBackendServiceClient.create()) {
   ProjectRegionBackendServiceName backendService = ProjectRegionBackendServiceName.of("[PROJECT]", "[REGION]", "[BACKEND_SERVICE]");
   Operation response = regionBackendServiceClient.deleteRegionBackendService(backendService);
 }
 
 

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

To customize credentials:

 
 RegionBackendServiceSettings regionBackendServiceSettings =
     RegionBackendServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegionBackendServiceClient regionBackendServiceClient =
     RegionBackendServiceClient.create(regionBackendServiceSettings);
 
 

To customize the endpoint:

 
 RegionBackendServiceSettings regionBackendServiceSettings =
     RegionBackendServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 RegionBackendServiceClient regionBackendServiceClient =
     RegionBackendServiceClient.create(regionBackendServiceSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegionBackendServiceClient.ListRegionBackendServicesFixedSizeCollection
static class	RegionBackendServiceClient.ListRegionBackendServicesPage
static class	RegionBackendServiceClient.ListRegionBackendServicesPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RegionBackendServiceClient(RegionBackendServiceSettings settings) Constructs an instance of RegionBackendServiceClient, using the given settings.
protected	RegionBackendServiceClient(RegionBackendServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static RegionBackendServiceClient	create() Constructs an instance of RegionBackendServiceClient with default settings.
static RegionBackendServiceClient	create(RegionBackendServiceSettings settings) Constructs an instance of RegionBackendServiceClient, using the given settings.
static RegionBackendServiceClient	create(RegionBackendServiceStub stub) Constructs an instance of RegionBackendServiceClient, using the given stub for making calls.
Operation	deleteRegionBackendService(DeleteRegionBackendServiceHttpRequest request) Deletes the specified regional BackendService resource.
Operation	deleteRegionBackendService(ProjectRegionBackendServiceName backendService) Deletes the specified regional BackendService resource.
Operation	deleteRegionBackendService(String backendService) Deletes the specified regional BackendService resource.
UnaryCallable<DeleteRegionBackendServiceHttpRequest,Operation>	deleteRegionBackendServiceCallable() Deletes the specified regional BackendService resource.
BackendServiceGroupHealth	getHealthRegionBackendService(GetHealthRegionBackendServiceHttpRequest request) Gets the most recent health check results for this regional BackendService.
BackendServiceGroupHealth	getHealthRegionBackendService(ProjectRegionBackendServiceName backendService, ResourceGroupReference resourceGroupReferenceResource) Gets the most recent health check results for this regional BackendService.
BackendServiceGroupHealth	getHealthRegionBackendService(String backendService, ResourceGroupReference resourceGroupReferenceResource) Gets the most recent health check results for this regional BackendService.
UnaryCallable<GetHealthRegionBackendServiceHttpRequest,BackendServiceGroupHealth>	getHealthRegionBackendServiceCallable() Gets the most recent health check results for this regional BackendService.
BackendService	getRegionBackendService(GetRegionBackendServiceHttpRequest request) Returns the specified regional BackendService resource.
BackendService	getRegionBackendService(ProjectRegionBackendServiceName backendService) Returns the specified regional BackendService resource.
BackendService	getRegionBackendService(String backendService) Returns the specified regional BackendService resource.
UnaryCallable<GetRegionBackendServiceHttpRequest,BackendService>	getRegionBackendServiceCallable() Returns the specified regional BackendService resource.
RegionBackendServiceSettings	getSettings()
RegionBackendServiceStub	getStub()
Operation	insertRegionBackendService(InsertRegionBackendServiceHttpRequest request) Creates a regional BackendService resource in the specified project using the data included in the request.
Operation	insertRegionBackendService(ProjectRegionName region, BackendService backendServiceResource) Creates a regional BackendService resource in the specified project using the data included in the request.
Operation	insertRegionBackendService(String region, BackendService backendServiceResource) Creates a regional BackendService resource in the specified project using the data included in the request.
UnaryCallable<InsertRegionBackendServiceHttpRequest,Operation>	insertRegionBackendServiceCallable() Creates a regional BackendService resource in the specified project using the data included in the request.
boolean	isShutdown()
boolean	isTerminated()
RegionBackendServiceClient.ListRegionBackendServicesPagedResponse	listRegionBackendServices(ListRegionBackendServicesHttpRequest request) Retrieves the list of regional BackendService resources available to the specified project in the given region.
RegionBackendServiceClient.ListRegionBackendServicesPagedResponse	listRegionBackendServices(ProjectRegionName region) Retrieves the list of regional BackendService resources available to the specified project in the given region.
RegionBackendServiceClient.ListRegionBackendServicesPagedResponse	listRegionBackendServices(String region) Retrieves the list of regional BackendService resources available to the specified project in the given region.
UnaryCallable<ListRegionBackendServicesHttpRequest,BackendServiceList>	listRegionBackendServicesCallable() Retrieves the list of regional BackendService resources available to the specified project in the given region.
UnaryCallable<ListRegionBackendServicesHttpRequest,RegionBackendServiceClient.ListRegionBackendServicesPagedResponse>	listRegionBackendServicesPagedCallable() Retrieves the list of regional BackendService resources available to the specified project in the given region.
Operation	patchRegionBackendService(PatchRegionBackendServiceHttpRequest request) Updates the specified regional BackendService resource with the data included in the request.
Operation	patchRegionBackendService(ProjectRegionBackendServiceName backendService, BackendService backendServiceResource, List<String> fieldMask) Updates the specified regional BackendService resource with the data included in the request.
Operation	patchRegionBackendService(String backendService, BackendService backendServiceResource, List<String> fieldMask) Updates the specified regional BackendService resource with the data included in the request.
UnaryCallable<PatchRegionBackendServiceHttpRequest,Operation>	patchRegionBackendServiceCallable() Updates the specified regional BackendService resource with the data included in the request.
void	shutdown()
void	shutdownNow()
Operation	updateRegionBackendService(ProjectRegionBackendServiceName backendService, BackendService backendServiceResource, List<String> fieldMask) Updates the specified regional BackendService resource with the data included in the request.
Operation	updateRegionBackendService(String backendService, BackendService backendServiceResource, List<String> fieldMask) Updates the specified regional BackendService resource with the data included in the request.
Operation	updateRegionBackendService(UpdateRegionBackendServiceHttpRequest request) Updates the specified regional BackendService resource with the data included in the request.
UnaryCallable<UpdateRegionBackendServiceHttpRequest,Operation>	updateRegionBackendServiceCallable() 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

RegionBackendServiceClient

protected RegionBackendServiceClient(RegionBackendServiceSettings settings)
                              throws IOException

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

RegionBackendServiceClient

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

Method Detail

create

public static final RegionBackendServiceClient create()
                                               throws IOException

Constructs an instance of RegionBackendServiceClient with default settings.

Throws:

IOException

create

public static final RegionBackendServiceClient create(RegionBackendServiceSettings settings)
                                               throws IOException

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

Throws:

IOException

create

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

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

getSettings

public final RegionBackendServiceSettings getSettings()

getStub

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

deleteRegionBackendService

@BetaApi
public final Operation deleteRegionBackendService(ProjectRegionBackendServiceName backendService)

Deletes the specified regional BackendService resource.

Sample code:

 try (RegionBackendServiceClient regionBackendServiceClient = RegionBackendServiceClient.create()) {
   ProjectRegionBackendServiceName backendService = ProjectRegionBackendServiceName.of("[PROJECT]", "[REGION]", "[BACKEND_SERVICE]");
   Operation response = regionBackendServiceClient.deleteRegionBackendService(backendService);
 }
 

Parameters:

backendService - Name of the BackendService resource to delete.

Throws:

ApiException - if the remote call fails

deleteRegionBackendService

@BetaApi
public final Operation deleteRegionBackendService(String backendService)

Deletes the specified regional BackendService resource.

Sample code:

 try (RegionBackendServiceClient regionBackendServiceClient = RegionBackendServiceClient.create()) {
   ProjectRegionBackendServiceName backendService = ProjectRegionBackendServiceName.of("[PROJECT]", "[REGION]", "[BACKEND_SERVICE]");
   Operation response = regionBackendServiceClient.deleteRegionBackendService(backendService.toString());
 }
 

Parameters:

backendService - Name of the BackendService resource to delete.

Throws:

ApiException - if the remote call fails

deleteRegionBackendService

@BetaApi
public final Operation deleteRegionBackendService(DeleteRegionBackendServiceHttpRequest request)

Deletes the specified regional BackendService resource.

Sample code:

 try (RegionBackendServiceClient regionBackendServiceClient = RegionBackendServiceClient.create()) {
   String formattedBackendService = ProjectRegionBackendServiceName.format("[PROJECT]", "[REGION]", "[BACKEND_SERVICE]");
   DeleteRegionBackendServiceHttpRequest request = DeleteRegionBackendServiceHttpRequest.newBuilder()
     .setBackendService(formattedBackendService)
     .build();
   Operation response = regionBackendServiceClient.deleteRegionBackendService(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

deleteRegionBackendServiceCallable

@BetaApi
public final UnaryCallable<DeleteRegionBackendServiceHttpRequest,Operation> deleteRegionBackendServiceCallable()

Deletes the specified regional BackendService resource.

Sample code:

 try (RegionBackendServiceClient regionBackendServiceClient = RegionBackendServiceClient.create()) {
   String formattedBackendService = ProjectRegionBackendServiceName.format("[PROJECT]", "[REGION]", "[BACKEND_SERVICE]");
   DeleteRegionBackendServiceHttpRequest request = DeleteRegionBackendServiceHttpRequest.newBuilder()
     .setBackendService(formattedBackendService)
     .build();
   ApiFuture<Operation> future = regionBackendServiceClient.deleteRegionBackendServiceCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

getRegionBackendService

@BetaApi
public final BackendService getRegionBackendService(ProjectRegionBackendServiceName backendService)

Returns the specified regional BackendService resource.

Sample code:

 try (RegionBackendServiceClient regionBackendServiceClient = RegionBackendServiceClient.create()) {
   ProjectRegionBackendServiceName backendService = ProjectRegionBackendServiceName.of("[PROJECT]", "[REGION]", "[BACKEND_SERVICE]");
   BackendService response = regionBackendServiceClient.getRegionBackendService(backendService);
 }
 

Parameters:

backendService - Name of the BackendService resource to return.

Throws:

ApiException - if the remote call fails

getRegionBackendService

@BetaApi
public final BackendService getRegionBackendService(String backendService)

Returns the specified regional BackendService resource.

Sample code:

 try (RegionBackendServiceClient regionBackendServiceClient = RegionBackendServiceClient.create()) {
   ProjectRegionBackendServiceName backendService = ProjectRegionBackendServiceName.of("[PROJECT]", "[REGION]", "[BACKEND_SERVICE]");
   BackendService response = regionBackendServiceClient.getRegionBackendService(backendService.toString());
 }
 

Parameters:

backendService - Name of the BackendService resource to return.

Throws:

ApiException - if the remote call fails

getRegionBackendService

@BetaApi
public final BackendService getRegionBackendService(GetRegionBackendServiceHttpRequest request)

Returns the specified regional BackendService resource.

Sample code:

 try (RegionBackendServiceClient regionBackendServiceClient = RegionBackendServiceClient.create()) {
   String formattedBackendService = ProjectRegionBackendServiceName.format("[PROJECT]", "[REGION]", "[BACKEND_SERVICE]");
   GetRegionBackendServiceHttpRequest request = GetRegionBackendServiceHttpRequest.newBuilder()
     .setBackendService(formattedBackendService)
     .build();
   BackendService response = regionBackendServiceClient.getRegionBackendService(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

getRegionBackendServiceCallable

@BetaApi
public final UnaryCallable<GetRegionBackendServiceHttpRequest,BackendService> getRegionBackendServiceCallable()

Returns the specified regional BackendService resource.

Sample code:

 try (RegionBackendServiceClient regionBackendServiceClient = RegionBackendServiceClient.create()) {
   String formattedBackendService = ProjectRegionBackendServiceName.format("[PROJECT]", "[REGION]", "[BACKEND_SERVICE]");
   GetRegionBackendServiceHttpRequest request = GetRegionBackendServiceHttpRequest.newBuilder()
     .setBackendService(formattedBackendService)
     .build();
   ApiFuture<BackendService> future = regionBackendServiceClient.getRegionBackendServiceCallable().futureCall(request);
   // Do something
   BackendService response = future.get();
 }
 

getHealthRegionBackendService

@BetaApi
public final BackendServiceGroupHealth getHealthRegionBackendService(ProjectRegionBackendServiceName backendService,
                                                                              ResourceGroupReference resourceGroupReferenceResource)

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

Sample code:

 try (RegionBackendServiceClient regionBackendServiceClient = RegionBackendServiceClient.create()) {
   ProjectRegionBackendServiceName backendService = ProjectRegionBackendServiceName.of("[PROJECT]", "[REGION]", "[BACKEND_SERVICE]");
   ResourceGroupReference resourceGroupReferenceResource = ResourceGroupReference.newBuilder().build();
   BackendServiceGroupHealth response = regionBackendServiceClient.getHealthRegionBackendService(backendService, resourceGroupReferenceResource);
 }
 

Parameters:

backendService - Name of the BackendService resource for which to get health.

resourceGroupReferenceResource -

Throws:

ApiException - if the remote call fails

getHealthRegionBackendService

@BetaApi
public final BackendServiceGroupHealth getHealthRegionBackendService(String backendService,
                                                                              ResourceGroupReference resourceGroupReferenceResource)

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

Sample code:

 try (RegionBackendServiceClient regionBackendServiceClient = RegionBackendServiceClient.create()) {
   ProjectRegionBackendServiceName backendService = ProjectRegionBackendServiceName.of("[PROJECT]", "[REGION]", "[BACKEND_SERVICE]");
   ResourceGroupReference resourceGroupReferenceResource = ResourceGroupReference.newBuilder().build();
   BackendServiceGroupHealth response = regionBackendServiceClient.getHealthRegionBackendService(backendService.toString(), resourceGroupReferenceResource);
 }
 

Parameters:

backendService - Name of the BackendService resource for which to get health.

resourceGroupReferenceResource -

Throws:

ApiException - if the remote call fails

getHealthRegionBackendService

@BetaApi
public final BackendServiceGroupHealth getHealthRegionBackendService(GetHealthRegionBackendServiceHttpRequest request)

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

Sample code:

 try (RegionBackendServiceClient regionBackendServiceClient = RegionBackendServiceClient.create()) {
   String formattedBackendService = ProjectRegionBackendServiceName.format("[PROJECT]", "[REGION]", "[BACKEND_SERVICE]");
   ResourceGroupReference resourceGroupReferenceResource = ResourceGroupReference.newBuilder().build();
   GetHealthRegionBackendServiceHttpRequest request = GetHealthRegionBackendServiceHttpRequest.newBuilder()
     .setBackendService(formattedBackendService)
     .setResourceGroupReferenceResource(resourceGroupReferenceResource)
     .build();
   BackendServiceGroupHealth response = regionBackendServiceClient.getHealthRegionBackendService(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

getHealthRegionBackendServiceCallable

@BetaApi
public final UnaryCallable<GetHealthRegionBackendServiceHttpRequest,BackendServiceGroupHealth> getHealthRegionBackendServiceCallable()

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

Sample code:

 try (RegionBackendServiceClient regionBackendServiceClient = RegionBackendServiceClient.create()) {
   String formattedBackendService = ProjectRegionBackendServiceName.format("[PROJECT]", "[REGION]", "[BACKEND_SERVICE]");
   ResourceGroupReference resourceGroupReferenceResource = ResourceGroupReference.newBuilder().build();
   GetHealthRegionBackendServiceHttpRequest request = GetHealthRegionBackendServiceHttpRequest.newBuilder()
     .setBackendService(formattedBackendService)
     .setResourceGroupReferenceResource(resourceGroupReferenceResource)
     .build();
   ApiFuture<BackendServiceGroupHealth> future = regionBackendServiceClient.getHealthRegionBackendServiceCallable().futureCall(request);
   // Do something
   BackendServiceGroupHealth response = future.get();
 }
 

insertRegionBackendService

@BetaApi
public final Operation insertRegionBackendService(ProjectRegionName region,
                                                           BackendService backendServiceResource)

Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read Restrictions and Guidelines for more information.

Sample code:

 try (RegionBackendServiceClient regionBackendServiceClient = RegionBackendServiceClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   BackendService backendServiceResource = BackendService.newBuilder().build();
   Operation response = regionBackendServiceClient.insertRegionBackendService(region, backendServiceResource);
 }
 

Parameters:

region - Name of the region scoping this request.

backendServiceResource - A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==)

Throws:

ApiException - if the remote call fails

insertRegionBackendService

@BetaApi
public final Operation insertRegionBackendService(String region,
                                                           BackendService backendServiceResource)

Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read Restrictions and Guidelines for more information.

Sample code:

 try (RegionBackendServiceClient regionBackendServiceClient = RegionBackendServiceClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   BackendService backendServiceResource = BackendService.newBuilder().build();
   Operation response = regionBackendServiceClient.insertRegionBackendService(region.toString(), backendServiceResource);
 }
 

Parameters:

region - Name of the region scoping this request.

backendServiceResource - A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==)

Throws:

ApiException - if the remote call fails

insertRegionBackendService

@BetaApi
public final Operation insertRegionBackendService(InsertRegionBackendServiceHttpRequest request)

Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read Restrictions and Guidelines for more information.

Sample code:

 try (RegionBackendServiceClient regionBackendServiceClient = RegionBackendServiceClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   BackendService backendServiceResource = BackendService.newBuilder().build();
   InsertRegionBackendServiceHttpRequest request = InsertRegionBackendServiceHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .setBackendServiceResource(backendServiceResource)
     .build();
   Operation response = regionBackendServiceClient.insertRegionBackendService(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

insertRegionBackendServiceCallable

@BetaApi
public final UnaryCallable<InsertRegionBackendServiceHttpRequest,Operation> insertRegionBackendServiceCallable()

Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read Restrictions and Guidelines for more information.

Sample code:

 try (RegionBackendServiceClient regionBackendServiceClient = RegionBackendServiceClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   BackendService backendServiceResource = BackendService.newBuilder().build();
   InsertRegionBackendServiceHttpRequest request = InsertRegionBackendServiceHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .setBackendServiceResource(backendServiceResource)
     .build();
   ApiFuture<Operation> future = regionBackendServiceClient.insertRegionBackendServiceCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

listRegionBackendServices

@BetaApi
public final RegionBackendServiceClient.ListRegionBackendServicesPagedResponse listRegionBackendServices(ProjectRegionName region)

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

Sample code:

 try (RegionBackendServiceClient regionBackendServiceClient = RegionBackendServiceClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   for (BackendService element : regionBackendServiceClient.listRegionBackendServices(region).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

region - Name of the region scoping this request.

Throws:

ApiException - if the remote call fails

listRegionBackendServices

@BetaApi
public final RegionBackendServiceClient.ListRegionBackendServicesPagedResponse listRegionBackendServices(String region)

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

Sample code:

 try (RegionBackendServiceClient regionBackendServiceClient = RegionBackendServiceClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   for (BackendService element : regionBackendServiceClient.listRegionBackendServices(region.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

region - Name of the region scoping this request.

Throws:

ApiException - if the remote call fails

listRegionBackendServices

@BetaApi
public final RegionBackendServiceClient.ListRegionBackendServicesPagedResponse listRegionBackendServices(ListRegionBackendServicesHttpRequest request)

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

Sample code:

 try (RegionBackendServiceClient regionBackendServiceClient = RegionBackendServiceClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ListRegionBackendServicesHttpRequest request = ListRegionBackendServicesHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   for (BackendService element : regionBackendServiceClient.listRegionBackendServices(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

listRegionBackendServicesPagedCallable

@BetaApi
public final UnaryCallable<ListRegionBackendServicesHttpRequest,RegionBackendServiceClient.ListRegionBackendServicesPagedResponse> listRegionBackendServicesPagedCallable()

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

Sample code:

 try (RegionBackendServiceClient regionBackendServiceClient = RegionBackendServiceClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ListRegionBackendServicesHttpRequest request = ListRegionBackendServicesHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   ApiFuture<ListRegionBackendServicesPagedResponse> future = regionBackendServiceClient.listRegionBackendServicesPagedCallable().futureCall(request);
   // Do something
   for (BackendService element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listRegionBackendServicesCallable

@BetaApi
public final UnaryCallable<ListRegionBackendServicesHttpRequest,BackendServiceList> listRegionBackendServicesCallable()

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

Sample code:

 try (RegionBackendServiceClient regionBackendServiceClient = RegionBackendServiceClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ListRegionBackendServicesHttpRequest request = ListRegionBackendServicesHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   while (true) {
     BackendServiceList response = regionBackendServiceClient.listRegionBackendServicesCallable().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;
     }
   }
 }
 

patchRegionBackendService

@BetaApi
public final Operation patchRegionBackendService(ProjectRegionBackendServiceName backendService,
                                                          BackendService backendServiceResource,
                                                          List<String> fieldMask)

Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Sample code:

 try (RegionBackendServiceClient regionBackendServiceClient = RegionBackendServiceClient.create()) {
   ProjectRegionBackendServiceName backendService = ProjectRegionBackendServiceName.of("[PROJECT]", "[REGION]", "[BACKEND_SERVICE]");
   BackendService backendServiceResource = BackendService.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = regionBackendServiceClient.patchRegionBackendService(backendService, backendServiceResource, fieldMask);
 }
 

Parameters:

backendService - Name of the BackendService resource to patch.

backendServiceResource - A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==)

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

Throws:

ApiException - if the remote call fails

patchRegionBackendService

@BetaApi
public final Operation patchRegionBackendService(String backendService,
                                                          BackendService backendServiceResource,
                                                          List<String> fieldMask)

Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Sample code:

 try (RegionBackendServiceClient regionBackendServiceClient = RegionBackendServiceClient.create()) {
   ProjectRegionBackendServiceName backendService = ProjectRegionBackendServiceName.of("[PROJECT]", "[REGION]", "[BACKEND_SERVICE]");
   BackendService backendServiceResource = BackendService.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = regionBackendServiceClient.patchRegionBackendService(backendService.toString(), backendServiceResource, fieldMask);
 }
 

Parameters:

backendService - Name of the BackendService resource to patch.

backendServiceResource - A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==)

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

Throws:

ApiException - if the remote call fails

patchRegionBackendService

@BetaApi
public final Operation patchRegionBackendService(PatchRegionBackendServiceHttpRequest request)

Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Sample code:

 try (RegionBackendServiceClient regionBackendServiceClient = RegionBackendServiceClient.create()) {
   String formattedBackendService = ProjectRegionBackendServiceName.format("[PROJECT]", "[REGION]", "[BACKEND_SERVICE]");
   BackendService backendServiceResource = BackendService.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   PatchRegionBackendServiceHttpRequest request = PatchRegionBackendServiceHttpRequest.newBuilder()
     .setBackendService(formattedBackendService)
     .setBackendServiceResource(backendServiceResource)
     .addAllFieldMask(fieldMask)
     .build();
   Operation response = regionBackendServiceClient.patchRegionBackendService(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

patchRegionBackendServiceCallable

@BetaApi
public final UnaryCallable<PatchRegionBackendServiceHttpRequest,Operation> patchRegionBackendServiceCallable()

Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Sample code:

 try (RegionBackendServiceClient regionBackendServiceClient = RegionBackendServiceClient.create()) {
   String formattedBackendService = ProjectRegionBackendServiceName.format("[PROJECT]", "[REGION]", "[BACKEND_SERVICE]");
   BackendService backendServiceResource = BackendService.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   PatchRegionBackendServiceHttpRequest request = PatchRegionBackendServiceHttpRequest.newBuilder()
     .setBackendService(formattedBackendService)
     .setBackendServiceResource(backendServiceResource)
     .addAllFieldMask(fieldMask)
     .build();
   ApiFuture<Operation> future = regionBackendServiceClient.patchRegionBackendServiceCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

updateRegionBackendService

@BetaApi
public final Operation updateRegionBackendService(ProjectRegionBackendServiceName backendService,
                                                           BackendService backendServiceResource,
                                                           List<String> fieldMask)

Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.

Sample code:

 try (RegionBackendServiceClient regionBackendServiceClient = RegionBackendServiceClient.create()) {
   ProjectRegionBackendServiceName backendService = ProjectRegionBackendServiceName.of("[PROJECT]", "[REGION]", "[BACKEND_SERVICE]");
   BackendService backendServiceResource = BackendService.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = regionBackendServiceClient.updateRegionBackendService(backendService, backendServiceResource, fieldMask);
 }
 

Parameters:

backendService - Name of the BackendService resource to update.

backendServiceResource - A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==)

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

Throws:

ApiException - if the remote call fails

updateRegionBackendService

@BetaApi
public final Operation updateRegionBackendService(String backendService,
                                                           BackendService backendServiceResource,
                                                           List<String> fieldMask)

Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.

Sample code:

 try (RegionBackendServiceClient regionBackendServiceClient = RegionBackendServiceClient.create()) {
   ProjectRegionBackendServiceName backendService = ProjectRegionBackendServiceName.of("[PROJECT]", "[REGION]", "[BACKEND_SERVICE]");
   BackendService backendServiceResource = BackendService.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = regionBackendServiceClient.updateRegionBackendService(backendService.toString(), backendServiceResource, fieldMask);
 }
 

Parameters:

backendService - Name of the BackendService resource to update.

backendServiceResource - A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==)

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

Throws:

ApiException - if the remote call fails

updateRegionBackendService

@BetaApi
public final Operation updateRegionBackendService(UpdateRegionBackendServiceHttpRequest request)

Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.

Sample code:

 try (RegionBackendServiceClient regionBackendServiceClient = RegionBackendServiceClient.create()) {
   String formattedBackendService = ProjectRegionBackendServiceName.format("[PROJECT]", "[REGION]", "[BACKEND_SERVICE]");
   BackendService backendServiceResource = BackendService.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   UpdateRegionBackendServiceHttpRequest request = UpdateRegionBackendServiceHttpRequest.newBuilder()
     .setBackendService(formattedBackendService)
     .setBackendServiceResource(backendServiceResource)
     .addAllFieldMask(fieldMask)
     .build();
   Operation response = regionBackendServiceClient.updateRegionBackendService(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

updateRegionBackendServiceCallable

@BetaApi
public final UnaryCallable<UpdateRegionBackendServiceHttpRequest,Operation> updateRegionBackendServiceCallable()

Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.

Sample code:

 try (RegionBackendServiceClient regionBackendServiceClient = RegionBackendServiceClient.create()) {
   String formattedBackendService = ProjectRegionBackendServiceName.format("[PROJECT]", "[REGION]", "[BACKEND_SERVICE]");
   BackendService backendServiceResource = BackendService.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   UpdateRegionBackendServiceHttpRequest request = UpdateRegionBackendServiceHttpRequest.newBuilder()
     .setBackendService(formattedBackendService)
     .setBackendServiceResource(backendServiceResource)
     .addAllFieldMask(fieldMask)
     .build();
   ApiFuture<Operation> future = regionBackendServiceClient.updateRegionBackendServiceCallable().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 BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface BackgroundResource

awaitTermination

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

Specified by:

awaitTermination in interface BackgroundResource

Throws:

InterruptedException