patch method

Future<Operation> patch(Target request, String name, { bool? allowMissing, String? requestId, String? updateMask, bool? validateOnly, String? $fields, })

Updates the parameters of a single Target.

request - The metadata request object.

Request parameters:

name - Optional. Name of the Target. Format is projects/{project}/locations/{location}/targets/a-z{0,62}. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/targets/\[^/\]+$.

allowMissing - Optional. If set to true, updating a Target that does not exist will result in the creation of a new Target.

requestId - Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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 Target resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it's in the mask. If the user doesn't provide a mask then all fields are overwritten.

validateOnly - Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

$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(
  Target request,
  core.String name, {
  core.bool? allowMissing,
  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>>{
    if (allowMissing != null) 'allowMissing': ['${allowMissing}'],
    if (requestId != null) 'requestId': [requestId],
    if (updateMask != null) 'updateMask': [updateMask],
    if (validateOnly != null) 'validateOnly': ['${validateOnly}'],
    if ($fields != null) 'fields': [$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>);
}