Google Cloud Monitoring v3 API - Class UptimeCheckServiceClientImpl (3.12.0) 

public sealed class UptimeCheckServiceClientImpl : UptimeCheckServiceClient

Reference documentation and code samples for the Google Cloud Monitoring v3 API class UptimeCheckServiceClientImpl.

UptimeCheckService client wrapper implementation, for convenient use.

Inheritance

object > UptimeCheckServiceClient > UptimeCheckServiceClientImpl

Namespace

Google.Cloud.Monitoring.V3

Assembly

Google.Cloud.Monitoring.V3.dll

Remarks

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

Constructors

UptimeCheckServiceClientImpl(UptimeCheckServiceClient, UptimeCheckServiceSettings, ILogger)

public UptimeCheckServiceClientImpl(UptimeCheckService.UptimeCheckServiceClient grpcClient, UptimeCheckServiceSettings settings, ILogger logger)

Constructs a client wrapper for the UptimeCheckService service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient UptimeCheckServiceUptimeCheckServiceClient

The underlying gRPC client.
settings UptimeCheckServiceSettings

The base UptimeCheckServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override UptimeCheckService.UptimeCheckServiceClient GrpcClient { get; }

The underlying gRPC UptimeCheckService client

Property Value
Type Description
UptimeCheckServiceUptimeCheckServiceClient
Overrides

Methods

CreateUptimeCheckConfig(CreateUptimeCheckConfigRequest, CallSettings)

public override UptimeCheckConfig CreateUptimeCheckConfig(CreateUptimeCheckConfigRequest request, CallSettings callSettings = null)

Creates a new Uptime check configuration.

Parameters
Name Description
request CreateUptimeCheckConfigRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
UptimeCheckConfig

The RPC response.
Overrides

CreateUptimeCheckConfigAsync(CreateUptimeCheckConfigRequest, CallSettings)

public override Task<UptimeCheckConfig> CreateUptimeCheckConfigAsync(CreateUptimeCheckConfigRequest request, CallSettings callSettings = null)

Creates a new Uptime check configuration.

Parameters
Name Description
request CreateUptimeCheckConfigRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskUptimeCheckConfig

A Task containing the RPC response.
Overrides

DeleteUptimeCheckConfig(DeleteUptimeCheckConfigRequest, CallSettings)

public override void DeleteUptimeCheckConfig(DeleteUptimeCheckConfigRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request DeleteUptimeCheckConfigRequest

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

If not null, applies overrides to this RPC call.
Overrides

DeleteUptimeCheckConfigAsync(DeleteUptimeCheckConfigRequest, CallSettings)

public override Task DeleteUptimeCheckConfigAsync(DeleteUptimeCheckConfigRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request DeleteUptimeCheckConfigRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

GetUptimeCheckConfig(GetUptimeCheckConfigRequest, CallSettings)

public override UptimeCheckConfig GetUptimeCheckConfig(GetUptimeCheckConfigRequest request, CallSettings callSettings = null)

Gets a single Uptime check configuration.

Parameters
Name Description
request GetUptimeCheckConfigRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
UptimeCheckConfig

The RPC response.
Overrides

GetUptimeCheckConfigAsync(GetUptimeCheckConfigRequest, CallSettings)

public override Task<UptimeCheckConfig> GetUptimeCheckConfigAsync(GetUptimeCheckConfigRequest request, CallSettings callSettings = null)

Gets a single Uptime check configuration.

Parameters
Name Description
request GetUptimeCheckConfigRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskUptimeCheckConfig

A Task containing the RPC response.
Overrides

ListUptimeCheckConfigs(ListUptimeCheckConfigsRequest, CallSettings)

public override PagedEnumerable<ListUptimeCheckConfigsResponse, UptimeCheckConfig> ListUptimeCheckConfigs(ListUptimeCheckConfigsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListUptimeCheckConfigsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListUptimeCheckConfigsResponseUptimeCheckConfig

A pageable sequence of UptimeCheckConfig resources.
Overrides

ListUptimeCheckConfigsAsync(ListUptimeCheckConfigsRequest, CallSettings)

public override PagedAsyncEnumerable<ListUptimeCheckConfigsResponse, UptimeCheckConfig> ListUptimeCheckConfigsAsync(ListUptimeCheckConfigsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListUptimeCheckConfigsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListUptimeCheckConfigsResponseUptimeCheckConfig

A pageable asynchronous sequence of UptimeCheckConfig resources.
Overrides

ListUptimeCheckIps(ListUptimeCheckIpsRequest, CallSettings)

public override PagedEnumerable<ListUptimeCheckIpsResponse, UptimeCheckIp> ListUptimeCheckIps(ListUptimeCheckIpsRequest request, CallSettings callSettings = null)

Returns the list of IP addresses that checkers run from

Parameters
Name Description
request ListUptimeCheckIpsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListUptimeCheckIpsResponseUptimeCheckIp

A pageable sequence of UptimeCheckIp resources.
Overrides

ListUptimeCheckIpsAsync(ListUptimeCheckIpsRequest, CallSettings)

public override PagedAsyncEnumerable<ListUptimeCheckIpsResponse, UptimeCheckIp> ListUptimeCheckIpsAsync(ListUptimeCheckIpsRequest request, CallSettings callSettings = null)

Returns the list of IP addresses that checkers run from

Parameters
Name Description
request ListUptimeCheckIpsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListUptimeCheckIpsResponseUptimeCheckIp

A pageable asynchronous sequence of UptimeCheckIp resources.
Overrides

UpdateUptimeCheckConfig(UpdateUptimeCheckConfigRequest, CallSettings)

public override UptimeCheckConfig UpdateUptimeCheckConfig(UpdateUptimeCheckConfigRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request UpdateUptimeCheckConfigRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
UptimeCheckConfig

The RPC response.
Overrides

UpdateUptimeCheckConfigAsync(UpdateUptimeCheckConfigRequest, CallSettings)

public override Task<UptimeCheckConfig> UpdateUptimeCheckConfigAsync(UpdateUptimeCheckConfigRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request UpdateUptimeCheckConfigRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskUptimeCheckConfig

A Task containing the RPC response.
Overrides