Google Cloud Monitoring v3 API - Class UptimeCheckService.UptimeCheckServiceClient (3.3.0)

public class UptimeCheckService.UptimeCheckServiceClient : ClientBase<UptimeCheckService.UptimeCheckServiceClient>

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

Client for UptimeCheckService

Inheritance

object > ClientBase > ClientBaseUptimeCheckServiceUptimeCheckServiceClient > UptimeCheckService.UptimeCheckServiceClient

Namespace

Google.Cloud.Monitoring.V3

Assembly

Google.Cloud.Monitoring.V3.dll

Constructors

UptimeCheckServiceClient()

protected UptimeCheckServiceClient()

Protected parameterless constructor to allow creation of test doubles.

UptimeCheckServiceClient(CallInvoker)

public UptimeCheckServiceClient(CallInvoker callInvoker)

Creates a new client for UptimeCheckService that uses a custom CallInvoker.

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

UptimeCheckServiceClient(ChannelBase)

public UptimeCheckServiceClient(ChannelBase channel)

Creates a new client for UptimeCheckService

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

UptimeCheckServiceClient(ClientBaseConfiguration)

protected UptimeCheckServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateUptimeCheckConfig(CreateUptimeCheckConfigRequest, CallOptions)

public virtual UptimeCheckConfig CreateUptimeCheckConfig(CreateUptimeCheckConfigRequest request, CallOptions options)

Creates a new Uptime check configuration.

Parameters
NameDescription
requestCreateUptimeCheckConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
UptimeCheckConfig

The response received from the server.

CreateUptimeCheckConfig(CreateUptimeCheckConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual UptimeCheckConfig CreateUptimeCheckConfig(CreateUptimeCheckConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new Uptime check configuration.

Parameters
NameDescription
requestCreateUptimeCheckConfigRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
UptimeCheckConfig

The response received from the server.

CreateUptimeCheckConfigAsync(CreateUptimeCheckConfigRequest, CallOptions)

public virtual AsyncUnaryCall<UptimeCheckConfig> CreateUptimeCheckConfigAsync(CreateUptimeCheckConfigRequest request, CallOptions options)

Creates a new Uptime check configuration.

Parameters
NameDescription
requestCreateUptimeCheckConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallUptimeCheckConfig

The call object.

CreateUptimeCheckConfigAsync(CreateUptimeCheckConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<UptimeCheckConfig> CreateUptimeCheckConfigAsync(CreateUptimeCheckConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new Uptime check configuration.

Parameters
NameDescription
requestCreateUptimeCheckConfigRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallUptimeCheckConfig

The call object.

DeleteUptimeCheckConfig(DeleteUptimeCheckConfigRequest, CallOptions)

public virtual Empty DeleteUptimeCheckConfig(DeleteUptimeCheckConfigRequest request, CallOptions options)

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
NameDescription
requestDeleteUptimeCheckConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteUptimeCheckConfig(DeleteUptimeCheckConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteUptimeCheckConfig(DeleteUptimeCheckConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestDeleteUptimeCheckConfigRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteUptimeCheckConfigAsync(DeleteUptimeCheckConfigRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteUptimeCheckConfigAsync(DeleteUptimeCheckConfigRequest request, CallOptions options)

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
NameDescription
requestDeleteUptimeCheckConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallEmpty

The call object.

DeleteUptimeCheckConfigAsync(DeleteUptimeCheckConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteUptimeCheckConfigAsync(DeleteUptimeCheckConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestDeleteUptimeCheckConfigRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallEmpty

The call object.

GetUptimeCheckConfig(GetUptimeCheckConfigRequest, CallOptions)

public virtual UptimeCheckConfig GetUptimeCheckConfig(GetUptimeCheckConfigRequest request, CallOptions options)

Gets a single Uptime check configuration.

Parameters
NameDescription
requestGetUptimeCheckConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
UptimeCheckConfig

The response received from the server.

GetUptimeCheckConfig(GetUptimeCheckConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual UptimeCheckConfig GetUptimeCheckConfig(GetUptimeCheckConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a single Uptime check configuration.

Parameters
NameDescription
requestGetUptimeCheckConfigRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
UptimeCheckConfig

The response received from the server.

GetUptimeCheckConfigAsync(GetUptimeCheckConfigRequest, CallOptions)

public virtual AsyncUnaryCall<UptimeCheckConfig> GetUptimeCheckConfigAsync(GetUptimeCheckConfigRequest request, CallOptions options)

Gets a single Uptime check configuration.

Parameters
NameDescription
requestGetUptimeCheckConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallUptimeCheckConfig

The call object.

GetUptimeCheckConfigAsync(GetUptimeCheckConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<UptimeCheckConfig> GetUptimeCheckConfigAsync(GetUptimeCheckConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a single Uptime check configuration.

Parameters
NameDescription
requestGetUptimeCheckConfigRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallUptimeCheckConfig

The call object.

ListUptimeCheckConfigs(ListUptimeCheckConfigsRequest, CallOptions)

public virtual ListUptimeCheckConfigsResponse ListUptimeCheckConfigs(ListUptimeCheckConfigsRequest request, CallOptions options)

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

Parameters
NameDescription
requestListUptimeCheckConfigsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListUptimeCheckConfigsResponse

The response received from the server.

ListUptimeCheckConfigs(ListUptimeCheckConfigsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListUptimeCheckConfigsResponse ListUptimeCheckConfigs(ListUptimeCheckConfigsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestListUptimeCheckConfigsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListUptimeCheckConfigsResponse

The response received from the server.

ListUptimeCheckConfigsAsync(ListUptimeCheckConfigsRequest, CallOptions)

public virtual AsyncUnaryCall<ListUptimeCheckConfigsResponse> ListUptimeCheckConfigsAsync(ListUptimeCheckConfigsRequest request, CallOptions options)

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

Parameters
NameDescription
requestListUptimeCheckConfigsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListUptimeCheckConfigsResponse

The call object.

ListUptimeCheckConfigsAsync(ListUptimeCheckConfigsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListUptimeCheckConfigsResponse> ListUptimeCheckConfigsAsync(ListUptimeCheckConfigsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestListUptimeCheckConfigsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListUptimeCheckConfigsResponse

The call object.

ListUptimeCheckIps(ListUptimeCheckIpsRequest, CallOptions)

public virtual ListUptimeCheckIpsResponse ListUptimeCheckIps(ListUptimeCheckIpsRequest request, CallOptions options)

Returns the list of IP addresses that checkers run from

Parameters
NameDescription
requestListUptimeCheckIpsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListUptimeCheckIpsResponse

The response received from the server.

ListUptimeCheckIps(ListUptimeCheckIpsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListUptimeCheckIpsResponse ListUptimeCheckIps(ListUptimeCheckIpsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the list of IP addresses that checkers run from

Parameters
NameDescription
requestListUptimeCheckIpsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListUptimeCheckIpsResponse

The response received from the server.

ListUptimeCheckIpsAsync(ListUptimeCheckIpsRequest, CallOptions)

public virtual AsyncUnaryCall<ListUptimeCheckIpsResponse> ListUptimeCheckIpsAsync(ListUptimeCheckIpsRequest request, CallOptions options)

Returns the list of IP addresses that checkers run from

Parameters
NameDescription
requestListUptimeCheckIpsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListUptimeCheckIpsResponse

The call object.

ListUptimeCheckIpsAsync(ListUptimeCheckIpsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListUptimeCheckIpsResponse> ListUptimeCheckIpsAsync(ListUptimeCheckIpsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the list of IP addresses that checkers run from

Parameters
NameDescription
requestListUptimeCheckIpsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListUptimeCheckIpsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override UptimeCheckService.UptimeCheckServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration
Returns
TypeDescription
UptimeCheckServiceUptimeCheckServiceClient
Overrides

UpdateUptimeCheckConfig(UpdateUptimeCheckConfigRequest, CallOptions)

public virtual UptimeCheckConfig UpdateUptimeCheckConfig(UpdateUptimeCheckConfigRequest request, CallOptions options)

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
NameDescription
requestUpdateUptimeCheckConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
UptimeCheckConfig

The response received from the server.

UpdateUptimeCheckConfig(UpdateUptimeCheckConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual UptimeCheckConfig UpdateUptimeCheckConfig(UpdateUptimeCheckConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestUpdateUptimeCheckConfigRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
UptimeCheckConfig

The response received from the server.

UpdateUptimeCheckConfigAsync(UpdateUptimeCheckConfigRequest, CallOptions)

public virtual AsyncUnaryCall<UptimeCheckConfig> UpdateUptimeCheckConfigAsync(UpdateUptimeCheckConfigRequest request, CallOptions options)

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
NameDescription
requestUpdateUptimeCheckConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallUptimeCheckConfig

The call object.

UpdateUptimeCheckConfigAsync(UpdateUptimeCheckConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<UptimeCheckConfig> UpdateUptimeCheckConfigAsync(UpdateUptimeCheckConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestUpdateUptimeCheckConfigRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallUptimeCheckConfig

The call object.