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

Version 3.3.0

• 3.13.0 (latest)
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.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

Inherited Members

ClientBase<UptimeCheckService.UptimeCheckServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

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
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

UptimeCheckServiceClient(ChannelBase)

public UptimeCheckServiceClient(ChannelBase channel)

Creates a new client for UptimeCheckService

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

UptimeCheckServiceClient(ClientBaseConfiguration)

protected UptimeCheckServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateUptimeCheckConfig(CreateUptimeCheckConfigRequest, CallOptions)

public virtual UptimeCheckConfig CreateUptimeCheckConfig(CreateUptimeCheckConfigRequest request, CallOptions options)

Creates a new Uptime check configuration.

Parameters
Name	Description
request	CreateUptimeCheckConfigRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
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
Name	Description
request	CreateUptimeCheckConfigRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
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
Name	Description
request	CreateUptimeCheckConfigRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
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
Name	Description
request	CreateUptimeCheckConfigRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
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
Name	Description
request	DeleteUptimeCheckConfigRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
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
Name	Description
request	DeleteUptimeCheckConfigRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
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
Name	Description
request	DeleteUptimeCheckConfigRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
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
Name	Description
request	DeleteUptimeCheckConfigRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

GetUptimeCheckConfig(GetUptimeCheckConfigRequest, CallOptions)

public virtual UptimeCheckConfig GetUptimeCheckConfig(GetUptimeCheckConfigRequest request, CallOptions options)

Gets a single Uptime check configuration.

Parameters
Name	Description
request	GetUptimeCheckConfigRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
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
Name	Description
request	GetUptimeCheckConfigRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
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
Name	Description
request	GetUptimeCheckConfigRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
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
Name	Description
request	GetUptimeCheckConfigRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
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
Name	Description
request	ListUptimeCheckConfigsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
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
Name	Description
request	ListUptimeCheckConfigsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
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
Name	Description
request	ListUptimeCheckConfigsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
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
Name	Description
request	ListUptimeCheckConfigsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
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
Name	Description
request	ListUptimeCheckIpsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
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
Name	Description
request	ListUptimeCheckIpsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
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
Name	Description
request	ListUptimeCheckIpsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
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
Name	Description
request	ListUptimeCheckIpsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListUptimeCheckIpsResponse	The call object.

NewInstance(ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
UptimeCheckServiceUptimeCheckServiceClient

Overrides

ClientBase<UptimeCheckService.UptimeCheckServiceClient>.NewInstance(ClientBase.ClientBaseConfiguration)

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
Name	Description
request	UpdateUptimeCheckConfigRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
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
Name	Description
request	UpdateUptimeCheckConfigRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
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
Name	Description
request	UpdateUptimeCheckConfigRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
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
Name	Description
request	UpdateUptimeCheckConfigRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallUptimeCheckConfig	The call object.