Class HealthChecksClient (1.64.0)

GitHub RepositoryProduct Reference

Service Description: The HealthChecks 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 (HealthChecksClient healthChecksClient = HealthChecksClient.create()) {
   String project = "project-309310695";
   String healthCheck = "healthCheck-1938093044";
   HealthCheck response = healthChecksClient.get(project, healthCheck);
 }

Note: close() needs to be called on the HealthChecksClient 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

AggregatedList

Retrieves the list of all HealthCheck resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • aggregatedList(AggregatedListHealthChecksRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • aggregatedList(String project)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • aggregatedListPagedCallable()

  • aggregatedListCallable()

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(DeleteHealthCheckRequest 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 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(GetHealthCheckRequest 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 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(InsertHealthCheckRequest 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, 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(ListHealthChecksRequest 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)

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(PatchHealthCheckRequest 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 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(UpdateHealthCheckRequest 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 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 HealthChecksSettings 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
 HealthChecksSettings healthChecksSettings =
     HealthChecksSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 HealthChecksClient healthChecksClient = HealthChecksClient.create(healthChecksSettings);

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
 HealthChecksSettings healthChecksSettings =
     HealthChecksSettings.newBuilder().setEndpoint(myEndpoint).build();
 HealthChecksClient healthChecksClient = HealthChecksClient.create(healthChecksSettings);

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

Inheritance

java.lang.Object > HealthChecksClient

Static Methods

create()

public static final HealthChecksClient create()

Constructs an instance of HealthChecksClient with default settings.

Returns
Type Description
HealthChecksClient
Exceptions
Type Description
IOException

create(HealthChecksSettings settings)

public static final HealthChecksClient create(HealthChecksSettings settings)

Constructs an instance of HealthChecksClient, 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 HealthChecksSettings
Returns
Type Description
HealthChecksClient
Exceptions
Type Description
IOException

create(HealthChecksStub stub)

public static final HealthChecksClient create(HealthChecksStub stub)

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

Parameter
Name Description
stub HealthChecksStub
Returns
Type Description
HealthChecksClient

Constructors

HealthChecksClient(HealthChecksSettings settings)

protected HealthChecksClient(HealthChecksSettings settings)

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

HealthChecksClient(HealthChecksStub stub)

protected HealthChecksClient(HealthChecksStub stub)
Parameter
Name Description
stub HealthChecksStub

Methods

aggregatedList(AggregatedListHealthChecksRequest request)

public final HealthChecksClient.AggregatedListPagedResponse aggregatedList(AggregatedListHealthChecksRequest request)

Retrieves the list of all HealthCheck resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (HealthChecksClient healthChecksClient = HealthChecksClient.create()) {
   AggregatedListHealthChecksRequest request =
       AggregatedListHealthChecksRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   for (Map.Entry<String, HealthChecksScopedList> element :
       healthChecksClient.aggregatedList(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request AggregatedListHealthChecksRequest

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

aggregatedList(String project)

public final HealthChecksClient.AggregatedListPagedResponse aggregatedList(String project)

Retrieves the list of all HealthCheck resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (HealthChecksClient healthChecksClient = HealthChecksClient.create()) {
   String project = "project-309310695";
   for (Map.Entry<String, HealthChecksScopedList> element :
       healthChecksClient.aggregatedList(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
project String

Name of the project scoping this request.
Returns
Type Description
HealthChecksClient.AggregatedListPagedResponse

aggregatedListCallable()

public final UnaryCallable<AggregatedListHealthChecksRequest,HealthChecksAggregatedList> aggregatedListCallable()

Retrieves the list of all HealthCheck resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (HealthChecksClient healthChecksClient = HealthChecksClient.create()) {
   AggregatedListHealthChecksRequest request =
       AggregatedListHealthChecksRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   while (true) {
     HealthChecksAggregatedList response =
         healthChecksClient.aggregatedListCallable().call(request);
     for (Map.Entry<String, HealthChecksScopedList> 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<AggregatedListHealthChecksRequest,HealthChecksAggregatedList>

aggregatedListPagedCallable()

public final UnaryCallable<AggregatedListHealthChecksRequest,HealthChecksClient.AggregatedListPagedResponse> aggregatedListPagedCallable()

Retrieves the list of all HealthCheck resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (HealthChecksClient healthChecksClient = HealthChecksClient.create()) {
   AggregatedListHealthChecksRequest request =
       AggregatedListHealthChecksRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   ApiFuture<Map.Entry<String, HealthChecksScopedList>> future =
       healthChecksClient.aggregatedListPagedCallable().futureCall(request);
   // Do something.
   for (Map.Entry<String, HealthChecksScopedList> element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<AggregatedListHealthChecksRequest,AggregatedListPagedResponse>

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

public final OperationFuture<Operation,Operation> deleteAsync(DeleteHealthCheckRequest 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 (HealthChecksClient healthChecksClient = HealthChecksClient.create()) {
   DeleteHealthCheckRequest request =
       DeleteHealthCheckRequest.newBuilder()
           .setHealthCheck("healthCheck-1938093044")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   Operation response = healthChecksClient.deleteAsync(request).get();
 }
Parameter
Name Description
request DeleteHealthCheckRequest

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

deleteAsync(String project, String healthCheck)

public final OperationFuture<Operation,Operation> deleteAsync(String project, 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 (HealthChecksClient healthChecksClient = HealthChecksClient.create()) {
   String project = "project-309310695";
   String healthCheck = "healthCheck-1938093044";
   Operation response = healthChecksClient.deleteAsync(project, healthCheck).get();
 }
Parameters
Name Description
project String

Project ID for this request.
healthCheck String

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

deleteCallable()

public final UnaryCallable<DeleteHealthCheckRequest,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 (HealthChecksClient healthChecksClient = HealthChecksClient.create()) {
   DeleteHealthCheckRequest request =
       DeleteHealthCheckRequest.newBuilder()
           .setHealthCheck("healthCheck-1938093044")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = healthChecksClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<DeleteHealthCheckRequest,Operation>

deleteOperationCallable()

public final OperationCallable<DeleteHealthCheckRequest,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 (HealthChecksClient healthChecksClient = HealthChecksClient.create()) {
   DeleteHealthCheckRequest request =
       DeleteHealthCheckRequest.newBuilder()
           .setHealthCheck("healthCheck-1938093044")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       healthChecksClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<DeleteHealthCheckRequest,Operation,Operation>

get(GetHealthCheckRequest request)

public final HealthCheck get(GetHealthCheckRequest 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 (HealthChecksClient healthChecksClient = HealthChecksClient.create()) {
   GetHealthCheckRequest request =
       GetHealthCheckRequest.newBuilder()
           .setHealthCheck("healthCheck-1938093044")
           .setProject("project-309310695")
           .build();
   HealthCheck response = healthChecksClient.get(request);
 }
Parameter
Name Description
request GetHealthCheckRequest

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

get(String project, String healthCheck)

public final HealthCheck get(String project, 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 (HealthChecksClient healthChecksClient = HealthChecksClient.create()) {
   String project = "project-309310695";
   String healthCheck = "healthCheck-1938093044";
   HealthCheck response = healthChecksClient.get(project, healthCheck);
 }
Parameters
Name Description
project String

Project ID for this request.
healthCheck String

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

getCallable()

public final UnaryCallable<GetHealthCheckRequest,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 (HealthChecksClient healthChecksClient = HealthChecksClient.create()) {
   GetHealthCheckRequest request =
       GetHealthCheckRequest.newBuilder()
           .setHealthCheck("healthCheck-1938093044")
           .setProject("project-309310695")
           .build();
   ApiFuture<HealthCheck> future = healthChecksClient.getCallable().futureCall(request);
   // Do something.
   HealthCheck response = future.get();
 }
Returns
Type Description
UnaryCallable<GetHealthCheckRequest,HealthCheck>

getSettings()

public final HealthChecksSettings getSettings()
Returns
Type Description
HealthChecksSettings

getStub()

public HealthChecksStub getStub()
Returns
Type Description
HealthChecksStub

insertAsync(InsertHealthCheckRequest request)

public final OperationFuture<Operation,Operation> insertAsync(InsertHealthCheckRequest 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 (HealthChecksClient healthChecksClient = HealthChecksClient.create()) {
   InsertHealthCheckRequest request =
       InsertHealthCheckRequest.newBuilder()
           .setHealthCheckResource(HealthCheck.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   Operation response = healthChecksClient.insertAsync(request).get();
 }
Parameter
Name Description
request InsertHealthCheckRequest

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

insertAsync(String project, HealthCheck healthCheckResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, 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 (HealthChecksClient healthChecksClient = HealthChecksClient.create()) {
   String project = "project-309310695";
   HealthCheck healthCheckResource = HealthCheck.newBuilder().build();
   Operation response = healthChecksClient.insertAsync(project, healthCheckResource).get();
 }
Parameters
Name Description
project String

Project ID for this request.
healthCheckResource HealthCheck

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

insertCallable()

public final UnaryCallable<InsertHealthCheckRequest,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 (HealthChecksClient healthChecksClient = HealthChecksClient.create()) {
   InsertHealthCheckRequest request =
       InsertHealthCheckRequest.newBuilder()
           .setHealthCheckResource(HealthCheck.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = healthChecksClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<InsertHealthCheckRequest,Operation>

insertOperationCallable()

public final OperationCallable<InsertHealthCheckRequest,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 (HealthChecksClient healthChecksClient = HealthChecksClient.create()) {
   InsertHealthCheckRequest request =
       InsertHealthCheckRequest.newBuilder()
           .setHealthCheckResource(HealthCheck.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       healthChecksClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<InsertHealthCheckRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

list(ListHealthChecksRequest request)

public final HealthChecksClient.ListPagedResponse list(ListHealthChecksRequest 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 (HealthChecksClient healthChecksClient = HealthChecksClient.create()) {
   ListHealthChecksRequest request =
       ListHealthChecksRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (HealthCheck element : healthChecksClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListHealthChecksRequest

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

list(String project)

public final HealthChecksClient.ListPagedResponse list(String project)

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 (HealthChecksClient healthChecksClient = HealthChecksClient.create()) {
   String project = "project-309310695";
   for (HealthCheck element : healthChecksClient.list(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
project String

Project ID for this request.
Returns
Type Description
HealthChecksClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListHealthChecksRequest,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 (HealthChecksClient healthChecksClient = HealthChecksClient.create()) {
   ListHealthChecksRequest request =
       ListHealthChecksRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     HealthCheckList response = healthChecksClient.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<ListHealthChecksRequest,HealthCheckList>

listPagedCallable()

public final UnaryCallable<ListHealthChecksRequest,HealthChecksClient.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 (HealthChecksClient healthChecksClient = HealthChecksClient.create()) {
   ListHealthChecksRequest request =
       ListHealthChecksRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<HealthCheck> future = healthChecksClient.listPagedCallable().futureCall(request);
   // Do something.
   for (HealthCheck element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListHealthChecksRequest,ListPagedResponse>

patchAsync(PatchHealthCheckRequest request)

public final OperationFuture<Operation,Operation> patchAsync(PatchHealthCheckRequest 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 (HealthChecksClient healthChecksClient = HealthChecksClient.create()) {
   PatchHealthCheckRequest request =
       PatchHealthCheckRequest.newBuilder()
           .setHealthCheck("healthCheck-1938093044")
           .setHealthCheckResource(HealthCheck.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   Operation response = healthChecksClient.patchAsync(request).get();
 }
Parameter
Name Description
request PatchHealthCheckRequest

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

patchAsync(String project, String healthCheck, HealthCheck healthCheckResource)

public final OperationFuture<Operation,Operation> patchAsync(String project, 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 (HealthChecksClient healthChecksClient = HealthChecksClient.create()) {
   String project = "project-309310695";
   String healthCheck = "healthCheck-1938093044";
   HealthCheck healthCheckResource = HealthCheck.newBuilder().build();
   Operation response =
       healthChecksClient.patchAsync(project, healthCheck, healthCheckResource).get();
 }
Parameters
Name Description
project String

Project ID for 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<PatchHealthCheckRequest,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 (HealthChecksClient healthChecksClient = HealthChecksClient.create()) {
   PatchHealthCheckRequest request =
       PatchHealthCheckRequest.newBuilder()
           .setHealthCheck("healthCheck-1938093044")
           .setHealthCheckResource(HealthCheck.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = healthChecksClient.patchCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<PatchHealthCheckRequest,Operation>

patchOperationCallable()

public final OperationCallable<PatchHealthCheckRequest,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 (HealthChecksClient healthChecksClient = HealthChecksClient.create()) {
   PatchHealthCheckRequest request =
       PatchHealthCheckRequest.newBuilder()
           .setHealthCheck("healthCheck-1938093044")
           .setHealthCheckResource(HealthCheck.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       healthChecksClient.patchOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<PatchHealthCheckRequest,Operation,Operation>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateAsync(UpdateHealthCheckRequest request)

public final OperationFuture<Operation,Operation> updateAsync(UpdateHealthCheckRequest 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 (HealthChecksClient healthChecksClient = HealthChecksClient.create()) {
   UpdateHealthCheckRequest request =
       UpdateHealthCheckRequest.newBuilder()
           .setHealthCheck("healthCheck-1938093044")
           .setHealthCheckResource(HealthCheck.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   Operation response = healthChecksClient.updateAsync(request).get();
 }
Parameter
Name Description
request UpdateHealthCheckRequest

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

updateAsync(String project, String healthCheck, HealthCheck healthCheckResource)

public final OperationFuture<Operation,Operation> updateAsync(String project, 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 (HealthChecksClient healthChecksClient = HealthChecksClient.create()) {
   String project = "project-309310695";
   String healthCheck = "healthCheck-1938093044";
   HealthCheck healthCheckResource = HealthCheck.newBuilder().build();
   Operation response =
       healthChecksClient.updateAsync(project, healthCheck, healthCheckResource).get();
 }
Parameters
Name Description
project String

Project ID for 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<UpdateHealthCheckRequest,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 (HealthChecksClient healthChecksClient = HealthChecksClient.create()) {
   UpdateHealthCheckRequest request =
       UpdateHealthCheckRequest.newBuilder()
           .setHealthCheck("healthCheck-1938093044")
           .setHealthCheckResource(HealthCheck.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = healthChecksClient.updateCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateHealthCheckRequest,Operation>

updateOperationCallable()

public final OperationCallable<UpdateHealthCheckRequest,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 (HealthChecksClient healthChecksClient = HealthChecksClient.create()) {
   UpdateHealthCheckRequest request =
       UpdateHealthCheckRequest.newBuilder()
           .setHealthCheck("healthCheck-1938093044")
           .setHealthCheckResource(HealthCheck.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       healthChecksClient.updateOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<UpdateHealthCheckRequest,Operation,Operation>