update method
Updates an existing group.
You can change any group attributes except name.
request
- The metadata request object.
Request parameters:
name
- Output only. The name of this group. The format is:
projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] When creating a
group, this field is ignored and a new name is created consisting of the
project specified in the call to CreateGroup and a unique [GROUP_ID]
that is generated automatically.
Value must have pattern ^projects/\[^/\]+/groups/\[^/\]+$
.
validateOnly
- If true, validate this request but do not update the
existing group.
$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> update(
Group request,
core.String name, {
core.bool? validateOnly,
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if (validateOnly != null) 'validateOnly': ['${validateOnly}'],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v3/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'PUT',
body: body_,
queryParams: queryParams_,
);
return Group.fromJson(response_ as core.Map<core.String, core.dynamic>);
}