patch method
- AlertPolicy request,
- String name, {
- String? updateMask,
- String? $fields,
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.
request
- The metadata request object.
Request parameters:
name
- 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.
Value must have pattern ^projects/\[^/\]+/alertPolicies/\[^/\]+$
.
updateMask
- 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.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a AlertPolicy.
Completes with a commons.ApiRequestError if the API endpoint returned an error.
If the used http.Client
completes with an error when making a REST call,
this method will complete with the same error.
Implementation
async.Future<AlertPolicy> patch(
AlertPolicy request,
core.String name, {
core.String? updateMask,
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if (updateMask != null) 'updateMask': [updateMask],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v3/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'PATCH',
body: body_,
queryParams: queryParams_,
);
return AlertPolicy.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}