Class UptimeCheckServiceClient

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

Inheritance

builtins.object > UptimeCheckServiceClient

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
UptimeCheckServiceTransportThe transport used by the client instance.

Methods

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

.. warning:: ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

Parameter
NameDescription
billing_account str

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

Parameter
NameDescription
folder str

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

Parameters
NameDescription
project str
location str

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

Parameter
NameDescription
organization str

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

Parameter
NameDescription
project str

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.

Parameters
NameDescription
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
TypeDescription
google.cloud.monitoring_v3.types.UptimeCheckConfigThis 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.

Parameters
NameDescription
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.

Parameters
NameDescription
filename str

The path to the service account private key json file.

args

Additional arguments to pass to the constructor.

kwargs

Additional arguments to pass to the constructor.

Returns
TypeDescription
UptimeCheckServiceClientThe 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.

Parameters
NameDescription
info dict

The service account private key info.

args

Additional arguments to pass to the constructor.

kwargs

Additional arguments to pass to the constructor.

Returns
TypeDescription
UptimeCheckServiceClientThe 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.

Parameters
NameDescription
filename str

The path to the service account private key json file.

args

Additional arguments to pass to the constructor.

kwargs

Additional arguments to pass to the constructor.

Returns
TypeDescription
UptimeCheckServiceClientThe constructed client.

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.

Parameters
NameDescription
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
TypeDescription
google.cloud.monitoring_v3.types.UptimeCheckConfigThis 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).

Parameters
NameDescription
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
TypeDescription
google.cloud.monitoring_v3.services.uptime_check_service.pagers.ListUptimeCheckConfigsPagerThe 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

Parameters
NameDescription
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
TypeDescription
google.cloud.monitoring_v3.services.uptime_check_service.pagers.ListUptimeCheckIpsPagerThe 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.

Parameter
NameDescription
path str

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

Parameter
NameDescription
path str

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

Parameter
NameDescription
path str

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

Parameter
NameDescription
path str

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

Parameter
NameDescription
path str

parse_uptime_check_config_path

parse_uptime_check_config_path(path: str)

Parses a uptime_check_config path into its component segments.

Parameter
NameDescription
path str

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.

Parameters
NameDescription
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
TypeDescription
google.cloud.monitoring_v3.types.UptimeCheckConfigThis 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.

Parameters
NameDescription
project str
uptime_check_config str