Class HealthCheckServiceClient (0.11.0)

Version 0.11.0

• 0.12.0 (latest)
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

GitHub Repository

Product Reference

RPC Documentation

Service Description: HealthCheckService provides an interface for Vertex AI Vision Cluster Health Check.

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 (HealthCheckServiceClient healthCheckServiceClient = HealthCheckServiceClient.create()) {
   HealthCheckRequest request =
       HealthCheckRequest.newBuilder()
           .setCluster(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .build();
   HealthCheckResponse response = healthCheckServiceClient.healthCheck(request);
 }
 

Note: close() needs to be called on the HealthCheckServiceClient 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
HealthCheck	HealthCheck method checks the health status of the cluster.	Request object method variants only take one parameter, a request object, which must be constructed before the call. healthCheck(HealthCheckRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. healthCheckCallable()

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 HealthCheckServiceSettings 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
 HealthCheckServiceSettings healthCheckServiceSettings =
     HealthCheckServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 HealthCheckServiceClient healthCheckServiceClient =
     HealthCheckServiceClient.create(healthCheckServiceSettings);
 

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
 HealthCheckServiceSettings healthCheckServiceSettings =
     HealthCheckServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 HealthCheckServiceClient healthCheckServiceClient =
     HealthCheckServiceClient.create(healthCheckServiceSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:

 // 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
 HealthCheckServiceSettings healthCheckServiceSettings =
     HealthCheckServiceSettings.newHttpJsonBuilder().build();
 HealthCheckServiceClient healthCheckServiceClient =
     HealthCheckServiceClient.create(healthCheckServiceSettings);
 

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

Inheritance

java.lang.Object > HealthCheckServiceClient

Static Methods

create()

public static final HealthCheckServiceClient create()

Constructs an instance of HealthCheckServiceClient with default settings.

Returns
Type	Description
HealthCheckServiceClient

Exceptions
Type	Description
IOException

create(HealthCheckServiceSettings settings)

public static final HealthCheckServiceClient create(HealthCheckServiceSettings settings)

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

Returns
Type	Description
HealthCheckServiceClient

Exceptions
Type	Description
IOException

create(HealthCheckServiceStub stub)

public static final HealthCheckServiceClient create(HealthCheckServiceStub stub)

Constructs an instance of HealthCheckServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(HealthCheckServiceSettings).

Parameter
Name	Description
stub	HealthCheckServiceStub

Returns
Type	Description
HealthCheckServiceClient

Constructors

HealthCheckServiceClient(HealthCheckServiceSettings settings)

protected HealthCheckServiceClient(HealthCheckServiceSettings settings)

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

HealthCheckServiceClient(HealthCheckServiceStub stub)

protected HealthCheckServiceClient(HealthCheckServiceStub stub)

Parameter
Name	Description
stub	HealthCheckServiceStub

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

getSettings()

public final HealthCheckServiceSettings getSettings()

Returns
Type	Description
HealthCheckServiceSettings

getStub()

public HealthCheckServiceStub getStub()

Returns
Type	Description
HealthCheckServiceStub

healthCheck(HealthCheckRequest request)

public final HealthCheckResponse healthCheck(HealthCheckRequest request)

HealthCheck method checks the health status of the cluster.

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 (HealthCheckServiceClient healthCheckServiceClient = HealthCheckServiceClient.create()) {
   HealthCheckRequest request =
       HealthCheckRequest.newBuilder()
           .setCluster(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .build();
   HealthCheckResponse response = healthCheckServiceClient.healthCheck(request);
 }
 

Parameter
Name	Description
request	HealthCheckRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
HealthCheckResponse

healthCheckCallable()

public final UnaryCallable<HealthCheckRequest,HealthCheckResponse> healthCheckCallable()

HealthCheck method checks the health status of the cluster.

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 (HealthCheckServiceClient healthCheckServiceClient = HealthCheckServiceClient.create()) {
   HealthCheckRequest request =
       HealthCheckRequest.newBuilder()
           .setCluster(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .build();
   ApiFuture<HealthCheckResponse> future =
       healthCheckServiceClient.healthCheckCallable().futureCall(request);
   // Do something.
   HealthCheckResponse response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<HealthCheckRequest,HealthCheckResponse>

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()