patch method
Updates a Snooze, identified by its name, with the parameters in the given Snooze object.
request
- The metadata request object.
Request parameters:
name
- Required. Identifier. The name of the Snooze. The format is:
projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the
Snooze will be generated by the system.
Value must have pattern ^projects/\[^/\]+/snoozes/\[^/\]+$
.
updateMask
- Required. The fields to update.For each field listed in
update_mask: If the Snooze object supplied in the UpdateSnoozeRequest has
a value for that field, the value of the field in the existing Snooze will
be set to the value of the field in the supplied Snooze. If the field does
not have a value in the supplied Snooze, the field in the existing Snooze
is set to its default value.Fields not listed retain their existing
value.The following are the field names that are accepted in update_mask:
display_name interval.start_time interval.end_timeThat said, the start
time and end time of the Snooze determines which fields can legally be
updated. Before attempting an update, users should consult the
documentation for UpdateSnoozeRequest, which talks about which fields can
be updated.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a Snooze.
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<Snooze> patch(
Snooze 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 Snooze.fromJson(response_ as core.Map<core.String, core.dynamic>);
}