com.google.cloud.monitoring.v3

Class UptimeCheckServiceClient

java.lang.Object

com.google.cloud.monitoring.v3.UptimeCheckServiceClient

All Implemented Interfaces:

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

@Generated(value="by gapic-generator")
public class UptimeCheckServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: The UptimeCheckService API is used to manage (list, create, delete, edit) Uptime check configurations in the Stackdriver Monitoring product. An Uptime check is a piece of configuration that determines which resources and services to monitor for availability. These configurations can also be configured interactively by navigating to the [Cloud Console] (http://console.cloud.google.com), selecting the appropriate project, clicking on "Monitoring" on the left-hand side to navigate to Stackdriver, and then clicking on "Uptime".

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 
 try (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   UptimeCheckConfigName name = UptimeCheckConfigName.of("[PROJECT]", "[UPTIME_CHECK_CONFIG]");
   UptimeCheckConfig response = uptimeCheckServiceClient.getUptimeCheckConfig(name);
 }
 
 

Note: close() needs to be called on the uptimeCheckServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of UptimeCheckServiceSettings to create(). For example:

To customize credentials:

 
 UptimeCheckServiceSettings uptimeCheckServiceSettings =
     UptimeCheckServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 UptimeCheckServiceClient uptimeCheckServiceClient =
     UptimeCheckServiceClient.create(uptimeCheckServiceSettings);
 
 

To customize the endpoint:

 
 UptimeCheckServiceSettings uptimeCheckServiceSettings =
     UptimeCheckServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 UptimeCheckServiceClient uptimeCheckServiceClient =
     UptimeCheckServiceClient.create(uptimeCheckServiceSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UptimeCheckServiceClient.ListUptimeCheckConfigsFixedSizeCollection
static class	UptimeCheckServiceClient.ListUptimeCheckConfigsPage
static class	UptimeCheckServiceClient.ListUptimeCheckConfigsPagedResponse
static class	UptimeCheckServiceClient.ListUptimeCheckIpsFixedSizeCollection
static class	UptimeCheckServiceClient.ListUptimeCheckIpsPage
static class	UptimeCheckServiceClient.ListUptimeCheckIpsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UptimeCheckServiceClient(UptimeCheckServiceSettings settings) Constructs an instance of UptimeCheckServiceClient, using the given settings.
protected	UptimeCheckServiceClient(UptimeCheckServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static UptimeCheckServiceClient	create() Constructs an instance of UptimeCheckServiceClient with default settings.
static UptimeCheckServiceClient	create(UptimeCheckServiceSettings settings) Constructs an instance of UptimeCheckServiceClient, using the given settings.
static UptimeCheckServiceClient	create(UptimeCheckServiceStub stub) Constructs an instance of UptimeCheckServiceClient, using the given stub for making calls.
UptimeCheckConfig	createUptimeCheckConfig(CreateUptimeCheckConfigRequest request) Creates a new Uptime check configuration.
UptimeCheckConfig	createUptimeCheckConfig(String parent, UptimeCheckConfig uptimeCheckConfig) Creates a new Uptime check configuration.
com.google.api.gax.rpc.UnaryCallable<CreateUptimeCheckConfigRequest,UptimeCheckConfig>	createUptimeCheckConfigCallable() Creates a new Uptime check configuration.
void	deleteUptimeCheckConfig(DeleteUptimeCheckConfigRequest request) Deletes an Uptime check configuration.
void	deleteUptimeCheckConfig(String name) Deletes an Uptime check configuration.
void	deleteUptimeCheckConfig(UptimeCheckConfigName name) Deletes an Uptime check configuration.
com.google.api.gax.rpc.UnaryCallable<DeleteUptimeCheckConfigRequest,Empty>	deleteUptimeCheckConfigCallable() Deletes an Uptime check configuration.
UptimeCheckServiceSettings	getSettings()
UptimeCheckServiceStub	getStub()
UptimeCheckConfig	getUptimeCheckConfig(GetUptimeCheckConfigRequest request) Gets a single Uptime check configuration.
UptimeCheckConfig	getUptimeCheckConfig(String name) Gets a single Uptime check configuration.
UptimeCheckConfig	getUptimeCheckConfig(UptimeCheckConfigName name) Gets a single Uptime check configuration.
com.google.api.gax.rpc.UnaryCallable<GetUptimeCheckConfigRequest,UptimeCheckConfig>	getUptimeCheckConfigCallable() Gets a single Uptime check configuration.
boolean	isShutdown()
boolean	isTerminated()
UptimeCheckServiceClient.ListUptimeCheckConfigsPagedResponse	listUptimeCheckConfigs(ListUptimeCheckConfigsRequest request) Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations).
UptimeCheckServiceClient.ListUptimeCheckConfigsPagedResponse	listUptimeCheckConfigs(String parent) Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations).
com.google.api.gax.rpc.UnaryCallable<ListUptimeCheckConfigsRequest,ListUptimeCheckConfigsResponse>	listUptimeCheckConfigsCallable() Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations).
com.google.api.gax.rpc.UnaryCallable<ListUptimeCheckConfigsRequest,UptimeCheckServiceClient.ListUptimeCheckConfigsPagedResponse>	listUptimeCheckConfigsPagedCallable() Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations).
UptimeCheckServiceClient.ListUptimeCheckIpsPagedResponse	listUptimeCheckIps(ListUptimeCheckIpsRequest request) Returns the list of IP addresses that checkers run from
com.google.api.gax.rpc.UnaryCallable<ListUptimeCheckIpsRequest,ListUptimeCheckIpsResponse>	listUptimeCheckIpsCallable() Returns the list of IP addresses that checkers run from
com.google.api.gax.rpc.UnaryCallable<ListUptimeCheckIpsRequest,UptimeCheckServiceClient.ListUptimeCheckIpsPagedResponse>	listUptimeCheckIpsPagedCallable() Returns the list of IP addresses that checkers run from
void	shutdown()
void	shutdownNow()
UptimeCheckConfig	updateUptimeCheckConfig(UpdateUptimeCheckConfigRequest request) Updates an Uptime check configuration.
UptimeCheckConfig	updateUptimeCheckConfig(UptimeCheckConfig uptimeCheckConfig) Updates an Uptime check configuration.
com.google.api.gax.rpc.UnaryCallable<UpdateUptimeCheckConfigRequest,UptimeCheckConfig>	updateUptimeCheckConfigCallable() Updates an Uptime check configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UptimeCheckServiceClient

protected UptimeCheckServiceClient(UptimeCheckServiceSettings settings)
                            throws IOException

Constructs an instance of UptimeCheckServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

UptimeCheckServiceClient

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

Method Detail

create

public static final UptimeCheckServiceClient create()
                                             throws IOException

Constructs an instance of UptimeCheckServiceClient with default settings.

Throws:

IOException

create

public static final UptimeCheckServiceClient create(UptimeCheckServiceSettings settings)
                                             throws IOException

Constructs an instance of UptimeCheckServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final UptimeCheckServiceClient create(UptimeCheckServiceStub stub)

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

getSettings

public final UptimeCheckServiceSettings getSettings()

getStub

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

listUptimeCheckConfigs

public final UptimeCheckServiceClient.ListUptimeCheckConfigsPagedResponse listUptimeCheckConfigs(String parent)

Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations).

Sample code:

 try (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   String formattedParent = ProjectName.format("[PROJECT]");
   for (UptimeCheckConfig element : uptimeCheckServiceClient.listUptimeCheckConfigs(formattedParent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - The project whose Uptime check configurations are listed. The format is `projects/[PROJECT_ID]`.

Throws:

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

listUptimeCheckConfigs

public final UptimeCheckServiceClient.ListUptimeCheckConfigsPagedResponse listUptimeCheckConfigs(ListUptimeCheckConfigsRequest request)

Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations).

Sample code:

 try (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   String formattedParent = ProjectName.format("[PROJECT]");
   ListUptimeCheckConfigsRequest request = ListUptimeCheckConfigsRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   for (UptimeCheckConfig element : uptimeCheckServiceClient.listUptimeCheckConfigs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

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

listUptimeCheckConfigsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListUptimeCheckConfigsRequest,UptimeCheckServiceClient.ListUptimeCheckConfigsPagedResponse> listUptimeCheckConfigsPagedCallable()

Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations).

Sample code:

 try (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   String formattedParent = ProjectName.format("[PROJECT]");
   ListUptimeCheckConfigsRequest request = ListUptimeCheckConfigsRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   ApiFuture<ListUptimeCheckConfigsPagedResponse> future = uptimeCheckServiceClient.listUptimeCheckConfigsPagedCallable().futureCall(request);
   // Do something
   for (UptimeCheckConfig element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listUptimeCheckConfigsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListUptimeCheckConfigsRequest,ListUptimeCheckConfigsResponse> listUptimeCheckConfigsCallable()

Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations).

Sample code:

 try (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   String formattedParent = ProjectName.format("[PROJECT]");
   ListUptimeCheckConfigsRequest request = ListUptimeCheckConfigsRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   while (true) {
     ListUptimeCheckConfigsResponse response = uptimeCheckServiceClient.listUptimeCheckConfigsCallable().call(request);
     for (UptimeCheckConfig element : response.getUptimeCheckConfigsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

getUptimeCheckConfig

public final UptimeCheckConfig getUptimeCheckConfig(UptimeCheckConfigName name)

Gets a single Uptime check configuration.

Sample code:

 try (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   UptimeCheckConfigName name = UptimeCheckConfigName.of("[PROJECT]", "[UPTIME_CHECK_CONFIG]");
   UptimeCheckConfig response = uptimeCheckServiceClient.getUptimeCheckConfig(name);
 }
 

Parameters:

name - The Uptime check configuration to retrieve. The format is `projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]`.

Throws:

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

getUptimeCheckConfig

public final UptimeCheckConfig getUptimeCheckConfig(String name)

Gets a single Uptime check configuration.

Sample code:

 try (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   UptimeCheckConfigName name = UptimeCheckConfigName.of("[PROJECT]", "[UPTIME_CHECK_CONFIG]");
   UptimeCheckConfig response = uptimeCheckServiceClient.getUptimeCheckConfig(name.toString());
 }
 

Parameters:

name - The Uptime check configuration to retrieve. The format is `projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]`.

Throws:

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

getUptimeCheckConfig

public final UptimeCheckConfig getUptimeCheckConfig(GetUptimeCheckConfigRequest request)

Gets a single Uptime check configuration.

Sample code:

 try (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   UptimeCheckConfigName name = UptimeCheckConfigName.of("[PROJECT]", "[UPTIME_CHECK_CONFIG]");
   GetUptimeCheckConfigRequest request = GetUptimeCheckConfigRequest.newBuilder()
     .setName(name.toString())
     .build();
   UptimeCheckConfig response = uptimeCheckServiceClient.getUptimeCheckConfig(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

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

getUptimeCheckConfigCallable

public final com.google.api.gax.rpc.UnaryCallable<GetUptimeCheckConfigRequest,UptimeCheckConfig> getUptimeCheckConfigCallable()

Gets a single Uptime check configuration.

Sample code:

 try (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   UptimeCheckConfigName name = UptimeCheckConfigName.of("[PROJECT]", "[UPTIME_CHECK_CONFIG]");
   GetUptimeCheckConfigRequest request = GetUptimeCheckConfigRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<UptimeCheckConfig> future = uptimeCheckServiceClient.getUptimeCheckConfigCallable().futureCall(request);
   // Do something
   UptimeCheckConfig response = future.get();
 }
 

createUptimeCheckConfig

public final UptimeCheckConfig createUptimeCheckConfig(String parent,
                                                       UptimeCheckConfig uptimeCheckConfig)

Creates a new Uptime check configuration.

Sample code:

 try (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   String formattedParent = ProjectName.format("[PROJECT]");
   UptimeCheckConfig uptimeCheckConfig = UptimeCheckConfig.newBuilder().build();
   UptimeCheckConfig response = uptimeCheckServiceClient.createUptimeCheckConfig(formattedParent, uptimeCheckConfig);
 }
 

Parameters:

parent - The project in which to create the Uptime check. The format is `projects/[PROJECT_ID]`.

uptimeCheckConfig - The new Uptime check configuration.

Throws:

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

createUptimeCheckConfig

public final UptimeCheckConfig createUptimeCheckConfig(CreateUptimeCheckConfigRequest request)

Creates a new Uptime check configuration.

Sample code:

 try (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   String formattedParent = ProjectName.format("[PROJECT]");
   UptimeCheckConfig uptimeCheckConfig = UptimeCheckConfig.newBuilder().build();
   CreateUptimeCheckConfigRequest request = CreateUptimeCheckConfigRequest.newBuilder()
     .setParent(formattedParent)
     .setUptimeCheckConfig(uptimeCheckConfig)
     .build();
   UptimeCheckConfig response = uptimeCheckServiceClient.createUptimeCheckConfig(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

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

createUptimeCheckConfigCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateUptimeCheckConfigRequest,UptimeCheckConfig> createUptimeCheckConfigCallable()

Creates a new Uptime check configuration.

Sample code:

 try (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   String formattedParent = ProjectName.format("[PROJECT]");
   UptimeCheckConfig uptimeCheckConfig = UptimeCheckConfig.newBuilder().build();
   CreateUptimeCheckConfigRequest request = CreateUptimeCheckConfigRequest.newBuilder()
     .setParent(formattedParent)
     .setUptimeCheckConfig(uptimeCheckConfig)
     .build();
   ApiFuture<UptimeCheckConfig> future = uptimeCheckServiceClient.createUptimeCheckConfigCallable().futureCall(request);
   // Do something
   UptimeCheckConfig response = future.get();
 }
 

updateUptimeCheckConfig

public final UptimeCheckConfig updateUptimeCheckConfig(UptimeCheckConfig uptimeCheckConfig)

Updates an Uptime check configuration. You can either replace the entire configuration with a new one or replace only certain fields in the current configuration by specifying the fields to be updated via `updateMask`. Returns the updated configuration.

Sample code:

 try (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   UptimeCheckConfig uptimeCheckConfig = UptimeCheckConfig.newBuilder().build();
   UptimeCheckConfig response = uptimeCheckServiceClient.updateUptimeCheckConfig(uptimeCheckConfig);
 }
 

Parameters:

uptimeCheckConfig - Required. If an `updateMask` has been specified, this field gives the values for the set of fields mentioned in the `updateMask`. If an `updateMask` has not been given, this Uptime check configuration replaces the current configuration. If a field is mentioned in `updateMask` but the corresonding field is omitted in this partial Uptime check configuration, it has the effect of deleting/clearing the field from the configuration on the server.

The following fields can be updated: `display_name`, `http_check`, `tcp_check`, `timeout`, `content_matchers`, and `selected_regions`.

Throws:

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

updateUptimeCheckConfig

public final UptimeCheckConfig updateUptimeCheckConfig(UpdateUptimeCheckConfigRequest request)

Updates an Uptime check configuration. You can either replace the entire configuration with a new one or replace only certain fields in the current configuration by specifying the fields to be updated via `updateMask`. Returns the updated configuration.

Sample code:

 try (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   UptimeCheckConfig uptimeCheckConfig = UptimeCheckConfig.newBuilder().build();
   UpdateUptimeCheckConfigRequest request = UpdateUptimeCheckConfigRequest.newBuilder()
     .setUptimeCheckConfig(uptimeCheckConfig)
     .build();
   UptimeCheckConfig response = uptimeCheckServiceClient.updateUptimeCheckConfig(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

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

updateUptimeCheckConfigCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateUptimeCheckConfigRequest,UptimeCheckConfig> updateUptimeCheckConfigCallable()

Updates an Uptime check configuration. You can either replace the entire configuration with a new one or replace only certain fields in the current configuration by specifying the fields to be updated via `updateMask`. Returns the updated configuration.

Sample code:

 try (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   UptimeCheckConfig uptimeCheckConfig = UptimeCheckConfig.newBuilder().build();
   UpdateUptimeCheckConfigRequest request = UpdateUptimeCheckConfigRequest.newBuilder()
     .setUptimeCheckConfig(uptimeCheckConfig)
     .build();
   ApiFuture<UptimeCheckConfig> future = uptimeCheckServiceClient.updateUptimeCheckConfigCallable().futureCall(request);
   // Do something
   UptimeCheckConfig response = future.get();
 }
 

deleteUptimeCheckConfig

public final void deleteUptimeCheckConfig(UptimeCheckConfigName name)

Deletes an Uptime check configuration. Note that this method will fail if the Uptime check configuration is referenced by an alert policy or other dependent configs that would be rendered invalid by the deletion.

Sample code:

 try (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   UptimeCheckConfigName name = UptimeCheckConfigName.of("[PROJECT]", "[UPTIME_CHECK_CONFIG]");
   uptimeCheckServiceClient.deleteUptimeCheckConfig(name);
 }
 

Parameters:

name - The Uptime check configuration to delete. The format is `projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]`.

Throws:

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

deleteUptimeCheckConfig

public final void deleteUptimeCheckConfig(String name)

Deletes an Uptime check configuration. Note that this method will fail if the Uptime check configuration is referenced by an alert policy or other dependent configs that would be rendered invalid by the deletion.

Sample code:

 try (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   UptimeCheckConfigName name = UptimeCheckConfigName.of("[PROJECT]", "[UPTIME_CHECK_CONFIG]");
   uptimeCheckServiceClient.deleteUptimeCheckConfig(name.toString());
 }
 

Parameters:

name - The Uptime check configuration to delete. The format is `projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]`.

Throws:

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

deleteUptimeCheckConfig

public final void deleteUptimeCheckConfig(DeleteUptimeCheckConfigRequest request)

Deletes an Uptime check configuration. Note that this method will fail if the Uptime check configuration is referenced by an alert policy or other dependent configs that would be rendered invalid by the deletion.

Sample code:

 try (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   UptimeCheckConfigName name = UptimeCheckConfigName.of("[PROJECT]", "[UPTIME_CHECK_CONFIG]");
   DeleteUptimeCheckConfigRequest request = DeleteUptimeCheckConfigRequest.newBuilder()
     .setName(name.toString())
     .build();
   uptimeCheckServiceClient.deleteUptimeCheckConfig(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

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

deleteUptimeCheckConfigCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteUptimeCheckConfigRequest,Empty> deleteUptimeCheckConfigCallable()

Deletes an Uptime check configuration. Note that this method will fail if the Uptime check configuration is referenced by an alert policy or other dependent configs that would be rendered invalid by the deletion.

Sample code:

 try (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   UptimeCheckConfigName name = UptimeCheckConfigName.of("[PROJECT]", "[UPTIME_CHECK_CONFIG]");
   DeleteUptimeCheckConfigRequest request = DeleteUptimeCheckConfigRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Void> future = uptimeCheckServiceClient.deleteUptimeCheckConfigCallable().futureCall(request);
   // Do something
   future.get();
 }
 

listUptimeCheckIps

public final UptimeCheckServiceClient.ListUptimeCheckIpsPagedResponse listUptimeCheckIps(ListUptimeCheckIpsRequest request)

Returns the list of IP addresses that checkers run from

Sample code:

 try (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   ListUptimeCheckIpsRequest request = ListUptimeCheckIpsRequest.newBuilder().build();
   for (UptimeCheckIp element : uptimeCheckServiceClient.listUptimeCheckIps(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

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

listUptimeCheckIpsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListUptimeCheckIpsRequest,UptimeCheckServiceClient.ListUptimeCheckIpsPagedResponse> listUptimeCheckIpsPagedCallable()

Returns the list of IP addresses that checkers run from

Sample code:

 try (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   ListUptimeCheckIpsRequest request = ListUptimeCheckIpsRequest.newBuilder().build();
   ApiFuture<ListUptimeCheckIpsPagedResponse> future = uptimeCheckServiceClient.listUptimeCheckIpsPagedCallable().futureCall(request);
   // Do something
   for (UptimeCheckIp element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listUptimeCheckIpsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListUptimeCheckIpsRequest,ListUptimeCheckIpsResponse> listUptimeCheckIpsCallable()

Returns the list of IP addresses that checkers run from

Sample code:

 try (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   ListUptimeCheckIpsRequest request = ListUptimeCheckIpsRequest.newBuilder().build();
   while (true) {
     ListUptimeCheckIpsResponse response = uptimeCheckServiceClient.listUptimeCheckIpsCallable().call(request);
     for (UptimeCheckIp element : response.getUptimeCheckIpsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException