java.lang.Object
- com.google.cloud.monitoring.v3.UptimeCheckServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable
```
@Generated("by gapic-generator-java")
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 Cloud 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] (https://console.cloud.google.com), selecting the appropriate project, clicking on "Monitoring" on the left-hand side to navigate to Cloud Monitoring, 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:
```
 // 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 (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   UptimeCheckConfigName name =
       UptimeCheckConfigName.ofProjectUptimeCheckConfigName(
           "[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:
```
 // 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
 UptimeCheckServiceSettings uptimeCheckServiceSettings =
     UptimeCheckServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 UptimeCheckServiceClient uptimeCheckServiceClient =
     UptimeCheckServiceClient.create(uptimeCheckServiceSettings);
 
```
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
 UptimeCheckServiceSettings uptimeCheckServiceSettings =
     UptimeCheckServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 UptimeCheckServiceClient uptimeCheckServiceClient =
     UptimeCheckServiceClient.create(uptimeCheckServiceSettings);
 
```
Please refer to the GitHub repository's samples for more quickstart code snippets.

Nested Class Summary

Nested Classes
Modifier and Type	Class	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	Description
`protected`	`UptimeCheckServiceClient(UptimeCheckServiceStub stub)`
`protected`	`UptimeCheckServiceClient(UptimeCheckServiceSettings settings)`	Constructs an instance of UptimeCheckServiceClient, using the given settings.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static UptimeCheckServiceClient`	`create()`	Constructs an instance of UptimeCheckServiceClient with default settings.
`static UptimeCheckServiceClient`	`create(UptimeCheckServiceStub stub)`	Constructs an instance of UptimeCheckServiceClient, using the given stub for making calls.
`static UptimeCheckServiceClient`	`create(UptimeCheckServiceSettings settings)`	Constructs an instance of UptimeCheckServiceClient, using the given settings.
`UptimeCheckConfig`	`createUptimeCheckConfig(com.google.api.resourcenames.ResourceName parent, UptimeCheckConfig uptimeCheckConfig)`	Creates a new Uptime check configuration.
`UptimeCheckConfig`	`createUptimeCheckConfig(CreateUptimeCheckConfigRequest request)`	Creates a new Uptime check configuration.
`UptimeCheckConfig`	`createUptimeCheckConfig(OrganizationName parent, UptimeCheckConfig uptimeCheckConfig)`	Creates a new Uptime check configuration.
`UptimeCheckConfig`	`createUptimeCheckConfig(ProjectName parent, UptimeCheckConfig uptimeCheckConfig)`	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(UptimeCheckConfigName name)`	Deletes an Uptime check configuration.
`void`	`deleteUptimeCheckConfig(String name)`	Deletes an Uptime check configuration.
`com.google.api.gax.rpc.UnaryCallable<DeleteUptimeCheckConfigRequest,com.google.protobuf.Empty>`	`deleteUptimeCheckConfigCallable()`	Deletes an Uptime check configuration.
`UptimeCheckServiceSettings`	`getSettings()`
`UptimeCheckServiceStub`	`getStub()`
`UptimeCheckConfig`	`getUptimeCheckConfig(GetUptimeCheckConfigRequest request)`	Gets a single Uptime check configuration.
`UptimeCheckConfig`	`getUptimeCheckConfig(UptimeCheckConfigName name)`	Gets a single Uptime check configuration.
`UptimeCheckConfig`	`getUptimeCheckConfig(String 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(com.google.api.resourcenames.ResourceName parent)`	Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations).
`UptimeCheckServiceClient.ListUptimeCheckConfigsPagedResponse`	`listUptimeCheckConfigs(ListUptimeCheckConfigsRequest request)`	Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations).
`UptimeCheckServiceClient.ListUptimeCheckConfigsPagedResponse`	`listUptimeCheckConfigs(OrganizationName parent)`	Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations).
`UptimeCheckServiceClient.ListUptimeCheckConfigsPagedResponse`	`listUptimeCheckConfigs(ProjectName parent)`	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
```
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
```
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 using create(UptimeCheckServiceSettings).

getSettings

public final UptimeCheckServiceSettings getSettings()