Class UptimeCheckServiceClient (3.22.0)

public class UptimeCheckServiceClient implements 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, 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:

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 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.

Inheritance

java.lang.Object > UptimeCheckServiceClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final UptimeCheckServiceClient create()

Constructs an instance of UptimeCheckServiceClient with default settings.

Returns
Type	Description
`UptimeCheckServiceClient`

Exceptions
Type	Description
`IOException`

create(UptimeCheckServiceSettings settings)

public static final UptimeCheckServiceClient create(UptimeCheckServiceSettings settings)

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.

Parameter
Name	Description
`settings`	`UptimeCheckServiceSettings`

Returns
Type	Description
`UptimeCheckServiceClient`

Exceptions
Type	Description
`IOException`

create(UptimeCheckServiceStub stub)

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).

Parameter
Name	Description
`stub`	`UptimeCheckServiceStub`

Returns
Type	Description
`UptimeCheckServiceClient`

Constructors

UptimeCheckServiceClient(UptimeCheckServiceSettings settings)

protected UptimeCheckServiceClient(UptimeCheckServiceSettings settings)

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.

Parameter
Name	Description
`settings`	`UptimeCheckServiceSettings`

UptimeCheckServiceClient(UptimeCheckServiceStub stub)

protected UptimeCheckServiceClient(UptimeCheckServiceStub stub)

Parameter
Name	Description
`stub`	`UptimeCheckServiceStub`

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

createUptimeCheckConfig(ResourceName parent, UptimeCheckConfig uptimeCheckConfig)

public final UptimeCheckConfig createUptimeCheckConfig(ResourceName parent, UptimeCheckConfig uptimeCheckConfig)

Creates a new Uptime check configuration.

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 (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   ResourceName parent = ResourceName.of("[FOLDER]");
   UptimeCheckConfig uptimeCheckConfig = UptimeCheckConfig.newBuilder().build();
   UptimeCheckConfig response =
       uptimeCheckServiceClient.createUptimeCheckConfig(parent, uptimeCheckConfig);
 }

Parameters

Name Description

parent

com.google.api.resourcenames.ResourceName

Required. The project in which to create the Uptime check. The format is:

projects/[PROJECT_ID_OR_NUMBER]

uptimeCheckConfig

UptimeCheckConfig

Required. The new Uptime check configuration.

Returns
Type	Description
`UptimeCheckConfig`

createUptimeCheckConfig(CreateUptimeCheckConfigRequest request)

public final UptimeCheckConfig createUptimeCheckConfig(CreateUptimeCheckConfigRequest request)

Creates a new Uptime check configuration.

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 (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   CreateUptimeCheckConfigRequest request =
       CreateUptimeCheckConfigRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setUptimeCheckConfig(UptimeCheckConfig.newBuilder().build())
           .build();
   UptimeCheckConfig response = uptimeCheckServiceClient.createUptimeCheckConfig(request);
 }

Parameter
Name	Description
`request`	`CreateUptimeCheckConfigRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`UptimeCheckConfig`

createUptimeCheckConfig(OrganizationName parent, UptimeCheckConfig uptimeCheckConfig)

public final UptimeCheckConfig createUptimeCheckConfig(OrganizationName parent, UptimeCheckConfig uptimeCheckConfig)

Creates a new Uptime check configuration.

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 (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   OrganizationName parent = OrganizationName.of("[ORGANIZATION]");
   UptimeCheckConfig uptimeCheckConfig = UptimeCheckConfig.newBuilder().build();
   UptimeCheckConfig response =
       uptimeCheckServiceClient.createUptimeCheckConfig(parent, uptimeCheckConfig);
 }

Parameters

Name Description

parent

OrganizationName

Required. The project in which to create the Uptime check. The format is:

projects/[PROJECT_ID_OR_NUMBER]

uptimeCheckConfig

UptimeCheckConfig

Required. The new Uptime check configuration.

Returns
Type	Description
`UptimeCheckConfig`

createUptimeCheckConfig(ProjectName parent, UptimeCheckConfig uptimeCheckConfig)

public final UptimeCheckConfig createUptimeCheckConfig(ProjectName parent, UptimeCheckConfig uptimeCheckConfig)

Creates a new Uptime check configuration.

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 (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   UptimeCheckConfig uptimeCheckConfig = UptimeCheckConfig.newBuilder().build();
   UptimeCheckConfig response =
       uptimeCheckServiceClient.createUptimeCheckConfig(parent, uptimeCheckConfig);
 }

Parameters

Name Description

parent

ProjectName

Required. The project in which to create the Uptime check. The format is:

projects/[PROJECT_ID_OR_NUMBER]

uptimeCheckConfig

UptimeCheckConfig

Required. The new Uptime check configuration.

Returns
Type	Description
`UptimeCheckConfig`

createUptimeCheckConfig(String parent, UptimeCheckConfig uptimeCheckConfig)

public final UptimeCheckConfig createUptimeCheckConfig(String parent, UptimeCheckConfig uptimeCheckConfig)

Creates a new Uptime check configuration.

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 (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   UptimeCheckConfig uptimeCheckConfig = UptimeCheckConfig.newBuilder().build();
   UptimeCheckConfig response =
       uptimeCheckServiceClient.createUptimeCheckConfig(parent, uptimeCheckConfig);
 }

Parameters

Name Description

parent

String

Required. The project in which to create the Uptime check. The format is:

projects/[PROJECT_ID_OR_NUMBER]

uptimeCheckConfig

UptimeCheckConfig

Required. The new Uptime check configuration.

Returns
Type	Description
`UptimeCheckConfig`

createUptimeCheckConfigCallable()

public final UnaryCallable<CreateUptimeCheckConfigRequest,UptimeCheckConfig> createUptimeCheckConfigCallable()

Creates a new Uptime check configuration.

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 (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   CreateUptimeCheckConfigRequest request =
       CreateUptimeCheckConfigRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setUptimeCheckConfig(UptimeCheckConfig.newBuilder().build())
           .build();
   ApiFuture<UptimeCheckConfig> future =
       uptimeCheckServiceClient.createUptimeCheckConfigCallable().futureCall(request);
   // Do something.
   UptimeCheckConfig response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateUptimeCheckConfigRequest,UptimeCheckConfig>`

deleteUptimeCheckConfig(DeleteUptimeCheckConfigRequest request)

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:


 // 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()) {
   DeleteUptimeCheckConfigRequest request =
       DeleteUptimeCheckConfigRequest.newBuilder()
           .setName(
               UptimeCheckConfigName.ofProjectUptimeCheckConfigName(
                       "[PROJECT]", "[UPTIME_CHECK_CONFIG]")
                   .toString())
           .build();
   uptimeCheckServiceClient.deleteUptimeCheckConfig(request);
 }

Parameter
Name	Description
`request`	`DeleteUptimeCheckConfigRequest` The request object containing all of the parameters for the API call.

deleteUptimeCheckConfig(UptimeCheckConfigName name)

public final void deleteUptimeCheckConfig(UptimeCheckConfigName name)

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 (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   UptimeCheckConfigName name =
       UptimeCheckConfigName.ofProjectUptimeCheckConfigName(
           "[PROJECT]", "[UPTIME_CHECK_CONFIG]");
   uptimeCheckServiceClient.deleteUptimeCheckConfig(name);
 }

Parameter

Name Description

name

UptimeCheckConfigName

Required. The Uptime check configuration to delete. The format is:

projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

deleteUptimeCheckConfig(String name)

public final void deleteUptimeCheckConfig(String name)

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 (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   String name =
       UptimeCheckConfigName.ofProjectUptimeCheckConfigName("[PROJECT]", "[UPTIME_CHECK_CONFIG]")
           .toString();
   uptimeCheckServiceClient.deleteUptimeCheckConfig(name);
 }

Parameter

Name Description

name

String

Required. The Uptime check configuration to delete. The format is:

projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

deleteUptimeCheckConfigCallable()

public final UnaryCallable<DeleteUptimeCheckConfigRequest,Empty> deleteUptimeCheckConfigCallable()

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 (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   DeleteUptimeCheckConfigRequest request =
       DeleteUptimeCheckConfigRequest.newBuilder()
           .setName(
               UptimeCheckConfigName.ofProjectUptimeCheckConfigName(
                       "[PROJECT]", "[UPTIME_CHECK_CONFIG]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       uptimeCheckServiceClient.deleteUptimeCheckConfigCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteUptimeCheckConfigRequest,Empty>`

getSettings()

public final UptimeCheckServiceSettings getSettings()

Returns
Type	Description
`UptimeCheckServiceSettings`

getStub()

public UptimeCheckServiceStub getStub()

Returns
Type	Description
`UptimeCheckServiceStub`

getUptimeCheckConfig(GetUptimeCheckConfigRequest request)

public final UptimeCheckConfig getUptimeCheckConfig(GetUptimeCheckConfigRequest request)

Gets a single Uptime check configuration.

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 (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   GetUptimeCheckConfigRequest request =
       GetUptimeCheckConfigRequest.newBuilder()
           .setName(
               UptimeCheckConfigName.ofProjectUptimeCheckConfigName(
                       "[PROJECT]", "[UPTIME_CHECK_CONFIG]")
                   .toString())
           .build();
   UptimeCheckConfig response = uptimeCheckServiceClient.getUptimeCheckConfig(request);
 }

Parameter
Name	Description
`request`	`GetUptimeCheckConfigRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`UptimeCheckConfig`

getUptimeCheckConfig(UptimeCheckConfigName name)

public final UptimeCheckConfig getUptimeCheckConfig(UptimeCheckConfigName name)

Gets a single Uptime check configuration.

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 (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   UptimeCheckConfigName name =
       UptimeCheckConfigName.ofProjectUptimeCheckConfigName(
           "[PROJECT]", "[UPTIME_CHECK_CONFIG]");
   UptimeCheckConfig response = uptimeCheckServiceClient.getUptimeCheckConfig(name);
 }

Parameter

Name Description

name

UptimeCheckConfigName

Required. The Uptime check configuration to retrieve. The format is:

projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

Returns
Type	Description
`UptimeCheckConfig`

getUptimeCheckConfig(String name)

public final UptimeCheckConfig getUptimeCheckConfig(String name)

Gets a single Uptime check configuration.

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 (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   String name =
       UptimeCheckConfigName.ofProjectUptimeCheckConfigName("[PROJECT]", "[UPTIME_CHECK_CONFIG]")
           .toString();
   UptimeCheckConfig response = uptimeCheckServiceClient.getUptimeCheckConfig(name);
 }

Parameter

Name Description

name

String

Required. The Uptime check configuration to retrieve. The format is:

projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

Returns
Type	Description
`UptimeCheckConfig`

getUptimeCheckConfigCallable()

public final UnaryCallable<GetUptimeCheckConfigRequest,UptimeCheckConfig> getUptimeCheckConfigCallable()

Gets a single Uptime check configuration.

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 (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   GetUptimeCheckConfigRequest request =
       GetUptimeCheckConfigRequest.newBuilder()
           .setName(
               UptimeCheckConfigName.ofProjectUptimeCheckConfigName(
                       "[PROJECT]", "[UPTIME_CHECK_CONFIG]")
                   .toString())
           .build();
   ApiFuture<UptimeCheckConfig> future =
       uptimeCheckServiceClient.getUptimeCheckConfigCallable().futureCall(request);
   // Do something.
   UptimeCheckConfig response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetUptimeCheckConfigRequest,UptimeCheckConfig>`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listUptimeCheckConfigs(ResourceName parent)

public final UptimeCheckServiceClient.ListUptimeCheckConfigsPagedResponse listUptimeCheckConfigs(ResourceName parent)

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

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 (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   ResourceName parent = ResourceName.of("[FOLDER]");
   for (UptimeCheckConfig element :
       uptimeCheckServiceClient.listUptimeCheckConfigs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name Description

parent

com.google.api.resourcenames.ResourceName

Required. The project whose Uptime check configurations are listed. The format is:

projects/[PROJECT_ID_OR_NUMBER]

Returns
Type	Description
`UptimeCheckServiceClient.ListUptimeCheckConfigsPagedResponse`

listUptimeCheckConfigs(ListUptimeCheckConfigsRequest request)

public final UptimeCheckServiceClient.ListUptimeCheckConfigsPagedResponse listUptimeCheckConfigs(ListUptimeCheckConfigsRequest request)

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

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 (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   ListUptimeCheckConfigsRequest request =
       ListUptimeCheckConfigsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (UptimeCheckConfig element :
       uptimeCheckServiceClient.listUptimeCheckConfigs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListUptimeCheckConfigsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`UptimeCheckServiceClient.ListUptimeCheckConfigsPagedResponse`

listUptimeCheckConfigs(OrganizationName parent)

public final UptimeCheckServiceClient.ListUptimeCheckConfigsPagedResponse listUptimeCheckConfigs(OrganizationName parent)

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

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 (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   OrganizationName parent = OrganizationName.of("[ORGANIZATION]");
   for (UptimeCheckConfig element :
       uptimeCheckServiceClient.listUptimeCheckConfigs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name Description

parent

OrganizationName

Required. The project whose Uptime check configurations are listed. The format is:

projects/[PROJECT_ID_OR_NUMBER]

Returns
Type	Description
`UptimeCheckServiceClient.ListUptimeCheckConfigsPagedResponse`

listUptimeCheckConfigs(ProjectName parent)

public final UptimeCheckServiceClient.ListUptimeCheckConfigsPagedResponse listUptimeCheckConfigs(ProjectName parent)

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

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 (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (UptimeCheckConfig element :
       uptimeCheckServiceClient.listUptimeCheckConfigs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name Description

parent

ProjectName

Required. The project whose Uptime check configurations are listed. The format is:

projects/[PROJECT_ID_OR_NUMBER]

Returns
Type	Description
`UptimeCheckServiceClient.ListUptimeCheckConfigsPagedResponse`

listUptimeCheckConfigs(String parent)

public final UptimeCheckServiceClient.ListUptimeCheckConfigsPagedResponse listUptimeCheckConfigs(String parent)

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

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 (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   for (UptimeCheckConfig element :
       uptimeCheckServiceClient.listUptimeCheckConfigs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name Description

parent

String

Required. The project whose Uptime check configurations are listed. The format is:

projects/[PROJECT_ID_OR_NUMBER]

Returns
Type	Description
`UptimeCheckServiceClient.ListUptimeCheckConfigsPagedResponse`

listUptimeCheckConfigsCallable()

public final UnaryCallable<ListUptimeCheckConfigsRequest,ListUptimeCheckConfigsResponse> listUptimeCheckConfigsCallable()

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

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 (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   ListUptimeCheckConfigsRequest request =
       ListUptimeCheckConfigsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .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;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListUptimeCheckConfigsRequest,ListUptimeCheckConfigsResponse>`

listUptimeCheckConfigsPagedCallable()

public final UnaryCallable<ListUptimeCheckConfigsRequest,UptimeCheckServiceClient.ListUptimeCheckConfigsPagedResponse> listUptimeCheckConfigsPagedCallable()

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

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 (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   ListUptimeCheckConfigsRequest request =
       ListUptimeCheckConfigsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<UptimeCheckConfig> future =
       uptimeCheckServiceClient.listUptimeCheckConfigsPagedCallable().futureCall(request);
   // Do something.
   for (UptimeCheckConfig element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListUptimeCheckConfigsRequest,ListUptimeCheckConfigsPagedResponse>`

listUptimeCheckIps(ListUptimeCheckIpsRequest request)

public final UptimeCheckServiceClient.ListUptimeCheckIpsPagedResponse listUptimeCheckIps(ListUptimeCheckIpsRequest request)

Returns the list of IP addresses that checkers run from

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 (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   ListUptimeCheckIpsRequest request =
       ListUptimeCheckIpsRequest.newBuilder()
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (UptimeCheckIp element :
       uptimeCheckServiceClient.listUptimeCheckIps(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListUptimeCheckIpsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`UptimeCheckServiceClient.ListUptimeCheckIpsPagedResponse`

listUptimeCheckIpsCallable()

public final UnaryCallable<ListUptimeCheckIpsRequest,ListUptimeCheckIpsResponse> listUptimeCheckIpsCallable()

Returns the list of IP addresses that checkers run from

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 (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   ListUptimeCheckIpsRequest request =
       ListUptimeCheckIpsRequest.newBuilder()
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .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;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListUptimeCheckIpsRequest,ListUptimeCheckIpsResponse>`

listUptimeCheckIpsPagedCallable()

public final UnaryCallable<ListUptimeCheckIpsRequest,UptimeCheckServiceClient.ListUptimeCheckIpsPagedResponse> listUptimeCheckIpsPagedCallable()

Returns the list of IP addresses that checkers run from

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 (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   ListUptimeCheckIpsRequest request =
       ListUptimeCheckIpsRequest.newBuilder()
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<UptimeCheckIp> future =
       uptimeCheckServiceClient.listUptimeCheckIpsPagedCallable().futureCall(request);
   // Do something.
   for (UptimeCheckIp element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListUptimeCheckIpsRequest,ListUptimeCheckIpsPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateUptimeCheckConfig(UpdateUptimeCheckConfigRequest request)

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:


 // 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()) {
   UpdateUptimeCheckConfigRequest request =
       UpdateUptimeCheckConfigRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setUptimeCheckConfig(UptimeCheckConfig.newBuilder().build())
           .build();
   UptimeCheckConfig response = uptimeCheckServiceClient.updateUptimeCheckConfig(request);
 }

Parameter
Name	Description
`request`	`UpdateUptimeCheckConfigRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`UptimeCheckConfig`

updateUptimeCheckConfig(UptimeCheckConfig uptimeCheckConfig)

public final UptimeCheckConfig updateUptimeCheckConfig(UptimeCheckConfig uptimeCheckConfig)

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 (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   UptimeCheckConfig uptimeCheckConfig = UptimeCheckConfig.newBuilder().build();
   UptimeCheckConfig response =
       uptimeCheckServiceClient.updateUptimeCheckConfig(uptimeCheckConfig);
 }

Parameter

Name Description

uptimeCheckConfig

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 corresponding 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.

Returns
Type	Description
`UptimeCheckConfig`

updateUptimeCheckConfigCallable()

public final UnaryCallable<UpdateUptimeCheckConfigRequest,UptimeCheckConfig> updateUptimeCheckConfigCallable()

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 (UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.create()) {
   UpdateUptimeCheckConfigRequest request =
       UpdateUptimeCheckConfigRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setUptimeCheckConfig(UptimeCheckConfig.newBuilder().build())
           .build();
   ApiFuture<UptimeCheckConfig> future =
       uptimeCheckServiceClient.updateUptimeCheckConfigCallable().futureCall(request);
   // Do something.
   UptimeCheckConfig response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateUptimeCheckConfigRequest,UptimeCheckConfig>`