patch method
- BackupPlanAssociation request,
- String name, {
- String? requestId,
- String? updateMask,
- String? $fields,
Update a BackupPlanAssociation.
request
- The metadata request object.
Request parameters:
name
- Output only. Identifier. The resource name of
BackupPlanAssociation in below format Format :
projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}
Value must have pattern
^projects/\[^/\]+/locations/\[^/\]+/backupPlanAssociations/\[^/\]+$
.
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 t he 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. The list of fields to update. Field mask is used
to specify the fields to be overwritten in the BackupPlanAssociation
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 is in the mask. If the user does not provide a mask then
the request will fail. Currently backup_plan_association.backup_plan is
the only supported field.
$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(
BackupPlanAssociation 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>);
}