patch method

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

Updates specified tenant.

request - The metadata request object.

Request parameters:

name - Required during tenant update. The resource name for a tenant. This is generated by the service when a tenant is created. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar". Value must have pattern ^projects/\[^/\]+/tenants/\[^/\]+$.

updateMask - Strongly recommended for the best service experience. If update_mask is provided, only the specified fields in tenant are updated. Otherwise all the fields are updated. A field mask to specify the tenant fields to be updated. Only top level fields of Tenant are supported.

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

Completes with a Tenant.

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<Tenant> patch(
  Tenant 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_ = 'v4/' + core.Uri.encodeFull('$name');

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