Stackdriver Monitoring V3 Client - Class AlertPolicy (1.9.0)

Reference documentation and code samples for the Stackdriver Monitoring V3 Client class 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.

Generated from protobuf message google.monitoring.v3.AlertPolicy

Namespace

Google \ Cloud \ Monitoring \ V3

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] `[ALERT_POLICY_ID]` is assigned by Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the `name` field in the alerting policy passed as part of the request.
`↳ display_name`	`string` A short name or phrase used to identify the policy in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple policies in the same project. The name is limited to 512 Unicode characters. The convention for the display_name of a PrometheusQueryLanguageCondition is "{rule group name}/{alert name}", where the {rule group name} and {alert name} should be taken from the corresponding Prometheus configuration file. This convention is not enforced. In any case the display_name is not a unique key of the AlertPolicy.
`↳ documentation`	`Google\Cloud\Monitoring\V3\AlertPolicy\Documentation` Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation.
`↳ user_labels`	`array\|Google\Protobuf\Internal\MapField` User-supplied key/value data to be used for organizing and identifying the `AlertPolicy` objects. The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter. Note that Prometheus {alert name} is a valid Prometheus label names, whereas Prometheus {rule group} is an unrestricted UTF-8 string. This means that they cannot be stored as-is in user labels, because they may contain characters that are not allowed in user-label values.
`↳ conditions`	`array<Google\Cloud\Monitoring\V3\AlertPolicy\Condition>` A list of conditions for the policy. The conditions are combined by AND or OR according to the `combiner` field. If the combined conditions evaluate to true, then an incident is created. A policy can have from one to six conditions. If `condition_time_series_query_language` is present, it must be the only `condition`. If `condition_monitoring_query_language` is present, it must be the only `condition`.
`↳ combiner`	`int` How to combine the results of multiple conditions to determine if an incident should be opened. If `condition_time_series_query_language` is present, this must be `COMBINE_UNSPECIFIED`.
`↳ enabled`	`Google\Protobuf\BoolValue` Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out.
`↳ validity`	`Google\Rpc\Status` Read-only description of how the alert policy is invalid. This field is only set when the alert policy is invalid. An invalid alert policy will not generate incidents.
`↳ notification_channels`	`array` Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident. Each element of this array corresponds to the `name` field in each of the `NotificationChannel` objects that are returned from the [`ListNotificationChannels`] [google.monitoring.v3.NotificationChannelService.ListNotificationChannels] method. The format of the entries in this field is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
`↳ creation_record`	`Google\Cloud\Monitoring\V3\MutationRecord` A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored.
`↳ mutation_record`	`Google\Cloud\Monitoring\V3\MutationRecord` A read-only record of the most recent change to the alerting policy. If provided in a call to create or update, this field will be ignored.
`↳ alert_strategy`	`Google\Cloud\Monitoring\V3\AlertPolicy\AlertStrategy` Control over how this alert policy's notification channels are notified.
`↳ severity`	`int` Optional. The severity of an alert policy indicates how important incidents generated by that policy are. The severity level will be displayed on the Incident detail page and in notifications.

getName

Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request.

Returns
Type	Description
`string`

setName

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

A short name or phrase used to identify the policy in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple policies in the same project. The name is limited to 512 Unicode characters.

The convention for the display_name of a PrometheusQueryLanguageCondition is "{rule group name}/{alert name}", where the {rule group name} and {alert name} should be taken from the corresponding Prometheus configuration file. This convention is not enforced. In any case the display_name is not a unique key of the AlertPolicy.

Returns
Type	Description
`string`

setDisplayName

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDocumentation

Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation.

Returns
Type	Description
`Google\Cloud\Monitoring\V3\AlertPolicy\Documentation\|null`

hasDocumentation

clearDocumentation

setDocumentation

Parameter
Name	Description
`var`	`Google\Cloud\Monitoring\V3\AlertPolicy\Documentation`

Returns
Type	Description
`$this`

getUserLabels

User-supplied key/value data to be used for organizing and identifying the AlertPolicy objects.

The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter. Note that Prometheus {alert name} is a valid Prometheus label names, whereas Prometheus {rule group} is an unrestricted UTF-8 string. This means that they cannot be stored as-is in user labels, because they may contain characters that are not allowed in user-label values.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setUserLabels

User-supplied key/value data to be used for organizing and identifying the AlertPolicy objects.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getConditions

A list of conditions for the policy. The conditions are combined by AND or OR according to the combiner field. If the combined conditions evaluate to true, then an incident is created. A policy can have from one to six conditions.

If condition_time_series_query_language is present, it must be the only condition. If condition_monitoring_query_language is present, it must be the only condition.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setConditions

If condition_time_series_query_language is present, it must be the only condition. If condition_monitoring_query_language is present, it must be the only condition.

Parameter
Name	Description
`var`	`array<Google\Cloud\Monitoring\V3\AlertPolicy\Condition>`

Returns
Type	Description
`$this`

getCombiner

How to combine the results of multiple conditions to determine if an incident should be opened.

If condition_time_series_query_language is present, this must be COMBINE_UNSPECIFIED.

Returns
Type	Description
`int`

setCombiner

How to combine the results of multiple conditions to determine if an incident should be opened.

If condition_time_series_query_language is present, this must be COMBINE_UNSPECIFIED.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getEnabled

Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out.

Returns
Type	Description
`Google\Protobuf\BoolValue\|null`

hasEnabled

clearEnabled

getEnabledValue

Returns the unboxed value from getEnabled()

Returns
Type	Description
`bool\|null`

setEnabled

Parameter
Name	Description
`var`	`Google\Protobuf\BoolValue`

Returns
Type	Description
`$this`

setEnabledValue

Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.

Parameter
Name	Description
`var`	`bool\|null`

Returns
Type	Description
`$this`

getValidity

Read-only description of how the alert policy is invalid. This field is only set when the alert policy is invalid. An invalid alert policy will not generate incidents.

Returns
Type	Description
`Google\Rpc\Status\|null`

hasValidity

clearValidity

setValidity

Read-only description of how the alert policy is invalid. This field is only set when the alert policy is invalid. An invalid alert policy will not generate incidents.

Parameter
Name	Description
`var`	`Google\Rpc\Status`

Returns
Type	Description
`$this`

getNotificationChannels

Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident. Each element of this array corresponds to the name field in each of the NotificationChannel objects that are returned from the ListNotificationChannels method. The format of the entries in this field is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setNotificationChannels

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getCreationRecord

A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored.

Returns
Type	Description
`Google\Cloud\Monitoring\V3\MutationRecord\|null`

hasCreationRecord

clearCreationRecord

setCreationRecord

A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored.

Parameter
Name	Description
`var`	`Google\Cloud\Monitoring\V3\MutationRecord`

Returns
Type	Description
`$this`

getMutationRecord

A read-only record of the most recent change to the alerting policy. If provided in a call to create or update, this field will be ignored.

Returns
Type	Description
`Google\Cloud\Monitoring\V3\MutationRecord\|null`

hasMutationRecord

clearMutationRecord

setMutationRecord

A read-only record of the most recent change to the alerting policy. If provided in a call to create or update, this field will be ignored.

Parameter
Name	Description
`var`	`Google\Cloud\Monitoring\V3\MutationRecord`

Returns
Type	Description
`$this`

getAlertStrategy

Control over how this alert policy's notification channels are notified.

Returns
Type	Description
`Google\Cloud\Monitoring\V3\AlertPolicy\AlertStrategy\|null`

hasAlertStrategy

clearAlertStrategy

setAlertStrategy

Control over how this alert policy's notification channels are notified.

Parameter
Name	Description
`var`	`Google\Cloud\Monitoring\V3\AlertPolicy\AlertStrategy`

Returns
Type	Description
`$this`

getSeverity

Optional. The severity of an alert policy indicates how important incidents generated by that policy are. The severity level will be displayed on the Incident detail page and in notifications.

Returns
Type	Description
`int`

setSeverity

Optional. The severity of an alert policy indicates how important incidents generated by that policy are. The severity level will be displayed on the Incident detail page and in notifications.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`