Reference documentation and code samples for the Stackdriver Monitoring V3 Client class AlertStrategy.
Control over how the notification channels in notification_channels
are notified when this alert fires.
Generated from protobuf message google.monitoring.v3.AlertPolicy.AlertStrategy
Namespace
Google \ Cloud \ Monitoring \ V3 \ AlertPolicyMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ notification_rate_limit |
AlertStrategy\NotificationRateLimit
Required for log-based alerting policies, i.e. policies with a |
↳ notification_prompts |
array
For log-based alert policies, the notification prompts is always [OPENED]. For non log-based alert policies, the notification prompts can be [OPENED] or [OPENED, CLOSED]. |
↳ auto_close |
Google\Protobuf\Duration
If an alerting policy that was active has no data for this long, any open incidents will close |
↳ notification_channel_strategy |
array<AlertStrategy\NotificationChannelStrategy>
Control how notifications will be sent out, on a per-channel basis. |
getNotificationRateLimit
Required for log-based alerting policies, i.e. policies with a LogMatch
condition.
This limit is not implemented for alerting policies that do not have a LogMatch condition.
| Returns | |
|---|---|
| Type | Description |
AlertStrategy\NotificationRateLimit|null |
|
hasNotificationRateLimit
clearNotificationRateLimit
setNotificationRateLimit
Required for log-based alerting policies, i.e. policies with a LogMatch
condition.
This limit is not implemented for alerting policies that do not have a LogMatch condition.
| Parameter | |
|---|---|
| Name | Description |
var |
AlertStrategy\NotificationRateLimit
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNotificationPrompts
For log-based alert policies, the notification prompts is always [OPENED]. For non log-based alert policies, the notification prompts can be [OPENED] or [OPENED, CLOSED].
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setNotificationPrompts
For log-based alert policies, the notification prompts is always [OPENED]. For non log-based alert policies, the notification prompts can be [OPENED] or [OPENED, CLOSED].
| Parameter | |
|---|---|
| Name | Description |
var |
int[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAutoClose
If an alerting policy that was active has no data for this long, any open incidents will close
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasAutoClose
clearAutoClose
setAutoClose
If an alerting policy that was active has no data for this long, any open incidents will close
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNotificationChannelStrategy
Control how notifications will be sent out, on a per-channel basis.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setNotificationChannelStrategy
Control how notifications will be sent out, on a per-channel basis.
| Parameter | |
|---|---|
| Name | Description |
var |
array<AlertStrategy\NotificationChannelStrategy>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|