Class RegionHealthChecksClient (1.65.0)

GitHub RepositoryProduct Reference

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.

Inheritance

java.lang.Object > RegionHealthChecksClient

Static Methods

create()

public static final RegionHealthChecksClient create()

Constructs an instance of RegionHealthChecksClient with default settings.

Returns
Type Description
RegionHealthChecksClient
Exceptions
Type Description
IOException

create(RegionHealthChecksSettings settings)

public static final RegionHealthChecksClient create(RegionHealthChecksSettings settings)

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.

Parameter
Name Description
settings RegionHealthChecksSettings
Returns
Type Description
RegionHealthChecksClient
Exceptions
Type Description
IOException

create(RegionHealthChecksStub stub)

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

Parameter
Name Description
stub RegionHealthChecksStub
Returns
Type Description
RegionHealthChecksClient

Constructors

RegionHealthChecksClient(RegionHealthChecksSettings settings)

protected RegionHealthChecksClient(RegionHealthChecksSettings settings)

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.

Parameter
Name Description
settings RegionHealthChecksSettings

RegionHealthChecksClient(RegionHealthChecksStub stub)

protected RegionHealthChecksClient(RegionHealthChecksStub stub)
Parameter
Name Description
stub RegionHealthChecksStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

deleteAsync(DeleteRegionHealthCheckRequest request)

public final 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();
 }
Parameter
Name Description
request DeleteRegionHealthCheckRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String region, String healthCheck)

public final 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
Name Description
project String

Project ID for this request.
region String

Name of the region scoping this request.
healthCheck String

Name of the HealthCheck resource to delete.
Returns
Type Description
OperationFuture<Operation,Operation>

deleteCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<DeleteRegionHealthCheckRequest,Operation>

deleteOperationCallable()

public final 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();
 }
Returns
Type Description
OperationCallable<DeleteRegionHealthCheckRequest,Operation,Operation>

get(GetRegionHealthCheckRequest request)

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);
 }
Parameter
Name Description
request GetRegionHealthCheckRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
HealthCheck

get(String project, String region, String healthCheck)

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
Name Description
project String

Project ID for this request.
region String

Name of the region scoping this request.
healthCheck String

Name of the HealthCheck resource to return.
Returns
Type Description
HealthCheck

getCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<GetRegionHealthCheckRequest,HealthCheck>

getSettings()

public final RegionHealthChecksSettings getSettings()
Returns
Type Description
RegionHealthChecksSettings

getStub()

public RegionHealthChecksStub getStub()
Returns
Type Description
RegionHealthChecksStub

insertAsync(InsertRegionHealthCheckRequest request)

public final 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();
 }
Parameter
Name Description
request InsertRegionHealthCheckRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

insertAsync(String project, String region, HealthCheck healthCheckResource)

public final 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
Name Description
project String

Project ID for this request.
region String

Name of the region scoping this request.
healthCheckResource HealthCheck

The body resource for this request
Returns
Type Description
OperationFuture<Operation,Operation>

insertCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<InsertRegionHealthCheckRequest,Operation>

insertOperationCallable()

public final 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();
 }
Returns
Type Description
OperationCallable<InsertRegionHealthCheckRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

list(ListRegionHealthChecksRequest request)

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);
   }
 }
Parameter
Name Description
request ListRegionHealthChecksRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
RegionHealthChecksClient.ListPagedResponse

list(String project, String region)

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
Name Description
project String

Project ID for this request.
region String

Name of the region scoping this request.
Returns
Type Description
RegionHealthChecksClient.ListPagedResponse

listCallable()

public final 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;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListRegionHealthChecksRequest,HealthCheckList>

listPagedCallable()

public final 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);
   }
 }
Returns
Type Description
UnaryCallable<ListRegionHealthChecksRequest,ListPagedResponse>

patchAsync(PatchRegionHealthCheckRequest request)

public final 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();
 }
Parameter
Name Description
request PatchRegionHealthCheckRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

patchAsync(String project, String region, String healthCheck, HealthCheck healthCheckResource)

public final 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
Name Description
project String

Project ID for this request.
region String

Name of the region scoping this request.
healthCheck String

Name of the HealthCheck resource to patch.
healthCheckResource HealthCheck

The body resource for this request
Returns
Type Description
OperationFuture<Operation,Operation>

patchCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<PatchRegionHealthCheckRequest,Operation>

patchOperationCallable()

public final 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();
 }
Returns
Type Description
OperationCallable<PatchRegionHealthCheckRequest,Operation,Operation>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateAsync(UpdateRegionHealthCheckRequest request)

public final 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();
 }
Parameter
Name Description
request UpdateRegionHealthCheckRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

updateAsync(String project, String region, String healthCheck, HealthCheck healthCheckResource)

public final 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
Name Description
project String

Project ID for this request.
region String

Name of the region scoping this request.
healthCheck String

Name of the HealthCheck resource to update.
healthCheckResource HealthCheck

The body resource for this request
Returns
Type Description
OperationFuture<Operation,Operation>

updateCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<UpdateRegionHealthCheckRequest,Operation>

updateOperationCallable()

public final 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();
 }
Returns
Type Description
OperationCallable<UpdateRegionHealthCheckRequest,Operation,Operation>