com.google.cloud.compute.v1

Class RegionHealthCheckClient

java.lang.Object

com.google.cloud.compute.v1.RegionHealthCheckClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

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

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

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

 
 try (RegionHealthCheckClient regionHealthCheckClient = RegionHealthCheckClient.create()) {
   ProjectRegionHealthCheckName healthCheck = ProjectRegionHealthCheckName.of("[PROJECT]", "[REGION]", "[HEALTH_CHECK]");
   Operation response = regionHealthCheckClient.deleteRegionHealthCheck(healthCheck);
 }
 
 

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

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

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

See the individual methods for example code.

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

This class can be customized by passing in a custom instance of RegionHealthCheckSettings to create(). For example:

To customize credentials:

 
 RegionHealthCheckSettings regionHealthCheckSettings =
     RegionHealthCheckSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegionHealthCheckClient regionHealthCheckClient =
     RegionHealthCheckClient.create(regionHealthCheckSettings);
 
 

To customize the endpoint:

 
 RegionHealthCheckSettings regionHealthCheckSettings =
     RegionHealthCheckSettings.newBuilder().setEndpoint(myEndpoint).build();
 RegionHealthCheckClient regionHealthCheckClient =
     RegionHealthCheckClient.create(regionHealthCheckSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegionHealthCheckClient.ListRegionHealthChecksFixedSizeCollection
static class	RegionHealthCheckClient.ListRegionHealthChecksPage
static class	RegionHealthCheckClient.ListRegionHealthChecksPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RegionHealthCheckClient(RegionHealthCheckSettings settings) Constructs an instance of RegionHealthCheckClient, using the given settings.
protected	RegionHealthCheckClient(RegionHealthCheckStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static RegionHealthCheckClient	create() Constructs an instance of RegionHealthCheckClient with default settings.
static RegionHealthCheckClient	create(RegionHealthCheckSettings settings) Constructs an instance of RegionHealthCheckClient, using the given settings.
static RegionHealthCheckClient	create(RegionHealthCheckStub stub) Constructs an instance of RegionHealthCheckClient, using the given stub for making calls.
Operation	deleteRegionHealthCheck(DeleteRegionHealthCheckHttpRequest request) Deletes the specified HealthCheck resource.
Operation	deleteRegionHealthCheck(ProjectRegionHealthCheckName healthCheck) Deletes the specified HealthCheck resource.
Operation	deleteRegionHealthCheck(String healthCheck) Deletes the specified HealthCheck resource.
com.google.api.gax.rpc.UnaryCallable<DeleteRegionHealthCheckHttpRequest,Operation>	deleteRegionHealthCheckCallable() Deletes the specified HealthCheck resource.
HealthCheck	getRegionHealthCheck(GetRegionHealthCheckHttpRequest request) Returns the specified HealthCheck resource.
HealthCheck	getRegionHealthCheck(ProjectRegionHealthCheckName healthCheck) Returns the specified HealthCheck resource.
HealthCheck	getRegionHealthCheck(String healthCheck) Returns the specified HealthCheck resource.
com.google.api.gax.rpc.UnaryCallable<GetRegionHealthCheckHttpRequest,HealthCheck>	getRegionHealthCheckCallable() Returns the specified HealthCheck resource.
RegionHealthCheckSettings	getSettings()
RegionHealthCheckStub	getStub()
Operation	insertRegionHealthCheck(InsertRegionHealthCheckHttpRequest request) Creates a HealthCheck resource in the specified project using the data included in the request.
Operation	insertRegionHealthCheck(ProjectRegionName region, HealthCheck healthCheckResource) Creates a HealthCheck resource in the specified project using the data included in the request.
Operation	insertRegionHealthCheck(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<InsertRegionHealthCheckHttpRequest,Operation>	insertRegionHealthCheckCallable() Creates a HealthCheck resource in the specified project using the data included in the request.
boolean	isShutdown()
boolean	isTerminated()
RegionHealthCheckClient.ListRegionHealthChecksPagedResponse	listRegionHealthChecks(ListRegionHealthChecksHttpRequest request) Retrieves the list of HealthCheck resources available to the specified project.
RegionHealthCheckClient.ListRegionHealthChecksPagedResponse	listRegionHealthChecks(ProjectRegionName region) Retrieves the list of HealthCheck resources available to the specified project.
RegionHealthCheckClient.ListRegionHealthChecksPagedResponse	listRegionHealthChecks(String region) Retrieves the list of HealthCheck resources available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListRegionHealthChecksHttpRequest,HealthCheckList>	listRegionHealthChecksCallable() Retrieves the list of HealthCheck resources available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListRegionHealthChecksHttpRequest,RegionHealthCheckClient.ListRegionHealthChecksPagedResponse>	listRegionHealthChecksPagedCallable() Retrieves the list of HealthCheck resources available to the specified project.
Operation	patchRegionHealthCheck(PatchRegionHealthCheckHttpRequest request) Updates a HealthCheck resource in the specified project using the data included in the request.
Operation	patchRegionHealthCheck(ProjectRegionHealthCheckName healthCheck, HealthCheck healthCheckResource, List<String> fieldMask) Updates a HealthCheck resource in the specified project using the data included in the request.
Operation	patchRegionHealthCheck(String healthCheck, HealthCheck healthCheckResource, List<String> fieldMask) Updates a HealthCheck resource in the specified project using the data included in the request.
com.google.api.gax.rpc.UnaryCallable<PatchRegionHealthCheckHttpRequest,Operation>	patchRegionHealthCheckCallable() Updates a HealthCheck resource in the specified project using the data included in the request.
void	shutdown()
void	shutdownNow()
Operation	updateRegionHealthCheck(ProjectRegionHealthCheckName healthCheck, HealthCheck healthCheckResource, List<String> fieldMask) Updates a HealthCheck resource in the specified project using the data included in the request.
Operation	updateRegionHealthCheck(String healthCheck, HealthCheck healthCheckResource, List<String> fieldMask) Updates a HealthCheck resource in the specified project using the data included in the request.
Operation	updateRegionHealthCheck(UpdateRegionHealthCheckHttpRequest request) Updates a HealthCheck resource in the specified project using the data included in the request.
com.google.api.gax.rpc.UnaryCallable<UpdateRegionHealthCheckHttpRequest,Operation>	updateRegionHealthCheckCallable() 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

RegionHealthCheckClient

protected RegionHealthCheckClient(RegionHealthCheckSettings settings)
                           throws IOException

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

RegionHealthCheckClient

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

Method Detail

create

public static final RegionHealthCheckClient create()
                                            throws IOException

Constructs an instance of RegionHealthCheckClient with default settings.

Throws:

IOException

create

public static final RegionHealthCheckClient create(RegionHealthCheckSettings settings)
                                            throws IOException

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

Throws:

IOException

create

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

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

getSettings

public final RegionHealthCheckSettings getSettings()

getStub

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

deleteRegionHealthCheck

@BetaApi
public final Operation deleteRegionHealthCheck(ProjectRegionHealthCheckName healthCheck)

Deletes the specified HealthCheck resource.

Sample code:

 try (RegionHealthCheckClient regionHealthCheckClient = RegionHealthCheckClient.create()) {
   ProjectRegionHealthCheckName healthCheck = ProjectRegionHealthCheckName.of("[PROJECT]", "[REGION]", "[HEALTH_CHECK]");
   Operation response = regionHealthCheckClient.deleteRegionHealthCheck(healthCheck);
 }
 

Parameters:

healthCheck - Name of the HealthCheck resource to delete.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteRegionHealthCheck

@BetaApi
public final Operation deleteRegionHealthCheck(String healthCheck)

Deletes the specified HealthCheck resource.

Sample code:

 try (RegionHealthCheckClient regionHealthCheckClient = RegionHealthCheckClient.create()) {
   ProjectRegionHealthCheckName healthCheck = ProjectRegionHealthCheckName.of("[PROJECT]", "[REGION]", "[HEALTH_CHECK]");
   Operation response = regionHealthCheckClient.deleteRegionHealthCheck(healthCheck.toString());
 }
 

Parameters:

healthCheck - Name of the HealthCheck resource to delete.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteRegionHealthCheck

@BetaApi
public final Operation deleteRegionHealthCheck(DeleteRegionHealthCheckHttpRequest request)

Deletes the specified HealthCheck resource.

Sample code:

 try (RegionHealthCheckClient regionHealthCheckClient = RegionHealthCheckClient.create()) {
   String formattedHealthCheck = ProjectRegionHealthCheckName.format("[PROJECT]", "[REGION]", "[HEALTH_CHECK]");
   DeleteRegionHealthCheckHttpRequest request = DeleteRegionHealthCheckHttpRequest.newBuilder()
     .setHealthCheck(formattedHealthCheck)
     .build();
   Operation response = regionHealthCheckClient.deleteRegionHealthCheck(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

deleteRegionHealthCheckCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<DeleteRegionHealthCheckHttpRequest,Operation> deleteRegionHealthCheckCallable()

Deletes the specified HealthCheck resource.

Sample code:

 try (RegionHealthCheckClient regionHealthCheckClient = RegionHealthCheckClient.create()) {
   String formattedHealthCheck = ProjectRegionHealthCheckName.format("[PROJECT]", "[REGION]", "[HEALTH_CHECK]");
   DeleteRegionHealthCheckHttpRequest request = DeleteRegionHealthCheckHttpRequest.newBuilder()
     .setHealthCheck(formattedHealthCheck)
     .build();
   ApiFuture<Operation> future = regionHealthCheckClient.deleteRegionHealthCheckCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

getRegionHealthCheck

@BetaApi
public final HealthCheck getRegionHealthCheck(ProjectRegionHealthCheckName healthCheck)

Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.

Sample code:

 try (RegionHealthCheckClient regionHealthCheckClient = RegionHealthCheckClient.create()) {
   ProjectRegionHealthCheckName healthCheck = ProjectRegionHealthCheckName.of("[PROJECT]", "[REGION]", "[HEALTH_CHECK]");
   HealthCheck response = regionHealthCheckClient.getRegionHealthCheck(healthCheck);
 }
 

Parameters:

healthCheck - Name of the HealthCheck resource to return.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getRegionHealthCheck

@BetaApi
public final HealthCheck getRegionHealthCheck(String healthCheck)

Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.

Sample code:

 try (RegionHealthCheckClient regionHealthCheckClient = RegionHealthCheckClient.create()) {
   ProjectRegionHealthCheckName healthCheck = ProjectRegionHealthCheckName.of("[PROJECT]", "[REGION]", "[HEALTH_CHECK]");
   HealthCheck response = regionHealthCheckClient.getRegionHealthCheck(healthCheck.toString());
 }
 

Parameters:

healthCheck - Name of the HealthCheck resource to return.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getRegionHealthCheck

@BetaApi
public final HealthCheck getRegionHealthCheck(GetRegionHealthCheckHttpRequest request)

Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.

Sample code:

 try (RegionHealthCheckClient regionHealthCheckClient = RegionHealthCheckClient.create()) {
   String formattedHealthCheck = ProjectRegionHealthCheckName.format("[PROJECT]", "[REGION]", "[HEALTH_CHECK]");
   GetRegionHealthCheckHttpRequest request = GetRegionHealthCheckHttpRequest.newBuilder()
     .setHealthCheck(formattedHealthCheck)
     .build();
   HealthCheck response = regionHealthCheckClient.getRegionHealthCheck(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

getRegionHealthCheckCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetRegionHealthCheckHttpRequest,HealthCheck> getRegionHealthCheckCallable()

Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.

Sample code:

 try (RegionHealthCheckClient regionHealthCheckClient = RegionHealthCheckClient.create()) {
   String formattedHealthCheck = ProjectRegionHealthCheckName.format("[PROJECT]", "[REGION]", "[HEALTH_CHECK]");
   GetRegionHealthCheckHttpRequest request = GetRegionHealthCheckHttpRequest.newBuilder()
     .setHealthCheck(formattedHealthCheck)
     .build();
   ApiFuture<HealthCheck> future = regionHealthCheckClient.getRegionHealthCheckCallable().futureCall(request);
   // Do something
   HealthCheck response = future.get();
 }
 

insertRegionHealthCheck

@BetaApi
public final Operation insertRegionHealthCheck(ProjectRegionName region,
                                                        HealthCheck healthCheckResource)

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

Sample code:

 try (RegionHealthCheckClient regionHealthCheckClient = RegionHealthCheckClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   HealthCheck healthCheckResource = HealthCheck.newBuilder().build();
   Operation response = regionHealthCheckClient.insertRegionHealthCheck(region, healthCheckResource);
 }
 

Parameters:

region - Name of the region scoping this request.

healthCheckResource - Represents a Health Check resource.

Health checks are used for most GCP load balancers and managed instance group auto-healing. For more information, read Health Check Concepts.

To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

insertRegionHealthCheck

@BetaApi
public final Operation insertRegionHealthCheck(String region,
                                                        HealthCheck healthCheckResource)

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

Sample code:

 try (RegionHealthCheckClient regionHealthCheckClient = RegionHealthCheckClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   HealthCheck healthCheckResource = HealthCheck.newBuilder().build();
   Operation response = regionHealthCheckClient.insertRegionHealthCheck(region.toString(), healthCheckResource);
 }
 

Parameters:

region - Name of the region scoping this request.

healthCheckResource - Represents a Health Check resource.

Health checks are used for most GCP load balancers and managed instance group auto-healing. For more information, read Health Check Concepts.

To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

insertRegionHealthCheck

@BetaApi
public final Operation insertRegionHealthCheck(InsertRegionHealthCheckHttpRequest request)

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

Sample code:

 try (RegionHealthCheckClient regionHealthCheckClient = RegionHealthCheckClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   HealthCheck healthCheckResource = HealthCheck.newBuilder().build();
   InsertRegionHealthCheckHttpRequest request = InsertRegionHealthCheckHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .setHealthCheckResource(healthCheckResource)
     .build();
   Operation response = regionHealthCheckClient.insertRegionHealthCheck(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

insertRegionHealthCheckCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<InsertRegionHealthCheckHttpRequest,Operation> insertRegionHealthCheckCallable()

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

Sample code:

 try (RegionHealthCheckClient regionHealthCheckClient = RegionHealthCheckClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   HealthCheck healthCheckResource = HealthCheck.newBuilder().build();
   InsertRegionHealthCheckHttpRequest request = InsertRegionHealthCheckHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .setHealthCheckResource(healthCheckResource)
     .build();
   ApiFuture<Operation> future = regionHealthCheckClient.insertRegionHealthCheckCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

listRegionHealthChecks

@BetaApi
public final RegionHealthCheckClient.ListRegionHealthChecksPagedResponse listRegionHealthChecks(ProjectRegionName region)

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

Sample code:

 try (RegionHealthCheckClient regionHealthCheckClient = RegionHealthCheckClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   for (HealthCheck element : regionHealthCheckClient.listRegionHealthChecks(region).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

region - Name of the region scoping this request.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listRegionHealthChecks

@BetaApi
public final RegionHealthCheckClient.ListRegionHealthChecksPagedResponse listRegionHealthChecks(String region)

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

Sample code:

 try (RegionHealthCheckClient regionHealthCheckClient = RegionHealthCheckClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   for (HealthCheck element : regionHealthCheckClient.listRegionHealthChecks(region.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

region - Name of the region scoping this request.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listRegionHealthChecks

@BetaApi
public final RegionHealthCheckClient.ListRegionHealthChecksPagedResponse listRegionHealthChecks(ListRegionHealthChecksHttpRequest request)

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

Sample code:

 try (RegionHealthCheckClient regionHealthCheckClient = RegionHealthCheckClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ListRegionHealthChecksHttpRequest request = ListRegionHealthChecksHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   for (HealthCheck element : regionHealthCheckClient.listRegionHealthChecks(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

listRegionHealthChecksPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListRegionHealthChecksHttpRequest,RegionHealthCheckClient.ListRegionHealthChecksPagedResponse> listRegionHealthChecksPagedCallable()

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

Sample code:

 try (RegionHealthCheckClient regionHealthCheckClient = RegionHealthCheckClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ListRegionHealthChecksHttpRequest request = ListRegionHealthChecksHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   ApiFuture<ListRegionHealthChecksPagedResponse> future = regionHealthCheckClient.listRegionHealthChecksPagedCallable().futureCall(request);
   // Do something
   for (HealthCheck element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listRegionHealthChecksCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListRegionHealthChecksHttpRequest,HealthCheckList> listRegionHealthChecksCallable()

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

Sample code:

 try (RegionHealthCheckClient regionHealthCheckClient = RegionHealthCheckClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ListRegionHealthChecksHttpRequest request = ListRegionHealthChecksHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   while (true) {
     HealthCheckList response = regionHealthCheckClient.listRegionHealthChecksCallable().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;
     }
   }
 }
 

patchRegionHealthCheck

@BetaApi
public final Operation patchRegionHealthCheck(ProjectRegionHealthCheckName healthCheck,
                                                       HealthCheck healthCheckResource,
                                                       List<String> fieldMask)

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:

 try (RegionHealthCheckClient regionHealthCheckClient = RegionHealthCheckClient.create()) {
   ProjectRegionHealthCheckName healthCheck = ProjectRegionHealthCheckName.of("[PROJECT]", "[REGION]", "[HEALTH_CHECK]");
   HealthCheck healthCheckResource = HealthCheck.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = regionHealthCheckClient.patchRegionHealthCheck(healthCheck, healthCheckResource, fieldMask);
 }
 

Parameters:

healthCheck - Name of the HealthCheck resource to patch.

healthCheckResource - Represents a Health Check resource.

Health checks are used for most GCP load balancers and managed instance group auto-healing. For more information, read Health Check Concepts.

To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

patchRegionHealthCheck

@BetaApi
public final Operation patchRegionHealthCheck(String healthCheck,
                                                       HealthCheck healthCheckResource,
                                                       List<String> fieldMask)

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:

 try (RegionHealthCheckClient regionHealthCheckClient = RegionHealthCheckClient.create()) {
   ProjectRegionHealthCheckName healthCheck = ProjectRegionHealthCheckName.of("[PROJECT]", "[REGION]", "[HEALTH_CHECK]");
   HealthCheck healthCheckResource = HealthCheck.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = regionHealthCheckClient.patchRegionHealthCheck(healthCheck.toString(), healthCheckResource, fieldMask);
 }
 

Parameters:

healthCheck - Name of the HealthCheck resource to patch.

healthCheckResource - Represents a Health Check resource.

Health checks are used for most GCP load balancers and managed instance group auto-healing. For more information, read Health Check Concepts.

To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

patchRegionHealthCheck

@BetaApi
public final Operation patchRegionHealthCheck(PatchRegionHealthCheckHttpRequest 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:

 try (RegionHealthCheckClient regionHealthCheckClient = RegionHealthCheckClient.create()) {
   String formattedHealthCheck = ProjectRegionHealthCheckName.format("[PROJECT]", "[REGION]", "[HEALTH_CHECK]");
   HealthCheck healthCheckResource = HealthCheck.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   PatchRegionHealthCheckHttpRequest request = PatchRegionHealthCheckHttpRequest.newBuilder()
     .setHealthCheck(formattedHealthCheck)
     .setHealthCheckResource(healthCheckResource)
     .addAllFieldMask(fieldMask)
     .build();
   Operation response = regionHealthCheckClient.patchRegionHealthCheck(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

patchRegionHealthCheckCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<PatchRegionHealthCheckHttpRequest,Operation> patchRegionHealthCheckCallable()

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:

 try (RegionHealthCheckClient regionHealthCheckClient = RegionHealthCheckClient.create()) {
   String formattedHealthCheck = ProjectRegionHealthCheckName.format("[PROJECT]", "[REGION]", "[HEALTH_CHECK]");
   HealthCheck healthCheckResource = HealthCheck.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   PatchRegionHealthCheckHttpRequest request = PatchRegionHealthCheckHttpRequest.newBuilder()
     .setHealthCheck(formattedHealthCheck)
     .setHealthCheckResource(healthCheckResource)
     .addAllFieldMask(fieldMask)
     .build();
   ApiFuture<Operation> future = regionHealthCheckClient.patchRegionHealthCheckCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

updateRegionHealthCheck

@BetaApi
public final Operation updateRegionHealthCheck(ProjectRegionHealthCheckName healthCheck,
                                                        HealthCheck healthCheckResource,
                                                        List<String> fieldMask)

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

Sample code:

 try (RegionHealthCheckClient regionHealthCheckClient = RegionHealthCheckClient.create()) {
   ProjectRegionHealthCheckName healthCheck = ProjectRegionHealthCheckName.of("[PROJECT]", "[REGION]", "[HEALTH_CHECK]");
   HealthCheck healthCheckResource = HealthCheck.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = regionHealthCheckClient.updateRegionHealthCheck(healthCheck, healthCheckResource, fieldMask);
 }
 

Parameters:

healthCheck - Name of the HealthCheck resource to update.

healthCheckResource - Represents a Health Check resource.

Health checks are used for most GCP load balancers and managed instance group auto-healing. For more information, read Health Check Concepts.

To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateRegionHealthCheck

@BetaApi
public final Operation updateRegionHealthCheck(String healthCheck,
                                                        HealthCheck healthCheckResource,
                                                        List<String> fieldMask)

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

Sample code:

 try (RegionHealthCheckClient regionHealthCheckClient = RegionHealthCheckClient.create()) {
   ProjectRegionHealthCheckName healthCheck = ProjectRegionHealthCheckName.of("[PROJECT]", "[REGION]", "[HEALTH_CHECK]");
   HealthCheck healthCheckResource = HealthCheck.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = regionHealthCheckClient.updateRegionHealthCheck(healthCheck.toString(), healthCheckResource, fieldMask);
 }
 

Parameters:

healthCheck - Name of the HealthCheck resource to update.

healthCheckResource - Represents a Health Check resource.

Health checks are used for most GCP load balancers and managed instance group auto-healing. For more information, read Health Check Concepts.

To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateRegionHealthCheck

@BetaApi
public final Operation updateRegionHealthCheck(UpdateRegionHealthCheckHttpRequest request)

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

Sample code:

 try (RegionHealthCheckClient regionHealthCheckClient = RegionHealthCheckClient.create()) {
   String formattedHealthCheck = ProjectRegionHealthCheckName.format("[PROJECT]", "[REGION]", "[HEALTH_CHECK]");
   HealthCheck healthCheckResource = HealthCheck.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   UpdateRegionHealthCheckHttpRequest request = UpdateRegionHealthCheckHttpRequest.newBuilder()
     .setHealthCheck(formattedHealthCheck)
     .setHealthCheckResource(healthCheckResource)
     .addAllFieldMask(fieldMask)
     .build();
   Operation response = regionHealthCheckClient.updateRegionHealthCheck(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

updateRegionHealthCheckCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<UpdateRegionHealthCheckHttpRequest,Operation> updateRegionHealthCheckCallable()

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

Sample code:

 try (RegionHealthCheckClient regionHealthCheckClient = RegionHealthCheckClient.create()) {
   String formattedHealthCheck = ProjectRegionHealthCheckName.format("[PROJECT]", "[REGION]", "[HEALTH_CHECK]");
   HealthCheck healthCheckResource = HealthCheck.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   UpdateRegionHealthCheckHttpRequest request = UpdateRegionHealthCheckHttpRequest.newBuilder()
     .setHealthCheck(formattedHealthCheck)
     .setHealthCheckResource(healthCheckResource)
     .addAllFieldMask(fieldMask)
     .build();
   ApiFuture<Operation> future = regionHealthCheckClient.updateRegionHealthCheckCallable().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