Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backupId} where the cluster and backup ID segments should satisfy the regex expression [a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource: * projects/{project}/locations/{region}
Optional. Field mask is used to specify the fields to be overwritten in the Backup resource by the update. The fields specified in the 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 all fields will be overwritten.
This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
requestId
string
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees 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 the original operation with the same request ID was received, and if so, ignores 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).
validateOnly
boolean
Optional. If set, the backend validates the request, but doesn't actually execute it.
allowMissing
boolean
Optional. If set to true, update succeeds even if instance is not found. In that case, a new backup is created and updateMask is ignored.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-15 UTC."],[[["\u003cp\u003eThis API endpoint updates the parameters of a single Backup resource using a PATCH request.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ebackup.name\u003c/code\u003e path parameter is required and specifies the unique identifier of the backup in the format \u003ccode\u003eprojects/*/locations/*/backups/*\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eupdateMask\u003c/code\u003e query parameter allows for selective updating of specific fields within the Backup resource, with all fields being overwritten if a mask is not provided.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003erequestId\u003c/code\u003e query parameter allows clients to provide an optional unique ID to prevent duplicate operations from being created.\u003c/p\u003e\n"],["\u003cp\u003eThe request body contains an instance of a Backup resource, and a successful response returns an instance of an Operation resource.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.backups.patch\n\nUpdates the parameters of a single Backup.\n\n### HTTP request\n\n`PATCH https://alloydb.googleapis.com/v1/{backup.name=projects/*/locations/*/backups/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body contains an instance of [Backup](/alloydb/docs/reference/rest/v1/projects.locations.backups#Backup).\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/alloydb/docs/reference/rest/Shared.Types/ListOperationsResponse#Operation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
