patch method
Updates the parameters of a source.
request
- The metadata request object.
Request parameters:
name
- Output only. The full name of the source.
Value must have pattern
^projects/\[^/\]+/locations/\[^/\]+/sources/\[^/\]+$
.
requestId
- Optional. An optional request ID to identify requests.
Specify a unique request ID so that if you must retry your request, the
server will know to ignore the request if it has already been completed.
The server will guarantee that for at least 60 minutes since 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 Source
resource by the update. The values specified
in the update_mask
field are relative to the resource, not the full
request. A field will be overwritten if it is in the mask. A single *
value in the mask lets you to overwrite all fields.
$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(
Source request,
core.String name, {
core.String? requestId,
core.String? updateMask,
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if (requestId != null) 'requestId': [requestId],
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 Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}