Google Cloud Filestore V1 Client - Class Backup (1.0.3)

Reference documentation and code samples for the Google Cloud Filestore V1 Client class Backup.

A Cloud Filestore backup.

Generated from protobuf message google.cloud.filestore.v1.Backup

Methods

__construct

Constructor.

Parameters
NameDescription
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 Google\Protobuf\Timestamp

Output only. The time when the backup was created.

↳ labels array|Google\Protobuf\Internal\MapField

Resource labels to represent user provided metadata.

↳ 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 Cloud 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 Cloud Filestore instance that the backup is created from.

↳ source_instance_tier int

Output only. The service tier of the source Cloud 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 Google\Protobuf\BoolValue

Output only. Reserved for future use.

getName

Output only. The resource name of the backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}.

Returns
TypeDescription
string

setName

Output only. The resource name of the backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

A description of the backup with 2048 characters or less.

Requests with longer descriptions will be rejected.

Returns
TypeDescription
string

setDescription

A description of the backup with 2048 characters or less.

Requests with longer descriptions will be rejected.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getState

Output only. The backup state.

Returns
TypeDescription
int

setState

Output only. The backup state.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getCreateTime

Output only. The time when the backup was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when the backup was created.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getLabels

Resource labels to represent user provided metadata.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

Resource labels to represent user provided metadata.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getCapacityGb

Output only. Capacity of the source file share when the backup was created.

Returns
TypeDescription
int|string

setCapacityGb

Output only. Capacity of the source file share when the backup was created.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$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.

Returns
TypeDescription
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.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getSourceInstance

The resource name of the source Cloud Filestore instance, in the format projects/{project_number}/locations/{location_id}/instances/{instance_id}, used to create this backup.

Returns
TypeDescription
string

setSourceInstance

The resource name of the source Cloud Filestore instance, in the format projects/{project_number}/locations/{location_id}/instances/{instance_id}, used to create this backup.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSourceFileShare

Name of the file share in the source Cloud Filestore instance that the backup is created from.

Returns
TypeDescription
string

setSourceFileShare

Name of the file share in the source Cloud Filestore instance that the backup is created from.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSourceInstanceTier

Output only. The service tier of the source Cloud Filestore instance that this backup is created from.

Returns
TypeDescription
int

setSourceInstanceTier

Output only. The service tier of the source Cloud Filestore instance that this backup is created from.

Parameter
NameDescription
var int
Returns
TypeDescription
$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.

Returns
TypeDescription
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.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getSatisfiesPzs

Output only. Reserved for future use.

Returns
TypeDescription
Google\Protobuf\BoolValue|null

hasSatisfiesPzs

clearSatisfiesPzs

getSatisfiesPzsValue

Returns the unboxed value from getSatisfiesPzs()

Output only. Reserved for future use.

Returns
TypeDescription
bool|null

setSatisfiesPzs

Output only. Reserved for future use.

Parameter
NameDescription
var Google\Protobuf\BoolValue
Returns
TypeDescription
$this

setSatisfiesPzsValue

Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.

Output only. Reserved for future use.

Parameter
NameDescription
var bool|null
Returns
TypeDescription
$this