Class ServiceMonitoringServiceClient (2.7.0)

ServiceMonitoringServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.monitoring_v3.services.service_monitoring_service.transports.base.ServiceMonitoringServiceTransport]] = 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 Cloud Monitoring Service-Oriented Monitoring API has endpoints for managing and querying aspects of a workspace's services. These include the Service's monitored resources, its Service-Level Objectives, and a taxonomy of categorized Health Metrics.

Properties

transport

Returns the transport used by the client instance.

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

Methods

ServiceMonitoringServiceClient

ServiceMonitoringServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.monitoring_v3.services.service_monitoring_service.transports.base.ServiceMonitoringServiceTransport]] = 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 service monitoring 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, ServiceMonitoringServiceTransport]` 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_service

create_service(request: Optional[Union[google.cloud.monitoring_v3.types.service_service.CreateServiceRequest, dict]] = None, *, parent: Optional[str] = None, service: Optional[google.cloud.monitoring_v3.types.service.Service] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Create a Service.

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.CreateServiceRequest, dict]` The request object. The `CreateService` request.
`parent`	`str` Required. Resource `name https://cloud.google.com/monitoring/api/v3#project_name`__ of the parent workspace. 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.
`service`	`google.cloud.monitoring_v3.types.Service` Required. The `Service` to create. This corresponds to the `service` 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.Service`	A Service is a discrete, autonomous, and network-accessible unit, designed to solve an individual concern ([Wikipedia](https://en.wikipedia.org/wiki/Service-orientation)). In Cloud Monitoring, a Service acts as the root resource under which operational aspects of the service are accessible.

create_service_level_objective

create_service_level_objective(request: Optional[Union[google.cloud.monitoring_v3.types.service_service.CreateServiceLevelObjectiveRequest, dict]] = None, *, parent: Optional[str] = None, service_level_objective: Optional[google.cloud.monitoring_v3.types.service.ServiceLevelObjective] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Create a ServiceLevelObjective for the given Service.

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.CreateServiceLevelObjectiveRequest, dict]` The request object. The `CreateServiceLevelObjective` request.
`parent`	`str` Required. Resource name of the parent `Service`. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`service_level_objective`	`google.cloud.monitoring_v3.types.ServiceLevelObjective` Required. The `ServiceLevelObjective` to create. The provided `name` will be respected if no `ServiceLevelObjective` exists with this name. This corresponds to the `service_level_objective` 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.ServiceLevelObjective A Service-Level Objective (SLO) describes a level of desired good service. It consists of a service-level indicator (SLI), a performance goal, and a period over which the objective is to be evaluated against that goal. The SLO can use SLIs defined in a number of different manners. Typical SLOs might include "99% of requests in each rolling week have latency below 200 milliseconds" or "99.5% of requests in each calendar month return successfully."

delete_service

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

Soft delete this Service.

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.DeleteServiceRequest, dict]` The request object. The `DeleteService` request.
`name`	`str` Required. Resource name of the `Service` to delete. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_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.

delete_service_level_objective

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

Delete the given ServiceLevelObjective.

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.DeleteServiceLevelObjectiveRequest, dict]` The request object. The `DeleteServiceLevelObjective` request.
`name`	`str` Required. Resource name of the `ServiceLevelObjective` to delete. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] 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
`ServiceMonitoringServiceClient`	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
`ServiceMonitoringServiceClient`	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
`ServiceMonitoringServiceClient`	The constructed client.

get_service

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

Get the named Service.

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.GetServiceRequest, dict]` The request object. The `GetService` request.
`name`	`str` Required. Resource name of the `Service`. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_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.Service`	A Service is a discrete, autonomous, and network-accessible unit, designed to solve an individual concern ([Wikipedia](https://en.wikipedia.org/wiki/Service-orientation)). In Cloud Monitoring, a Service acts as the root resource under which operational aspects of the service are accessible.

get_service_level_objective

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

Get a ServiceLevelObjective by name.

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.GetServiceLevelObjectiveRequest, dict]` The request object. The `GetServiceLevelObjective` request.
`name`	`str` Required. Resource name of the `ServiceLevelObjective` to get. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] 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

list_service_level_objectives

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

List the ServiceLevelObjective\ s for the given Service.

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.ListServiceLevelObjectivesRequest, dict]` The request object. The `ListServiceLevelObjectives` request.
`parent`	`str` Required. Resource name of the parent containing the listed SLOs, either a project or a Monitoring Workspace. The formats are: :: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] workspaces/[HOST_PROJECT_ID_OR_NUMBER]/services/- 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.service_monitoring_service.pagers.ListServiceLevelObjectivesPager`	The ListServiceLevelObjectives response. Iterating over this object will yield results and resolve additional pages automatically.

list_services

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

List Service\ s for this workspace.

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.ListServicesRequest, dict]` The request object. The `ListServices` request.
`parent`	`str` Required. Resource name of the parent containing the listed services, either a `project https://cloud.google.com/monitoring/api/v3#project_name`__ or a Monitoring Workspace. The formats are: :: projects/[PROJECT_ID_OR_NUMBER] workspaces/[HOST_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.service_monitoring_service.pagers.ListServicesPager`	The ListServices 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_service_level_objective_path

parse_service_level_objective_path(path: str)

Parses a service_level_objective path into its component segments.

parse_service_path

parse_service_path(path: str)

Parses a service path into its component segments.

service_level_objective_path

service_level_objective_path(
    project: str, service: str, service_level_objective: str
)

Returns a fully-qualified service_level_objective string.

service_path

service_path(project: str, service: str)

Returns a fully-qualified service string.

update_service

update_service(request: Optional[Union[google.cloud.monitoring_v3.types.service_service.UpdateServiceRequest, dict]] = None, *, service: Optional[google.cloud.monitoring_v3.types.service.Service] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Update this Service.

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.UpdateServiceRequest, dict]` The request object. The `UpdateService` request.
`service`	`google.cloud.monitoring_v3.types.Service` Required. The `Service` to draw updates from. The given `name` specifies the resource to update. This corresponds to the `service` 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.Service`	A Service is a discrete, autonomous, and network-accessible unit, designed to solve an individual concern ([Wikipedia](https://en.wikipedia.org/wiki/Service-orientation)). In Cloud Monitoring, a Service acts as the root resource under which operational aspects of the service are accessible.

update_service_level_objective

update_service_level_objective(request: Optional[Union[google.cloud.monitoring_v3.types.service_service.UpdateServiceLevelObjectiveRequest, dict]] = None, *, service_level_objective: Optional[google.cloud.monitoring_v3.types.service.ServiceLevelObjective] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Update the given ServiceLevelObjective.

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.UpdateServiceLevelObjectiveRequest, dict]` The request object. The `UpdateServiceLevelObjective` request.
`service_level_objective`	`google.cloud.monitoring_v3.types.ServiceLevelObjective` Required. The `ServiceLevelObjective` to draw updates from. The given `name` specifies the resource to update. This corresponds to the `service_level_objective` 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