Reference documentation and code samples for the Google Cloud Filestore V1 Client class Backup.
A Filestore backup.
Generated from protobuf message google.cloud.filestore.v1.Backup
Namespace
Google \ Cloud \ Filestore \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. The resource name of the backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}
.
↳ description
string
A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
↳ state
int
Output only. The backup state.
↳ create_time
↳ labels
↳ capacity_gb
int|string
Output only. Capacity of the source file share when the backup was created.
↳ storage_bytes
int|string
Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.
↳ source_instance
string
The resource name of the source Filestore instance, in the format projects/{project_number}/locations/{location_id}/instances/{instance_id}
, used to create this backup.
↳ source_file_share
string
Name of the file share in the source Filestore instance that the backup is created from.
↳ source_instance_tier
int
Output only. The service tier of the source Filestore instance that this backup is created from.
↳ download_bytes
int|string
Output 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.
↳ satisfies_pzs
↳ satisfies_pzi
bool
Output only. Reserved for future use.
↳ kms_key
string
Immutable. KMS key name used for data encryption.
↳ tags
array| Google\Protobuf\Internal\MapField
Optional. Input only. Immutable. Tag key-value pairs bound to this resource. Each key must be a namespaced name and each value a short name. Example: "123456789012/environment" : "production", "123456789013/costCenter" : "marketing" See the documentation for more information: - Namespaced name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key - Short name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_value
↳ file_system_protocol
int
Output only. The file system protocol of the source Filestore instance that this backup is created from.
getName
Output only. The resource name of the backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}
.
string
setName
Output only. The resource name of the backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}
.
var
string
$this
getDescription
A description of the backup with 2048 characters or less.
Requests with longer descriptions will be rejected.
string
setDescription
A description of the backup with 2048 characters or less.
Requests with longer descriptions will be rejected.
var
string
$this
getState
Output only. The backup state.
int
setState
Output only. The backup state.
var
int
$this
getCreateTime
Output only. The time when the backup was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time when the backup was created.
$this
getLabels
Resource labels to represent user provided metadata.
setLabels
Resource labels to represent user provided metadata.
$this
getCapacityGb
Output only. Capacity of the source file share when the backup was created.
int|string
setCapacityGb
Output only. Capacity of the source file share when the backup was created.
var
int|string
$this
getStorageBytes
Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.
int|string
setStorageBytes
Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.
var
int|string
$this
getSourceInstance
The resource name of the source Filestore instance, in the format projects/{project_number}/locations/{location_id}/instances/{instance_id}
,
used to create this backup.
string
setSourceInstance
The resource name of the source Filestore instance, in the format projects/{project_number}/locations/{location_id}/instances/{instance_id}
,
used to create this backup.
var
string
$this
getSourceFileShare
Name of the file share in the source Filestore instance that the backup is created from.
string
setSourceFileShare
Name of the file share in the source Filestore instance that the backup is created from.
var
string
$this
getSourceInstanceTier
Output only. The service tier of the source Filestore instance that this backup is created from.
int
setSourceInstanceTier
Output only. The service tier of the source Filestore instance that this backup is created from.
var
int
$this
getDownloadBytes
Output 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.
int|string
setDownloadBytes
Output 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.
var
int|string
$this
getSatisfiesPzs
Output only. Reserved for future use.
hasSatisfiesPzs
clearSatisfiesPzs
getSatisfiesPzsUnwrapped
Returns the unboxed value from getSatisfiesPzs()
Output only. Reserved for future use.
bool|null
setSatisfiesPzs
Output only. Reserved for future use.
$this
setSatisfiesPzsUnwrapped
Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.
Output only. Reserved for future use.
var
bool|null
$this
getSatisfiesPzi
Output only. Reserved for future use.
bool
setSatisfiesPzi
Output only. Reserved for future use.
var
bool
$this
getKmsKey
Immutable. KMS key name used for data encryption.
string
setKmsKey
Immutable. KMS key name used for data encryption.
var
string
$this
getTags
Optional. Input only. Immutable. Tag key-value pairs bound to this resource. Each key must be a namespaced name and each value a short name.
Example: "123456789012/environment" : "production", "123456789013/costCenter" : "marketing" See the documentation for more information:
setTags
Optional. Input only. Immutable. Tag key-value pairs bound to this resource. Each key must be a namespaced name and each value a short name.
Example: "123456789012/environment" : "production", "123456789013/costCenter" : "marketing" See the documentation for more information:
$this
getFileSystemProtocol
Output only. The file system protocol of the source Filestore instance that this backup is created from.
int
setFileSystemProtocol
Output only. The file system protocol of the source Filestore instance that this backup is created from.
var
int
$this
