Google Cloud Filestore V1 Client - Class Backup (1.2.1)

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 \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`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 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`	`Google\Protobuf\BoolValue` Output only. Reserved for future use.
`↳ kms_key`	`string` Immutable. KMS key name used for data encryption.

getName

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

Returns
Type	Description
`string`

setName

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

A description of the backup with 2048 characters or less.

Requests with longer descriptions will be rejected.

Returns
Type	Description
`string`

setDescription

A description of the backup with 2048 characters or less.

Requests with longer descriptions will be rejected.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getState

Output only. The backup state.

Returns
Type	Description
`int`

setState

Output only. The backup state.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getCreateTime

Output only. The time when the backup was created.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when the backup was created.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getLabels

Resource labels to represent user provided metadata.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

Resource labels to represent user provided metadata.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getCapacityGb

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

Returns
Type	Description
`int\|string`

setCapacityGb

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

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$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
Type	Description
`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
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$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.

Returns
Type	Description
`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.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSourceFileShare

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

Returns
Type	Description
`string`

setSourceFileShare

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSourceInstanceTier

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

Returns
Type	Description
`int`

setSourceInstanceTier

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

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$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
Type	Description
`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
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getSatisfiesPzs

Output only. Reserved for future use.

Returns
Type	Description
`Google\Protobuf\BoolValue\|null`

hasSatisfiesPzs

clearSatisfiesPzs

getSatisfiesPzsValue

Returns the unboxed value from getSatisfiesPzs()

Output only. Reserved for future use.

Returns
Type	Description
`bool\|null`

setSatisfiesPzs

Output only. Reserved for future use.

Parameter
Name	Description
`var`	`Google\Protobuf\BoolValue`

Returns
Type	Description
`$this`

setSatisfiesPzsValue

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

Output only. Reserved for future use.

Parameter
Name	Description
`var`	`bool\|null`

Returns
Type	Description
`$this`

getKmsKey

Immutable. KMS key name used for data encryption.

Returns
Type	Description
`string`

setKmsKey

Immutable. KMS key name used for data encryption.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`