com.google.cloud.compute.v1

Class HealthCheckClient

java.lang.Object

com.google.cloud.compute.v1.HealthCheckClient

All Implemented Interfaces:

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

@Generated(value="by gapic-generator")
 @BetaApi
public class HealthCheckClient
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 (HealthCheckClient healthCheckClient = HealthCheckClient.create()) {
   ProjectGlobalHealthCheckName healthCheck = ProjectGlobalHealthCheckName.of("[PROJECT]", "[HEALTH_CHECK]");
   Operation response = healthCheckClient.deleteHealthCheck(healthCheck);
 }
 
 

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

To customize credentials:

 
 HealthCheckSettings healthCheckSettings =
     HealthCheckSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 HealthCheckClient healthCheckClient =
     HealthCheckClient.create(healthCheckSettings);
 
 

To customize the endpoint:

 
 HealthCheckSettings healthCheckSettings =
     HealthCheckSettings.newBuilder().setEndpoint(myEndpoint).build();
 HealthCheckClient healthCheckClient =
     HealthCheckClient.create(healthCheckSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HealthCheckClient.AggregatedListHealthChecksFixedSizeCollection
static class	HealthCheckClient.AggregatedListHealthChecksPage
static class	HealthCheckClient.AggregatedListHealthChecksPagedResponse
static class	HealthCheckClient.ListHealthChecksFixedSizeCollection
static class	HealthCheckClient.ListHealthChecksPage
static class	HealthCheckClient.ListHealthChecksPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HealthCheckClient(HealthCheckSettings settings) Constructs an instance of HealthCheckClient, using the given settings.
protected	HealthCheckClient(HealthCheckStub stub)

Method Summary

Modifier and Type	Method and Description
HealthCheckClient.AggregatedListHealthChecksPagedResponse	aggregatedListHealthChecks(AggregatedListHealthChecksHttpRequest request) Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.
HealthCheckClient.AggregatedListHealthChecksPagedResponse	aggregatedListHealthChecks(ProjectName project) Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.
HealthCheckClient.AggregatedListHealthChecksPagedResponse	aggregatedListHealthChecks(String project) Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.
com.google.api.gax.rpc.UnaryCallable<AggregatedListHealthChecksHttpRequest,HealthChecksAggregatedList>	aggregatedListHealthChecksCallable() Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.
com.google.api.gax.rpc.UnaryCallable<AggregatedListHealthChecksHttpRequest,HealthCheckClient.AggregatedListHealthChecksPagedResponse>	aggregatedListHealthChecksPagedCallable() Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static HealthCheckClient	create() Constructs an instance of HealthCheckClient with default settings.
static HealthCheckClient	create(HealthCheckSettings settings) Constructs an instance of HealthCheckClient, using the given settings.
static HealthCheckClient	create(HealthCheckStub stub) Constructs an instance of HealthCheckClient, using the given stub for making calls.
Operation	deleteHealthCheck(DeleteHealthCheckHttpRequest request) Deletes the specified HealthCheck resource.
Operation	deleteHealthCheck(ProjectGlobalHealthCheckName healthCheck) Deletes the specified HealthCheck resource.
Operation	deleteHealthCheck(String healthCheck) Deletes the specified HealthCheck resource.
com.google.api.gax.rpc.UnaryCallable<DeleteHealthCheckHttpRequest,Operation>	deleteHealthCheckCallable() Deletes the specified HealthCheck resource.
HealthCheck	getHealthCheck(GetHealthCheckHttpRequest request) Returns the specified HealthCheck resource.
HealthCheck	getHealthCheck(ProjectGlobalHealthCheckName healthCheck) Returns the specified HealthCheck resource.
HealthCheck	getHealthCheck(String healthCheck) Returns the specified HealthCheck resource.
com.google.api.gax.rpc.UnaryCallable<GetHealthCheckHttpRequest,HealthCheck>	getHealthCheckCallable() Returns the specified HealthCheck resource.
HealthCheckSettings	getSettings()
HealthCheckStub	getStub()
Operation	insertHealthCheck(InsertHealthCheckHttpRequest request) Creates a HealthCheck resource in the specified project using the data included in the request.
Operation	insertHealthCheck(ProjectName project, HealthCheck healthCheckResource) Creates a HealthCheck resource in the specified project using the data included in the request.
Operation	insertHealthCheck(String project, HealthCheck healthCheckResource) Creates a HealthCheck resource in the specified project using the data included in the request.
com.google.api.gax.rpc.UnaryCallable<InsertHealthCheckHttpRequest,Operation>	insertHealthCheckCallable() Creates a HealthCheck resource in the specified project using the data included in the request.
boolean	isShutdown()
boolean	isTerminated()
HealthCheckClient.ListHealthChecksPagedResponse	listHealthChecks(ListHealthChecksHttpRequest request) Retrieves the list of HealthCheck resources available to the specified project.
HealthCheckClient.ListHealthChecksPagedResponse	listHealthChecks(ProjectName project) Retrieves the list of HealthCheck resources available to the specified project.
HealthCheckClient.ListHealthChecksPagedResponse	listHealthChecks(String project) Retrieves the list of HealthCheck resources available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListHealthChecksHttpRequest,HealthCheckList>	listHealthChecksCallable() Retrieves the list of HealthCheck resources available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListHealthChecksHttpRequest,HealthCheckClient.ListHealthChecksPagedResponse>	listHealthChecksPagedCallable() Retrieves the list of HealthCheck resources available to the specified project.
Operation	patchHealthCheck(PatchHealthCheckHttpRequest request) Updates a HealthCheck resource in the specified project using the data included in the request.
Operation	patchHealthCheck(ProjectGlobalHealthCheckName healthCheck, HealthCheck healthCheckResource, List<String> fieldMask) Updates a HealthCheck resource in the specified project using the data included in the request.
Operation	patchHealthCheck(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<PatchHealthCheckHttpRequest,Operation>	patchHealthCheckCallable() Updates a HealthCheck resource in the specified project using the data included in the request.
void	shutdown()
void	shutdownNow()
Operation	updateHealthCheck(ProjectGlobalHealthCheckName healthCheck, HealthCheck healthCheckResource, List<String> fieldMask) Updates a HealthCheck resource in the specified project using the data included in the request.
Operation	updateHealthCheck(String healthCheck, HealthCheck healthCheckResource, List<String> fieldMask) Updates a HealthCheck resource in the specified project using the data included in the request.
Operation	updateHealthCheck(UpdateHealthCheckHttpRequest request) Updates a HealthCheck resource in the specified project using the data included in the request.
com.google.api.gax.rpc.UnaryCallable<UpdateHealthCheckHttpRequest,Operation>	updateHealthCheckCallable() 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

HealthCheckClient

protected HealthCheckClient(HealthCheckSettings settings)
                     throws IOException

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

HealthCheckClient

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

Method Detail

create

public static final HealthCheckClient create()
                                      throws IOException

Constructs an instance of HealthCheckClient with default settings.

Throws:

IOException

create

public static final HealthCheckClient create(HealthCheckSettings settings)
                                      throws IOException

Constructs an instance of HealthCheckClient, 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 HealthCheckClient create(HealthCheckStub stub)

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

getSettings

public final HealthCheckSettings getSettings()

getStub

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

aggregatedListHealthChecks

@BetaApi
public final HealthCheckClient.AggregatedListHealthChecksPagedResponse aggregatedListHealthChecks(ProjectName project)

Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.

Sample code:

 try (HealthCheckClient healthCheckClient = HealthCheckClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (HealthChecksScopedList element : healthCheckClient.aggregatedListHealthChecks(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Name of the project scoping this request.

Throws:

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

aggregatedListHealthChecks

@BetaApi
public final HealthCheckClient.AggregatedListHealthChecksPagedResponse aggregatedListHealthChecks(String project)

Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.

Sample code:

 try (HealthCheckClient healthCheckClient = HealthCheckClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (HealthChecksScopedList element : healthCheckClient.aggregatedListHealthChecks(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Name of the project scoping this request.

Throws:

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

aggregatedListHealthChecks

@BetaApi
public final HealthCheckClient.AggregatedListHealthChecksPagedResponse aggregatedListHealthChecks(AggregatedListHealthChecksHttpRequest request)

Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.

Sample code:

 try (HealthCheckClient healthCheckClient = HealthCheckClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListHealthChecksHttpRequest request = AggregatedListHealthChecksHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (HealthChecksScopedList element : healthCheckClient.aggregatedListHealthChecks(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

aggregatedListHealthChecksPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListHealthChecksHttpRequest,HealthCheckClient.AggregatedListHealthChecksPagedResponse> aggregatedListHealthChecksPagedCallable()

Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.

Sample code:

 try (HealthCheckClient healthCheckClient = HealthCheckClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListHealthChecksHttpRequest request = AggregatedListHealthChecksHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<AggregatedListHealthChecksPagedResponse> future = healthCheckClient.aggregatedListHealthChecksPagedCallable().futureCall(request);
   // Do something
   for (HealthChecksScopedList element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

aggregatedListHealthChecksCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListHealthChecksHttpRequest,HealthChecksAggregatedList> aggregatedListHealthChecksCallable()

Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.

Sample code:

 try (HealthCheckClient healthCheckClient = HealthCheckClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListHealthChecksHttpRequest request = AggregatedListHealthChecksHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     HealthChecksAggregatedList response = healthCheckClient.aggregatedListHealthChecksCallable().call(request);
     for (HealthChecksScopedList element : response.getItemsMap()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

deleteHealthCheck

@BetaApi
public final Operation deleteHealthCheck(ProjectGlobalHealthCheckName healthCheck)

Deletes the specified HealthCheck resource.

Sample code:

 try (HealthCheckClient healthCheckClient = HealthCheckClient.create()) {
   ProjectGlobalHealthCheckName healthCheck = ProjectGlobalHealthCheckName.of("[PROJECT]", "[HEALTH_CHECK]");
   Operation response = healthCheckClient.deleteHealthCheck(healthCheck);
 }
 

Parameters:

healthCheck - Name of the HealthCheck resource to delete.

Throws:

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

deleteHealthCheck

@BetaApi
public final Operation deleteHealthCheck(String healthCheck)

Deletes the specified HealthCheck resource.

Sample code:

 try (HealthCheckClient healthCheckClient = HealthCheckClient.create()) {
   ProjectGlobalHealthCheckName healthCheck = ProjectGlobalHealthCheckName.of("[PROJECT]", "[HEALTH_CHECK]");
   Operation response = healthCheckClient.deleteHealthCheck(healthCheck.toString());
 }
 

Parameters:

healthCheck - Name of the HealthCheck resource to delete.

Throws:

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

deleteHealthCheck

@BetaApi
public final Operation deleteHealthCheck(DeleteHealthCheckHttpRequest request)

Deletes the specified HealthCheck resource.

Sample code:

 try (HealthCheckClient healthCheckClient = HealthCheckClient.create()) {
   String formattedHealthCheck = ProjectGlobalHealthCheckName.format("[PROJECT]", "[HEALTH_CHECK]");
   DeleteHealthCheckHttpRequest request = DeleteHealthCheckHttpRequest.newBuilder()
     .setHealthCheck(formattedHealthCheck)
     .build();
   Operation response = healthCheckClient.deleteHealthCheck(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

deleteHealthCheckCallable

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

Deletes the specified HealthCheck resource.

Sample code:

 try (HealthCheckClient healthCheckClient = HealthCheckClient.create()) {
   String formattedHealthCheck = ProjectGlobalHealthCheckName.format("[PROJECT]", "[HEALTH_CHECK]");
   DeleteHealthCheckHttpRequest request = DeleteHealthCheckHttpRequest.newBuilder()
     .setHealthCheck(formattedHealthCheck)
     .build();
   ApiFuture<Operation> future = healthCheckClient.deleteHealthCheckCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

getHealthCheck

@BetaApi
public final HealthCheck getHealthCheck(ProjectGlobalHealthCheckName healthCheck)

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

Sample code:

 try (HealthCheckClient healthCheckClient = HealthCheckClient.create()) {
   ProjectGlobalHealthCheckName healthCheck = ProjectGlobalHealthCheckName.of("[PROJECT]", "[HEALTH_CHECK]");
   HealthCheck response = healthCheckClient.getHealthCheck(healthCheck);
 }
 

Parameters:

healthCheck - Name of the HealthCheck resource to return.

Throws:

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

getHealthCheck

@BetaApi
public final HealthCheck getHealthCheck(String healthCheck)

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

Sample code:

 try (HealthCheckClient healthCheckClient = HealthCheckClient.create()) {
   ProjectGlobalHealthCheckName healthCheck = ProjectGlobalHealthCheckName.of("[PROJECT]", "[HEALTH_CHECK]");
   HealthCheck response = healthCheckClient.getHealthCheck(healthCheck.toString());
 }
 

Parameters:

healthCheck - Name of the HealthCheck resource to return.

Throws:

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

getHealthCheck

@BetaApi
public final HealthCheck getHealthCheck(GetHealthCheckHttpRequest request)

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

Sample code:

 try (HealthCheckClient healthCheckClient = HealthCheckClient.create()) {
   String formattedHealthCheck = ProjectGlobalHealthCheckName.format("[PROJECT]", "[HEALTH_CHECK]");
   GetHealthCheckHttpRequest request = GetHealthCheckHttpRequest.newBuilder()
     .setHealthCheck(formattedHealthCheck)
     .build();
   HealthCheck response = healthCheckClient.getHealthCheck(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

getHealthCheckCallable

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

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

Sample code:

 try (HealthCheckClient healthCheckClient = HealthCheckClient.create()) {
   String formattedHealthCheck = ProjectGlobalHealthCheckName.format("[PROJECT]", "[HEALTH_CHECK]");
   GetHealthCheckHttpRequest request = GetHealthCheckHttpRequest.newBuilder()
     .setHealthCheck(formattedHealthCheck)
     .build();
   ApiFuture<HealthCheck> future = healthCheckClient.getHealthCheckCallable().futureCall(request);
   // Do something
   HealthCheck response = future.get();
 }
 

insertHealthCheck

@BetaApi
public final Operation insertHealthCheck(ProjectName project,
                                                  HealthCheck healthCheckResource)

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

Sample code:

 try (HealthCheckClient healthCheckClient = HealthCheckClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   HealthCheck healthCheckResource = HealthCheck.newBuilder().build();
   Operation response = healthCheckClient.insertHealthCheck(project, healthCheckResource);
 }
 

Parameters:

project - Project ID for 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

insertHealthCheck

@BetaApi
public final Operation insertHealthCheck(String project,
                                                  HealthCheck healthCheckResource)

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

Sample code:

 try (HealthCheckClient healthCheckClient = HealthCheckClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   HealthCheck healthCheckResource = HealthCheck.newBuilder().build();
   Operation response = healthCheckClient.insertHealthCheck(project.toString(), healthCheckResource);
 }
 

Parameters:

project - Project ID for 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

insertHealthCheck

@BetaApi
public final Operation insertHealthCheck(InsertHealthCheckHttpRequest request)

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

Sample code:

 try (HealthCheckClient healthCheckClient = HealthCheckClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   HealthCheck healthCheckResource = HealthCheck.newBuilder().build();
   InsertHealthCheckHttpRequest request = InsertHealthCheckHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setHealthCheckResource(healthCheckResource)
     .build();
   Operation response = healthCheckClient.insertHealthCheck(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

insertHealthCheckCallable

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

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

Sample code:

 try (HealthCheckClient healthCheckClient = HealthCheckClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   HealthCheck healthCheckResource = HealthCheck.newBuilder().build();
   InsertHealthCheckHttpRequest request = InsertHealthCheckHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setHealthCheckResource(healthCheckResource)
     .build();
   ApiFuture<Operation> future = healthCheckClient.insertHealthCheckCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

listHealthChecks

@BetaApi
public final HealthCheckClient.ListHealthChecksPagedResponse listHealthChecks(ProjectName project)

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

Sample code:

 try (HealthCheckClient healthCheckClient = HealthCheckClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (HealthCheck element : healthCheckClient.listHealthChecks(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

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

listHealthChecks

@BetaApi
public final HealthCheckClient.ListHealthChecksPagedResponse listHealthChecks(String project)

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

Sample code:

 try (HealthCheckClient healthCheckClient = HealthCheckClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (HealthCheck element : healthCheckClient.listHealthChecks(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

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

listHealthChecks

@BetaApi
public final HealthCheckClient.ListHealthChecksPagedResponse listHealthChecks(ListHealthChecksHttpRequest request)

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

Sample code:

 try (HealthCheckClient healthCheckClient = HealthCheckClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListHealthChecksHttpRequest request = ListHealthChecksHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (HealthCheck element : healthCheckClient.listHealthChecks(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

listHealthChecksPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListHealthChecksHttpRequest,HealthCheckClient.ListHealthChecksPagedResponse> listHealthChecksPagedCallable()

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

Sample code:

 try (HealthCheckClient healthCheckClient = HealthCheckClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListHealthChecksHttpRequest request = ListHealthChecksHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<ListHealthChecksPagedResponse> future = healthCheckClient.listHealthChecksPagedCallable().futureCall(request);
   // Do something
   for (HealthCheck element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listHealthChecksCallable

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

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

Sample code:

 try (HealthCheckClient healthCheckClient = HealthCheckClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListHealthChecksHttpRequest request = ListHealthChecksHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     HealthCheckList response = healthCheckClient.listHealthChecksCallable().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;
     }
   }
 }
 

patchHealthCheck

@BetaApi
public final Operation patchHealthCheck(ProjectGlobalHealthCheckName 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 (HealthCheckClient healthCheckClient = HealthCheckClient.create()) {
   ProjectGlobalHealthCheckName healthCheck = ProjectGlobalHealthCheckName.of("[PROJECT]", "[HEALTH_CHECK]");
   HealthCheck healthCheckResource = HealthCheck.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = healthCheckClient.patchHealthCheck(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

patchHealthCheck

@BetaApi
public final Operation patchHealthCheck(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 (HealthCheckClient healthCheckClient = HealthCheckClient.create()) {
   ProjectGlobalHealthCheckName healthCheck = ProjectGlobalHealthCheckName.of("[PROJECT]", "[HEALTH_CHECK]");
   HealthCheck healthCheckResource = HealthCheck.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = healthCheckClient.patchHealthCheck(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

patchHealthCheck

@BetaApi
public final Operation patchHealthCheck(PatchHealthCheckHttpRequest 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 (HealthCheckClient healthCheckClient = HealthCheckClient.create()) {
   String formattedHealthCheck = ProjectGlobalHealthCheckName.format("[PROJECT]", "[HEALTH_CHECK]");
   HealthCheck healthCheckResource = HealthCheck.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   PatchHealthCheckHttpRequest request = PatchHealthCheckHttpRequest.newBuilder()
     .setHealthCheck(formattedHealthCheck)
     .setHealthCheckResource(healthCheckResource)
     .addAllFieldMask(fieldMask)
     .build();
   Operation response = healthCheckClient.patchHealthCheck(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

patchHealthCheckCallable

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

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 (HealthCheckClient healthCheckClient = HealthCheckClient.create()) {
   String formattedHealthCheck = ProjectGlobalHealthCheckName.format("[PROJECT]", "[HEALTH_CHECK]");
   HealthCheck healthCheckResource = HealthCheck.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   PatchHealthCheckHttpRequest request = PatchHealthCheckHttpRequest.newBuilder()
     .setHealthCheck(formattedHealthCheck)
     .setHealthCheckResource(healthCheckResource)
     .addAllFieldMask(fieldMask)
     .build();
   ApiFuture<Operation> future = healthCheckClient.patchHealthCheckCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

updateHealthCheck

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

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

Sample code:

 try (HealthCheckClient healthCheckClient = HealthCheckClient.create()) {
   ProjectGlobalHealthCheckName healthCheck = ProjectGlobalHealthCheckName.of("[PROJECT]", "[HEALTH_CHECK]");
   HealthCheck healthCheckResource = HealthCheck.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = healthCheckClient.updateHealthCheck(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

updateHealthCheck

@BetaApi
public final Operation updateHealthCheck(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 (HealthCheckClient healthCheckClient = HealthCheckClient.create()) {
   ProjectGlobalHealthCheckName healthCheck = ProjectGlobalHealthCheckName.of("[PROJECT]", "[HEALTH_CHECK]");
   HealthCheck healthCheckResource = HealthCheck.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = healthCheckClient.updateHealthCheck(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

updateHealthCheck

@BetaApi
public final Operation updateHealthCheck(UpdateHealthCheckHttpRequest request)

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

Sample code:

 try (HealthCheckClient healthCheckClient = HealthCheckClient.create()) {
   String formattedHealthCheck = ProjectGlobalHealthCheckName.format("[PROJECT]", "[HEALTH_CHECK]");
   HealthCheck healthCheckResource = HealthCheck.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   UpdateHealthCheckHttpRequest request = UpdateHealthCheckHttpRequest.newBuilder()
     .setHealthCheck(formattedHealthCheck)
     .setHealthCheckResource(healthCheckResource)
     .addAllFieldMask(fieldMask)
     .build();
   Operation response = healthCheckClient.updateHealthCheck(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

updateHealthCheckCallable

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

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

Sample code:

 try (HealthCheckClient healthCheckClient = HealthCheckClient.create()) {
   String formattedHealthCheck = ProjectGlobalHealthCheckName.format("[PROJECT]", "[HEALTH_CHECK]");
   HealthCheck healthCheckResource = HealthCheck.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   UpdateHealthCheckHttpRequest request = UpdateHealthCheckHttpRequest.newBuilder()
     .setHealthCheck(formattedHealthCheck)
     .setHealthCheckResource(healthCheckResource)
     .addAllFieldMask(fieldMask)
     .build();
   ApiFuture<Operation> future = healthCheckClient.updateHealthCheckCallable().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