- 1.63.0 (latest)
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 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
GitHub Repository | Product Reference |
Service Description: The RegionHealthCheckServices 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 (RegionHealthCheckServicesClient regionHealthCheckServicesClient =
RegionHealthCheckServicesClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String healthCheckService = "healthCheckService-917902071";
HealthCheckService response =
regionHealthCheckServicesClient.get(project, region, healthCheckService);
}
Note: close() needs to be called on the RegionHealthCheckServicesClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
Method | Description | Method Variants |
---|---|---|
Delete | Deletes the specified regional HealthCheckService. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
Get | Returns the specified regional HealthCheckService resource. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
Insert | Creates a regional HealthCheckService resource in the specified project and region 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.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
List | Lists all the HealthCheckService resources that have been configured for the specified project in the given region. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
Patch | Updates the specified regional HealthCheckService resource with 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.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return 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 RegionHealthCheckServicesSettings 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
RegionHealthCheckServicesSettings regionHealthCheckServicesSettings =
RegionHealthCheckServicesSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
RegionHealthCheckServicesClient regionHealthCheckServicesClient =
RegionHealthCheckServicesClient.create(regionHealthCheckServicesSettings);
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
RegionHealthCheckServicesSettings regionHealthCheckServicesSettings =
RegionHealthCheckServicesSettings.newBuilder().setEndpoint(myEndpoint).build();
RegionHealthCheckServicesClient regionHealthCheckServicesClient =
RegionHealthCheckServicesClient.create(regionHealthCheckServicesSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final RegionHealthCheckServicesClient create()
Constructs an instance of RegionHealthCheckServicesClient with default settings.
Returns | |
---|---|
Type | Description |
RegionHealthCheckServicesClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(RegionHealthCheckServicesSettings settings)
public static final RegionHealthCheckServicesClient create(RegionHealthCheckServicesSettings settings)
Constructs an instance of RegionHealthCheckServicesClient, 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 | RegionHealthCheckServicesSettings |
Returns | |
---|---|
Type | Description |
RegionHealthCheckServicesClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(RegionHealthCheckServicesStub stub)
public static final RegionHealthCheckServicesClient create(RegionHealthCheckServicesStub stub)
Constructs an instance of RegionHealthCheckServicesClient, using the given stub for making calls. This is for advanced usage - prefer using create(RegionHealthCheckServicesSettings).
Parameter | |
---|---|
Name | Description |
stub | RegionHealthCheckServicesStub |
Returns | |
---|---|
Type | Description |
RegionHealthCheckServicesClient |
Constructors
RegionHealthCheckServicesClient(RegionHealthCheckServicesSettings settings)
protected RegionHealthCheckServicesClient(RegionHealthCheckServicesSettings settings)
Constructs an instance of RegionHealthCheckServicesClient, 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 | RegionHealthCheckServicesSettings |
RegionHealthCheckServicesClient(RegionHealthCheckServicesStub stub)
protected RegionHealthCheckServicesClient(RegionHealthCheckServicesStub stub)
Parameter | |
---|---|
Name | Description |
stub | RegionHealthCheckServicesStub |
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()
deleteAsync(DeleteRegionHealthCheckServiceRequest request)
public final OperationFuture<Operation,Operation> deleteAsync(DeleteRegionHealthCheckServiceRequest request)
Deletes the specified regional HealthCheckService.
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 (RegionHealthCheckServicesClient regionHealthCheckServicesClient =
RegionHealthCheckServicesClient.create()) {
DeleteRegionHealthCheckServiceRequest request =
DeleteRegionHealthCheckServiceRequest.newBuilder()
.setHealthCheckService("healthCheckService-917902071")
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
Operation response = regionHealthCheckServicesClient.deleteAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | DeleteRegionHealthCheckServiceRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
deleteAsync(String project, String region, String healthCheckService)
public final OperationFuture<Operation,Operation> deleteAsync(String project, String region, String healthCheckService)
Deletes the specified regional HealthCheckService.
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 (RegionHealthCheckServicesClient regionHealthCheckServicesClient =
RegionHealthCheckServicesClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String healthCheckService = "healthCheckService-917902071";
Operation response =
regionHealthCheckServicesClient.deleteAsync(project, region, healthCheckService).get();
}
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String Name of the region scoping this request. |
healthCheckService | String Name of the HealthCheckService to delete. The name must be 1-63 characters long, and comply with RFC1035. |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
deleteCallable()
public final UnaryCallable<DeleteRegionHealthCheckServiceRequest,Operation> deleteCallable()
Deletes the specified regional HealthCheckService.
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 (RegionHealthCheckServicesClient regionHealthCheckServicesClient =
RegionHealthCheckServicesClient.create()) {
DeleteRegionHealthCheckServiceRequest request =
DeleteRegionHealthCheckServiceRequest.newBuilder()
.setHealthCheckService("healthCheckService-917902071")
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future =
regionHealthCheckServicesClient.deleteCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteRegionHealthCheckServiceRequest,Operation> |
deleteOperationCallable()
public final OperationCallable<DeleteRegionHealthCheckServiceRequest,Operation,Operation> deleteOperationCallable()
Deletes the specified regional HealthCheckService.
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 (RegionHealthCheckServicesClient regionHealthCheckServicesClient =
RegionHealthCheckServicesClient.create()) {
DeleteRegionHealthCheckServiceRequest request =
DeleteRegionHealthCheckServiceRequest.newBuilder()
.setHealthCheckService("healthCheckService-917902071")
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
OperationFuture<Operation, Operation> future =
regionHealthCheckServicesClient.deleteOperationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DeleteRegionHealthCheckServiceRequest,Operation,Operation> |
get(GetRegionHealthCheckServiceRequest request)
public final HealthCheckService get(GetRegionHealthCheckServiceRequest request)
Returns the specified regional HealthCheckService 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 (RegionHealthCheckServicesClient regionHealthCheckServicesClient =
RegionHealthCheckServicesClient.create()) {
GetRegionHealthCheckServiceRequest request =
GetRegionHealthCheckServiceRequest.newBuilder()
.setHealthCheckService("healthCheckService-917902071")
.setProject("project-309310695")
.setRegion("region-934795532")
.build();
HealthCheckService response = regionHealthCheckServicesClient.get(request);
}
Parameter | |
---|---|
Name | Description |
request | GetRegionHealthCheckServiceRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
HealthCheckService |
get(String project, String region, String healthCheckService)
public final HealthCheckService get(String project, String region, String healthCheckService)
Returns the specified regional HealthCheckService 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 (RegionHealthCheckServicesClient regionHealthCheckServicesClient =
RegionHealthCheckServicesClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String healthCheckService = "healthCheckService-917902071";
HealthCheckService response =
regionHealthCheckServicesClient.get(project, region, healthCheckService);
}
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String Name of the region scoping this request. |
healthCheckService | String Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035. |
Returns | |
---|---|
Type | Description |
HealthCheckService |
getCallable()
public final UnaryCallable<GetRegionHealthCheckServiceRequest,HealthCheckService> getCallable()
Returns the specified regional HealthCheckService 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 (RegionHealthCheckServicesClient regionHealthCheckServicesClient =
RegionHealthCheckServicesClient.create()) {
GetRegionHealthCheckServiceRequest request =
GetRegionHealthCheckServiceRequest.newBuilder()
.setHealthCheckService("healthCheckService-917902071")
.setProject("project-309310695")
.setRegion("region-934795532")
.build();
ApiFuture<HealthCheckService> future =
regionHealthCheckServicesClient.getCallable().futureCall(request);
// Do something.
HealthCheckService response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetRegionHealthCheckServiceRequest,HealthCheckService> |
getSettings()
public final RegionHealthCheckServicesSettings getSettings()
Returns | |
---|---|
Type | Description |
RegionHealthCheckServicesSettings |
getStub()
public RegionHealthCheckServicesStub getStub()
Returns | |
---|---|
Type | Description |
RegionHealthCheckServicesStub |
insertAsync(InsertRegionHealthCheckServiceRequest request)
public final OperationFuture<Operation,Operation> insertAsync(InsertRegionHealthCheckServiceRequest request)
Creates a regional HealthCheckService resource in the specified project and region 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 (RegionHealthCheckServicesClient regionHealthCheckServicesClient =
RegionHealthCheckServicesClient.create()) {
InsertRegionHealthCheckServiceRequest request =
InsertRegionHealthCheckServiceRequest.newBuilder()
.setHealthCheckServiceResource(HealthCheckService.newBuilder().build())
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
Operation response = regionHealthCheckServicesClient.insertAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | InsertRegionHealthCheckServiceRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
insertAsync(String project, String region, HealthCheckService healthCheckServiceResource)
public final OperationFuture<Operation,Operation> insertAsync(String project, String region, HealthCheckService healthCheckServiceResource)
Creates a regional HealthCheckService resource in the specified project and region 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 (RegionHealthCheckServicesClient regionHealthCheckServicesClient =
RegionHealthCheckServicesClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
HealthCheckService healthCheckServiceResource = HealthCheckService.newBuilder().build();
Operation response =
regionHealthCheckServicesClient
.insertAsync(project, region, healthCheckServiceResource)
.get();
}
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String Name of the region scoping this request. |
healthCheckServiceResource | HealthCheckService The body resource for this request |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
insertCallable()
public final UnaryCallable<InsertRegionHealthCheckServiceRequest,Operation> insertCallable()
Creates a regional HealthCheckService resource in the specified project and region 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 (RegionHealthCheckServicesClient regionHealthCheckServicesClient =
RegionHealthCheckServicesClient.create()) {
InsertRegionHealthCheckServiceRequest request =
InsertRegionHealthCheckServiceRequest.newBuilder()
.setHealthCheckServiceResource(HealthCheckService.newBuilder().build())
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future =
regionHealthCheckServicesClient.insertCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<InsertRegionHealthCheckServiceRequest,Operation> |
insertOperationCallable()
public final OperationCallable<InsertRegionHealthCheckServiceRequest,Operation,Operation> insertOperationCallable()
Creates a regional HealthCheckService resource in the specified project and region 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 (RegionHealthCheckServicesClient regionHealthCheckServicesClient =
RegionHealthCheckServicesClient.create()) {
InsertRegionHealthCheckServiceRequest request =
InsertRegionHealthCheckServiceRequest.newBuilder()
.setHealthCheckServiceResource(HealthCheckService.newBuilder().build())
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
OperationFuture<Operation, Operation> future =
regionHealthCheckServicesClient.insertOperationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<InsertRegionHealthCheckServiceRequest,Operation,Operation> |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
list(ListRegionHealthCheckServicesRequest request)
public final RegionHealthCheckServicesClient.ListPagedResponse list(ListRegionHealthCheckServicesRequest request)
Lists all the HealthCheckService resources that have been configured for the specified project in the given region.
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 (RegionHealthCheckServicesClient regionHealthCheckServicesClient =
RegionHealthCheckServicesClient.create()) {
ListRegionHealthCheckServicesRequest request =
ListRegionHealthCheckServicesRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setRegion("region-934795532")
.setReturnPartialSuccess(true)
.build();
for (HealthCheckService element :
regionHealthCheckServicesClient.list(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | ListRegionHealthCheckServicesRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
RegionHealthCheckServicesClient.ListPagedResponse |
list(String project, String region)
public final RegionHealthCheckServicesClient.ListPagedResponse list(String project, String region)
Lists all the HealthCheckService resources that have been configured for the specified project in the given region.
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 (RegionHealthCheckServicesClient regionHealthCheckServicesClient =
RegionHealthCheckServicesClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
for (HealthCheckService element :
regionHealthCheckServicesClient.list(project, region).iterateAll()) {
// doThingsWith(element);
}
}
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String Name of the region scoping this request. |
Returns | |
---|---|
Type | Description |
RegionHealthCheckServicesClient.ListPagedResponse |
listCallable()
public final UnaryCallable<ListRegionHealthCheckServicesRequest,HealthCheckServicesList> listCallable()
Lists all the HealthCheckService resources that have been configured for the specified project in the given region.
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 (RegionHealthCheckServicesClient regionHealthCheckServicesClient =
RegionHealthCheckServicesClient.create()) {
ListRegionHealthCheckServicesRequest request =
ListRegionHealthCheckServicesRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setRegion("region-934795532")
.setReturnPartialSuccess(true)
.build();
while (true) {
HealthCheckServicesList response =
regionHealthCheckServicesClient.listCallable().call(request);
for (HealthCheckService 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<ListRegionHealthCheckServicesRequest,HealthCheckServicesList> |
listPagedCallable()
public final UnaryCallable<ListRegionHealthCheckServicesRequest,RegionHealthCheckServicesClient.ListPagedResponse> listPagedCallable()
Lists all the HealthCheckService resources that have been configured for the specified project in the given region.
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 (RegionHealthCheckServicesClient regionHealthCheckServicesClient =
RegionHealthCheckServicesClient.create()) {
ListRegionHealthCheckServicesRequest request =
ListRegionHealthCheckServicesRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setRegion("region-934795532")
.setReturnPartialSuccess(true)
.build();
ApiFuture<HealthCheckService> future =
regionHealthCheckServicesClient.listPagedCallable().futureCall(request);
// Do something.
for (HealthCheckService element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListRegionHealthCheckServicesRequest,ListPagedResponse> |
patchAsync(PatchRegionHealthCheckServiceRequest request)
public final OperationFuture<Operation,Operation> patchAsync(PatchRegionHealthCheckServiceRequest request)
Updates the specified regional HealthCheckService resource with 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 (RegionHealthCheckServicesClient regionHealthCheckServicesClient =
RegionHealthCheckServicesClient.create()) {
PatchRegionHealthCheckServiceRequest request =
PatchRegionHealthCheckServiceRequest.newBuilder()
.setHealthCheckService("healthCheckService-917902071")
.setHealthCheckServiceResource(HealthCheckService.newBuilder().build())
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
Operation response = regionHealthCheckServicesClient.patchAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | PatchRegionHealthCheckServiceRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
patchAsync(String project, String region, String healthCheckService, HealthCheckService healthCheckServiceResource)
public final OperationFuture<Operation,Operation> patchAsync(String project, String region, String healthCheckService, HealthCheckService healthCheckServiceResource)
Updates the specified regional HealthCheckService resource with 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 (RegionHealthCheckServicesClient regionHealthCheckServicesClient =
RegionHealthCheckServicesClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String healthCheckService = "healthCheckService-917902071";
HealthCheckService healthCheckServiceResource = HealthCheckService.newBuilder().build();
Operation response =
regionHealthCheckServicesClient
.patchAsync(project, region, healthCheckService, healthCheckServiceResource)
.get();
}
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String Name of the region scoping this request. |
healthCheckService | String Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035. |
healthCheckServiceResource | HealthCheckService The body resource for this request |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
patchCallable()
public final UnaryCallable<PatchRegionHealthCheckServiceRequest,Operation> patchCallable()
Updates the specified regional HealthCheckService resource with 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 (RegionHealthCheckServicesClient regionHealthCheckServicesClient =
RegionHealthCheckServicesClient.create()) {
PatchRegionHealthCheckServiceRequest request =
PatchRegionHealthCheckServiceRequest.newBuilder()
.setHealthCheckService("healthCheckService-917902071")
.setHealthCheckServiceResource(HealthCheckService.newBuilder().build())
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future =
regionHealthCheckServicesClient.patchCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<PatchRegionHealthCheckServiceRequest,Operation> |
patchOperationCallable()
public final OperationCallable<PatchRegionHealthCheckServiceRequest,Operation,Operation> patchOperationCallable()
Updates the specified regional HealthCheckService resource with 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 (RegionHealthCheckServicesClient regionHealthCheckServicesClient =
RegionHealthCheckServicesClient.create()) {
PatchRegionHealthCheckServiceRequest request =
PatchRegionHealthCheckServiceRequest.newBuilder()
.setHealthCheckService("healthCheckService-917902071")
.setHealthCheckServiceResource(HealthCheckService.newBuilder().build())
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
OperationFuture<Operation, Operation> future =
regionHealthCheckServicesClient.patchOperationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<PatchRegionHealthCheckServiceRequest,Operation,Operation> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()