Class UptimeCheckServiceClient (2.23.1)

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

Return the API endpoint used by the client instance.

Returns the transport used by the client instance.

Return the universe domain used by the client instance.

Instantiates the uptime check service client.

Releases underlying transport's resources.

Returns a fully-qualified billing_account string.

Returns a fully-qualified folder string.

Returns a fully-qualified location string.

Returns a fully-qualified organization string.

Returns a fully-qualified project string.

Creates a new Uptime check configuration.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import monitoring_v3

def sample_create_uptime_check_config():
    # Create a client
    client = monitoring_v3.UptimeCheckServiceClient()

    # Initialize request argument(s)
    request = monitoring_v3.CreateUptimeCheckConfigRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_uptime_check_config(request=request)

    # Handle the response
    print(response)

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import monitoring_v3

def sample_delete_uptime_check_config():
    # Create a client
    client = monitoring_v3.UptimeCheckServiceClient()

    # Initialize request argument(s)
    request = monitoring_v3.DeleteUptimeCheckConfigRequest(
        name="name_value",
    )

    # Make the request
    client.delete_uptime_check_config(request=request)

Creates an instance of this client using the provided credentials file.

Creates an instance of this client using the provided credentials info.

Creates an instance of this client using the provided credentials file.

Returns a fully-qualified function string.

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Gets a single Uptime check configuration.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import monitoring_v3

def sample_get_uptime_check_config():
    # Create a client
    client = monitoring_v3.UptimeCheckServiceClient()

    # Initialize request argument(s)
    request = monitoring_v3.GetUptimeCheckConfigRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_uptime_check_config(request=request)

    # Handle the response
    print(response)

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import monitoring_v3

def sample_list_uptime_check_configs():
    # Create a client
    client = monitoring_v3.UptimeCheckServiceClient()

    # Initialize request argument(s)
    request = monitoring_v3.ListUptimeCheckConfigsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_uptime_check_configs(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Returns the list of IP addresses that checkers run from

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import monitoring_v3

def sample_list_uptime_check_ips():
    # Create a client
    client = monitoring_v3.UptimeCheckServiceClient()

    # Initialize request argument(s)
    request = monitoring_v3.ListUptimeCheckIpsRequest(
    )

    # Make the request
    page_result = client.list_uptime_check_ips(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parse a billing_account path into its component segments.

Parse a folder path into its component segments.

Parse a location path into its component segments.

Parse a organization path into its component segments.

Parse a project path into its component segments.

Parses a function path into its component segments.

Parses a uptime_check_config path into its component segments.

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import monitoring_v3

def sample_update_uptime_check_config():
    # Create a client
    client = monitoring_v3.UptimeCheckServiceClient()

    # Initialize request argument(s)
    request = monitoring_v3.UpdateUptimeCheckConfigRequest(
    )

    # Make the request
    response = client.update_uptime_check_config(request=request)

    # Handle the response
    print(response)

Returns a fully-qualified uptime_check_config string.