patch method

Future<GoogleCloudApihubV1Api> patch(
  1. GoogleCloudApihubV1Api request,
  2. String name, {
  3. String? updateMask,
  4. String? $fields,
})

Update an API resource in the API hub.

The following fields in the API can be updated: * display_name * description * owner * documentation * target_user * team * business_unit * maturity_level * api_style * attributes The update_mask should be used to specify the fields being updated. Updating the owner field requires complete owner message and updates both owner and email fields.

request - The metadata request object.

Request parameters:

name - Identifier. The name of the API resource in the API Hub. Format: projects/{project}/locations/{location}/apis/{api} Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/apis/\[^/\]+$.

updateMask - Required. The list of fields to update.

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

Completes with a GoogleCloudApihubV1Api.

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<GoogleCloudApihubV1Api> patch(
  GoogleCloudApihubV1Api request,
  core.String name, {
  core.String? updateMask,
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    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 GoogleCloudApihubV1Api.fromJson(
    response_ as core.Map<core.String, core.dynamic>,
  );
}