Google Cloud Monitoring v3 API - Class UptimeCheckServiceClient (3.6.0)

public abstract class UptimeCheckServiceClient

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

UptimeCheckService client wrapper, for convenient use.

Inheritance

object > UptimeCheckServiceClient

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

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the UptimeCheckService service, which is a host of "monitoring.googleapis.com" and a port of 443.

Property Value
TypeDescription
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default UptimeCheckService scopes.

Property Value
TypeDescription
IReadOnlyListstring
Remarks

GrpcClient

public virtual UptimeCheckService.UptimeCheckServiceClient GrpcClient { get; }

The underlying gRPC UptimeCheckService client

Property Value
TypeDescription
UptimeCheckServiceUptimeCheckServiceClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
TypeDescription
ServiceMetadata

Methods

Create()

public static UptimeCheckServiceClient Create()

Synchronously creates a UptimeCheckServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use UptimeCheckServiceClientBuilder .

Returns
TypeDescription
UptimeCheckServiceClient

The created UptimeCheckServiceClient.

CreateAsync(CancellationToken)

public static Task<UptimeCheckServiceClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a UptimeCheckServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use UptimeCheckServiceClientBuilder .

Parameter
NameDescription
cancellationTokenCancellationToken

The CancellationToken to use while creating the client.

Returns
TypeDescription
TaskUptimeCheckServiceClient

The task representing the created UptimeCheckServiceClient.

CreateUptimeCheckConfig(IResourceName, UptimeCheckConfig, CallSettings)

public virtual UptimeCheckConfig CreateUptimeCheckConfig(IResourceName parent, UptimeCheckConfig uptimeCheckConfig, CallSettings callSettings = null)

Creates a new Uptime check configuration.

Parameters
NameDescription
parentIResourceName

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

projects/[PROJECT_ID_OR_NUMBER]

uptimeCheckConfigUptimeCheckConfig

Required. The new Uptime check configuration.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
UptimeCheckConfig

The RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.Create();
// Initialize request argument(s)
IResourceName parent = new UnparsedResourceName("a/wildcard/resource");
UptimeCheckConfig uptimeCheckConfig = new UptimeCheckConfig();
// Make the request
UptimeCheckConfig response = uptimeCheckServiceClient.CreateUptimeCheckConfig(parent, uptimeCheckConfig);

CreateUptimeCheckConfig(FolderName, UptimeCheckConfig, CallSettings)

public virtual UptimeCheckConfig CreateUptimeCheckConfig(FolderName parent, UptimeCheckConfig uptimeCheckConfig, CallSettings callSettings = null)

Creates a new Uptime check configuration.

Parameters
NameDescription
parentFolderName

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

projects/[PROJECT_ID_OR_NUMBER]

uptimeCheckConfigUptimeCheckConfig

Required. The new Uptime check configuration.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
UptimeCheckConfig

The RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.Create();
// Initialize request argument(s)
FolderName parent = FolderName.FromFolder("[FOLDER]");
UptimeCheckConfig uptimeCheckConfig = new UptimeCheckConfig();
// Make the request
UptimeCheckConfig response = uptimeCheckServiceClient.CreateUptimeCheckConfig(parent, uptimeCheckConfig);

CreateUptimeCheckConfig(OrganizationName, UptimeCheckConfig, CallSettings)

public virtual UptimeCheckConfig CreateUptimeCheckConfig(OrganizationName parent, UptimeCheckConfig uptimeCheckConfig, CallSettings callSettings = null)

Creates a new Uptime check configuration.

Parameters
NameDescription
parentOrganizationName

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

projects/[PROJECT_ID_OR_NUMBER]

uptimeCheckConfigUptimeCheckConfig

Required. The new Uptime check configuration.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
UptimeCheckConfig

The RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.Create();
// Initialize request argument(s)
OrganizationName parent = OrganizationName.FromOrganization("[ORGANIZATION]");
UptimeCheckConfig uptimeCheckConfig = new UptimeCheckConfig();
// Make the request
UptimeCheckConfig response = uptimeCheckServiceClient.CreateUptimeCheckConfig(parent, uptimeCheckConfig);

CreateUptimeCheckConfig(ProjectName, UptimeCheckConfig, CallSettings)

public virtual UptimeCheckConfig CreateUptimeCheckConfig(ProjectName parent, UptimeCheckConfig uptimeCheckConfig, CallSettings callSettings = null)

Creates a new Uptime check configuration.

Parameters
NameDescription
parentProjectName

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

projects/[PROJECT_ID_OR_NUMBER]

uptimeCheckConfigUptimeCheckConfig

Required. The new Uptime check configuration.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
UptimeCheckConfig

The RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
UptimeCheckConfig uptimeCheckConfig = new UptimeCheckConfig();
// Make the request
UptimeCheckConfig response = uptimeCheckServiceClient.CreateUptimeCheckConfig(parent, uptimeCheckConfig);

CreateUptimeCheckConfig(CreateUptimeCheckConfigRequest, CallSettings)

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

Creates a new Uptime check configuration.

Parameters
NameDescription
requestCreateUptimeCheckConfigRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
UptimeCheckConfig

The RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.Create();
// Initialize request argument(s)
CreateUptimeCheckConfigRequest request = new CreateUptimeCheckConfigRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    UptimeCheckConfig = new UptimeCheckConfig(),
};
// Make the request
UptimeCheckConfig response = uptimeCheckServiceClient.CreateUptimeCheckConfig(request);

CreateUptimeCheckConfig(string, UptimeCheckConfig, CallSettings)

public virtual UptimeCheckConfig CreateUptimeCheckConfig(string parent, UptimeCheckConfig uptimeCheckConfig, CallSettings callSettings = null)

Creates a new Uptime check configuration.

Parameters
NameDescription
parentstring

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

projects/[PROJECT_ID_OR_NUMBER]

uptimeCheckConfigUptimeCheckConfig

Required. The new Uptime check configuration.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
UptimeCheckConfig

The RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
UptimeCheckConfig uptimeCheckConfig = new UptimeCheckConfig();
// Make the request
UptimeCheckConfig response = uptimeCheckServiceClient.CreateUptimeCheckConfig(parent, uptimeCheckConfig);

CreateUptimeCheckConfigAsync(IResourceName, UptimeCheckConfig, CallSettings)

public virtual Task<UptimeCheckConfig> CreateUptimeCheckConfigAsync(IResourceName parent, UptimeCheckConfig uptimeCheckConfig, CallSettings callSettings = null)

Creates a new Uptime check configuration.

Parameters
NameDescription
parentIResourceName

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

projects/[PROJECT_ID_OR_NUMBER]

uptimeCheckConfigUptimeCheckConfig

Required. The new Uptime check configuration.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskUptimeCheckConfig

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
IResourceName parent = new UnparsedResourceName("a/wildcard/resource");
UptimeCheckConfig uptimeCheckConfig = new UptimeCheckConfig();
// Make the request
UptimeCheckConfig response = await uptimeCheckServiceClient.CreateUptimeCheckConfigAsync(parent, uptimeCheckConfig);

CreateUptimeCheckConfigAsync(IResourceName, UptimeCheckConfig, CancellationToken)

public virtual Task<UptimeCheckConfig> CreateUptimeCheckConfigAsync(IResourceName parent, UptimeCheckConfig uptimeCheckConfig, CancellationToken cancellationToken)

Creates a new Uptime check configuration.

Parameters
NameDescription
parentIResourceName

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

projects/[PROJECT_ID_OR_NUMBER]

uptimeCheckConfigUptimeCheckConfig

Required. The new Uptime check configuration.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskUptimeCheckConfig

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
IResourceName parent = new UnparsedResourceName("a/wildcard/resource");
UptimeCheckConfig uptimeCheckConfig = new UptimeCheckConfig();
// Make the request
UptimeCheckConfig response = await uptimeCheckServiceClient.CreateUptimeCheckConfigAsync(parent, uptimeCheckConfig);

CreateUptimeCheckConfigAsync(FolderName, UptimeCheckConfig, CallSettings)

public virtual Task<UptimeCheckConfig> CreateUptimeCheckConfigAsync(FolderName parent, UptimeCheckConfig uptimeCheckConfig, CallSettings callSettings = null)

Creates a new Uptime check configuration.

Parameters
NameDescription
parentFolderName

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

projects/[PROJECT_ID_OR_NUMBER]

uptimeCheckConfigUptimeCheckConfig

Required. The new Uptime check configuration.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskUptimeCheckConfig

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
FolderName parent = FolderName.FromFolder("[FOLDER]");
UptimeCheckConfig uptimeCheckConfig = new UptimeCheckConfig();
// Make the request
UptimeCheckConfig response = await uptimeCheckServiceClient.CreateUptimeCheckConfigAsync(parent, uptimeCheckConfig);

CreateUptimeCheckConfigAsync(FolderName, UptimeCheckConfig, CancellationToken)

public virtual Task<UptimeCheckConfig> CreateUptimeCheckConfigAsync(FolderName parent, UptimeCheckConfig uptimeCheckConfig, CancellationToken cancellationToken)

Creates a new Uptime check configuration.

Parameters
NameDescription
parentFolderName

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

projects/[PROJECT_ID_OR_NUMBER]

uptimeCheckConfigUptimeCheckConfig

Required. The new Uptime check configuration.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskUptimeCheckConfig

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
FolderName parent = FolderName.FromFolder("[FOLDER]");
UptimeCheckConfig uptimeCheckConfig = new UptimeCheckConfig();
// Make the request
UptimeCheckConfig response = await uptimeCheckServiceClient.CreateUptimeCheckConfigAsync(parent, uptimeCheckConfig);

CreateUptimeCheckConfigAsync(OrganizationName, UptimeCheckConfig, CallSettings)

public virtual Task<UptimeCheckConfig> CreateUptimeCheckConfigAsync(OrganizationName parent, UptimeCheckConfig uptimeCheckConfig, CallSettings callSettings = null)

Creates a new Uptime check configuration.

Parameters
NameDescription
parentOrganizationName

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

projects/[PROJECT_ID_OR_NUMBER]

uptimeCheckConfigUptimeCheckConfig

Required. The new Uptime check configuration.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskUptimeCheckConfig

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
OrganizationName parent = OrganizationName.FromOrganization("[ORGANIZATION]");
UptimeCheckConfig uptimeCheckConfig = new UptimeCheckConfig();
// Make the request
UptimeCheckConfig response = await uptimeCheckServiceClient.CreateUptimeCheckConfigAsync(parent, uptimeCheckConfig);

CreateUptimeCheckConfigAsync(OrganizationName, UptimeCheckConfig, CancellationToken)

public virtual Task<UptimeCheckConfig> CreateUptimeCheckConfigAsync(OrganizationName parent, UptimeCheckConfig uptimeCheckConfig, CancellationToken cancellationToken)

Creates a new Uptime check configuration.

Parameters
NameDescription
parentOrganizationName

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

projects/[PROJECT_ID_OR_NUMBER]

uptimeCheckConfigUptimeCheckConfig

Required. The new Uptime check configuration.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskUptimeCheckConfig

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
OrganizationName parent = OrganizationName.FromOrganization("[ORGANIZATION]");
UptimeCheckConfig uptimeCheckConfig = new UptimeCheckConfig();
// Make the request
UptimeCheckConfig response = await uptimeCheckServiceClient.CreateUptimeCheckConfigAsync(parent, uptimeCheckConfig);

CreateUptimeCheckConfigAsync(ProjectName, UptimeCheckConfig, CallSettings)

public virtual Task<UptimeCheckConfig> CreateUptimeCheckConfigAsync(ProjectName parent, UptimeCheckConfig uptimeCheckConfig, CallSettings callSettings = null)

Creates a new Uptime check configuration.

Parameters
NameDescription
parentProjectName

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

projects/[PROJECT_ID_OR_NUMBER]

uptimeCheckConfigUptimeCheckConfig

Required. The new Uptime check configuration.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskUptimeCheckConfig

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
UptimeCheckConfig uptimeCheckConfig = new UptimeCheckConfig();
// Make the request
UptimeCheckConfig response = await uptimeCheckServiceClient.CreateUptimeCheckConfigAsync(parent, uptimeCheckConfig);

CreateUptimeCheckConfigAsync(ProjectName, UptimeCheckConfig, CancellationToken)

public virtual Task<UptimeCheckConfig> CreateUptimeCheckConfigAsync(ProjectName parent, UptimeCheckConfig uptimeCheckConfig, CancellationToken cancellationToken)

Creates a new Uptime check configuration.

Parameters
NameDescription
parentProjectName

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

projects/[PROJECT_ID_OR_NUMBER]

uptimeCheckConfigUptimeCheckConfig

Required. The new Uptime check configuration.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskUptimeCheckConfig

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
UptimeCheckConfig uptimeCheckConfig = new UptimeCheckConfig();
// Make the request
UptimeCheckConfig response = await uptimeCheckServiceClient.CreateUptimeCheckConfigAsync(parent, uptimeCheckConfig);

CreateUptimeCheckConfigAsync(CreateUptimeCheckConfigRequest, CallSettings)

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

Creates a new Uptime check configuration.

Parameters
NameDescription
requestCreateUptimeCheckConfigRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskUptimeCheckConfig

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
CreateUptimeCheckConfigRequest request = new CreateUptimeCheckConfigRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    UptimeCheckConfig = new UptimeCheckConfig(),
};
// Make the request
UptimeCheckConfig response = await uptimeCheckServiceClient.CreateUptimeCheckConfigAsync(request);

CreateUptimeCheckConfigAsync(CreateUptimeCheckConfigRequest, CancellationToken)

public virtual Task<UptimeCheckConfig> CreateUptimeCheckConfigAsync(CreateUptimeCheckConfigRequest request, CancellationToken cancellationToken)

Creates a new Uptime check configuration.

Parameters
NameDescription
requestCreateUptimeCheckConfigRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskUptimeCheckConfig

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
CreateUptimeCheckConfigRequest request = new CreateUptimeCheckConfigRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    UptimeCheckConfig = new UptimeCheckConfig(),
};
// Make the request
UptimeCheckConfig response = await uptimeCheckServiceClient.CreateUptimeCheckConfigAsync(request);

CreateUptimeCheckConfigAsync(string, UptimeCheckConfig, CallSettings)

public virtual Task<UptimeCheckConfig> CreateUptimeCheckConfigAsync(string parent, UptimeCheckConfig uptimeCheckConfig, CallSettings callSettings = null)

Creates a new Uptime check configuration.

Parameters
NameDescription
parentstring

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

projects/[PROJECT_ID_OR_NUMBER]

uptimeCheckConfigUptimeCheckConfig

Required. The new Uptime check configuration.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskUptimeCheckConfig

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
UptimeCheckConfig uptimeCheckConfig = new UptimeCheckConfig();
// Make the request
UptimeCheckConfig response = await uptimeCheckServiceClient.CreateUptimeCheckConfigAsync(parent, uptimeCheckConfig);

CreateUptimeCheckConfigAsync(string, UptimeCheckConfig, CancellationToken)

public virtual Task<UptimeCheckConfig> CreateUptimeCheckConfigAsync(string parent, UptimeCheckConfig uptimeCheckConfig, CancellationToken cancellationToken)

Creates a new Uptime check configuration.

Parameters
NameDescription
parentstring

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

projects/[PROJECT_ID_OR_NUMBER]

uptimeCheckConfigUptimeCheckConfig

Required. The new Uptime check configuration.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskUptimeCheckConfig

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
UptimeCheckConfig uptimeCheckConfig = new UptimeCheckConfig();
// Make the request
UptimeCheckConfig response = await uptimeCheckServiceClient.CreateUptimeCheckConfigAsync(parent, uptimeCheckConfig);

DeleteUptimeCheckConfig(IResourceName, CallSettings)

public virtual void DeleteUptimeCheckConfig(IResourceName name, 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
NameDescription
nameIResourceName

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

projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.Create();
// Initialize request argument(s)
IResourceName name = new UnparsedResourceName("a/wildcard/resource");
// Make the request
uptimeCheckServiceClient.DeleteUptimeCheckConfig(name);

DeleteUptimeCheckConfig(DeleteUptimeCheckConfigRequest, CallSettings)

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

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.Create();
// Initialize request argument(s)
DeleteUptimeCheckConfigRequest request = new DeleteUptimeCheckConfigRequest
{
    UptimeCheckConfigName = UptimeCheckConfigName.FromProjectUptimeCheckConfig("[PROJECT]", "[UPTIME_CHECK_CONFIG]"),
};
// Make the request
uptimeCheckServiceClient.DeleteUptimeCheckConfig(request);

DeleteUptimeCheckConfig(UptimeCheckConfigName, CallSettings)

public virtual void DeleteUptimeCheckConfig(UptimeCheckConfigName name, 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
NameDescription
nameUptimeCheckConfigName

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

projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.Create();
// Initialize request argument(s)
UptimeCheckConfigName name = UptimeCheckConfigName.FromProjectUptimeCheckConfig("[PROJECT]", "[UPTIME_CHECK_CONFIG]");
// Make the request
uptimeCheckServiceClient.DeleteUptimeCheckConfig(name);

DeleteUptimeCheckConfig(string, CallSettings)

public virtual void DeleteUptimeCheckConfig(string name, 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
NameDescription
namestring

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

projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/uptimeCheckConfigs/[UPTIME_CHECK_CONFIG]";
// Make the request
uptimeCheckServiceClient.DeleteUptimeCheckConfig(name);

DeleteUptimeCheckConfigAsync(IResourceName, CallSettings)

public virtual Task DeleteUptimeCheckConfigAsync(IResourceName name, 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
NameDescription
nameIResourceName

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

projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
IResourceName name = new UnparsedResourceName("a/wildcard/resource");
// Make the request
await uptimeCheckServiceClient.DeleteUptimeCheckConfigAsync(name);

DeleteUptimeCheckConfigAsync(IResourceName, CancellationToken)

public virtual Task DeleteUptimeCheckConfigAsync(IResourceName name, CancellationToken cancellationToken)

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
nameIResourceName

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

projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
IResourceName name = new UnparsedResourceName("a/wildcard/resource");
// Make the request
await uptimeCheckServiceClient.DeleteUptimeCheckConfigAsync(name);

DeleteUptimeCheckConfigAsync(DeleteUptimeCheckConfigRequest, CallSettings)

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

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteUptimeCheckConfigRequest request = new DeleteUptimeCheckConfigRequest
{
    UptimeCheckConfigName = UptimeCheckConfigName.FromProjectUptimeCheckConfig("[PROJECT]", "[UPTIME_CHECK_CONFIG]"),
};
// Make the request
await uptimeCheckServiceClient.DeleteUptimeCheckConfigAsync(request);

DeleteUptimeCheckConfigAsync(DeleteUptimeCheckConfigRequest, CancellationToken)

public virtual Task DeleteUptimeCheckConfigAsync(DeleteUptimeCheckConfigRequest request, CancellationToken cancellationToken)

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 object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteUptimeCheckConfigRequest request = new DeleteUptimeCheckConfigRequest
{
    UptimeCheckConfigName = UptimeCheckConfigName.FromProjectUptimeCheckConfig("[PROJECT]", "[UPTIME_CHECK_CONFIG]"),
};
// Make the request
await uptimeCheckServiceClient.DeleteUptimeCheckConfigAsync(request);

DeleteUptimeCheckConfigAsync(UptimeCheckConfigName, CallSettings)

public virtual Task DeleteUptimeCheckConfigAsync(UptimeCheckConfigName name, 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
NameDescription
nameUptimeCheckConfigName

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

projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
UptimeCheckConfigName name = UptimeCheckConfigName.FromProjectUptimeCheckConfig("[PROJECT]", "[UPTIME_CHECK_CONFIG]");
// Make the request
await uptimeCheckServiceClient.DeleteUptimeCheckConfigAsync(name);

DeleteUptimeCheckConfigAsync(UptimeCheckConfigName, CancellationToken)

public virtual Task DeleteUptimeCheckConfigAsync(UptimeCheckConfigName name, CancellationToken cancellationToken)

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
nameUptimeCheckConfigName

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

projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
UptimeCheckConfigName name = UptimeCheckConfigName.FromProjectUptimeCheckConfig("[PROJECT]", "[UPTIME_CHECK_CONFIG]");
// Make the request
await uptimeCheckServiceClient.DeleteUptimeCheckConfigAsync(name);

DeleteUptimeCheckConfigAsync(string, CallSettings)

public virtual Task DeleteUptimeCheckConfigAsync(string name, 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
NameDescription
namestring

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

projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/uptimeCheckConfigs/[UPTIME_CHECK_CONFIG]";
// Make the request
await uptimeCheckServiceClient.DeleteUptimeCheckConfigAsync(name);

DeleteUptimeCheckConfigAsync(string, CancellationToken)

public virtual Task DeleteUptimeCheckConfigAsync(string name, CancellationToken cancellationToken)

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
namestring

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

projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/uptimeCheckConfigs/[UPTIME_CHECK_CONFIG]";
// Make the request
await uptimeCheckServiceClient.DeleteUptimeCheckConfigAsync(name);

GetUptimeCheckConfig(IResourceName, CallSettings)

public virtual UptimeCheckConfig GetUptimeCheckConfig(IResourceName name, CallSettings callSettings = null)

Gets a single Uptime check configuration.

Parameters
NameDescription
nameIResourceName

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

projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
UptimeCheckConfig

The RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.Create();
// Initialize request argument(s)
IResourceName name = new UnparsedResourceName("a/wildcard/resource");
// Make the request
UptimeCheckConfig response = uptimeCheckServiceClient.GetUptimeCheckConfig(name);

GetUptimeCheckConfig(GetUptimeCheckConfigRequest, CallSettings)

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

Gets a single Uptime check configuration.

Parameters
NameDescription
requestGetUptimeCheckConfigRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
UptimeCheckConfig

The RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.Create();
// Initialize request argument(s)
GetUptimeCheckConfigRequest request = new GetUptimeCheckConfigRequest
{
    UptimeCheckConfigName = UptimeCheckConfigName.FromProjectUptimeCheckConfig("[PROJECT]", "[UPTIME_CHECK_CONFIG]"),
};
// Make the request
UptimeCheckConfig response = uptimeCheckServiceClient.GetUptimeCheckConfig(request);

GetUptimeCheckConfig(UptimeCheckConfigName, CallSettings)

public virtual UptimeCheckConfig GetUptimeCheckConfig(UptimeCheckConfigName name, CallSettings callSettings = null)

Gets a single Uptime check configuration.

Parameters
NameDescription
nameUptimeCheckConfigName

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

projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
UptimeCheckConfig

The RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.Create();
// Initialize request argument(s)
UptimeCheckConfigName name = UptimeCheckConfigName.FromProjectUptimeCheckConfig("[PROJECT]", "[UPTIME_CHECK_CONFIG]");
// Make the request
UptimeCheckConfig response = uptimeCheckServiceClient.GetUptimeCheckConfig(name);

GetUptimeCheckConfig(string, CallSettings)

public virtual UptimeCheckConfig GetUptimeCheckConfig(string name, CallSettings callSettings = null)

Gets a single Uptime check configuration.

Parameters
NameDescription
namestring

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

projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
UptimeCheckConfig

The RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/uptimeCheckConfigs/[UPTIME_CHECK_CONFIG]";
// Make the request
UptimeCheckConfig response = uptimeCheckServiceClient.GetUptimeCheckConfig(name);

GetUptimeCheckConfigAsync(IResourceName, CallSettings)

public virtual Task<UptimeCheckConfig> GetUptimeCheckConfigAsync(IResourceName name, CallSettings callSettings = null)

Gets a single Uptime check configuration.

Parameters
NameDescription
nameIResourceName

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

projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskUptimeCheckConfig

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
IResourceName name = new UnparsedResourceName("a/wildcard/resource");
// Make the request
UptimeCheckConfig response = await uptimeCheckServiceClient.GetUptimeCheckConfigAsync(name);

GetUptimeCheckConfigAsync(IResourceName, CancellationToken)

public virtual Task<UptimeCheckConfig> GetUptimeCheckConfigAsync(IResourceName name, CancellationToken cancellationToken)

Gets a single Uptime check configuration.

Parameters
NameDescription
nameIResourceName

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

projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskUptimeCheckConfig

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
IResourceName name = new UnparsedResourceName("a/wildcard/resource");
// Make the request
UptimeCheckConfig response = await uptimeCheckServiceClient.GetUptimeCheckConfigAsync(name);

GetUptimeCheckConfigAsync(GetUptimeCheckConfigRequest, CallSettings)

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

Gets a single Uptime check configuration.

Parameters
NameDescription
requestGetUptimeCheckConfigRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskUptimeCheckConfig

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
GetUptimeCheckConfigRequest request = new GetUptimeCheckConfigRequest
{
    UptimeCheckConfigName = UptimeCheckConfigName.FromProjectUptimeCheckConfig("[PROJECT]", "[UPTIME_CHECK_CONFIG]"),
};
// Make the request
UptimeCheckConfig response = await uptimeCheckServiceClient.GetUptimeCheckConfigAsync(request);

GetUptimeCheckConfigAsync(GetUptimeCheckConfigRequest, CancellationToken)

public virtual Task<UptimeCheckConfig> GetUptimeCheckConfigAsync(GetUptimeCheckConfigRequest request, CancellationToken cancellationToken)

Gets a single Uptime check configuration.

Parameters
NameDescription
requestGetUptimeCheckConfigRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskUptimeCheckConfig

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
GetUptimeCheckConfigRequest request = new GetUptimeCheckConfigRequest
{
    UptimeCheckConfigName = UptimeCheckConfigName.FromProjectUptimeCheckConfig("[PROJECT]", "[UPTIME_CHECK_CONFIG]"),
};
// Make the request
UptimeCheckConfig response = await uptimeCheckServiceClient.GetUptimeCheckConfigAsync(request);

GetUptimeCheckConfigAsync(UptimeCheckConfigName, CallSettings)

public virtual Task<UptimeCheckConfig> GetUptimeCheckConfigAsync(UptimeCheckConfigName name, CallSettings callSettings = null)

Gets a single Uptime check configuration.

Parameters
NameDescription
nameUptimeCheckConfigName

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

projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskUptimeCheckConfig

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
UptimeCheckConfigName name = UptimeCheckConfigName.FromProjectUptimeCheckConfig("[PROJECT]", "[UPTIME_CHECK_CONFIG]");
// Make the request
UptimeCheckConfig response = await uptimeCheckServiceClient.GetUptimeCheckConfigAsync(name);

GetUptimeCheckConfigAsync(UptimeCheckConfigName, CancellationToken)

public virtual Task<UptimeCheckConfig> GetUptimeCheckConfigAsync(UptimeCheckConfigName name, CancellationToken cancellationToken)

Gets a single Uptime check configuration.

Parameters
NameDescription
nameUptimeCheckConfigName

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

projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskUptimeCheckConfig

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
UptimeCheckConfigName name = UptimeCheckConfigName.FromProjectUptimeCheckConfig("[PROJECT]", "[UPTIME_CHECK_CONFIG]");
// Make the request
UptimeCheckConfig response = await uptimeCheckServiceClient.GetUptimeCheckConfigAsync(name);

GetUptimeCheckConfigAsync(string, CallSettings)

public virtual Task<UptimeCheckConfig> GetUptimeCheckConfigAsync(string name, CallSettings callSettings = null)

Gets a single Uptime check configuration.

Parameters
NameDescription
namestring

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

projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskUptimeCheckConfig

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/uptimeCheckConfigs/[UPTIME_CHECK_CONFIG]";
// Make the request
UptimeCheckConfig response = await uptimeCheckServiceClient.GetUptimeCheckConfigAsync(name);

GetUptimeCheckConfigAsync(string, CancellationToken)

public virtual Task<UptimeCheckConfig> GetUptimeCheckConfigAsync(string name, CancellationToken cancellationToken)

Gets a single Uptime check configuration.

Parameters
NameDescription
namestring

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

projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskUptimeCheckConfig

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/uptimeCheckConfigs/[UPTIME_CHECK_CONFIG]";
// Make the request
UptimeCheckConfig response = await uptimeCheckServiceClient.GetUptimeCheckConfigAsync(name);

ListUptimeCheckConfigs(IResourceName, string, int?, CallSettings)

public virtual PagedEnumerable<ListUptimeCheckConfigsResponse, UptimeCheckConfig> ListUptimeCheckConfigs(IResourceName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
NameDescription
parentIResourceName

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

projects/[PROJECT_ID_OR_NUMBER]

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListUptimeCheckConfigsResponseUptimeCheckConfig

A pageable sequence of UptimeCheckConfig resources.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.Create();
// Initialize request argument(s)
IResourceName parent = new UnparsedResourceName("a/wildcard/resource");
// Make the request
PagedEnumerable<ListUptimeCheckConfigsResponse, UptimeCheckConfig> response = uptimeCheckServiceClient.ListUptimeCheckConfigs(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (UptimeCheckConfig item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListUptimeCheckConfigsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UptimeCheckConfig item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UptimeCheckConfig> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UptimeCheckConfig item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListUptimeCheckConfigs(FolderName, string, int?, CallSettings)

public virtual PagedEnumerable<ListUptimeCheckConfigsResponse, UptimeCheckConfig> ListUptimeCheckConfigs(FolderName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
NameDescription
parentFolderName

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

projects/[PROJECT_ID_OR_NUMBER]

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListUptimeCheckConfigsResponseUptimeCheckConfig

A pageable sequence of UptimeCheckConfig resources.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.Create();
// Initialize request argument(s)
FolderName parent = FolderName.FromFolder("[FOLDER]");
// Make the request
PagedEnumerable<ListUptimeCheckConfigsResponse, UptimeCheckConfig> response = uptimeCheckServiceClient.ListUptimeCheckConfigs(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (UptimeCheckConfig item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListUptimeCheckConfigsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UptimeCheckConfig item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UptimeCheckConfig> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UptimeCheckConfig item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListUptimeCheckConfigs(OrganizationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListUptimeCheckConfigsResponse, UptimeCheckConfig> ListUptimeCheckConfigs(OrganizationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
NameDescription
parentOrganizationName

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

projects/[PROJECT_ID_OR_NUMBER]

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListUptimeCheckConfigsResponseUptimeCheckConfig

A pageable sequence of UptimeCheckConfig resources.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.Create();
// Initialize request argument(s)
OrganizationName parent = OrganizationName.FromOrganization("[ORGANIZATION]");
// Make the request
PagedEnumerable<ListUptimeCheckConfigsResponse, UptimeCheckConfig> response = uptimeCheckServiceClient.ListUptimeCheckConfigs(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (UptimeCheckConfig item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListUptimeCheckConfigsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UptimeCheckConfig item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UptimeCheckConfig> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UptimeCheckConfig item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListUptimeCheckConfigs(ProjectName, string, int?, CallSettings)

public virtual PagedEnumerable<ListUptimeCheckConfigsResponse, UptimeCheckConfig> ListUptimeCheckConfigs(ProjectName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
NameDescription
parentProjectName

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

projects/[PROJECT_ID_OR_NUMBER]

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListUptimeCheckConfigsResponseUptimeCheckConfig

A pageable sequence of UptimeCheckConfig resources.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
// Make the request
PagedEnumerable<ListUptimeCheckConfigsResponse, UptimeCheckConfig> response = uptimeCheckServiceClient.ListUptimeCheckConfigs(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (UptimeCheckConfig item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListUptimeCheckConfigsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UptimeCheckConfig item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UptimeCheckConfig> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UptimeCheckConfig item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListUptimeCheckConfigs(ListUptimeCheckConfigsRequest, CallSettings)

public virtual 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
NameDescription
requestListUptimeCheckConfigsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListUptimeCheckConfigsResponseUptimeCheckConfig

A pageable sequence of UptimeCheckConfig resources.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.Create();
// Initialize request argument(s)
ListUptimeCheckConfigsRequest request = new ListUptimeCheckConfigsRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Filter = "",
};
// Make the request
PagedEnumerable<ListUptimeCheckConfigsResponse, UptimeCheckConfig> response = uptimeCheckServiceClient.ListUptimeCheckConfigs(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (UptimeCheckConfig item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListUptimeCheckConfigsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UptimeCheckConfig item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UptimeCheckConfig> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UptimeCheckConfig item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListUptimeCheckConfigs(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListUptimeCheckConfigsResponse, UptimeCheckConfig> ListUptimeCheckConfigs(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
NameDescription
parentstring

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

projects/[PROJECT_ID_OR_NUMBER]

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListUptimeCheckConfigsResponseUptimeCheckConfig

A pageable sequence of UptimeCheckConfig resources.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
// Make the request
PagedEnumerable<ListUptimeCheckConfigsResponse, UptimeCheckConfig> response = uptimeCheckServiceClient.ListUptimeCheckConfigs(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (UptimeCheckConfig item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListUptimeCheckConfigsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UptimeCheckConfig item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UptimeCheckConfig> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UptimeCheckConfig item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListUptimeCheckConfigsAsync(IResourceName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListUptimeCheckConfigsResponse, UptimeCheckConfig> ListUptimeCheckConfigsAsync(IResourceName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
NameDescription
parentIResourceName

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

projects/[PROJECT_ID_OR_NUMBER]

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListUptimeCheckConfigsResponseUptimeCheckConfig

A pageable asynchronous sequence of UptimeCheckConfig resources.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
IResourceName parent = new UnparsedResourceName("a/wildcard/resource");
// Make the request
PagedAsyncEnumerable<ListUptimeCheckConfigsResponse, UptimeCheckConfig> response = uptimeCheckServiceClient.ListUptimeCheckConfigsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((UptimeCheckConfig item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListUptimeCheckConfigsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UptimeCheckConfig item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UptimeCheckConfig> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UptimeCheckConfig item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListUptimeCheckConfigsAsync(FolderName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListUptimeCheckConfigsResponse, UptimeCheckConfig> ListUptimeCheckConfigsAsync(FolderName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
NameDescription
parentFolderName

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

projects/[PROJECT_ID_OR_NUMBER]

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListUptimeCheckConfigsResponseUptimeCheckConfig

A pageable asynchronous sequence of UptimeCheckConfig resources.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
FolderName parent = FolderName.FromFolder("[FOLDER]");
// Make the request
PagedAsyncEnumerable<ListUptimeCheckConfigsResponse, UptimeCheckConfig> response = uptimeCheckServiceClient.ListUptimeCheckConfigsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((UptimeCheckConfig item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListUptimeCheckConfigsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UptimeCheckConfig item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UptimeCheckConfig> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UptimeCheckConfig item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListUptimeCheckConfigsAsync(OrganizationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListUptimeCheckConfigsResponse, UptimeCheckConfig> ListUptimeCheckConfigsAsync(OrganizationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
NameDescription
parentOrganizationName

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

projects/[PROJECT_ID_OR_NUMBER]

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListUptimeCheckConfigsResponseUptimeCheckConfig

A pageable asynchronous sequence of UptimeCheckConfig resources.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
OrganizationName parent = OrganizationName.FromOrganization("[ORGANIZATION]");
// Make the request
PagedAsyncEnumerable<ListUptimeCheckConfigsResponse, UptimeCheckConfig> response = uptimeCheckServiceClient.ListUptimeCheckConfigsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((UptimeCheckConfig item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListUptimeCheckConfigsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UptimeCheckConfig item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UptimeCheckConfig> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UptimeCheckConfig item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListUptimeCheckConfigsAsync(ProjectName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListUptimeCheckConfigsResponse, UptimeCheckConfig> ListUptimeCheckConfigsAsync(ProjectName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
NameDescription
parentProjectName

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

projects/[PROJECT_ID_OR_NUMBER]

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListUptimeCheckConfigsResponseUptimeCheckConfig

A pageable asynchronous sequence of UptimeCheckConfig resources.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
// Make the request
PagedAsyncEnumerable<ListUptimeCheckConfigsResponse, UptimeCheckConfig> response = uptimeCheckServiceClient.ListUptimeCheckConfigsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((UptimeCheckConfig item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListUptimeCheckConfigsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UptimeCheckConfig item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UptimeCheckConfig> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UptimeCheckConfig item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListUptimeCheckConfigsAsync(ListUptimeCheckConfigsRequest, CallSettings)

public virtual 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
NameDescription
requestListUptimeCheckConfigsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListUptimeCheckConfigsResponseUptimeCheckConfig

A pageable asynchronous sequence of UptimeCheckConfig resources.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
ListUptimeCheckConfigsRequest request = new ListUptimeCheckConfigsRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Filter = "",
};
// Make the request
PagedAsyncEnumerable<ListUptimeCheckConfigsResponse, UptimeCheckConfig> response = uptimeCheckServiceClient.ListUptimeCheckConfigsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((UptimeCheckConfig item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListUptimeCheckConfigsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UptimeCheckConfig item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UptimeCheckConfig> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UptimeCheckConfig item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListUptimeCheckConfigsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListUptimeCheckConfigsResponse, UptimeCheckConfig> ListUptimeCheckConfigsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
NameDescription
parentstring

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

projects/[PROJECT_ID_OR_NUMBER]

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListUptimeCheckConfigsResponseUptimeCheckConfig

A pageable asynchronous sequence of UptimeCheckConfig resources.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
// Make the request
PagedAsyncEnumerable<ListUptimeCheckConfigsResponse, UptimeCheckConfig> response = uptimeCheckServiceClient.ListUptimeCheckConfigsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((UptimeCheckConfig item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListUptimeCheckConfigsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UptimeCheckConfig item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UptimeCheckConfig> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UptimeCheckConfig item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListUptimeCheckIps(ListUptimeCheckIpsRequest, CallSettings)

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

Returns the list of IP addresses that checkers run from

Parameters
NameDescription
requestListUptimeCheckIpsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListUptimeCheckIpsResponseUptimeCheckIp

A pageable sequence of UptimeCheckIp resources.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.Create();
// Initialize request argument(s)
ListUptimeCheckIpsRequest request = new ListUptimeCheckIpsRequest { };
// Make the request
PagedEnumerable<ListUptimeCheckIpsResponse, UptimeCheckIp> response = uptimeCheckServiceClient.ListUptimeCheckIps(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (UptimeCheckIp item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListUptimeCheckIpsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UptimeCheckIp item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UptimeCheckIp> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UptimeCheckIp item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListUptimeCheckIpsAsync(ListUptimeCheckIpsRequest, CallSettings)

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

Returns the list of IP addresses that checkers run from

Parameters
NameDescription
requestListUptimeCheckIpsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListUptimeCheckIpsResponseUptimeCheckIp

A pageable asynchronous sequence of UptimeCheckIp resources.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
ListUptimeCheckIpsRequest request = new ListUptimeCheckIpsRequest { };
// Make the request
PagedAsyncEnumerable<ListUptimeCheckIpsResponse, UptimeCheckIp> response = uptimeCheckServiceClient.ListUptimeCheckIpsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((UptimeCheckIp item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListUptimeCheckIpsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UptimeCheckIp item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UptimeCheckIp> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UptimeCheckIp item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
TypeDescription
Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdateUptimeCheckConfig(UpdateUptimeCheckConfigRequest, CallSettings)

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

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
UptimeCheckConfig

The RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.Create();
// Initialize request argument(s)
UpdateUptimeCheckConfigRequest request = new UpdateUptimeCheckConfigRequest
{
    UpdateMask = new FieldMask(),
    UptimeCheckConfig = new UptimeCheckConfig(),
};
// Make the request
UptimeCheckConfig response = uptimeCheckServiceClient.UpdateUptimeCheckConfig(request);

UpdateUptimeCheckConfig(UptimeCheckConfig, CallSettings)

public virtual UptimeCheckConfig UpdateUptimeCheckConfig(UptimeCheckConfig uptimeCheckConfig, 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
NameDescription
uptimeCheckConfigUptimeCheckConfig

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
UptimeCheckConfig

The RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = UptimeCheckServiceClient.Create();
// Initialize request argument(s)
UptimeCheckConfig uptimeCheckConfig = new UptimeCheckConfig();
// Make the request
UptimeCheckConfig response = uptimeCheckServiceClient.UpdateUptimeCheckConfig(uptimeCheckConfig);

UpdateUptimeCheckConfigAsync(UpdateUptimeCheckConfigRequest, CallSettings)

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

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskUptimeCheckConfig

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateUptimeCheckConfigRequest request = new UpdateUptimeCheckConfigRequest
{
    UpdateMask = new FieldMask(),
    UptimeCheckConfig = new UptimeCheckConfig(),
};
// Make the request
UptimeCheckConfig response = await uptimeCheckServiceClient.UpdateUptimeCheckConfigAsync(request);

UpdateUptimeCheckConfigAsync(UpdateUptimeCheckConfigRequest, CancellationToken)

public virtual Task<UptimeCheckConfig> UpdateUptimeCheckConfigAsync(UpdateUptimeCheckConfigRequest request, CancellationToken cancellationToken)

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 object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskUptimeCheckConfig

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateUptimeCheckConfigRequest request = new UpdateUptimeCheckConfigRequest
{
    UpdateMask = new FieldMask(),
    UptimeCheckConfig = new UptimeCheckConfig(),
};
// Make the request
UptimeCheckConfig response = await uptimeCheckServiceClient.UpdateUptimeCheckConfigAsync(request);

UpdateUptimeCheckConfigAsync(UptimeCheckConfig, CallSettings)

public virtual Task<UptimeCheckConfig> UpdateUptimeCheckConfigAsync(UptimeCheckConfig uptimeCheckConfig, 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
NameDescription
uptimeCheckConfigUptimeCheckConfig

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskUptimeCheckConfig

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
UptimeCheckConfig uptimeCheckConfig = new UptimeCheckConfig();
// Make the request
UptimeCheckConfig response = await uptimeCheckServiceClient.UpdateUptimeCheckConfigAsync(uptimeCheckConfig);

UpdateUptimeCheckConfigAsync(UptimeCheckConfig, CancellationToken)

public virtual Task<UptimeCheckConfig> UpdateUptimeCheckConfigAsync(UptimeCheckConfig uptimeCheckConfig, CancellationToken cancellationToken)

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
uptimeCheckConfigUptimeCheckConfig

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.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskUptimeCheckConfig

A Task containing the RPC response.

Example
// Create client
UptimeCheckServiceClient uptimeCheckServiceClient = await UptimeCheckServiceClient.CreateAsync();
// Initialize request argument(s)
UptimeCheckConfig uptimeCheckConfig = new UptimeCheckConfig();
// Make the request
UptimeCheckConfig response = await uptimeCheckServiceClient.UpdateUptimeCheckConfigAsync(uptimeCheckConfig);