patch method

Future<Group> patch(
  1. Group request,
  2. String groupKey, {
  3. String? $fields,
})

Updates a group's properties.

This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch).

request - The metadata request object.

Request parameters:

groupKey - Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.

$fields - Selector specifying which fields to include in a partial response.

Completes with a Group.

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<Group> patch(
  Group request,
  core.String groupKey, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ =
      'admin/directory/v1/groups/' + commons.escapeVariable('$groupKey');

  final response_ = await _requester.request(
    url_,
    'PATCH',
    body: body_,
    queryParams: queryParams_,
  );
  return Group.fromJson(response_ as core.Map<core.String, core.dynamic>);
}