Patch v1+name — backupdr

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1339136214.2 KB

projects

Updates the settings of a Backup.

patch/v1/{+name}

Path parameters

namestring required

Output only. Identifier. Name of the backup to create. It must have the format"projects//locations//backupVaults//dataSources/{datasource}/backups/{backup}". {backup} cannot be changed after creation. It must be between 3-63 characters long and must be unique within the datasource.

Query parameters

requestIdstring

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).

updateMaskstring

Required. Field mask is used to specify the fields to be overwritten in the Backup 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.

updateMaskstring

Required. Field mask is used to specify the fields to be overwritten in the DataSource 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.

updateMaskstring

Required. Field mask is used to specify the fields to be overwritten in the BackupVault 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.

validateOnlyboolean

Optional. Only validate the request, but do not perform mutations. The default is 'false'.

Request body

labelsobject

Optional. Resource labels to represent user provided metadata. No labels currently defined.

updateTimestring google-datetime

Output only. The time when the instance was updated.

backupRetentionInheritance'BACKUP_RETENTION_INHERITANCE_UNSPECIFIED' | 'INHERIT_VAULT_RETENTION' | 'MATCH_BACKUP_EXPIRE_TIME'

Output only. Setting for how the enforced retention end time is inherited. This value is copied from this backup's BackupVault.

createTimestring google-datetime

Output only. The time when the instance was created.

satisfiesPzsboolean

Optional. Output only. Reserved for future use.

expireTimestring google-datetime

Optional. When this backup is automatically expired.

Output only. The Backup resource instance state.

satisfiesPziboolean

Optional. Output only. Reserved for future use.

descriptionstring

Output only. The description of the Backup instance (2048 characters or less).

namestring

resourceSizeBytesstring int64

Output only. source resource size in bytes at the time of the backup.

backupType'BACKUP_TYPE_UNSPECIFIED' | 'SCHEDULED' | 'ON_DEMAND' | 'ON_DEMAND_OPERATIONAL'

Output only. Type of the backup, unspecified, scheduled or ondemand.

kmsKeyVersionsstring[]

Optional. Output only. The list of KMS key versions used to encrypt the backup.

consistencyTimestring google-datetime

Output only. The point in time when this backup was captured from the source.

etagstring

Optional. Server specified ETag to prevent updates from overwriting each other.

enforcedRetentionEndTimestring google-datetime

Optional. The backup can not be deleted before this time.

Response

Successful response