update method
- GoogleCloudApigeeV1AppGroup request,
- String name, {
- String? action,
- String? $fields,
Updates an AppGroup.
This API replaces the existing AppGroup details with those specified in
the request. Include or exclude any existing details that you want to
retain or delete, respectively. Note that the state of the AppGroup should
be updated using action
, and not via AppGroup.
request
- The metadata request object.
Request parameters:
name
- Required. Name of the AppGroup. Use the following structure in
your request: organizations/{org}/appgroups/{app_group_name}
Value must have pattern ^organizations/\[^/\]+/appgroups/\[^/\]+$
.
action
- Activate or de-activate the AppGroup by setting the action as
active
or inactive
. The Content-Type
header must be set to
application/octet-stream
, with empty body.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a GoogleCloudApigeeV1AppGroup.
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<GoogleCloudApigeeV1AppGroup> update(
GoogleCloudApigeeV1AppGroup request,
core.String name, {
core.String? action,
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if (action != null) 'action': [action],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'PUT',
body: body_,
queryParams: queryParams_,
);
return GoogleCloudApigeeV1AppGroup.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}