Class RegionBackendServicesClient
- java.lang.Object
-
- com.google.cloud.compute.v1.RegionBackendServicesClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@Generated("by gapic-generator-java") public class RegionBackendServicesClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: The RegionBackendServices API.This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create()) { String project = "project-309310695"; String region = "region-934795532"; String backendService = "backendService-1884714623"; BackendService response = regionBackendServicesClient.get(project, region, backendService); }
Note: close() needs to be called on the RegionBackendServicesClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of RegionBackendServicesSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library RegionBackendServicesSettings regionBackendServicesSettings = RegionBackendServicesSettings.newBuilder() .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials)) .build(); RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create(regionBackendServicesSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library RegionBackendServicesSettings regionBackendServicesSettings = RegionBackendServicesSettings.newBuilder().setEndpoint(myEndpoint).build(); RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create(regionBackendServicesSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RegionBackendServicesClient.ListFixedSizeCollection
static class
RegionBackendServicesClient.ListPage
static class
RegionBackendServicesClient.ListPagedResponse
-
Constructor Summary
Constructors Modifier Constructor Description protected
RegionBackendServicesClient(RegionBackendServicesSettings settings)
Constructs an instance of RegionBackendServicesClient, using the given settings.protected
RegionBackendServicesClient(RegionBackendServicesStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
awaitTermination(long duration, TimeUnit unit)
void
close()
static RegionBackendServicesClient
create()
Constructs an instance of RegionBackendServicesClient with default settings.static RegionBackendServicesClient
create(RegionBackendServicesSettings settings)
Constructs an instance of RegionBackendServicesClient, using the given settings.static RegionBackendServicesClient
create(RegionBackendServicesStub stub)
Constructs an instance of RegionBackendServicesClient, using the given stub for making calls.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
deleteAsync(DeleteRegionBackendServiceRequest request)
Deletes the specified regional BackendService resource.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
deleteAsync(String project, String region, String backendService)
Deletes the specified regional BackendService resource.com.google.api.gax.rpc.UnaryCallable<DeleteRegionBackendServiceRequest,Operation>
deleteCallable()
Deletes the specified regional BackendService resource.com.google.api.gax.rpc.OperationCallable<DeleteRegionBackendServiceRequest,Operation,Operation>
deleteOperationCallable()
Deletes the specified regional BackendService resource.BackendService
get(GetRegionBackendServiceRequest request)
Returns the specified regional BackendService resource.BackendService
get(String project, String region, String backendService)
Returns the specified regional BackendService resource.com.google.api.gax.rpc.UnaryCallable<GetRegionBackendServiceRequest,BackendService>
getCallable()
Returns the specified regional BackendService resource.BackendServiceGroupHealth
getHealth(GetHealthRegionBackendServiceRequest request)
Gets the most recent health check results for this regional BackendService.BackendServiceGroupHealth
getHealth(String project, String region, String backendService, ResourceGroupReference resourceGroupReferenceResource)
Gets the most recent health check results for this regional BackendService.com.google.api.gax.rpc.UnaryCallable<GetHealthRegionBackendServiceRequest,BackendServiceGroupHealth>
getHealthCallable()
Gets the most recent health check results for this regional BackendService.Policy
getIamPolicy(GetIamPolicyRegionBackendServiceRequest request)
Gets the access control policy for a resource.Policy
getIamPolicy(String project, String region, String resource)
Gets the access control policy for a resource.com.google.api.gax.rpc.UnaryCallable<GetIamPolicyRegionBackendServiceRequest,Policy>
getIamPolicyCallable()
Gets the access control policy for a resource.RegionBackendServicesSettings
getSettings()
RegionBackendServicesStub
getStub()
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
insertAsync(InsertRegionBackendServiceRequest request)
Creates a regional BackendService resource in the specified project using the data included in the request.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
insertAsync(String project, String region, BackendService backendServiceResource)
Creates a regional BackendService resource in the specified project using the data included in the request.com.google.api.gax.rpc.UnaryCallable<InsertRegionBackendServiceRequest,Operation>
insertCallable()
Creates a regional BackendService resource in the specified project using the data included in the request.com.google.api.gax.rpc.OperationCallable<InsertRegionBackendServiceRequest,Operation,Operation>
insertOperationCallable()
Creates a regional BackendService resource in the specified project using the data included in the request.boolean
isShutdown()
boolean
isTerminated()
RegionBackendServicesClient.ListPagedResponse
list(ListRegionBackendServicesRequest request)
Retrieves the list of regional BackendService resources available to the specified project in the given region.RegionBackendServicesClient.ListPagedResponse
list(String project, String region)
Retrieves the list of regional BackendService resources available to the specified project in the given region.com.google.api.gax.rpc.UnaryCallable<ListRegionBackendServicesRequest,BackendServiceList>
listCallable()
Retrieves the list of regional BackendService resources available to the specified project in the given region.com.google.api.gax.rpc.UnaryCallable<ListRegionBackendServicesRequest,RegionBackendServicesClient.ListPagedResponse>
listPagedCallable()
Retrieves the list of regional BackendService resources available to the specified project in the given region.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
patchAsync(PatchRegionBackendServiceRequest request)
Updates the specified regional BackendService resource with the data included in the request.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
patchAsync(String project, String region, String backendService, BackendService backendServiceResource)
Updates the specified regional BackendService resource with the data included in the request.com.google.api.gax.rpc.UnaryCallable<PatchRegionBackendServiceRequest,Operation>
patchCallable()
Updates the specified regional BackendService resource with the data included in the request.com.google.api.gax.rpc.OperationCallable<PatchRegionBackendServiceRequest,Operation,Operation>
patchOperationCallable()
Updates the specified regional BackendService resource with the data included in the request.Policy
setIamPolicy(SetIamPolicyRegionBackendServiceRequest request)
Sets the access control policy on the specified resource.Policy
setIamPolicy(String project, String region, String resource, RegionSetPolicyRequest regionSetPolicyRequestResource)
Sets the access control policy on the specified resource.com.google.api.gax.rpc.UnaryCallable<SetIamPolicyRegionBackendServiceRequest,Policy>
setIamPolicyCallable()
Sets the access control policy on the specified resource.void
shutdown()
void
shutdownNow()
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
updateAsync(UpdateRegionBackendServiceRequest request)
Updates the specified regional BackendService resource with the data included in the request.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
updateAsync(String project, String region, String backendService, BackendService backendServiceResource)
Updates the specified regional BackendService resource with the data included in the request.com.google.api.gax.rpc.UnaryCallable<UpdateRegionBackendServiceRequest,Operation>
updateCallable()
Updates the specified regional BackendService resource with the data included in the request.com.google.api.gax.rpc.OperationCallable<UpdateRegionBackendServiceRequest,Operation,Operation>
updateOperationCallable()
Updates the specified regional BackendService resource with the data included in the request.
-
-
-
Constructor Detail
-
RegionBackendServicesClient
protected RegionBackendServicesClient(RegionBackendServicesSettings settings) throws IOException
Constructs an instance of RegionBackendServicesClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.- Throws:
IOException
-
RegionBackendServicesClient
protected RegionBackendServicesClient(RegionBackendServicesStub stub)
-
-
Method Detail
-
create
public static final RegionBackendServicesClient create() throws IOException
Constructs an instance of RegionBackendServicesClient with default settings.- Throws:
IOException
-
create
public static final RegionBackendServicesClient create(RegionBackendServicesSettings settings) throws IOException
Constructs an instance of RegionBackendServicesClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.- Throws:
IOException
-
create
public static final RegionBackendServicesClient create(RegionBackendServicesStub stub)
Constructs an instance of RegionBackendServicesClient, using the given stub for making calls. This is for advanced usage - prefer using create(RegionBackendServicesSettings).
-
getSettings
public final RegionBackendServicesSettings getSettings()
-
getStub
public RegionBackendServicesStub getStub()
-
deleteAsync
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> deleteAsync(String project, String region, String backendService)
Deletes the specified regional BackendService resource.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create()) { String project = "project-309310695"; String region = "region-934795532"; String backendService = "backendService-1884714623"; Operation response = regionBackendServicesClient.deleteAsync(project, region, backendService).get(); }
- Parameters:
project
- Project ID for this request.region
- Name of the region scoping this request.backendService
- Name of the BackendService resource to delete.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> deleteAsync(DeleteRegionBackendServiceRequest request)
Deletes the specified regional BackendService resource.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create()) { DeleteRegionBackendServiceRequest request = DeleteRegionBackendServiceRequest.newBuilder() .setBackendService("backendService-1884714623") .setProject("project-309310695") .setRegion("region-934795532") .setRequestId("requestId693933066") .build(); Operation response = regionBackendServicesClient.deleteAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteOperationCallable
public final com.google.api.gax.rpc.OperationCallable<DeleteRegionBackendServiceRequest,Operation,Operation> deleteOperationCallable()
Deletes the specified regional BackendService resource.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create()) { DeleteRegionBackendServiceRequest request = DeleteRegionBackendServiceRequest.newBuilder() .setBackendService("backendService-1884714623") .setProject("project-309310695") .setRegion("region-934795532") .setRequestId("requestId693933066") .build(); OperationFuture<Operation, Operation> future = regionBackendServicesClient.deleteOperationCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
deleteCallable
public final com.google.api.gax.rpc.UnaryCallable<DeleteRegionBackendServiceRequest,Operation> deleteCallable()
Deletes the specified regional BackendService resource.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create()) { DeleteRegionBackendServiceRequest request = DeleteRegionBackendServiceRequest.newBuilder() .setBackendService("backendService-1884714623") .setProject("project-309310695") .setRegion("region-934795532") .setRequestId("requestId693933066") .build(); ApiFuture<Operation> future = regionBackendServicesClient.deleteCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
get
public final BackendService get(String project, String region, String backendService)
Returns the specified regional BackendService resource.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create()) { String project = "project-309310695"; String region = "region-934795532"; String backendService = "backendService-1884714623"; BackendService response = regionBackendServicesClient.get(project, region, backendService); }
- Parameters:
project
- Project ID for this request.region
- Name of the region scoping this request.backendService
- Name of the BackendService resource to return.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
get
public final BackendService get(GetRegionBackendServiceRequest request)
Returns the specified regional BackendService resource.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create()) { GetRegionBackendServiceRequest request = GetRegionBackendServiceRequest.newBuilder() .setBackendService("backendService-1884714623") .setProject("project-309310695") .setRegion("region-934795532") .build(); BackendService response = regionBackendServicesClient.get(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getCallable
public final com.google.api.gax.rpc.UnaryCallable<GetRegionBackendServiceRequest,BackendService> getCallable()
Returns the specified regional BackendService resource.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create()) { GetRegionBackendServiceRequest request = GetRegionBackendServiceRequest.newBuilder() .setBackendService("backendService-1884714623") .setProject("project-309310695") .setRegion("region-934795532") .build(); ApiFuture<BackendService> future = regionBackendServicesClient.getCallable().futureCall(request); // Do something. BackendService response = future.get(); }
-
getHealth
public final BackendServiceGroupHealth getHealth(String project, String region, String backendService, ResourceGroupReference resourceGroupReferenceResource)
Gets the most recent health check results for this regional BackendService.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create()) { String project = "project-309310695"; String region = "region-934795532"; String backendService = "backendService-1884714623"; ResourceGroupReference resourceGroupReferenceResource = ResourceGroupReference.newBuilder().build(); BackendServiceGroupHealth response = regionBackendServicesClient.getHealth( project, region, backendService, resourceGroupReferenceResource); }
- Parameters:
project
-region
- Name of the region scoping this request.backendService
- Name of the BackendService resource for which to get health.resourceGroupReferenceResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getHealth
public final BackendServiceGroupHealth getHealth(GetHealthRegionBackendServiceRequest request)
Gets the most recent health check results for this regional BackendService.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create()) { GetHealthRegionBackendServiceRequest request = GetHealthRegionBackendServiceRequest.newBuilder() .setBackendService("backendService-1884714623") .setProject("project-309310695") .setRegion("region-934795532") .setResourceGroupReferenceResource(ResourceGroupReference.newBuilder().build()) .build(); BackendServiceGroupHealth response = regionBackendServicesClient.getHealth(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getHealthCallable
public final com.google.api.gax.rpc.UnaryCallable<GetHealthRegionBackendServiceRequest,BackendServiceGroupHealth> getHealthCallable()
Gets the most recent health check results for this regional BackendService.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create()) { GetHealthRegionBackendServiceRequest request = GetHealthRegionBackendServiceRequest.newBuilder() .setBackendService("backendService-1884714623") .setProject("project-309310695") .setRegion("region-934795532") .setResourceGroupReferenceResource(ResourceGroupReference.newBuilder().build()) .build(); ApiFuture<BackendServiceGroupHealth> future = regionBackendServicesClient.getHealthCallable().futureCall(request); // Do something. BackendServiceGroupHealth response = future.get(); }
-
getIamPolicy
public final Policy getIamPolicy(String project, String region, String resource)
Gets the access control policy for a resource. May be empty if no such policy or resource exists.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create()) { String project = "project-309310695"; String region = "region-934795532"; String resource = "resource-341064690"; Policy response = regionBackendServicesClient.getIamPolicy(project, region, resource); }
- Parameters:
project
- Project ID for this request.region
- The name of the region for this request.resource
- Name or id of the resource for this request.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getIamPolicy
public final Policy getIamPolicy(GetIamPolicyRegionBackendServiceRequest request)
Gets the access control policy for a resource. May be empty if no such policy or resource exists.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create()) { GetIamPolicyRegionBackendServiceRequest request = GetIamPolicyRegionBackendServiceRequest.newBuilder() .setOptionsRequestedPolicyVersion(-574521795) .setProject("project-309310695") .setRegion("region-934795532") .setResource("resource-341064690") .build(); Policy response = regionBackendServicesClient.getIamPolicy(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getIamPolicyCallable
public final com.google.api.gax.rpc.UnaryCallable<GetIamPolicyRegionBackendServiceRequest,Policy> getIamPolicyCallable()
Gets the access control policy for a resource. May be empty if no such policy or resource exists.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create()) { GetIamPolicyRegionBackendServiceRequest request = GetIamPolicyRegionBackendServiceRequest.newBuilder() .setOptionsRequestedPolicyVersion(-574521795) .setProject("project-309310695") .setRegion("region-934795532") .setResource("resource-341064690") .build(); ApiFuture<Policy> future = regionBackendServicesClient.getIamPolicyCallable().futureCall(request); // Do something. Policy response = future.get(); }
-
insertAsync
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> insertAsync(String project, String region, BackendService backendServiceResource)
Creates a regional BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create()) { String project = "project-309310695"; String region = "region-934795532"; BackendService backendServiceResource = BackendService.newBuilder().build(); Operation response = regionBackendServicesClient.insertAsync(project, region, backendServiceResource).get(); }
- Parameters:
project
- Project ID for this request.region
- Name of the region scoping this request.backendServiceResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
insertAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> insertAsync(InsertRegionBackendServiceRequest request)
Creates a regional BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create()) { InsertRegionBackendServiceRequest request = InsertRegionBackendServiceRequest.newBuilder() .setBackendServiceResource(BackendService.newBuilder().build()) .setProject("project-309310695") .setRegion("region-934795532") .setRequestId("requestId693933066") .build(); Operation response = regionBackendServicesClient.insertAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
insertOperationCallable
public final com.google.api.gax.rpc.OperationCallable<InsertRegionBackendServiceRequest,Operation,Operation> insertOperationCallable()
Creates a regional BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create()) { InsertRegionBackendServiceRequest request = InsertRegionBackendServiceRequest.newBuilder() .setBackendServiceResource(BackendService.newBuilder().build()) .setProject("project-309310695") .setRegion("region-934795532") .setRequestId("requestId693933066") .build(); OperationFuture<Operation, Operation> future = regionBackendServicesClient.insertOperationCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
insertCallable
public final com.google.api.gax.rpc.UnaryCallable<InsertRegionBackendServiceRequest,Operation> insertCallable()
Creates a regional BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create()) { InsertRegionBackendServiceRequest request = InsertRegionBackendServiceRequest.newBuilder() .setBackendServiceResource(BackendService.newBuilder().build()) .setProject("project-309310695") .setRegion("region-934795532") .setRequestId("requestId693933066") .build(); ApiFuture<Operation> future = regionBackendServicesClient.insertCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
list
public final RegionBackendServicesClient.ListPagedResponse list(String project, String region)
Retrieves the list of regional BackendService resources available to the specified project in the given region.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create()) { String project = "project-309310695"; String region = "region-934795532"; for (BackendService element : regionBackendServicesClient.list(project, region).iterateAll()) { // doThingsWith(element); } }
- Parameters:
project
- Project ID for this request.region
- Name of the region scoping this request.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
list
public final RegionBackendServicesClient.ListPagedResponse list(ListRegionBackendServicesRequest request)
Retrieves the list of regional BackendService resources available to the specified project in the given region.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create()) { ListRegionBackendServicesRequest request = ListRegionBackendServicesRequest.newBuilder() .setFilter("filter-1274492040") .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setRegion("region-934795532") .setReturnPartialSuccess(true) .build(); for (BackendService element : regionBackendServicesClient.list(request).iterateAll()) { // doThingsWith(element); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListRegionBackendServicesRequest,RegionBackendServicesClient.ListPagedResponse> listPagedCallable()
Retrieves the list of regional BackendService resources available to the specified project in the given region.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create()) { ListRegionBackendServicesRequest request = ListRegionBackendServicesRequest.newBuilder() .setFilter("filter-1274492040") .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setRegion("region-934795532") .setReturnPartialSuccess(true) .build(); ApiFuture<BackendService> future = regionBackendServicesClient.listPagedCallable().futureCall(request); // Do something. for (BackendService element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listCallable
public final com.google.api.gax.rpc.UnaryCallable<ListRegionBackendServicesRequest,BackendServiceList> listCallable()
Retrieves the list of regional BackendService resources available to the specified project in the given region.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create()) { ListRegionBackendServicesRequest request = ListRegionBackendServicesRequest.newBuilder() .setFilter("filter-1274492040") .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setRegion("region-934795532") .setReturnPartialSuccess(true) .build(); while (true) { BackendServiceList response = regionBackendServicesClient.listCallable().call(request); for (BackendService element : response.getItemsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
patchAsync
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> patchAsync(String project, String region, String backendService, BackendService backendServiceResource)
Updates the specified regional BackendService resource with the data included in the request. For more information, see Understanding backend services This method supports PATCH semantics and uses the JSON merge patch format and processing rules.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create()) { String project = "project-309310695"; String region = "region-934795532"; String backendService = "backendService-1884714623"; BackendService backendServiceResource = BackendService.newBuilder().build(); Operation response = regionBackendServicesClient .patchAsync(project, region, backendService, backendServiceResource) .get(); }
- Parameters:
project
- Project ID for this request.region
- Name of the region scoping this request.backendService
- Name of the BackendService resource to patch.backendServiceResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
patchAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> patchAsync(PatchRegionBackendServiceRequest request)
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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
patchOperationCallable
public final com.google.api.gax.rpc.OperationCallable<PatchRegionBackendServiceRequest,Operation,Operation> patchOperationCallable()
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(); }
-
patchCallable
public final com.google.api.gax.rpc.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(); }
-
setIamPolicy
public final Policy setIamPolicy(String project, String region, String resource, RegionSetPolicyRequest regionSetPolicyRequestResource)
Sets the access control policy on the specified resource. Replaces any existing policy.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create()) { String project = "project-309310695"; String region = "region-934795532"; String resource = "resource-341064690"; RegionSetPolicyRequest regionSetPolicyRequestResource = RegionSetPolicyRequest.newBuilder().build(); Policy response = regionBackendServicesClient.setIamPolicy( project, region, resource, regionSetPolicyRequestResource); }
- Parameters:
project
- Project ID for this request.region
- The name of the region for this request.resource
- Name or id of the resource for this request.regionSetPolicyRequestResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
setIamPolicy
public final Policy setIamPolicy(SetIamPolicyRegionBackendServiceRequest request)
Sets the access control policy on the specified resource. Replaces any existing policy.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create()) { SetIamPolicyRegionBackendServiceRequest request = SetIamPolicyRegionBackendServiceRequest.newBuilder() .setProject("project-309310695") .setRegion("region-934795532") .setRegionSetPolicyRequestResource(RegionSetPolicyRequest.newBuilder().build()) .setResource("resource-341064690") .build(); Policy response = regionBackendServicesClient.setIamPolicy(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
setIamPolicyCallable
public final com.google.api.gax.rpc.UnaryCallable<SetIamPolicyRegionBackendServiceRequest,Policy> setIamPolicyCallable()
Sets the access control policy on the specified resource. Replaces any existing policy.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create()) { SetIamPolicyRegionBackendServiceRequest request = SetIamPolicyRegionBackendServiceRequest.newBuilder() .setProject("project-309310695") .setRegion("region-934795532") .setRegionSetPolicyRequestResource(RegionSetPolicyRequest.newBuilder().build()) .setResource("resource-341064690") .build(); ApiFuture<Policy> future = regionBackendServicesClient.setIamPolicyCallable().futureCall(request); // Do something. Policy response = future.get(); }
-
updateAsync
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> updateAsync(String project, String region, String backendService, BackendService backendServiceResource)
Updates the specified regional BackendService resource with the data included in the request. For more information, see Backend services overview .Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create()) { String project = "project-309310695"; String region = "region-934795532"; String backendService = "backendService-1884714623"; BackendService backendServiceResource = BackendService.newBuilder().build(); Operation response = regionBackendServicesClient .updateAsync(project, region, backendService, backendServiceResource) .get(); }
- Parameters:
project
- Project ID for this request.region
- Name of the region scoping this request.backendService
- Name of the BackendService resource to update.backendServiceResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> updateAsync(UpdateRegionBackendServiceRequest request)
Updates the specified regional BackendService resource with the data included in the request. For more information, see Backend services overview .Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create()) { UpdateRegionBackendServiceRequest request = UpdateRegionBackendServiceRequest.newBuilder() .setBackendService("backendService-1884714623") .setBackendServiceResource(BackendService.newBuilder().build()) .setProject("project-309310695") .setRegion("region-934795532") .setRequestId("requestId693933066") .build(); Operation response = regionBackendServicesClient.updateAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateOperationCallable
public final com.google.api.gax.rpc.OperationCallable<UpdateRegionBackendServiceRequest,Operation,Operation> updateOperationCallable()
Updates the specified regional BackendService resource with the data included in the request. For more information, see Backend services overview .Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create()) { UpdateRegionBackendServiceRequest request = UpdateRegionBackendServiceRequest.newBuilder() .setBackendService("backendService-1884714623") .setBackendServiceResource(BackendService.newBuilder().build()) .setProject("project-309310695") .setRegion("region-934795532") .setRequestId("requestId693933066") .build(); OperationFuture<Operation, Operation> future = regionBackendServicesClient.updateOperationCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
updateCallable
public final com.google.api.gax.rpc.UnaryCallable<UpdateRegionBackendServiceRequest,Operation> updateCallable()
Updates the specified regional BackendService resource with the data included in the request. For more information, see Backend services overview .Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (RegionBackendServicesClient regionBackendServicesClient = RegionBackendServicesClient.create()) { UpdateRegionBackendServiceRequest request = UpdateRegionBackendServiceRequest.newBuilder() .setBackendService("backendService-1884714623") .setBackendServiceResource(BackendService.newBuilder().build()) .setProject("project-309310695") .setRegion("region-934795532") .setRequestId("requestId693933066") .build(); ApiFuture<Operation> future = regionBackendServicesClient.updateCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
InterruptedException
-
-