patch method

Future<Api> patch(Api request, String name, { bool? allowMissing, String? updateMask, String? $fields, })

Used to modify a specified API.

request - The metadata request object.

Request parameters:

name - Resource name. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/apis/\[^/\]+$.

allowMissing - If set to true, and the API is not found, a new API will be created. In this situation, update_mask is ignored.

updateMask - The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request.

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

Completes with a Api.

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

  final url_ = 'v1/' + core.Uri.encodeFull('$name');

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