RegionHealthChecksClient (Google Compute Engine 1.59.0 API)

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

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

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

Service Description: The RegionHealthChecks 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 (RegionHealthChecksClient regionHealthChecksClient = RegionHealthChecksClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String healthCheck = "healthCheck-1938093044";
   HealthCheck response = regionHealthChecksClient.get(project, region, healthCheck);
 }

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

Methods
Method	Description	Method Variants
Delete	Deletes the specified HealthCheck resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteAsync(DeleteRegionHealthCheckRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteAsync(String project, String region, String healthCheck) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteOperationCallable() deleteCallable()
Get	Returns the specified HealthCheck resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. get(GetRegionHealthCheckRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. get(String project, String region, String healthCheck) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getCallable()
Insert	Creates a HealthCheck resource in the specified project using the data included in the request.	Request object method variants only take one parameter, a request object, which must be constructed before the call. insertAsync(InsertRegionHealthCheckRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. insertAsync(String project, String region, HealthCheck healthCheckResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. insertOperationCallable() insertCallable()
List	Retrieves the list of HealthCheck resources available to the specified project.	Request object method variants only take one parameter, a request object, which must be constructed before the call. list(ListRegionHealthChecksRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. list(String project, String region) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listPagedCallable() listCallable()
Patch	Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.	Request object method variants only take one parameter, a request object, which must be constructed before the call. patchAsync(PatchRegionHealthCheckRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. patchAsync(String project, String region, String healthCheck, HealthCheck healthCheckResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. patchOperationCallable() patchCallable()
Update	Updates a HealthCheck resource in the specified project using the data included in the request.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateAsync(UpdateRegionHealthCheckRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. updateAsync(String project, String region, String healthCheck, HealthCheck healthCheckResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateOperationCallable() updateCallable()

See the individual methods for example code.

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

This class can be customized by passing in a custom instance of RegionHealthChecksSettings 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
 RegionHealthChecksSettings regionHealthChecksSettings =
     RegionHealthChecksSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegionHealthChecksClient regionHealthChecksClient =
     RegionHealthChecksClient.create(regionHealthChecksSettings);

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
 RegionHealthChecksSettings regionHealthChecksSettings =
     RegionHealthChecksSettings.newBuilder().setEndpoint(myEndpoint).build();
 RegionHealthChecksClient regionHealthChecksClient =
     RegionHealthChecksClient.create(regionHealthChecksSettings);

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RegionHealthChecksClient.ListFixedSizeCollection`
`static class`	`RegionHealthChecksClient.ListPage`
`static class`	`RegionHealthChecksClient.ListPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`RegionHealthChecksClient(RegionHealthChecksSettings settings)` Constructs an instance of RegionHealthChecksClient, using the given settings.
`protected`	`RegionHealthChecksClient(RegionHealthChecksStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static RegionHealthChecksClient`	`create()` Constructs an instance of RegionHealthChecksClient with default settings.
`static RegionHealthChecksClient`	`create(RegionHealthChecksSettings settings)` Constructs an instance of RegionHealthChecksClient, using the given settings.
`static RegionHealthChecksClient`	`create(RegionHealthChecksStub stub)` Constructs an instance of RegionHealthChecksClient, using the given stub for making calls.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`deleteAsync(DeleteRegionHealthCheckRequest request)` Deletes the specified HealthCheck resource.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`deleteAsync(String project, String region, String healthCheck)` Deletes the specified HealthCheck resource.
`com.google.api.gax.rpc.UnaryCallable<DeleteRegionHealthCheckRequest,Operation>`	`deleteCallable()` Deletes the specified HealthCheck resource.
`com.google.api.gax.rpc.OperationCallable<DeleteRegionHealthCheckRequest,Operation,Operation>`	`deleteOperationCallable()` Deletes the specified HealthCheck resource.
`HealthCheck`	`get(GetRegionHealthCheckRequest request)` Returns the specified HealthCheck resource.
`HealthCheck`	`get(String project, String region, String healthCheck)` Returns the specified HealthCheck resource.
`com.google.api.gax.rpc.UnaryCallable<GetRegionHealthCheckRequest,HealthCheck>`	`getCallable()` Returns the specified HealthCheck resource.
`RegionHealthChecksSettings`	`getSettings()`
`RegionHealthChecksStub`	`getStub()`
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`insertAsync(InsertRegionHealthCheckRequest request)` Creates a HealthCheck 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, HealthCheck healthCheckResource)` Creates a HealthCheck resource in the specified project using the data included in the request.
`com.google.api.gax.rpc.UnaryCallable<InsertRegionHealthCheckRequest,Operation>`	`insertCallable()` Creates a HealthCheck resource in the specified project using the data included in the request.
`com.google.api.gax.rpc.OperationCallable<InsertRegionHealthCheckRequest,Operation,Operation>`	`insertOperationCallable()` Creates a HealthCheck resource in the specified project using the data included in the request.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`RegionHealthChecksClient.ListPagedResponse`	`list(ListRegionHealthChecksRequest request)` Retrieves the list of HealthCheck resources available to the specified project.
`RegionHealthChecksClient.ListPagedResponse`	`list(String project, String region)` Retrieves the list of HealthCheck resources available to the specified project.
`com.google.api.gax.rpc.UnaryCallable<ListRegionHealthChecksRequest,HealthCheckList>`	`listCallable()` Retrieves the list of HealthCheck resources available to the specified project.
`com.google.api.gax.rpc.UnaryCallable<ListRegionHealthChecksRequest,RegionHealthChecksClient.ListPagedResponse>`	`listPagedCallable()` Retrieves the list of HealthCheck resources available to the specified project.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`patchAsync(PatchRegionHealthCheckRequest request)` Updates a HealthCheck resource in the specified project using the data included in the request.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`patchAsync(String project, String region, String healthCheck, HealthCheck healthCheckResource)` Updates a HealthCheck resource in the specified project using the data included in the request.
`com.google.api.gax.rpc.UnaryCallable<PatchRegionHealthCheckRequest,Operation>`	`patchCallable()` Updates a HealthCheck resource in the specified project using the data included in the request.
`com.google.api.gax.rpc.OperationCallable<PatchRegionHealthCheckRequest,Operation,Operation>`	`patchOperationCallable()` Updates a HealthCheck resource in the specified project using the data included in the request.
`void`	`shutdown()`
`void`	`shutdownNow()`
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`updateAsync(String project, String region, String healthCheck, HealthCheck healthCheckResource)` Updates a HealthCheck resource in the specified project using the data included in the request.
`com.google.api.gax.longrunning.OperationFuture<Operation,Operation>`	`updateAsync(UpdateRegionHealthCheckRequest request)` Updates a HealthCheck resource in the specified project using the data included in the request.
`com.google.api.gax.rpc.UnaryCallable<UpdateRegionHealthCheckRequest,Operation>`	`updateCallable()` Updates a HealthCheck resource in the specified project using the data included in the request.
`com.google.api.gax.rpc.OperationCallable<UpdateRegionHealthCheckRequest,Operation,Operation>`	`updateOperationCallable()` Updates a HealthCheck resource in the specified project using 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
- RegionHealthChecksClient
```
protected RegionHealthChecksClient(RegionHealthChecksSettings settings)
                            throws IOException
```
  Constructs an instance of RegionHealthChecksClient, 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
- RegionHealthChecksClient
```
protected RegionHealthChecksClient(RegionHealthChecksStub stub)
```

Method Detail

create

public static final RegionHealthChecksClient create()
                                             throws IOException

Constructs an instance of RegionHealthChecksClient with default settings.

Throws:: IOException

create
```
public static final RegionHealthChecksClient create(RegionHealthChecksSettings settings)
                                             throws IOException
```
Constructs an instance of RegionHealthChecksClient, 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 RegionHealthChecksClient create(RegionHealthChecksStub stub)
```
Constructs an instance of RegionHealthChecksClient, using the given stub for making calls. This is for advanced usage - prefer using create(RegionHealthChecksSettings).

getSettings

public final RegionHealthChecksSettings getSettings()

getStub

public RegionHealthChecksStub getStub()

deleteAsync

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

Deletes the specified HealthCheck 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 (RegionHealthChecksClient regionHealthChecksClient = RegionHealthChecksClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String healthCheck = "healthCheck-1938093044";
   Operation response = regionHealthChecksClient.deleteAsync(project, region, healthCheck).get();
 }

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

deleteAsync

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

Deletes the specified HealthCheck 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 (RegionHealthChecksClient regionHealthChecksClient = RegionHealthChecksClient.create()) {
   DeleteRegionHealthCheckRequest request =
       DeleteRegionHealthCheckRequest.newBuilder()
           .setHealthCheck("healthCheck-1938093044")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = regionHealthChecksClient.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<DeleteRegionHealthCheckRequest,Operation,Operation> deleteOperationCallable()

Deletes the specified HealthCheck 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 (RegionHealthChecksClient regionHealthChecksClient = RegionHealthChecksClient.create()) {
   DeleteRegionHealthCheckRequest request =
       DeleteRegionHealthCheckRequest.newBuilder()
           .setHealthCheck("healthCheck-1938093044")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       regionHealthChecksClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

deleteCallable

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

Deletes the specified HealthCheck 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 (RegionHealthChecksClient regionHealthChecksClient = RegionHealthChecksClient.create()) {
   DeleteRegionHealthCheckRequest request =
       DeleteRegionHealthCheckRequest.newBuilder()
           .setHealthCheck("healthCheck-1938093044")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = regionHealthChecksClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

get

public final HealthCheck get(String project,
                             String region,
                             String healthCheck)

Returns the specified HealthCheck 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 (RegionHealthChecksClient regionHealthChecksClient = RegionHealthChecksClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String healthCheck = "healthCheck-1938093044";
   HealthCheck response = regionHealthChecksClient.get(project, region, healthCheck);
 }

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

get

public final HealthCheck get(GetRegionHealthCheckRequest request)

Returns the specified HealthCheck 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 (RegionHealthChecksClient regionHealthChecksClient = RegionHealthChecksClient.create()) {
   GetRegionHealthCheckRequest request =
       GetRegionHealthCheckRequest.newBuilder()
           .setHealthCheck("healthCheck-1938093044")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   HealthCheck response = regionHealthChecksClient.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<GetRegionHealthCheckRequest,HealthCheck> getCallable()

Returns the specified HealthCheck 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 (RegionHealthChecksClient regionHealthChecksClient = RegionHealthChecksClient.create()) {
   GetRegionHealthCheckRequest request =
       GetRegionHealthCheckRequest.newBuilder()
           .setHealthCheck("healthCheck-1938093044")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   ApiFuture<HealthCheck> future = regionHealthChecksClient.getCallable().futureCall(request);
   // Do something.
   HealthCheck response = future.get();
 }

insertAsync

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

Creates a HealthCheck resource in the specified project using the data included in the request.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RegionHealthChecksClient regionHealthChecksClient = RegionHealthChecksClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   HealthCheck healthCheckResource = HealthCheck.newBuilder().build();
   Operation response =
       regionHealthChecksClient.insertAsync(project, region, healthCheckResource).get();
 }

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

insertAsync

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

Creates a HealthCheck resource in the specified project using the data included in the request.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RegionHealthChecksClient regionHealthChecksClient = RegionHealthChecksClient.create()) {
   InsertRegionHealthCheckRequest request =
       InsertRegionHealthCheckRequest.newBuilder()
           .setHealthCheckResource(HealthCheck.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = regionHealthChecksClient.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<InsertRegionHealthCheckRequest,Operation,Operation> insertOperationCallable()

Creates a HealthCheck resource in the specified project using the data included in the request.

Sample code:


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

insertCallable

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

Creates a HealthCheck resource in the specified project using the data included in the request.

Sample code:


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

list

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

Retrieves the list of HealthCheck resources available to the specified project.

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 (RegionHealthChecksClient regionHealthChecksClient = RegionHealthChecksClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (HealthCheck element : regionHealthChecksClient.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 RegionHealthChecksClient.ListPagedResponse list(ListRegionHealthChecksRequest request)

Retrieves the list of HealthCheck resources available to the specified project.

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 (RegionHealthChecksClient regionHealthChecksClient = RegionHealthChecksClient.create()) {
   ListRegionHealthChecksRequest request =
       ListRegionHealthChecksRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   for (HealthCheck element : regionHealthChecksClient.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<ListRegionHealthChecksRequest,RegionHealthChecksClient.ListPagedResponse> listPagedCallable()

Retrieves the list of HealthCheck resources available to the specified project.

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

listCallable

public final com.google.api.gax.rpc.UnaryCallable<ListRegionHealthChecksRequest,HealthCheckList> listCallable()

Retrieves the list of HealthCheck resources available to the specified project.

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 (RegionHealthChecksClient regionHealthChecksClient = RegionHealthChecksClient.create()) {
   ListRegionHealthChecksRequest request =
       ListRegionHealthChecksRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     HealthCheckList response = regionHealthChecksClient.listCallable().call(request);
     for (HealthCheck 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 healthCheck,
                                                                                            HealthCheck healthCheckResource)

Updates a HealthCheck resource in the specified project using the data included in the request. 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 (RegionHealthChecksClient regionHealthChecksClient = RegionHealthChecksClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String healthCheck = "healthCheck-1938093044";
   HealthCheck healthCheckResource = HealthCheck.newBuilder().build();
   Operation response =
       regionHealthChecksClient
           .patchAsync(project, region, healthCheck, healthCheckResource)
           .get();
 }

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

patchAsync

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

Updates a HealthCheck resource in the specified project using the data included in the request. 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 (RegionHealthChecksClient regionHealthChecksClient = RegionHealthChecksClient.create()) {
   PatchRegionHealthCheckRequest request =
       PatchRegionHealthCheckRequest.newBuilder()
           .setHealthCheck("healthCheck-1938093044")
           .setHealthCheckResource(HealthCheck.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = regionHealthChecksClient.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<PatchRegionHealthCheckRequest,Operation,Operation> patchOperationCallable()

Updates a HealthCheck resource in the specified project using the data included in the request. 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 (RegionHealthChecksClient regionHealthChecksClient = RegionHealthChecksClient.create()) {
   PatchRegionHealthCheckRequest request =
       PatchRegionHealthCheckRequest.newBuilder()
           .setHealthCheck("healthCheck-1938093044")
           .setHealthCheckResource(HealthCheck.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       regionHealthChecksClient.patchOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

patchCallable

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

Updates a HealthCheck resource in the specified project using the data included in the request. 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 (RegionHealthChecksClient regionHealthChecksClient = RegionHealthChecksClient.create()) {
   PatchRegionHealthCheckRequest request =
       PatchRegionHealthCheckRequest.newBuilder()
           .setHealthCheck("healthCheck-1938093044")
           .setHealthCheckResource(HealthCheck.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = regionHealthChecksClient.patchCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

updateAsync

public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> updateAsync(String project,
                                                                                             String region,
                                                                                             String healthCheck,
                                                                                             HealthCheck healthCheckResource)

Updates a HealthCheck resource in the specified project using the data included in the request.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RegionHealthChecksClient regionHealthChecksClient = RegionHealthChecksClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String healthCheck = "healthCheck-1938093044";
   HealthCheck healthCheckResource = HealthCheck.newBuilder().build();
   Operation response =
       regionHealthChecksClient
           .updateAsync(project, region, healthCheck, healthCheckResource)
           .get();
 }

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

updateAsync

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

Updates a HealthCheck resource in the specified project using the data included in the request.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (RegionHealthChecksClient regionHealthChecksClient = RegionHealthChecksClient.create()) {
   UpdateRegionHealthCheckRequest request =
       UpdateRegionHealthCheckRequest.newBuilder()
           .setHealthCheck("healthCheck-1938093044")
           .setHealthCheckResource(HealthCheck.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = regionHealthChecksClient.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<UpdateRegionHealthCheckRequest,Operation,Operation> updateOperationCallable()

Updates a HealthCheck resource in the specified project using the data included in the request.

Sample code:


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

updateCallable

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

Updates a HealthCheck resource in the specified project using the data included in the request.

Sample code:


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

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

close in interface AutoCloseable

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

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

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

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

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

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

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

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

awaitTermination

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

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

Class RegionHealthChecksClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RegionHealthChecksClient

RegionHealthChecksClient

Method Detail

create

create

create

getSettings

getStub

deleteAsync

deleteAsync

deleteOperationCallable

deleteCallable

get

get

getCallable

insertAsync

insertAsync

insertOperationCallable

insertCallable

list

list

listPagedCallable

listCallable

patchAsync

patchAsync

patchOperationCallable

patchCallable

updateAsync

updateAsync

updateOperationCallable

updateCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination