updateEnvironment method

Future<GoogleCloudApigeeV1Environment> updateEnvironment(GoogleCloudApigeeV1Environment request, String name, { String? $fields, })

Updates an existing environment.

When updating properties, you must pass all existing properties to the API, even if they are not being changed. If you omit properties from the payload, the properties are removed. To get the current list of properties for the environment, use the [Get Environment API](get). Note: Both PUT and POST methods are supported for updating an existing environment.

request - The metadata request object.

Request parameters:

name - Required. Name of the environment. Use the following structure in your request: organizations/{org}/environments/{env} Value must have pattern ^organizations/\[^/\]+/environments/\[^/\]+$.

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

Completes with a GoogleCloudApigeeV1Environment.

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<GoogleCloudApigeeV1Environment> updateEnvironment(
  GoogleCloudApigeeV1Environment request,
  core.String name, {
  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_ = 'v1/' + core.Uri.encodeFull('$name');

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