Skip to main content

backups

Overview

Namebackups
TypeResource
Idgoogle.file.backups

Fields

NameDatatypeDescription
namestringOutput only. The resource name of the backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}.
descriptionstringA description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
sourceFileSharestringName of the file share in the source Filestore instance that the backup is created from.
createTimestringOutput only. The time when the backup was created.
statestringOutput only. The backup state.
sourceInstanceTierstringOutput only. The service tier of the source Filestore instance that this backup is created from.
capacityGbstringOutput only. Capacity of the source file share when the backup was created.
storageBytesstringOutput only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.
sourceInstancestringThe resource name of the source Filestore instance, in the format projects/{project_number}/locations/{location_id}/instances/{instance_id}, used to create this backup.
downloadBytesstringOutput only. Amount of bytes that will be downloaded if the backup is restored. This may be different than storage bytes, since sequential backups of the same disk will share storage.
kmsKeystringImmutable. KMS key name used for data encryption.
labelsobjectResource labels to represent user provided metadata.
satisfiesPzsbooleanOutput only. Reserved for future use.

Methods

NameAccessible byRequired ParamsDescription
getSELECTbackupsId, locationsId, projectsIdGets the details of a specific backup.
listSELECTlocationsId, projectsIdLists all backups in a project for either a specified location or for all locations.
createINSERTlocationsId, projectsIdCreates a backup.
deleteDELETEbackupsId, locationsId, projectsIdDeletes a backup.
_listEXEClocationsId, projectsIdLists all backups in a project for either a specified location or for all locations.
patchEXECbackupsId, locationsId, projectsIdUpdates the settings of a specific backup.