Class: Google::Cloud::Monitoring::V3::UpdateAlertPolicyRequest

Inherits:

Object

Object
Google::Cloud::Monitoring::V3::UpdateAlertPolicyRequest

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/monitoring/v3/alert_service.rb

Overview

The protocol for the UpdateAlertPolicy request.

Instance Attribute Summary collapse

#alert_policy ⇒ ::Google::Cloud::Monitoring::V3::AlertPolicy
Required.
#update_mask ⇒ ::Google::Protobuf::FieldMask
Optional.

Instance Attribute Details

#alert_policy ⇒ `::Google::Cloud::Monitoring::V3::AlertPolicy`

Returns 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:

(::Google::Cloud::Monitoring::V3::AlertPolicy) —
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.

# File 'proto_docs/google/monitoring/v3/alert_service.rb', line 151

class UpdateAlertPolicyRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#update_mask ⇒ `::Google::Protobuf::FieldMask`

Returns 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 the name field with that [CONDITION_ID]. If the supplied condition omits the name field, then a new [CONDITION_ID] is created.