Reference documentation and code samples for the Stackdriver Monitoring V3 Client class UpdateAlertPolicyRequest.
The protocol for the UpdateAlertPolicy
request.
Generated from protobuf message google.monitoring.v3.UpdateAlertPolicyRequest
Namespace
Google \ Cloud \ Monitoring \ V3Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ update_mask |
Google\Protobuf\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\AlertPolicy
Required. The updated alerting policy or the updated values for the fields listed in |
getUpdateMask
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
),
or to the field's default value if the field is not in the supplied
alerting policy. Fields not listed retain their previous value.
Examples of valid field masks include display_name
, documentation
,
documentation.content
, documentation.mime_type
, user_labels
,
user_label.nameofkey
, enabled
, conditions
, combiner
, etc.
If this field is empty, then the supplied alerting policy replaces the
existing policy. It is the same as deleting the existing policy and
adding the supplied policy, except for the following:
- The new policy will have the same
[ALERT_POLICY_ID]
as the former policy. This gives you continuity with the former policy in your notifications and incidents. - Conditions in the new policy will keep their former
[CONDITION_ID]
if the supplied condition includes thename
field with that[CONDITION_ID]
. If the supplied condition omits thename
field, then a new[CONDITION_ID]
is created.
Returns | |
---|---|
Type | Description |
Google\Protobuf\FieldMask|null |
hasUpdateMask
clearUpdateMask
setUpdateMask
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
),
or to the field's default value if the field is not in the supplied
alerting policy. Fields not listed retain their previous value.
Examples of valid field masks include display_name
, documentation
,
documentation.content
, documentation.mime_type
, user_labels
,
user_label.nameofkey
, enabled
, conditions
, combiner
, etc.
If this field is empty, then the supplied alerting policy replaces the
existing policy. It is the same as deleting the existing policy and
adding the supplied policy, except for the following:
- The new policy will have the same
[ALERT_POLICY_ID]
as the former policy. This gives you continuity with the former policy in your notifications and incidents. - Conditions in the new policy will keep their former
[CONDITION_ID]
if the supplied condition includes thename
field with that[CONDITION_ID]
. If the supplied condition omits thename
field, then a new[CONDITION_ID]
is created.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\FieldMask
|
Returns | |
---|---|
Type | Description |
$this |
getAlertPolicy
Required. The updated alerting policy or the updated values for the
fields listed in update_mask
.
If update_mask
is not empty, any fields in this policy that are
not in update_mask
are ignored.
Returns | |
---|---|
Type | Description |
Google\Cloud\Monitoring\V3\AlertPolicy|null |
hasAlertPolicy
clearAlertPolicy
setAlertPolicy
Required. The updated alerting policy or the updated values for the
fields listed in update_mask
.
If update_mask
is not empty, any fields in this policy that are
not in update_mask
are ignored.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Monitoring\V3\AlertPolicy
|
Returns | |
---|---|
Type | Description |
$this |
static::build
Parameters | |
---|---|
Name | Description |
updateMask |
Google\Protobuf\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 ( Examples of valid field masks include If this field is empty, then the supplied alerting policy replaces the existing policy. It is the same as deleting the existing policy and adding the supplied policy, except for the following:
|
alertPolicy |
Google\Cloud\Monitoring\V3\AlertPolicy
Required. The updated alerting policy or the updated values for the
fields listed in |
Returns | |
---|---|
Type | Description |
Google\Cloud\Monitoring\V3\UpdateAlertPolicyRequest |