Google Cloud Monitoring v3 API - Class UptimeCheckServiceClient (3.4.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 <