AlertPolicyServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.monitoring_v3.services.alert_policy_service.transports.base.AlertPolicyServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
The AlertPolicyService API is used to manage (list, create, delete,
edit) alert policies in Cloud Monitoring. An alerting policy is a
description of the conditions under which some aspect of your system
is considered to be "unhealthy" and the ways to notify people or
services about this state. In addition to using this API, alert
policies can also be managed through Cloud
Monitoring <https://cloud.google.com/monitoring/docs/>
, which can
be reached by clicking the "Monitoring" tab in Cloud
console <https://console.cloud.google.com/>
.
Properties
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
AlertPolicyServiceTransport | The transport used by the client instance. |
Methods
AlertPolicyServiceClient
AlertPolicyServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.monitoring_v3.services.alert_policy_service.transports.base.AlertPolicyServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the alert policy 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, AlertPolicyServiceTransport]
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
Optional[Union[google.api_core.client_options.ClientOptions, dict]]
Custom options for the client. It won't take effect if a |
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 |
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.
alert_policy_condition_path
alert_policy_condition_path(project: str, alert_policy: str, condition: str) -> str
Returns a fully-qualified alert_policy_condition string.
alert_policy_path
alert_policy_path(project: str, alert_policy: str) -> str
Returns a fully-qualified alert_policy string.
common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
create_alert_policy
create_alert_policy(
request: typing.Optional[
typing.Union[
google.cloud.monitoring_v3.types.alert_service.CreateAlertPolicyRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
alert_policy: typing.Optional[
google.cloud.monitoring_v3.types.alert.AlertPolicy
] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.monitoring_v3.types.alert.AlertPolicy
Creates a new alerting policy.
Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.
# 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_alert_policy():
# Create a client
client = monitoring_v3.AlertPolicyServiceClient()
# Initialize request argument(s)
request = monitoring_v3.CreateAlertPolicyRequest(
name="name_value",
)
# Make the request
response = client.create_alert_policy(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.monitoring_v3.types.CreateAlertPolicyRequest, dict]
The request object. The protocol for the |
name |
str
Required. The |
alert_policy |
google.cloud.monitoring_v3.types.AlertPolicy
Required. The requested alerting policy. You should omit the |
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.AlertPolicy | A description of the conditions under which some aspect of your system is considered to be "unhealthy" and the ways to notify people or services about this state. For an overview of alert policies, see [Introduction to Alerting](\ https://cloud.google.com/monitoring/alerts/). |
delete_alert_policy
delete_alert_policy(
request: typing.Optional[
typing.Union[
google.cloud.monitoring_v3.types.alert_service.DeleteAlertPolicyRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes an alerting policy.
Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.
# 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_alert_policy():
# Create a client
client = monitoring_v3.AlertPolicyServiceClient()
# Initialize request argument(s)
request = monitoring_v3.DeleteAlertPolicyRequest(
name="name_value",
)
# Make the request
client.delete_alert_policy(request=request)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.monitoring_v3.types.DeleteAlertPolicyRequest, dict]
The request object. The protocol for the |
name |
str
Required. The alerting policy to delete. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] For more information, see |
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 |
AlertPolicyServiceClient | 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 |
AlertPolicyServiceClient | 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 |
AlertPolicyServiceClient | The constructed client. |
get_alert_policy
get_alert_policy(
request: typing.Optional[
typing.Union[
google.cloud.monitoring_v3.types.alert_service.GetAlertPolicyRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.monitoring_v3.types.alert.AlertPolicy
Gets a single alerting policy.
# 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_alert_policy():
# Create a client
client = monitoring_v3.AlertPolicyServiceClient()
# Initialize request argument(s)
request = monitoring_v3.GetAlertPolicyRequest(
name="name_value",
)
# Make the request
response = client.get_alert_policy(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.monitoring_v3.types.GetAlertPolicyRequest, dict]
The request object. The protocol for the |
name |
str
Required. The alerting policy to retrieve. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] This corresponds to the |
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.AlertPolicy | A description of the conditions under which some aspect of your system is considered to be "unhealthy" and the ways to notify people or services about this state. For an overview of alert policies, see [Introduction to Alerting](\ https://cloud.google.com/monitoring/alerts/). |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.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 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.
Parameter | |
---|---|
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
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. |
list_alert_policies
list_alert_policies(
request: typing.Optional[
typing.Union[
google.cloud.monitoring_v3.types.alert_service.ListAlertPoliciesRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.monitoring_v3.services.alert_policy_service.pagers.ListAlertPoliciesPager
)
Lists the existing alerting policies for the workspace.
# 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_alert_policies():
# Create a client
client = monitoring_v3.AlertPolicyServiceClient()
# Initialize request argument(s)
request = monitoring_v3.ListAlertPoliciesRequest(
name="name_value",
)
# Make the request
page_result = client.list_alert_policies(request=request)
# Handle the response
for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.monitoring_v3.types.ListAlertPoliciesRequest, dict]
The request object. The protocol for the |
name |
str
Required. The |
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.alert_policy_service.pagers.ListAlertPoliciesPager | The protocol for the ListAlertPolicies response. Iterating over this object will yield results and resolve additional pages automatically. |
parse_alert_policy_condition_path
parse_alert_policy_condition_path(path: str) -> typing.Dict[str, str]
Parses a alert_policy_condition path into its component segments.
parse_alert_policy_path
parse_alert_policy_path(path: str) -> typing.Dict[str, str]
Parses a alert_policy path into its component segments.
parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
update_alert_policy
update_alert_policy(
request: typing.Optional[
typing.Union[
google.cloud.monitoring_v3.types.alert_service.UpdateAlertPolicyRequest,
dict,
]
] = None,
*,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
alert_policy: typing.Optional[
google.cloud.monitoring_v3.types.alert.AlertPolicy
] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.monitoring_v3.types.alert.AlertPolicy
Updates an alerting policy. You can either replace the entire
policy with a new one or replace only certain fields in the
current alerting policy by specifying the fields to be updated
via updateMask
. Returns the updated alerting policy.
Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.
# 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_alert_policy():
# Create a client
client = monitoring_v3.AlertPolicyServiceClient()
# Initialize request argument(s)
request = monitoring_v3.UpdateAlertPolicyRequest(
)
# Make the request
response = client.update_alert_policy(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.monitoring_v3.types.UpdateAlertPolicyRequest, dict]
The request object. The protocol for the |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
Optional. A list of alerting policy field names. If this field is not empty, each listed field in the existing alerting policy is set to the value of the corresponding field in the supplied policy ( |
alert_policy |
google.cloud.monitoring_v3.types.AlertPolicy
Required. The updated alerting policy or the updated values for the fields listed in |
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.AlertPolicy | A description of the conditions under which some aspect of your system is considered to be "unhealthy" and the ways to notify people or services about this state. For an overview of alert policies, see [Introduction to Alerting](\ https://cloud.google.com/monitoring/alerts/). |