patch method

Future<Operation> patch(
  1. PrivateCloud request,
  2. String name, {
  3. String? requestId,
  4. String? updateMask,
  5. bool? validateOnly,
  6. String? $fields,
})

Modifies a PrivateCloud resource.

Only the following fields can be updated: description, encryption_config. If updateMask is provided, only fields specified in it are applied. If updateMask is not provided, the default behavior is to update the description. It is advised to provide an updateMask to avoid confusion. During operation processing, the resource is temporarily in the ACTIVE state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.

request - The metadata request object.

Request parameters:

name - Output only. Identifier. The resource name of this private cloud. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/privateClouds/\[^/\]+$.

requestId - Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

updateMask - Required. Field mask is used to specify the fields to be overwritten in the PrivateCloud resource by the update. The fields specified in updateMask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the description field will be overwritten.

validateOnly - Optional. If set to true, only validates the request but doesn’t execute the request. If set to false, validates and executes the request.

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

Completes with a Operation.

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

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

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