- 1.57.0 (latest)
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public class HealthChecksClient implements BackgroundResource
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().
The surface of this class includes several types of Java methods for each of the API's methods:
- 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.
- 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.
- 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 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.
Implements
BackgroundResourceStatic Methods
create()
public static final HealthChecksClient create()
Constructs an instance of HealthChecksClient with default settings.
Type | Description |
HealthChecksClient |
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.
Name | Description |
settings | HealthChecksSettings |
Type | Description |
HealthChecksClient |
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).
Name | Description |
stub | HealthChecksStub |
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.
Name | Description |
settings | HealthChecksSettings |
HealthChecksClient(HealthChecksStub stub)
protected HealthChecksClient(HealthChecksStub stub)
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.
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)
.build();
for (Map.Entry<String, HealthChecksScopedList> element :
healthChecksClient.aggregatedList(request).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
request | AggregatedListHealthChecksRequest The request object containing all of the parameters for the API call. |
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.
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);
}
}
Name | Description |
project | String Name of the project scoping this request. |
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.
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)
.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;
}
}
}
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.
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)
.build();
ApiFuture<Map.Entry<String, HealthChecksScopedList>> future =
healthChecksClient.aggregatedListPagedCallable().futureCall(request);
// Do something.
for (Map.Entry<String, HealthChecksScopedList> element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Type | Description |
UnaryCallable<AggregatedListHealthChecksRequest,AggregatedListPagedResponse> |
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Name | Description |
duration | long |
unit | TimeUnit |
Type | Description |
boolean |
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();
}
Name | Description |
request | DeleteHealthCheckRequest The request object containing all of the parameters for the API call. |
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();
}
Name | Description |
project | String Project ID for this request. |
healthCheck | String Name of the HealthCheck resource to delete. |
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();
}
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();
}
Type | Description |
OperationCallable<DeleteHealthCheckRequest,Operation,Operation> |
get(GetHealthCheckRequest request)
public final HealthCheck get(GetHealthCheckRequest request)
Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() 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()) {
GetHealthCheckRequest request =
GetHealthCheckRequest.newBuilder()
.setHealthCheck("healthCheck-1938093044")
.setProject("project-309310695")
.build();
HealthCheck response = healthChecksClient.get(request);
}
Name | Description |
request | GetHealthCheckRequest The request object containing all of the parameters for the API call. |
Type | Description |
HealthCheck |
get(String project, String healthCheck)
public final HealthCheck get(String project, String healthCheck)
Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() 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 response = healthChecksClient.get(project, healthCheck);
}
Name | Description |
project | String Project ID for this request. |
healthCheck | String Name of the HealthCheck resource to return. |
Type | Description |
HealthCheck |
getCallable()
public final UnaryCallable<GetHealthCheckRequest,HealthCheck> getCallable()
Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() 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()) {
GetHealthCheckRequest request =
GetHealthCheckRequest.newBuilder()
.setHealthCheck("healthCheck-1938093044")
.setProject("project-309310695")
.build();
ApiFuture<HealthCheck> future = healthChecksClient.getCallable().futureCall(request);
// Do something.
HealthCheck response = future.get();
}
Type | Description |
UnaryCallable<GetHealthCheckRequest,HealthCheck> |
getSettings()
public final HealthChecksSettings getSettings()
Type | Description |
HealthChecksSettings |
getStub()
public HealthChecksStub getStub()
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();
}
Name | Description |
request | InsertHealthCheckRequest The request object containing all of the parameters for the API call. |
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();
}
Name | Description |
project | String Project ID for this request. |
healthCheckResource | HealthCheck The body resource for this request |
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();
}
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();
}
Type | Description |
OperationCallable<InsertHealthCheckRequest,Operation,Operation> |
isShutdown()
public boolean isShutdown()
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
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);
}
}
Name | Description |
request | ListHealthChecksRequest The request object containing all of the parameters for the API call. |
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);
}
}
Name | Description |
project | String Project ID for this request. |
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;
}
}
}
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);
}
}
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();
}
Name | Description |
request | PatchHealthCheckRequest The request object containing all of the parameters for the API call. |
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();
}
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 |
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();
}
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();
}
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();
}
Name | Description |
request | UpdateHealthCheckRequest The request object containing all of the parameters for the API call. |
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();
}
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 |
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();
}
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();
}
Type | Description |
OperationCallable<UpdateHealthCheckRequest,Operation,Operation> |