Class UptimeCheckServiceClient (2.9.2)

UptimeCheckServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.monitoring_v3.services.uptime_check_service.transports.base.UptimeCheckServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

The UptimeCheckService API is used to manage (list, create, delete, edit) Uptime check configurations in the Stackdriver 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 Stackdriver, and then clicking on "Uptime".

Properties

transport

Returns the transport used by the client instance.

Returns
Type	Description
`UptimeCheckServiceTransport`	The transport used by the client instance.

Methods

UptimeCheckServiceClient

UptimeCheckServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.monitoring_v3.services.uptime_check_service.transports.base.UptimeCheckServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the uptime check service client.

Parameters
Name	Description
`credentials`	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
`transport`	`Union[str, UptimeCheckServiceTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
`client_info`	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If mutual TLS transport creation failed for any reason.

exit

__exit__(type, value, traceback)

Releases underlying transport's resources.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_uptime_check_config

create_uptime_check_config(request: Optional[Union[google.cloud.monitoring_v3.types.uptime_service.CreateUptimeCheckConfigRequest, dict]] = None, *, parent: Optional[str] = None, uptime_check_config: Optional[google.cloud.monitoring_v3.types.uptime.UptimeCheckConfig] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new Uptime check configuration.

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)

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.CreateUptimeCheckConfigRequest, dict]` The request object. The protocol for the `CreateUptimeCheckConfig` request.
`parent`	`str` Required. The `project https://cloud.google.com/monitoring/api/v3#project_name`__ in which to create the Uptime check. The format is: :: projects/[PROJECT_ID_OR_NUMBER] This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`uptime_check_config`	`google.cloud.monitoring_v3.types.UptimeCheckConfig` Required. The new Uptime check configuration. This corresponds to the `uptime_check_config` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.monitoring_v3.types.UptimeCheckConfig`	This message configures which resources and services to monitor for availability.

delete_uptime_check_config

delete_uptime_check_config(request: Optional[Union[google.cloud.monitoring_v3.types.uptime_service.DeleteUptimeCheckConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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.

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)

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.DeleteUptimeCheckConfigRequest, dict]` The request object. The protocol for the `DeleteUptimeCheckConfig` request.
`name`	`str` Required. The Uptime check configuration to delete. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

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

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`UptimeCheckServiceClient`	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

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

Parameter
Name	Description
`info`	`dict` The service account private key info.

Returns
Type	Description
`UptimeCheckServiceClient`	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

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

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`UptimeCheckServiceClient`	The constructed client.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)

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

Parameter
Name	Description
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. Only the `api_endpoint` and `client_cert_source` properties may be used in this method.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If any errors happen.

Returns
Type	Description
`Tuple[str, Callable[[], Tuple[bytes, bytes]]]`	returns the API endpoint and the client cert source to use.

get_uptime_check_config

get_uptime_check_config(request: Optional[Union[google.cloud.monitoring_v3.types.uptime_service.GetUptimeCheckConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a single Uptime check configuration.

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)

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.GetUptimeCheckConfigRequest, dict]` The request object. The protocol for the `GetUptimeCheckConfig` request.
`name`	`str` Required. The Uptime check configuration to retrieve. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.monitoring_v3.types.UptimeCheckConfig`	This message configures which resources and services to monitor for availability.

list_uptime_check_configs

list_uptime_check_configs(request: Optional[Union[google.cloud.monitoring_v3.types.uptime_service.ListUptimeCheckConfigsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

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)

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.ListUptimeCheckConfigsRequest, dict]` The request object. The protocol for the `ListUptimeCheckConfigs` request.
`parent`	`str` Required. The `project https://cloud.google.com/monitoring/api/v3#project_name`__ whose Uptime check configurations are listed. The format is: :: projects/[PROJECT_ID_OR_NUMBER] This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.monitoring_v3.services.uptime_check_service.pagers.ListUptimeCheckConfigsPager`	The protocol for the ListUptimeCheckConfigs response. Iterating over this object will yield results and resolve additional pages automatically.

list_uptime_check_ips

list_uptime_check_ips(request: Optional[Union[google.cloud.monitoring_v3.types.uptime_service.ListUptimeCheckIpsRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns the list of IP addresses that checkers run from

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)

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.ListUptimeCheckIpsRequest, dict]` The request object. The protocol for the `ListUptimeCheckIps` request.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.monitoring_v3.services.uptime_check_service.pagers.ListUptimeCheckIpsPager`	The protocol for the ListUptimeCheckIps response. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_uptime_check_config_path

parse_uptime_check_config_path(path: str)

Parses a uptime_check_config path into its component segments.

update_uptime_check_config

update_uptime_check_config(request: Optional[Union[google.cloud.monitoring_v3.types.uptime_service.UpdateUptimeCheckConfigRequest, dict]] = None, *, uptime_check_config: Optional[google.cloud.monitoring_v3.types.uptime.UptimeCheckConfig] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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.

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)

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.UpdateUptimeCheckConfigRequest, dict]` The request object. The protocol for the `UpdateUptimeCheckConfig` request.
`uptime_check_config`	`google.cloud.monitoring_v3.types.UptimeCheckConfig` 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 corresonding 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`. This corresponds to the `uptime_check_config` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.monitoring_v3.types.UptimeCheckConfig`	This message configures which resources and services to monitor for availability.

uptime_check_config_path

uptime_check_config_path(project: str, uptime_check_config: str)

Returns a fully-qualified uptime_check_config string.